[NoQA] Memoize expensive calls in ReportActionsList renderItem #27957

janicduplessis · 2023-09-21T17:18:51Z

Details

Some of the operations we do in ReportActionsList renderItem are pretty expensive since this function is executed for every items in the render window every time the render window changes. To improve performance of FlatList scrolling we need to move any expensive computation inside a memoized component. This way when FlatList re-renders to display new items but the data did not change only the new rendered items will need to render.

We were already memoizing ReportActionItem, but renderItem still contains some expensive calls, specifically isConsecutiveActionMadeByPreviousActor which has to do some date comparaisons. I moved those to a new component ReportActionsListItemRenderer which will prevent any re-renders coming from from FlatList for items that were already rendered. This reduces the number of calls to isConsecutiveActionMadeByPreviousActor from the number of currently rendered item (~100 depending on the FlatList window size) to just the new items being added (usually 10 since this is the batch size).

Fixed Issues

$ #27972

Tests

Make sure there are no behaviour change when scrolling in a chat.

Using react profile we can observe render time for new FlatList batches goes from ~100ms to ~30ms.

Verify that no errors appear in the JS console

Offline tests

QA Steps

No specific QA steps, general regression testing should catch any issues we might stumble upon

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

mountiny · 2023-09-22T01:51:41Z

src/pages/home/report/ReportActionsListItemRenderer.js

+    /** Report for this action */
+    report: reportPropTypes.isRequired,
+
+    /* Whether the option has an outstanding IOU */


Suggested change

/* Whether the option has an outstanding IOU */

/** Whether the option has an outstanding IOU */

src/pages/home/report/ReportActionsListItemRenderer.js

mollfpr · 2023-09-22T05:10:22Z

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 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 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

27957.Web.mov

Mobile Web - Chrome

Screen_Recording_20230922_134433_Chrome.mp4

Mobile Web - Safari

27957.mWeb.Safari.mp4

Desktop

27957.Desktop.mov

iOS

Simulator.Screen.Recording.-.iPhone.SE.3rd.generation.-.2023-09-22.at.13.42.41.mp4

Android

27957.Android.webm

mollfpr · 2023-09-22T05:52:19Z

@mountiny Should @janicduplessis be required to complete the recordings?

mountiny · 2023-09-22T06:23:16Z

@janicduplessis I thin kit would be great if you could get into habit of adding the recordings

But seems like you got ti covered now so if everything tests well now maybe we can proceed, what do you think?

mollfpr · 2023-09-22T06:32:56Z

But seems like you got ti covered now so if everything tests well now maybe we can proceed, what do you think?

Yup, everything looks good and I verified the re-render has decreased from before.

mountiny · 2023-09-22T06:48:49Z

@mollfpr In that case I think we can complete your checklist and merge

mollfpr · 2023-09-22T06:57:51Z

@mountiny There's one NAB we need to solve.

mountiny · 2023-09-22T07:11:26Z

I see thnaks!

janicduplessis · 2023-09-22T08:27:40Z

@mollfpr @mountiny Thanks for reviewing this, I addressed your feedback.

@mountiny Are the recordings always required? I thought since there are no behaviour change it was ok but I can always add in the future. It does make sense as a way to confirm it actually still works.

mollfpr

LGTM and tests well 👍

mountiny

Thanks

OSBotify · 2023-09-22T09:19:11Z

✋ 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-09-22T13:58:38Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.73-0 🚀

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

OSBotify · 2023-09-25T09:33:29Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:05:27Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.74-0 🚀

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

OSBotify · 2023-09-28T18:47:48Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

shubham1206agra · 2024-01-03T16:00:19Z

src/pages/home/report/ReportActionsListItemRenderer.js

+            shouldHideThreadDividerLine={shouldHideThreadDividerLine}
+            report={report}
+            action={reportAction}
+            displayAsGroup={ReportActionsUtils.isConsecutiveActionMadeByPreviousActor(sortedReportActions, index)}


This line created a bug in offline mode. More details in #32101

