Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix/35596: Last message text display incorrectly #37581

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Fix/35596: Last message text display incorrectly #37581

wants to merge 5 commits into from
+23 −11

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Mar 1, 2024 •
edited
Loading

Details

Fixed Issues

$ #35596
PROPOSAL: #35596 (comment)

Tests

  1. Open ND
  2. Open any report
  3. Send a multiple lines message. For example:
Line 1
Line 2
  1. Verify that only the first line of the message should be visible on LHN, and there is the ... at the end
  2. Refresh the page
  3. Verify that only the first line of the message should be visible on LHN, and there is the ... at the end (similar to step 4)
  • Verify that no errors appear in the JS console

Offline tests

  1. Open ND and go offline
  2. Open any report
  3. Send a multiple lines message. For example:
Line 1
Line 2
  1. Verify that only the first line of the message should be visible on LHN, and there is the ... at the end
  2. Refresh the page
  3. Verify that only the first line of the message should be visible on LHN, and there is the ... at the end (similar to step 4)

QA Steps

  1. Open ND
  2. Open any report
  3. Send a multiple lines message. For example:
Line 1
Line 2
  1. Verify that only the first line of the message should be visible on LHN, and there is the ... at the end
  2. Refresh the page
  3. Verify that only the first line of the message should be visible on LHN, and there is the ... at the end (similar to step 4)
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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
      • 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 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 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 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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Screencast.from.03-03-2024.23.26.03.webm
Android: mWeb Chrome
Screencast.from.01-03-2024.07.40.57.webm
iOS: Native
iOS: mWeb Safari
Screencast.from.01-03-2024.07.43.02.webm
MacOS: Chrome / Safari
Screencast.from.01-03-2024.07.34.27.webm
MacOS: Desktop

@dukenv0307 dukenv0307 marked this pull request as ready for review March 1, 2024 01:45
@dukenv0307 dukenv0307 requested a review from a team as a code owner March 1, 2024 01:45
@melvin-bot melvin-bot bot requested review from akinwale and removed request for a team March 1, 2024 01:45
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Mar 1, 2024

@akinwale 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]

@dukenv0307 dukenv0307 changed the title Fix/35596: Last message text display Fix/35596: Last message text display incorrectly Mar 1, 2024
@dukenv0307 dukenv0307 mentioned this pull request Mar 1, 2024
Closed
6 tasks
dukenv0307
dukenv0307 commented Mar 1, 2024
View reviewed changes
src/libs/ReportActionsUtils.ts
@@ -502,6 +502,7 @@ function getLastVisibleMessage(reportID: string, actionsToMerge: OnyxCollection<
}
return {
lastMessageText: messageText,
lastMessageHtml: message?.html,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To fix the main issue, our solution is to display the LHN text based on the lastMessageHtml. If we do not add lastMessageHtml: message?.html like this, when we remove any message, the LHN text is still the removed message

dukenv0307
dukenv0307 commented Mar 1, 2024
View reviewed changes
src/libs/ReportUtils.ts
return String(lastMessageText)
.trim()
.replace(CONST.REGEX.AFTER_FIRST_LINE_BREAK, ' '.repeat(CONST.REPORT.LAST_MESSAGE_TEXT_MAX_LENGTH))
.substring(0, CONST.REPORT.LAST_MESSAGE_TEXT_MAX_LENGTH);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to make sure when we send a multiple lines message, for example:

Line 1
Line 2

the LHN display as Line 1 ... (See issue)

akinwale
akinwale suggested changes Mar 2, 2024
View reviewed changes
Copy link
Contributor

@akinwale akinwale left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dukenv0307 Please, always test and upload videos or screenshots for all platforms.

The ellipses at the end are not displayed on Android and iOS native (look for the Multitline text in the LHN).

iOS native
Screenshot 2024-03-02 at 09 48 44

Android native
Screenshot 2024-03-02 at 09 50 34

iOS Safari for comparison
37581-ios-safari

@akinwale
Copy link
Contributor

akinwale commented Mar 3, 2024

@dukenv0307 Lint faililng.

@akinwale
Copy link
Contributor

akinwale commented Mar 3, 2024

Unit tests also failing.

@dukenv0307
Copy link
Contributor Author

@akinwale I am fixing all the issues and will ping you once done

akinwale
akinwale suggested changes Mar 4, 2024
View reviewed changes
Copy link
Contributor

@akinwale akinwale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dukenv0307 On iOS native, the ellipses are not at the end of the line, but are right next to the text instead.

Screenshot 2024-03-04 at 09 58 37

@dukenv0307
Copy link
Contributor Author

@akinwale Yeah, I see it. I am investigating that case and also, what do you think if we request the fix from BE side (the lastMessageText field ) rather than getting the last message text from lastMessageHTML?

@akinwale
Copy link
Contributor

akinwale commented Mar 4, 2024

@akinwale Yeah, I see it. I am investigating that case and also, what do you think if we request the fix from BE side (the lastMessageText field ) rather than getting the last message text from lastMessageHTML?

Based on my understanding, I think we generally want to avoid BE changes for things that can be fixed client-side, unless they're absolutely critical.

@puneetlath Any thoughts on this?

@puneetlath
Copy link
Contributor

Sorry, I don't totally understand the issue. Mind explaining it to me in plain terms?

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Mar 7, 2024 •
edited
Loading

@puneetlath
Currently, the report.lastMessageText that returned by BE is inconsistency.

  1. When we send a message:
Line 1
Line 2

the data returned in API AddComment is:

lastMessageText: "Line 1"
  1. Then refresh the page, the API OpenReport is called. The data returned in that API is:
lastMessageText: "Line 1 Line 2"

What we need is something like, lastMessageText: "Line 1 ...

I planned to fix it only on FE side by using lastMessageHTML field but finally, I think it will be better if we fix it on BE side for the consistency

@dukenv0307
Copy link
Contributor Author

@puneetlath Can you help check comment once you have a chance?

@puneetlath
Copy link
Contributor

Ah yes, interesting. I agree with you in that case that a BE fix makes the most sense.

@dukenv0307
Copy link
Contributor Author

@puneetlath Please ping me once BE is fixed. Thanks

@dukenv0307
Copy link
Contributor Author

@puneetlath Please help check this comment if you have a chance in case you miss it. Thanks

@puneetlath
Copy link
Contributor

I agree that we should fix on the back-end. I can update the issue to reflect that. Will we need to do anything with this PR then?

@dukenv0307
Copy link
Contributor Author

@puneetlath Yes. We need to fix the offline case after BE changes

@dukenv0307
Copy link
Contributor Author

@puneetlath Do we have any update here?

@puneetlath
Copy link
Contributor

Not yet. Haven't had a chance to prioritize the back-end fix.

@dukenv0307
Copy link
Contributor Author

@puneetlath Please ping me once you have any update. Thanks

@dukenv0307
Copy link
Contributor Author

@puneetlath Do you have any update on this?

@dukenv0307
Copy link
Contributor Author

@puneetlath Any updates? It has been delayed for a long time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akinwale akinwale akinwale requested changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dukenv0307 @akinwale @puneetlath