align lastMessageText formatting with backend by trimming leading and trailing spaces #18822

honnamkuan · 2023-05-12T07:13:44Z

@robertjchen @rushatgabhane this PR is ready, appreciate your review.
The bug reported can be reproduced in MacOS web browser and Desktop app, but not on mobile as the LHN is not displayed along with the report chat in mobile, but I have includes video recordings for all platforms for completeness.

Details

Align formatting of lastMessageText formatting with backend by trimming the text in construction of optimistic report, so that there will be no difference between the text which get displayed immediate in LHN and the text received by Pusher event, covering add new comment, edit existing, and delete comment scenarios.

Fixed Issues

$ #17896
PROPOSAL: #17896 (comment)

Tests

Open any chat report
Write triple backticks code block with content having leading spaces e.g. message 1
Inspect LHN report list, ensure the last message is "message 1" without the leading spaces
Open the chat report and write another triple backticks code block with content having leading spaces e.g. message 2
Edit the second message to message 2 edited
Inspect LHN report list, ensure that last message is "message 2 edited" without leading spaces
Open the chat report and delete the second message
Inspect LHN report list, ensure that last message is "message 1" without leading spaces

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Open any chat report
Write triple backticks code block with content having leading spaces e.g. message 1
Inspect LHN report list, ensure the last message is "message 1" without the leading spaces
Open the chat report and write another triple backticks code block with content having leading spaces e.g. message 2
Edit the second message to message 2 edited
Inspect LHN report list, ensure that last message is "message 2 edited" without leading spaces
Open the chat report and delete the second message
Inspect LHN report list, ensure that last message is "message 1" without leading spaces

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-05-12.at.11.57.40.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-05-12.at.2.44.50.PM.mov

Mobile Web - Safari

Screen.Recording.2023-05-12.at.2.50.47.PM.mov

Desktop

Screen.Recording.2023-05-12.at.11.52.03.AM.mov

iOS

Screen.Recording.2023-05-12.at.2.36.37.PM.mov

Android

Screen.Recording.2023-05-12.at.2.40.58.PM.mov

by trimming leading and trailing spaces

melvin-bot · 2023-05-12T07:13:50Z

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

honnamkuan · 2023-05-12T07:33:59Z

src/libs/ReportActionsUtils.js

@@ -158,7 +158,7 @@ function getLastVisibleMessageText(reportID, actionsToMerge = {}) {
    const htmlText = lodashGet(lastVisibleAction, 'message[0].html', '');
    const parser = new ExpensiMark();
    const messageText = parser.htmlToText(htmlText);
-    return String(messageText).replace(CONST.REGEX.AFTER_FIRST_LINE_BREAK, '').substring(0, CONST.REPORT.LAST_MESSAGE_TEXT_MAX_LENGTH);
+    return String(messageText).replace(CONST.REGEX.AFTER_FIRST_LINE_BREAK, '').substring(0, CONST.REPORT.LAST_MESSAGE_TEXT_MAX_LENGTH).trim();


Here we are not reusing ReportUtils.formatReportLastMessage because currently ReportUtils is importing ReportActionsUtils. We cannot import ReportUtils functions into ReportActionsUtils, otherwise there will be a cyclic dependency between the two utility libraries.

This was the decision from a separate PR https://github.com/Expensify/App/pull/14779/files#r1098049449

thanks, that's helpful!

rushatgabhane · 2023-05-15T09:31:16Z

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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 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 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.

Screenshots/Videos

Web

Screen.Recording.2023-05-16.at.01.29.57.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2023-05-16.at.01.39.23.mov

iOS

Screen.Recording.2023-05-16.at.01.34.42.mov

Android

Screen.Recording.2023-05-16.at.01.31.50.mov

rushatgabhane

@robertjchen LGTM!!

robertjchen

Thanks! 👍

OSBotify · 2023-05-16T02:34:40Z

✋ 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 · 2023-05-17T01:08:42Z

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.3.15-0 🚀

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

OSBotify · 2023-05-18T06:51:53Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.15-12 🚀

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

s77rt · 2023-06-02T23:27:19Z

src/libs/ReportUtils.js

 * @param {String} lastMessageText
 * @returns {String}
 */
 function formatReportLastMessageText(lastMessageText) {
-    return String(lastMessageText).replace(CONST.REGEX.AFTER_FIRST_LINE_BREAK, '').substring(0, CONST.REPORT.LAST_MESSAGE_TEXT_MAX_LENGTH);
+    return Str.htmlDecode(String(lastMessageText)).replace(CONST.REGEX.AFTER_FIRST_LINE_BREAK, '').substring(0, CONST.REPORT.LAST_MESSAGE_TEXT_MAX_LENGTH).trim();


Just a note for future reference, we should never decode a plain text. A plain text is a raw text and not html, there is nothing to decode here.

For historic reasons we used to decode those due to another bug in Expensify-Common. We fixed that bug here #17658.

align lastMessageText formatting with backend

20cbe50

by trimming leading and trailing spaces

honnamkuan requested a review from a team as a code owner May 12, 2023 07:13

melvin-bot bot requested review from robertjchen and rushatgabhane and removed request for a team May 12, 2023 07:13

apply prettier formatting

aa8d418

honnamkuan commented May 12, 2023

View reviewed changes

rushatgabhane approved these changes May 15, 2023

View reviewed changes

robertjchen approved these changes May 16, 2023

View reviewed changes

robertjchen merged commit dd5fbb6 into Expensify:main May 16, 2023

OSBotify mentioned this pull request May 16, 2023

Deploy Checklist: New Expensify 2023-05-16 #19088

Closed

71 tasks

melvin-bot bot mentioned this pull request May 18, 2023

[HOLD for payment 2023-05-25] [$1000] Space appears for a brief moment in the LHN message before correcting it if a codeblock has a space at the beginning #17896

Closed

6 tasks

s77rt reviewed Jun 2, 2023

View reviewed changes

honnamkuan deleted the 17896 branch June 2, 2023 23:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

align lastMessageText formatting with backend by trimming leading and trailing spaces #18822

align lastMessageText formatting with backend by trimming leading and trailing spaces #18822

honnamkuan commented May 12, 2023

melvin-bot bot commented May 12, 2023

honnamkuan May 12, 2023

rushatgabhane May 15, 2023

rushatgabhane commented May 15, 2023 •

edited

Loading

rushatgabhane left a comment

robertjchen left a comment

OSBotify commented May 16, 2023

OSBotify commented May 17, 2023

OSBotify commented May 18, 2023

s77rt Jun 2, 2023

align lastMessageText formatting with backend by trimming leading and trailing spaces #18822

align lastMessageText formatting with backend by trimming leading and trailing spaces #18822

Conversation

honnamkuan commented May 12, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 12, 2023

honnamkuan May 12, 2023

Choose a reason for hiding this comment

rushatgabhane May 15, 2023

Choose a reason for hiding this comment

rushatgabhane commented May 15, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane left a comment

Choose a reason for hiding this comment

robertjchen left a comment

Choose a reason for hiding this comment

OSBotify commented May 16, 2023

OSBotify commented May 17, 2023

OSBotify commented May 18, 2023

s77rt Jun 2, 2023

Choose a reason for hiding this comment

rushatgabhane commented May 15, 2023 •

edited

Loading