Skip to content

Open report from switcher perf improvement#64077

Merged
mountiny merged 9 commits intoExpensify:mainfrom
callstack-internal:Open-Report-from-Switcher-perf-improvement
Jul 2, 2025
Merged

Open report from switcher perf improvement#64077
mountiny merged 9 commits intoExpensify:mainfrom
callstack-internal:Open-Report-from-Switcher-perf-improvement

Conversation

@rinej
Copy link
Copy Markdown
Contributor

@rinej rinej commented Jun 12, 2025

Explanation of Change

Improve the time to display the report from Chat Switcher
Background
Navigating to a report from the Chat Switcher is slower than expected. There is a noticeable lag (~500ms) between the time the user clicks on a report and the OpenReport action is triggered.

Problem
It is cause because of the call onRouterClose() inside SearchRouter, which is executed immediately upon report click. This function closes a modal that’s mounted at the top level in AuthScreen, leading to re-renders and delays before the report is actually opened.

Solution

  1. Deferring onRouterClose() Execution
    Instead of calling onRouterClose() immediately, we delay its execution until after we start navigating to new report. This reduces contention in UI updates and avoids blocking navigation.

  2. Refactoring SearchRouterContext
    We can wrap the function in useCallback to avoid unnecesary rerenders when day are called. They are called when onRouterClose function is invoked.

Fixed Issues

$ #64174
PROPOSAL: https://callstack-hq.slack.com/archives/C05LX9D6E07/p1749814149209879

Tests

  • Same as QA Steps

Offline tests

QA Steps

  • Login with High Traffic user
  • Press cmd + K (on mobile click on the search magnifying glass)
  • Select the report
  • Notice that report is diplayed without any issues

🎥 Recording from before/after improvements:

Web before:
https://github.com/user-attachments/assets/d85cfc70-3ac6-4efb-8a2e-469cbbe1eaf9

Web after:
https://github.com/user-attachments/assets/f3679743-392a-48c3-adf8-bfbd4c9194c1

Android before:
https://github.com/user-attachments/assets/27e92b51-c6e2-4438-98d7-46570266a8d1

Android after:
https://github.com/user-attachments/assets/d120cd63-2267-479b-b484-44b98cf0875b

IOS before:
https://github.com/user-attachments/assets/0a693ca6-4d91-47cc-ad4c-3feae7ef4073

IOS after:
https://github.com/user-attachments/assets/d7595a01-decc-4dbf-adc6-55b64ab65288

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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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 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.ts 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 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@rinej rinej marked this pull request as ready for review June 16, 2025 16:19
@rinej rinej requested a review from a team as a code owner June 16, 2025 16:19
@melvin-bot melvin-bot Bot requested a review from Ollyws June 16, 2025 16:19
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Jun 16, 2025

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

@github-actions
Copy link
Copy Markdown
Contributor

🚧 @mountiny has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions

This comment has been minimized.

navigateToAndOpenReport(item.login ? [item.login] : [], false);
}
});
InteractionManager.runAfterInteractions(() => {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This delay is making things feel significantly less snappy for me on web in general.

Screen.Recording.2025-06-17.at.13.22.12.mov

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks a lot for the review and for catching that!

Just to clarify, what user account were you using during testing? And if I'm not mistaken, you were running this on Chrome?

I agree - the transition feels a bit cranky on the recording - and although it doesn't happen consistently (I personally haven't been able to reproduce it), even occasional hiccups in UX could outweigh the performance gain. The profiling tools shows improvement in performance (in loading the report), but we might be trading off too much in terms of perceived feeling.

I’ll revisit this approach and try to find some other way to optimize report opening

Copy link
Copy Markdown
Contributor

@Ollyws Ollyws Jun 17, 2025

Choose a reason for hiding this comment

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

I was just using my high traffic account, just a gmail account.
It does seem a fair bit smoother in the ad-hoc build, so it may just be an issue on my dev setup.
Maybe some others can give it a test and chime in.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@Ollyws I removed runAfterInteraction method, which might have been causing the issue, and also removed some logic in SearchRouterContext.
The changes are now minimal, so the performance gain won’t be as significant as initially expected, but it's still worth adding.

Let me know if the visual result is satisfactory - if not, I’ll revisit it and explore other ideas for improvement

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 1, 2025

🚧 @mountiny has triggered a test Expensify/App build. You can view the workflow run here.

@mountiny
Copy link
Copy Markdown
Contributor

mountiny commented Jul 1, 2025

@Ollyws Can you please prioritize the review here?

@mountiny mountiny moved this from CRITICAL to CRITICAL PR in [#whatsnext] #quality Jul 1, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 1, 2025

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #64077.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/64077/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/64077/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/64077/NewExpensify.dmg https://64077.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@Ollyws
Copy link
Copy Markdown
Contributor

Ollyws commented Jul 1, 2025

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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: HybridApp
01_Android_Native.mp4
Android: mWeb Chrome
02_Android_Chrome.mp4
iOS: HybridApp
03_iOS_Native.mp4
iOS: mWeb Safari
04_iOS_Safari.mp4
MacOS: Chrome / Safari
05_MacOS_Chrome.mp4
MacOS: Desktop
06_MacOS_Desktop.mp4

Copy link
Copy Markdown
Contributor

@Ollyws Ollyws left a comment

Choose a reason for hiding this comment

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

Alot smoother now, thanks!

@rinej
Copy link
Copy Markdown
Contributor Author

rinej commented Jul 2, 2025

@Ollyws @mountiny I resolved the conflicts

@mountiny mountiny merged commit 2eafe61 into Expensify:main Jul 2, 2025
18 checks passed
@github-project-automation github-project-automation Bot moved this from CRITICAL PR to Done in [#whatsnext] #quality Jul 2, 2025
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Jul 2, 2025

✋ 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
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 3, 2025

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

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 7, 2025

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.76-5 🚀

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

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

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants