perf: only call expensive getSearchOptions once by hannojg · Pull Request #54681 · Expensify/App

hannojg · 2024-12-31T12:53:01Z

Explanation of Change

Calling getSearchOptions is expensive. Before this PR we were calling getSearchOptions twice when opening the search page, once in SearchRouter and once in SearchRouterList.

To show the negative effect of that, here are the performance numbers on a lower end android device, where the impact of calling getSearchOptions twice is highlighted:

Timing:development.new.expensify.load_search_options 706.340307995677
Timing:development.new.expensify.load_search_options 790.5101539939642
Timing:development.new.expensify.open_search 6194.899076998234

it can be seen that of the 6194.89ms to open the search page 790.51ms were "wasted" by creating the search options twice.

Note: this doesn't fix #46590 entirely but is just one part of the fix.

Fixed Issues

$ #46590
PROPOSAL: #46590

Tests

Go to Search page, open Search router and try writing in the TextInput.
Make sure that written phrase is correctly searched, when submitted.
Go to some report, open Search router and make sure contextual Search works, clicking on "Search in {current report}" should add add phrase "in: {current report id}" to TextInput.
Make sure that recent Searches work.
Make sure that recent chats work.

Offline tests

QA Steps

Same as testing steps

PR Author Checklist

Screenshots/Videos

Android: Native

XRecorder_31122024_141510.mp4

Android: mWeb Chrome

XRecorder_31122024_143305.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.16.Pro.-.2024-12-31.at.14.27.58.mp4

iOS: mWeb Safari

Uploading Simulator Screen Recording - iPhone 16 Pro - 2024-12-31 at 14.28.31.mp4…

MacOS: Chrome / Safari

CleanShot.2024-12-31.at.14.06.58.mp4

MacOS: Desktop

CleanShot.2024-12-31.at.14.37.28.mp4

hannojg · 2024-12-31T12:53:38Z

cc @SzymczakJ & @Kicu as per https://margelo.slack.com/archives/C05LX9D6E07/p1735648787130889

melvin-bot · 2024-12-31T13:34:56Z

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

suneox · 2025-01-02T13:27:32Z

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-03.at.13.16.40.mp4

Android: mWeb Chrome

Screen.Recording.2025-01-03.at.13.18.23.mp4

iOS: Native

Screen.Recording.2025-01-03.at.13.12.01.mp4

iOS: mWeb Safari

Screen.Recording.2025-01-03.at.13.14.09.mp4

MacOS: Chrome / Safari

Screen.Recording.2025-01-03.at.13.09.03.mp4

MacOS: Desktop

Screen.Recording.2025-01-03.at.13.09.35.mp4

suneox

This change still works the same as the current behavior

Kicu

This PR looks good, and if it speeds things up then that's great and we can merge it. The injecting of searchOptions seems like a good idea

I wanted to share a few thoughts about why search is built the way it is, maybe it will will be helpful in future @hannojg
Check out this graph of search related components:

tl;dr

In the beginning we had just Router as a popover that we could open anywhere in E/App
later we wanted to have the exact same autocomplete list on the "Search (results) Page", So me and Jakub have split router into: SearchRouter and SearchRouterList
right now Router can be accessed from Search in some cases, but cannot in others (if you have Input visible in search, then you will focus it); Input on SearchPage and SearchRouter are exclusive
however soon, as part of #52317, we will make the Input be always displayed, and so the SearchRouter component will never be displayed on the Search page - maybe this can lead to some further enhancements

sakluger · 2025-01-08T22:49:58Z

Hey @hannojg - FYI @marcaaron is on parental leave so will be OOO for a few months. If you need another reviewer from the Expensify team, you'll need to find someone else.

Kicu · 2025-01-09T07:10:13Z

@luacmartins do you mind taking a look here as you worked a lot on Search? I already reviewed this and it's not a very big change.

luacmartins

LGTM! Thanks for working on this improvement.

luacmartins · 2025-01-09T16:52:57Z

@hannojg we have conflicts

…etSearchOptions-once

hannojg · 2025-01-13T09:13:07Z

Conflicts fixed!

luacmartins · 2025-01-13T14:05:51Z

Thanks!

OSBotify · 2025-01-13T14:16:10Z

✋ 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-14T13:59:53Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.85-0 🚀

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

github-actions · 2025-01-14T14:15:54Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.85-0 🚀

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

github-actions · 2025-01-14T14:41:16Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.85-0 🚀

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

github-actions · 2025-01-14T15:24:57Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.85-0 🚀

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

github-actions · 2025-01-14T15:49:08Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.85-0 🚀

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

github-actions · 2025-01-15T13:48:00Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.85-4 🚀

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

github-actions · 2025-01-15T15:48:56Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.85-4 🚀

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

perf: only call expensive getSearchOptions once

4dfe893

hannojg mentioned this pull request Dec 31, 2024

[Due for payment 2025-04-02] [Performance][Search] Opening search for the first time on a big account is causing the app to hang massively #46590

Closed

6 tasks

fix: no default ID

deffa56

hannojg marked this pull request as ready for review December 31, 2024 13:34

hannojg requested a review from a team as a code owner December 31, 2024 13:34

melvin-bot Bot requested review from suneox and removed request for a team December 31, 2024 13:34

suneox approved these changes Jan 3, 2025

View reviewed changes

melvin-bot Bot requested a review from marcaaron January 3, 2025 16:10

Kicu approved these changes Jan 7, 2025

View reviewed changes

luacmartins requested review from luacmartins and removed request for marcaaron January 9, 2025 16:40

luacmartins previously approved these changes Jan 9, 2025

View reviewed changes

Merge branch 'main' of github.com:Expensify/App into perf/only-call-g…

1359bc3

…etSearchOptions-once

hannojg dismissed luacmartins’s stale review via 1359bc3 January 13, 2025 09:11

fix

7f83d60

luacmartins approved these changes Jan 13, 2025

View reviewed changes

luacmartins merged commit 6a8125d into Expensify:main Jan 13, 2025

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

Deploy Checklist: New Expensify 2025-01-14 #55208

Closed

38 tasks

Conversation

hannojg commented Dec 31, 2024 • 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!

hannojg commented Dec 31, 2024

Uh oh!

melvin-bot Bot commented Dec 31, 2024

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

suneox left a comment

Choose a reason for hiding this comment

Uh oh!

Kicu left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sakluger commented Jan 8, 2025

Uh oh!

Kicu commented Jan 9, 2025

Uh oh!

luacmartins left a comment

Choose a reason for hiding this comment

Uh oh!

luacmartins commented Jan 9, 2025

Uh oh!

hannojg commented Jan 13, 2025

Uh oh!

luacmartins commented Jan 13, 2025

Uh oh!

OSBotify commented Jan 13, 2025

Uh oh!

github-actions Bot commented Jan 14, 2025

Uh oh!

github-actions Bot commented Jan 14, 2025

Uh oh!

github-actions Bot commented Jan 14, 2025

Uh oh!

github-actions Bot commented Jan 14, 2025

Uh oh!

github-actions Bot commented Jan 14, 2025

Uh oh!

github-actions Bot commented Jan 15, 2025

Uh oh!

github-actions Bot commented Jan 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

hannojg commented Dec 31, 2024 •

edited

Loading

suneox commented Jan 2, 2025 •

edited

Loading

Kicu left a comment •

edited

Loading