fix: use lazy loading for the IOU Report previews #33981

paultsimura · 2024-01-04T19:04:52Z

Details

Use report.lastMessageText in LHN as a fallback for the reports where an IOU Preview is the last action.

Fixed Issues

$ #32658
PROPOSAL: #32658 (comment)

Tests

Same as QA

Offline tests

Same as QA

QA Steps

Ensure that you have a 1:1 chat report where an IOU Preview is the last action
Log out
Log in

Verify that the summary text in the LHN for the mentioned report is "{userDisplayName} owes {amount}"

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

android-compressed.mp4

Android: mWeb Chrome

chrome-compressed.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-01-11.at.18.13.01.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-01-11.at.18.10.11.mp4

MacOS: Chrome / Safari

MacOS: Desktop

…eTextForReport

# Conflicts: # src/libs/PersonalDetailsUtils.ts

paultsimura · 2024-01-04T20:30:14Z

While working on this PR, I've noticed the following:
There are reports where a user we're having a conversation with is shown as "Hidden". But the BE sends their email as a part of report.lastMessageText anyway:

Since this account is hidden, we have no info about their personal details (no login to replace), and this brings a little complication to the current implementation:

I've seen in #32613 that there are plans to make all 1:1 contacts visible.
@mountiny @yuwenmemon should we hold this PR until then, or leave it as an edge case for now?

cubuspl42 · 2024-01-05T11:34:05Z

@paultsimura

Interesting findings.

What if we pivoted slightly? I wanted to suggest it earlier, just because I'm not super excited about purely textual search & replace, but now we have another reason.

function getLastMessageTextForReport(report: Report): string | null {
    // Mostly untouched, but...
    // - Return lastReportAction.message[0].text if lastReportAction is defined
    // - null otherwise (don't rely on lastMessageText in as fallback)
    throw new Error("TODO: Implement");
}

function getLastMessageForReport(report: Report | undefined): LastMessage {
    if (!report) {
        return {
            format: 'text',
            content: '',
        };
    }

    const customText = getLastMessageTextForReport(report);

    if (customText !== null) {
        return {
            format: 'text',
            content: customText,
        };
    } else {
        return {
            format: 'html',
            content: report?.lastMessageHtml ?? '',
        };
    }
}

On top of this, we could render html messages using RenderHTML, providing a very basic renderer.

For mention-user, we could extract part of the MentionUserRenderer. For other tags, just emit its text content.

paultsimura · 2024-01-05T17:24:24Z

@cubuspl42 I don't see a major benefit of this approach, could you please elaborate on why it's better for this case?

Unfortunately, the IOU summary from BE contains the same string for both text and html, so there's no chance to parse the mention-user from it:

Maybe I'm missing the point though...

cubuspl42 · 2024-01-08T12:21:01Z

@paultsimura I was confused, this message type indeed doesn't use the user-mention tag.

melvin-bot · 2024-01-11T17:23:18Z

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

paultsimura · 2024-01-11T17:27:00Z

Eventually, we've come to an agreement in Slack to use the report.lastMessageText as a general fallback without any changes to it.
Later on, the BE should return a user.displayName (or "Hidden") instead of the user.login in such messages.

Please note: for now, such messages will contain users' logins and will not be localizable – that's expected (Slack thread has more details about it).

cubuspl42 · 2024-01-12T11:43:59Z

Have you tested a case with the "Pay elsewhere" button, mentioned in the issue description?

cubuspl42 · 2024-01-12T11:47:18Z

I noticed this just now...

This isn't mentioned in the issue description, and we never included this in our discussion. I don't know what to do with this bit. It's obviously a problem; the only question is whether it falls under the scope of our issue & PR.

We'll have to confirm this...

paultsimura · 2024-01-12T11:57:17Z

the only question is whether it falls under the scope of our issue & PR.

IMO, this falls more into #33766.
And since I'm already assigned to that issue and started a PR, but it switched to Internal mid-way, maybe I could fix this bug in scope of that issue? Or at least investigate it.

@mountiny @youssef-lr WDYT?

cubuspl42 · 2024-01-12T12:33:44Z

@paultsimura If this is a known separate problem, then it should be fine! I didn't mean to add you extra work, I just thought that the other thing might not be tracked anywhere.

cubuspl42 · 2024-01-12T12:33:56Z

Have you tested a case with the "Pay elsewhere" button, mentioned in the issue description?

@paultsimura Bump on this

paultsimura · 2024-01-12T12:37:53Z

@cubuspl42 please check this: #32658 (comment)

It was decided to make it a separate issue. And apparently, the screenshot we've discussed earlier is also planned to be in that issue.

paultsimura · 2024-01-16T12:30:56Z

