perf: avoid using getOrderedReportIDs when calculating GBR/RBR state by TMisiukiewicz · Pull Request #55260 · Expensify/App

TMisiukiewicz · 2025-01-15T08:20:54Z

Explanation of Change

The function doing heavy calculations getOrderedReportIDs is called multiple times to calculate RBR state in the Bottom tabs menu. This leads to multiple slowdowns in the app when using account with a lot of data in the Onyx state, including switching between chats or switching between bottom tabs.

Fixed Issues

$ #55173
$ #54802
PROPOSAL: #54802 (comment)

Tests

Log in the app with freshly created account
Start a chat with any user
Create task and assign it to self
Verify the green dot is visible on the Inbox in the bottom menu
Resolve the task
Verify the green dot is not visible anymore
Split expense with anyone and upload an image which is not a receipt
After scanning, verify the red dot is visible on the Inbox in the bottom menu
Fill the amount in the expense manually
Verify the red dot is gone from Inbox

Log in with account that has a lot of data in the Onyx
Verify switching between chats goes smoothly

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2025-01-15T08:21:00Z

@rayane-djouah 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]

rayane-d · 2025-01-16T11:28:49Z

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 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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.ts 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Screen.Recording.2025-01-23.at.3.20.49.PM.mov

Android: mWeb Chrome

Screen.Recording.2025-01-23.at.3.22.11.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2025-01-23.at.15.16.43.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2025-01-23.at.15.18.36.mp4

MacOS: Chrome / Safari

Screen.Recording.2025-01-23.at.3.17.05.PM.mov

MacOS: Desktop

Screen.Recording.2025-01-23.at.3.17.34.PM.mov

…witch

TMisiukiewicz · 2025-01-20T12:25:50Z

Updated with latest main, @rayane-djouah mind taking a look?

adhorodyski · 2025-01-23T11:24:52Z

hey @rayane-djouah, friendly ping there!

rayane-d · 2025-01-23T11:47:31Z

-    const allReports = reportIDs.map((reportID) => reports?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]);
-
+function getChatTabBrickRoadReport(policyID: string | undefined, orderedReportIDs: string[] = []): OnyxEntry<Report> {
+    const allReports = orderedReportIDs.map((reportID) => reportsCollection?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]);


Not sure if this is necessary, but since we were returning undefined when reportIDs is empty, should we do the same for orderedReportIDs?

Suggested change

const allReports = orderedReportIDs.map((reportID) => reportsCollection?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]);

if (!orderedReportIDs.length) {

return undefined;

}

const allReports = orderedReportIDs.map((reportID) => reportsCollection?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]);

cc @adhorodyski @TMisiukiewicz

yeah we can do that for better readability, updated the PR

rayane-d · 2025-01-23T12:11:14Z

Bug: When there are multiple actions awaiting the user and the user performs one of them, the chat tab breadcrumb briefly hides and reappears. It should remain visible without disappearing momentarily.

Screen.Recording.2025-01-23.at.1.05.36.PM.mov

cc @TMisiukiewicz @adhorodyski

…witch

TMisiukiewicz · 2025-01-23T13:14:18Z

@rayane-djouah looks like a regression from another PR, the same happens on main 🤔 can it be fixed independently from this PR?

edit: looks like it happens on staging as well, once I have all tasks in concierge chat marked as done and I am checking tasks from another chat

rayane-d · 2025-01-23T13:50:04Z

Yeah, it seems reproducible on the main branch as well. I just reported it here: https://expensify.slack.com/archives/C049HHMV9SM/p1737639927181289. I also tested reverting our previous PR, but it appears to be unrelated 👍

rayane-d

LGTM and tests well

OSBotify · 2025-01-23T14:49: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.

github-actions · 2025-01-23T18:27:59Z

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.0.89-0 🚀

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

github-actions · 2025-01-28T01:51:24Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.89-8 🚀

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

TMisiukiewicz added 2 commits January 13, 2025 14:55

avoid using getOrderedReportIDs when calculating RBR state

6ef0b18

Merge branch 'main' into perf/improve-chat-switch

cc48a39

TMisiukiewicz requested a review from a team as a code owner January 15, 2025 08:20

melvin-bot Bot requested a review from rayane-d January 15, 2025 08:20

melvin-bot Bot removed the request for review from a team January 15, 2025 08:21

TMisiukiewicz changed the title ~~perf: avoid using getOrderedReportIDs when calculating RBR state~~ perf: avoid using getOrderedReportIDs when calculating GBR/RBR state Jan 15, 2025

fix changed

20adc9c

TMisiukiewicz force-pushed the perf/improve-chat-switch branch from fa2b147 to 20adc9c Compare January 15, 2025 10:55

Merge remote-tracking branch 'upstream/main' into perf/improve-chat-s…

b5d2009

…witch

TMisiukiewicz mentioned this pull request Jan 21, 2025

[HOLD for payment 2025-02-04] Extreme slowdowns on staging desktop Chrome and multi-second delay when switching chats #55173

Closed

8 tasks

rayane-d suggested changes Jan 23, 2025

View reviewed changes

TMisiukiewicz added 2 commits January 23, 2025 13:50

Merge remote-tracking branch 'upstream/main' into perf/improve-chat-s…

f1f00db

…witch

add early return

52caad0

TMisiukiewicz requested a review from rayane-d January 23, 2025 13:15

rayane-d approved these changes Jan 23, 2025

View reviewed changes

melvin-bot Bot requested a review from carlosmiceli January 23, 2025 14:23

carlosmiceli approved these changes Jan 23, 2025

View reviewed changes

carlosmiceli merged commit c26de24 into Expensify:main Jan 23, 2025

github-actions Bot mentioned this pull request Jan 23, 2025

Deploy Checklist: New Expensify 2025-01-23 #55657

Closed

melvin-bot Bot mentioned this pull request Jan 28, 2025

[HOLD for payment 2025-02-04] Frequent Client Hanging and Loss of Workspace List #54802

Closed

8 tasks

rayane-d mentioned this pull request Feb 3, 2025

Reports with "report not found" error cause Inbox tab RBR #51675

Merged

48 tasks

TMisiukiewicz mentioned this pull request Mar 19, 2025

[$250][HIGH] Android - workspace-On tapping "Go to workspace" a delayed response is shown #55565

Closed

8 tasks

Conversation

TMisiukiewicz commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Jan 15, 2025

Uh oh!

rayane-d commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

TMisiukiewicz commented Jan 20, 2025

Uh oh!

adhorodyski commented Jan 23, 2025

Uh oh!

rayane-d Jan 23, 2025

Choose a reason for hiding this comment

Uh oh!

rayane-d Jan 23, 2025

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz Jan 23, 2025

Choose a reason for hiding this comment

Uh oh!

rayane-d commented Jan 23, 2025

Uh oh!

TMisiukiewicz commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rayane-d commented Jan 23, 2025

Uh oh!

rayane-d left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jan 23, 2025

Uh oh!

github-actions Bot commented Jan 23, 2025

Uh oh!

github-actions Bot commented Jan 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

TMisiukiewicz commented Jan 15, 2025 •

edited

Loading

rayane-d commented Jan 16, 2025 •

edited

Loading

TMisiukiewicz commented Jan 23, 2025 •

edited

Loading