Parse comment before sending it to the back-end to preserve HTML entities

[pecanoro]

Details

WAF strips all HTML tags due to security reasons so if we don't encode the message, we lose them when showing them back to the user.

Fixed Issues

Part of #15131

Tests

1. Send/request money to any account.
2. In the what's for section, enter <a> blabla &nbsp </a>
3. Send the request, it should not fail and the message in the request in the chat should look like this:

4. Repeat the process but this time sending money, the message should be displayed exactly the same without missing any characters.
5. Click on the details for the request, the message should be properly formatted as well:

• Verify that no errors appear in the JS console

Offline tests

1. Send/request money to any account.
2. In the what's for section, enter <a> blabla &nbsp </a>
3. Send the request, it should not fail and the message in the request in the chat should look like this:

4. Repeat the process but this time sending money, the message should be displayed exactly the same without missing any characters.
5. Click on the details for the request, the message should be properly formatted as well:

QA Steps

1. Send/request money to any account.
2. In the what's for section, enter <a> blabla &nbsp </a>
3. Send the request, it should not fail and the message in the request in the chat should look like this:

4. Repeat the process but this time sending money, the message should be displayed exactly the same without missing any characters.
5. Click on the details for the request, the message should be properly formatted as well:

• Verify that no errors appear in the JS console

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • MacOS / Chrome / Safari
  • MacOS / Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (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. toggleReport and not onIconClick)
  • 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 shown in the product is localized by adding it to src/languages/* files and using the translation method
    • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• I followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• I verified that if a function's arguments changed that all usages have also been updated correctly
• 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 this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
  • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
  • 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(themeColors.componentBG)
• 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 Avatar is modified, I verified that Avatar is 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 a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
• If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
• I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[MelvinBot]

@aldo-expensify Please 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]

[tienifr]

@pecanoro I have checked the changes. It seems that you haven't addressed issues with the messages in BrowserNotification, LHN. Do I have to fix them in my PR (you told me to stick to the display name)? Thank you!

[luacmartins]

Web-E PR is in staging. Can we take this off hold?

[pecanoro]

Removing HOLD

[pecanoro]

@tienifr Back end is not encoding the HTML entities anymore for the text (still does for HTML) in the action, so if BrowserNotification and LHN are using that as they used to, it should work just fine. Changes form the back end are in staging, so you can test it using that.

[sobitneupane]

@pecanoro
Correct IOU Message is being displayed in chat. But in IOU Details page, the name "&#38" is being decoded to "&".

Expected Result: Requested NPR 70.00 from &#38 for <a> blabla &nbsp </a>

[sobitneupane]

@pecanoro We were having issue even with simple messages and IOU in browser notification, android push notification and LHN last message. It is pre-existing issue. Are we planning to solve it here?
Simple Message:
Expected message: hello &#38 <a>

IOU:
Expected message: Requested NPR 70.00 from &#38 for <a> blabla &nbsp </a>

LHN:
Expected message: hello &#38 <a>

[pecanoro]

@sobitneupane I am confused, which part do you say it's not working yet? I didn't change normal messages, only IOU messages. Do you mean that the IOU browser notification?

[sobitneupane]

@pecanoro #16055 (comment) is a pre-existing issue and is not resulted by this PR. The issue exists both for simple message and IOU message. It occurs in Browser Notification, LHN and android Notification.

[pecanoro]

@sobitneupane Gotcha! I think that issue is being handled here #15508

[sobitneupane]

Okay Thanks. Then we have one issue left. #16055 (comment)

[pecanoro]

@sobitneupane We are supposed to fix profile names in the other PR from @tienifr.

[pecanoro]

However, I actually think the converted characters should be handled by #15508

[sobitneupane]

I raised it here because IOU Message is displayed correctly in chat but not in IOU Details.

I think we should remove Str.htmlDecode and replace html with text in the following line.

App/src/components/ReportTransaction.js

Line 80 in 3be4d99

{Str.htmlDecode(this.props.action.message[0].html)}

We can either handle it here or in the other PR from @tienifr.

[sobitneupane]

I have added comment in #15508 (comment) to make sure #16055 (comment) issue gets resolved there.

[pecanoro]

I raised it here because IOU Message is displayed correctly in chat but not in IOU Details.

What do you mean by that? I tested that and it was showing correctly, I even added screenshots. Sorry, I am not sure if I am missing some specific case I didn't test. Did you use staging for the changes?

[pecanoro]

@sobitneupane Or are you are taking about the profile name? I didn't fix that, only focused on the message.

[sobitneupane]

@pecanoro
In the following screenshot, IOU Message in chat (in green box) is the expected IOU Message. You can notice that IOU Message in Details (in red box) has "&" instead of "&#38". IOU Message in chat (in green box) and IOU Message in Details (in red box) should be same.

[pecanoro]

@sobitneupane We mentioned that profile names were being handled in #15340.

[pecanoro]

@sobitneupane They probably need to be sent encoded to the back-end so they get decoded before being sent back.

[luacmartins]

I think we need to update the Split Bill flow as well

[sobitneupane]

@pecanoro Looks like we have merge conflicts.

[pecanoro]

I will update this today, I was on vacation for a few days!

[sobitneupane]

Screenshots/Videos

Web

Screen.Recording.2023-03-29.at.15.38.28.mov

Mobile Web - Chrome

Screen.Recording.2023-03-29.at.15.44.45.mov

Mobile Web - Safari

Screen.Recording.2023-03-29.at.15.46.47.mov

Desktop

Screen.Recording.2023-03-29.at.15.42.50.mov

iOS

Android

Screen.Recording.2023-03-29.at.15.57.51.mov

[sobitneupane]

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 Issues section 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 Tests section
  • I verified the steps for Staging and/or Production testing are in the QA steps section
  • 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 checked that screenshots or videos are included for tests on all platforms
• I included screenshots or videos for tests on all platforms
• I verified tests pass on all platforms & I tested again on:
  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • MacOS / Chrome / Safari
  • MacOS / Desktop
• 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. toggleReport and not onIconClick).
  • 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 shown in the product is localized by adding it to src/languages/* files and using the translation method
  • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• 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 using Avatar have been tested & I retested again)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• 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 this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
  • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
  • 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(themeColors.componentBG)
• 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 Avatar is modified, I verified that Avatar is 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 a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
• If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[OSBotify]

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.2.92-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.92-2 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