alitoshmatov · 2024-05-01T05:13:47Z

src/pages/home/report/ReportActionsListItemRenderer.js

+            action={reportAction}
+            displayAsGroup={ReportActionsUtils.isConsecutiveActionMadeByPreviousActor(sortedReportActions, index)}
+            shouldDisplayNewMarker={shouldDisplayNewMarker}
+            shouldShowSubscriptAvatar={


We don't want to show subscript avatar if it is money request: #38974

Memoize expensive calls in ReportActionsList renderItem

4c6a40f

janicduplessis requested a review from a team as a code owner September 21, 2023 17:18

Add prop types

2c539de

mountiny reviewed Sep 22, 2023

View reviewed changes

mountiny assigned janicduplessis Sep 22, 2023

mountiny requested review from mollfpr and removed request for a team September 22, 2023 03:14

mollfpr requested changes Sep 22, 2023

View reviewed changes

src/pages/home/report/ReportActionsListItemRenderer.js Show resolved Hide resolved

Review fixes

a53e871

mollfpr approved these changes Sep 22, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny September 22, 2023 08:33

mountiny changed the title ~~Memoize expensive calls in ReportActionsList renderItem~~ [NoQA] Memoize expensive calls in ReportActionsList renderItem Sep 22, 2023

mountiny approved these changes Sep 22, 2023

View reviewed changes

mountiny merged commit 887c7f8 into Expensify:main Sep 22, 2023

janicduplessis deleted the @janic/item-renderer branch September 22, 2023 09:38

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

melvin-bot bot mentioned this pull request Sep 25, 2023

[HOLD for payment 2023-10-02] Memoize expensive calls in ReportActionsList renderItem #27972

Closed

shubham1206agra reviewed Jan 3, 2024

View reviewed changes

shubham1206agra mentioned this pull request Jan 3, 2024

[HOLD for payment 2023-12-29] [$500] Chat–Name of message owner disappears from DM for a second when delete first message in Offline #32101

Closed

6 tasks

alitoshmatov reviewed May 1, 2024

View reviewed changes

alitoshmatov mentioned this pull request May 1, 2024

[HOLD for payment 2024-05-02] [$500] Avatars used in report and transaction actions are not consistent #38974

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] Memoize expensive calls in ReportActionsList renderItem #27957

[NoQA] Memoize expensive calls in ReportActionsList renderItem #27957

janicduplessis commented Sep 21, 2023 •

edited by mountiny

Loading

mountiny Sep 22, 2023

mollfpr commented Sep 22, 2023 •

edited

Loading

mollfpr commented Sep 22, 2023

mountiny commented Sep 22, 2023

mollfpr commented Sep 22, 2023

mountiny commented Sep 22, 2023

mollfpr commented Sep 22, 2023

mountiny commented Sep 22, 2023

janicduplessis commented Sep 22, 2023

mollfpr left a comment

mountiny left a comment

OSBotify commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

shubham1206agra Jan 3, 2024

alitoshmatov May 1, 2024

	/* Whether the option has an outstanding IOU */
	/** Whether the option has an outstanding IOU */

[NoQA] Memoize expensive calls in ReportActionsList renderItem #27957

[NoQA] Memoize expensive calls in ReportActionsList renderItem #27957

Conversation

janicduplessis commented Sep 21, 2023 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

mountiny Sep 22, 2023

Choose a reason for hiding this comment

mollfpr commented Sep 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr commented Sep 22, 2023

mountiny commented Sep 22, 2023

mollfpr commented Sep 22, 2023

mountiny commented Sep 22, 2023

mollfpr commented Sep 22, 2023

mountiny commented Sep 22, 2023

janicduplessis commented Sep 22, 2023

mollfpr left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

shubham1206agra Jan 3, 2024

Choose a reason for hiding this comment

alitoshmatov May 1, 2024

Choose a reason for hiding this comment

janicduplessis commented Sep 21, 2023 •

edited by mountiny

Loading

mollfpr commented Sep 22, 2023 •

edited

Loading