Message html to text and last message (LHN) fixes

[aldo-expensify]

This PR:

• ReportUtils.formatReportLastMessageText truncates to the first line (slack convo: https://expensify.slack.com/archives/C01GTK53T8Q/p1669671957761929).
• Simplified the code deciding between rendering as html or text (no UI change)
• Update expensify-common version (Fix new lines when replacing <blockquote> and <br /> expensify-common#474)

Related PRs:

• https://github.com/Expensify/Web-Expensify/pull/35658

  • Updates how we convert from message[0].html to message[0].text using a centralized function
  • ReportUtils::convertCommentsHtmlToText, and makes it consistent with ExpensiMark.htmlToText
  • Added tests
  • Updated code that produces lastMessageText to be consistent with the App code. Now we only keep the first line (slack convo: https://expensify.slack.com/archives/C01GTK53T8Q/p1669671957761929).

• Fix new lines when replacing <blockquote> and <br /> expensify-common#474:

  • Updates ExpensiMark.htmlToText to:
    • replace each <br /> by \n
    • replace <blockquote> by \n when there is content before it
    • replace </blockquote> by \n when there is content after it
  • Updated tests.

Fixed Issues

$ #12894 (partially)
#11494 (partially)
PROPOSAL: https://expensify.slack.com/archives/C01GTK53T8Q/p1669149309886219 (outdated)

Tests

1. Go to a chat
2. Go offline, this way we make sure you are seeing the data produced by the frontend and not what came from the backend
3. Compose a message by:
   1. Add an emoji
   2. Add two or more empty lines
   3. Add an emoji
      
4. Send the message
5. Verify that the report in the LHN shows just one emoji (first line) as the last message
6. Find report action in Onyx and make sure that the line breaks appear as \n in message[0].text
   
7. Compose another message with the content:

before quoted text
> quoted text
after quoted text

8. Verify that the report in the LHN shows "before quoted text" (first line) as the last message
9. Find report action in Onyx and make sure that the message[0].text contains before quoted text\nquoted text\nafter quoted text. This is because <blockquote> are block elements and they should cause line breaks in the content.
   
10. Use the "Copy to clipboard" action on the last message and paste it in a text editor.
11. Verify that the pasted message contain the line breaks

• Verify that no errors appear in the JS console

Offline tests

QA Steps

1. Go to a chat
2. Go offline, this way we make sure you are seeing the data produced by the frontend and not what came from the backend
3. Compose a message by:
   1. Add an emoji
   2. Add two or more empty lines
   3. Add an emoji
      
4. Send the message
5. Verify that the report in the LHN shows just one emoji (first line) as the last message
6. Find report action in Onyx and make sure that the line breaks appear as \n in message[0].text
   
7. Compose another message with the content:

before quoted text
> quoted text
after quoted text

8. Verify that the report in the LHN shows "before quoted text" (first line) as the last message
9. Find report action in Onyx and make sure that the message[0].text contains before quoted text\nquoted text\nafter quoted text. This is because <blockquote> are block elements and they should cause line breaks in the content.
   
10. Use the "Copy to clipboard" action on the last message and paste it in a text editor.
11. Verify that the pasted message contain the line breaks

• 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:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 was added in all src/languages/* files
  • 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 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.
• I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

• 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 expected offline behavior are in the Offline steps 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 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 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:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 was added in all src/languages/* files
  • 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
• 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 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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

 

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[aldo-expensify]

I'm guessing that rendering something with <Text> instead of <RenderHTML> is more performant too.

[melvin-bot]

@rushatgabhane @MariaHCD 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]

[rushatgabhane]

@aldo-expensify it looks like we're fixing #11494 too. Can you please update OP and add it in fixed issue

[aldo-expensify]

Done!

[rushatgabhane]

noticed that sending quotes with multiple line breakers between them just removes the line breakers.

This also happens on production.
@aldo-expensify Is it possible that Web-Expensify/pull/35658 introduced this bug? (can't be accessed externally)

Alright, I don't think so. Going offline and sending the message gives the same result on production. So I think this is an unrelated "bug".

Screen.Recording.2022-12-01.at.4.24.09.AM.mov

[aldo-expensify]

@aldo-expensify Is it possible that Web-Expensify/pull/35658 introduced this bug? (can't be accessed externally)

Nop, this PR has not reached production yet (has not been merged yet). Good thinking in testing with offline though :)

That's probably another "bug" we could tackle in a different set of PR because it being caused by something different

Update: that is normal behaviour for markdown I think, I'm not sure if we would want to change it:

[rushatgabhane]

that is normal behaviour for markdown I think, I'm not sure if we would want to change it

nice catch, i agree.

@aldo-expensify
small bug: sending a single message with multiple lines, only shows the first line in LHN.

1. send this message

line 1
line 2

2. check that LHN shows "line 1" only.
3. after API.AddComment is complete, LHN show "line 1 line 2"

What should be the expected result? We could change the server side to show "line 1" only.
But we must be showing all lines for a reason. So let's update the client side to show all lines seperated by a space.

What do you think?

Screen.Recording.2022-12-01.at.4.50.16.AM.mov

[aldo-expensify]

that is normal behaviour for markdown I think, I'm not sure if we would want to change it

nice catch, i agree.

@aldo-expensify small bug: sending a single message with multiple lines, only shows the first line in LHN.

1. send this message

line 1
line 2

2. check that LHN shows "line 1" only.
3. after API.AddComment is complete, LHN show "line 1 line 2"

What should be the expected result? We could change the server side to show "line 1" only. But we must be showing all lines for a reason. So let's update the client side to show all lines seperated by a space.

Yes, this is because the server side PR https://github.com/Expensify/Web-Expensify/pull/35658 has not been merged and deployed yet.. so when you get the response, it is the old way of calculating lastMessateText. I think you should only test this offline so you don't get confused by whatever outdated thing the server is responding. There will be a few days with these glitches while the front and back end PR are not in production at the same time, and I don't see an easy way to avoid it.

[rushatgabhane]

Reviewer Checklist

@MariaHCD LGTM!

• 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:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 was added in all src/languages/* files
  • 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 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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2022-12-01.at.9.44.15.AM.mov

Mobile Web - Chrome

WhatsApp.Video.2022-12-01.at.09.52.20.mp4

Mobile Web - Safari

Screen.Recording.2022-12-01.at.9.52.52.AM.mov

Desktop

Screen.Recording.2022-12-01.at.10.01.19.AM.mov

iOS

Screen.Recording.2022-12-01.at.9.56.32.AM.mov

Android

WhatsApp.Video.2022-12-01.at.06.46.39.mp4

[rushatgabhane]

Yes, this is because the server side PR https://github.com/Expensify/Web-Expensify/pull/35658 has not been merged and deployed yet

Thanks for explaining that

[aldo-expensify]

@rushatgabhane I thought a bit more about this: #12968 (comment)

I think maybe we should report it as a separate bug because it is inconsistent with other cases. In markdown, many line breaks together always get collapsed into one:

but this is not the case in our chat, we respect all line breaks except when it comes to two consecutive quoted blocks. I think the argument I made about it being like that in markdown doesn't apply here.

[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 @MariaHCD in version: 1.2.36-0 🚀

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

[OSBotify]

🚀 Deployed to production by @francoisl in version: 1.2.36-4 🚀

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