[CP Staging] Preserve self-closing tags and entities when tokenizing comment HTML - #97316
Conversation
tokenizeForReveal parsed comment HTML with htmlparser2 and re-serialized it with dom-serializer using default options on both calls. recognizeSelfClosing defaults to false in HTML mode, so the parser ignored the trailing slash on custom tags such as victorypie and nested every following sibling inside the previous element. The chart renderer walks the tree recursively when parsing but reads chart elements from direct children only, so it found the pie data yet never rendered the pie, leaving a chart with a title and centre total but no donut. The default serializer options also decoded escaped entities on output, so escaped markup in a comment came back as live markup.
|
@gijoe0295 @luacmartins One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button] |
Reviewer Checklist
Screenshots/VideosAndroid: HybridAppAndroid: mWeb ChromeiOS: HybridAppiOS: mWeb SafariMacOS: Chrome / Safari |
|
Testing... |
There was a problem hiding this comment.
Reviewer Checklist
- I have verified the author checklist is complete (all boxes are checked off).
- I verified the correct issue is linked in the
### Fixed Issuessection above - I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I verified the steps for local testing are in the
- I checked that screenshots or videos are included for tests on all platforms
- I included screenshots or videos for tests on all platforms
- I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
- I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
- I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e.
toggleReportand notonIconClick). - I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e.
- If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
- I verified that this PR follows the guidelines as stated in the Review Guidelines
- I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like
Avatar, I verified the components usingAvatarhave been tested & I retested again) - If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a
/** comment above it */ - The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
- If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
- If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e.
StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
- If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
- If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like
Avataris modified, I verified thatAvataris working as expected in all cases) - If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
- If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
- If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
- If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
29.07.2026_15.42.37_REC.mp4
29.07.2026_15.49.52_REC.mp4
🎀 👀 🎀 C+ reviewed
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
|
I was requested on Slack urgently and was already working on this. There was an old PR for this, which we closed where I was C+ as well.. Also, the checklist was not done, so I completed it given that it was urgent |
|
Hmm what a coincidence, I was requested as well while you're away Nvm 👍 |
|
Might be due to urgency but I was not away. Thanks. |
|
🚧 lakchote has triggered a test Expensify/App build. You can view the workflow run here. |
…eal-serialization [CP Staging] Preserve self-closing tags and entities when tokenizing comment HTML (cherry picked from commit f7d624b) (cherry-picked to staging by lakchote)
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
|
|
🚀 Cherry-picked to staging by https://github.com/lakchote in version: 9.4.45-13 🚀
|
|
🤖 No help site changes required. This PR is a purely internal rendering fix. It changes only the HTML parse/serialize options in Nothing here adds or changes a user-facing feature, setting, tab, button label, or workflow — the behavior a customer would follow is identical before and after. Expensify's help site articles under No draft docs PR was created. |
|
🚀 Deployed to production by https://github.com/marcaaron in version: 9.4.45-14 🚀
Bundle Size Analysis (Sentry): |
|
🚀 Cherry-picked to staging by https://github.com/lakchote in version: 9.4.46-0 🚀
|
|
🤖 I reviewed the changes in this PR and no help site changes are required, so I did not create a draft docs PR. Why: This is an internal rendering fix. It changes two @roryabraham, there's no help site PR to review since no docs changes are needed here. If you disagree and think a doc should be updated, let me know which article and I'll draft it. |
|
🚀 Deployed to production by https://github.com/marcaaron in version: 9.4.46-10 🚀
Bundle Size Analysis (Sentry): |
Explanation of Change
tokenizeForRevealbuilds streamed Concierge responses by parsing the comment HTML withhtmlparser2and re-serialising it withdom-serializer. Both calls used default options, which corrupts the markup in two ways:recognizeSelfClosingdefaults tofalsein HTML mode, so the parser ignores the trailing slash on custom tags.<victoryaxis … /><victorypie … />is parsed asvictoryaxiscontainingvictorypie, nesting every following sibling inside the previous element.processVictoryChartTreewalks the tree recursively so it still finds the pie and populates the chart data, butVictoryChartPolarreads chart elements fromtnode.childrenonly — so the pie is never rendered and the chart shows its background, title and centre total with no donut.decodeEntities,dom-serializerwrites attribute values and text with only"escaped, leaving&,<and>raw. Escaped markup in a comment is re-serialised as live markup.Passing
recognizeSelfClosing: truetoparseDocumentanddecodeEntities: truetorenderfixes both. The reveal now emits<victoryaxis …></victoryaxis>rather than<victoryaxis … />, which is not byte-identical to the input but parses to the same tree.The input to the tokenizer is the persisted
message.html, which is well formed —usePusherDraftPacingreads it viagetReportActionHtmland every reveal stage, including the final one, is serialiser output. This is why the chart renders correctly after a reload or after navigating away and back: those read the stored HTML directly and never pass through the tokenizer.Note
decodeEntities: truealso encodes non-ASCII characters as numeric references, so an emoji is serialised as😀. It re-parses to the same character, and reveal pacing is unaffected because anchors are computed from the DOM rather than the serialised string.Fixed Issues
$ #96699
PROPOSAL:
Tests
Offline tests
n/a - original bug happens only during streaming (online).
QA Steps
Same as tests.
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectioncanBeMissingparam foruseOnyxtoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
web.mov