Hey @cubuspl42, considering the discussion above, would you be able to finish with the review here, please?

cubuspl42 · 2024-01-16T12:36:35Z

Of course, it's due. Please merge main, I'll get back to testing LHN only.

cubuspl42 · 2024-01-16T12:47:48Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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(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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

cubuspl42

Please merge main, and we're good

OSBotify · 2024-01-16T21:37:28Z

✋ 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 · 2024-01-18T03:13:11Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.26-2 🚀

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

paultsimura added 3 commits January 2, 2024 16:36

Use report.lastMessageText as the all-case fallback for getLastMessag…

d0c910e

…eTextForReport

Merge branch 'main' into fix/32658-lazy-lhn-subtext

016a24c

# Conflicts: # src/libs/PersonalDetailsUtils.ts

Update usage of getDisplayNameOrDefault

1d1bf14

paultsimura force-pushed the fix/32658-lazy-lhn-subtext branch from 88dbc3f to 1d1bf14 Compare January 4, 2024 20:28

Merge branch 'main' into fix/32658-lazy-lhn-subtext

411ecdc

paultsimura added 3 commits January 11, 2024 17:43

Merge branch 'main' into fix/32658-lazy-lhn-subtext

1bb63ab

Merge branch 'main' into fix/32658-lazy-lhn-subtext

06da36a

Use report.lastMessageText as the all-case fallback

8e1d451

paultsimura marked this pull request as ready for review January 11, 2024 17:23

paultsimura requested a review from a team as a code owner January 11, 2024 17:23

melvin-bot bot requested review from cubuspl42 and removed request for a team January 11, 2024 17:23

paultsimura mentioned this pull request Jan 11, 2024

[HOLD for payment 2024-01-25] [$500] [Wave 6: Workspace Chats] IOU - Chat with IOU shows "This is beginning" in LHN after login and no Pay elsewhere in IOU preview #32658

Closed

6 tasks

cubuspl42 suggested changes Jan 16, 2024

View reviewed changes

mountiny assigned paultsimura Jan 16, 2024

Merge branch 'main' into fix/32658-lazy-lhn-subtext

9cbd2c6

paultsimura requested a review from cubuspl42 January 16, 2024 15:25

cubuspl42 approved these changes Jan 16, 2024

View reviewed changes

melvin-bot bot requested a review from yuwenmemon January 16, 2024 16:34

yuwenmemon approved these changes Jan 16, 2024

View reviewed changes

yuwenmemon merged commit a7a3e7f into Expensify:main Jan 16, 2024
16 checks passed

github-actions bot mentioned this pull request Jan 17, 2024

Deploy Checklist: New Expensify 2024-01-17 #34621

Closed

58 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: use lazy loading for the IOU Report previews #33981

fix: use lazy loading for the IOU Report previews #33981

paultsimura commented Jan 4, 2024 •

edited

Loading

paultsimura commented Jan 4, 2024

cubuspl42 commented Jan 5, 2024

paultsimura commented Jan 5, 2024

cubuspl42 commented Jan 8, 2024

melvin-bot bot commented Jan 11, 2024

paultsimura commented Jan 11, 2024

cubuspl42 commented Jan 12, 2024

cubuspl42 commented Jan 12, 2024

paultsimura commented Jan 12, 2024

cubuspl42 commented Jan 12, 2024

cubuspl42 commented Jan 12, 2024

paultsimura commented Jan 12, 2024

paultsimura commented Jan 16, 2024

cubuspl42 commented Jan 16, 2024

cubuspl42 commented Jan 16, 2024

cubuspl42 left a comment

OSBotify commented Jan 16, 2024

OSBotify commented Jan 18, 2024

fix: use lazy loading for the IOU Report previews #33981

fix: use lazy loading for the IOU Report previews #33981

Conversation

paultsimura commented Jan 4, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

paultsimura commented Jan 4, 2024

cubuspl42 commented Jan 5, 2024

paultsimura commented Jan 5, 2024

cubuspl42 commented Jan 8, 2024

melvin-bot bot commented Jan 11, 2024

paultsimura commented Jan 11, 2024

cubuspl42 commented Jan 12, 2024

cubuspl42 commented Jan 12, 2024

paultsimura commented Jan 12, 2024

cubuspl42 commented Jan 12, 2024

cubuspl42 commented Jan 12, 2024

paultsimura commented Jan 12, 2024

paultsimura commented Jan 16, 2024

cubuspl42 commented Jan 16, 2024

cubuspl42 commented Jan 16, 2024

Reviewer Checklist

Screenshots/Videos

cubuspl42 left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 16, 2024

OSBotify commented Jan 18, 2024

paultsimura commented Jan 4, 2024 •

edited

Loading