Skip to content

83207: debounce autocomplete query and memoize search options#86925

Open
abbasifaizan70 wants to merge 21 commits intoExpensify:mainfrom
abbasifaizan70:83207
Open

83207: debounce autocomplete query and memoize search options#86925
abbasifaizan70 wants to merge 21 commits intoExpensify:mainfrom
abbasifaizan70:83207

Conversation

@abbasifaizan70
Copy link
Copy Markdown
Contributor

@abbasifaizan70 abbasifaizan70 commented Apr 1, 2026

Explanation of Change

The SearchRouter was passing autocompleteQueryValue (updated via useState on every keystroke) directly to SearchAutocompleteList, triggering synchronous getSearchOptions() + combineOrderingOfReportsAndPersonalDetails() + isSearchStringMatch() on every character typed, freezing the JS thread on mobile.

Structural optimizations (debouncing + memoization prevent redundant work):

  • useDebouncedState for autocompleteQueryValue: Replaces useState so the expensive SearchAutocompleteList filtering only runs after the user pauses typing, not on every keystroke. The immediate value still drives arrow-key navigation and contextual logic.
  • useMemo for searchOptions: Wraps getSearchOptions() so it only re-runs when its 13 dependencies actually change, instead of re-computing on every render.
  • useMemo for recentReportsOptions: Wraps combineOrderingOfReportsAndPersonalDetails() so sorting/filtering is skipped when autocompleteQueryValue and searchOptions haven't changed.

Algorithmic improvement:

  • isSearchStringMatch: new RegExp() per word per item → compile once per call, reuse across all items
  • isSearchStringMatch: matching flag with continue past failures → early return false on first mismatch
  • searchWords: new Set() keeping empty strings → Array.from(new Set(...)).filter(Boolean)

Performance (Reassure, 40K reports):

Metric main (baseline) PR (current) Change
getFilteredOptions with search 2.8 ms 2.5 ms -0.3 ms (-11.7%)
filterAndOrderOptions (40K items, 3-word query) 11.1 ms 10.4 ms -0.7 ms (-6.4%)

Fixed Issues

$ #83207
PROPOSAL: #83207 (comment)

Tests

  1. Open the app on a mobile device (iOS or Android) and tap the search icon in Inbox
  2. Type rapidly into the search input (e.g. "Email Report Five") — verify the input stays responsive with no visible lag or dropped characters
  3. Stop typing and wait briefly — verify search results update and reflect the typed query
  4. Clear the search input — verify recent chats reappear immediately
  5. Type a partial query (e.g. "Exp") — verify autocomplete suggestions appear after a short delay
  6. Select an autocomplete suggestion — verify the query updates correctly and results reflect the selection
  7. Use arrow keys (desktop) or scroll (mobile) to navigate through the results list while typing — verify navigation remains responsive
  8. Type a multi-word query (e.g. "John Expense Report") — verify all matching results are returned correctly
  9. Open search on a device/account with many reports and contacts — verify no JS thread freeze or unresponsiveness during typing
  10. Press the back button or swipe to dismiss search while typing — verify navigation is not blocked
  • Verify that no errors appear in the JS console

Offline tests

Same as tests.

QA Steps

Same as tests.

  • Verify that no errors appear in the JS console

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
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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
Screen.Recording.2026-04-02.at.4.04.17.AM.mov
Android: mWeb Chrome
Screen.Recording.2026-04-02.at.4.05.33.AM.mov
iOS: Native
Screen.Recording.2026-04-02.at.3.57.50.AM.mov
iOS: mWeb Safari
Screen.Recording.2026-04-02.at.3.58.48.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2026-04-02.at.3.56.08.AM.mov

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 1, 2026

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
...rc/components/Search/SearchRouter/SearchRouter.tsx 40.32% <50.00%> (-0.67%) ⬇️
src/libs/OptionsListUtils/index.ts 83.18% <0.00%> (+0.12%) ⬆️
... and 12 files with indirect coverage changes

@abbasifaizan70 abbasifaizan70 marked this pull request as ready for review April 1, 2026 23:45
@abbasifaizan70 abbasifaizan70 requested review from a team as code owners April 1, 2026 23:46
@melvin-bot melvin-bot bot requested a review from aimane-chnaif April 1, 2026 23:46
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Apr 1, 2026

@aimane-chnaif 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]

@melvin-bot melvin-bot bot requested review from trjExpensify and removed request for a team April 1, 2026 23:46
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4e8ba5a482

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@trjExpensify
Copy link
Copy Markdown
Contributor

PR doesn’t need product input as a performance PR. Unassigning and unsubscribing myself.

@trjExpensify trjExpensify removed their request for review April 2, 2026 11:58
@abbasifaizan70 abbasifaizan70 changed the title 82307: debounce autocomplete query and memoize search options 83207: debounce autocomplete query and memoize search options Apr 2, 2026
@aimane-chnaif
Copy link
Copy Markdown
Contributor

Please merge main

@abbasifaizan70
Copy link
Copy Markdown
Contributor Author

@aimane-chnaif Update with the latest main. Thanks

@MelvinBot
Copy link
Copy Markdown
Contributor

🤖 Code Review

Overall this is a solid performance improvement — the debounce strategy and regex pre-compilation are both sound. A few items to consider:


1. Stale query fallback on line 350 (nit)

autocompleteQueryValue={textInputValue ? debouncedAutocompleteQueryValue || textInputValue : ''}

The || textInputValue fallback only fires when debouncedAutocompleteQueryValue is falsy (i.e. empty string). During normal typing it's always truthy (holding the previous query), so the fallback never kicks in mid-session — it only helps on the very first keystroke from empty. This is fine functionally (it's debouncing as intended), but the || textInputValue reads like it provides an immediate value during the debounce window, which it doesn't. A comment clarifying this would help future readers.

2. new RegExp(/&nbsp;/g) on line 511 of OptionsListUtils/index.ts (nit, pre-existing)

const valueToSearch = searchText?.replaceAll(new RegExp(/&nbsp;/g), '');

Wrapping a regex literal in new RegExp() is redundant — /&nbsp;/g alone works. This is pre-existing code though, so not something this PR needs to fix.

3. Perf tests look good — the filterAndOrderOptions test with 40K items and multi-word query is a great way to validate the regex optimization, and the SearchRouter render-count test covers the debounce path well.

No blocking issues — the changes are correct and well-scoped. 👍

@@ -507,18 +507,15 @@ function getAlternateText(
* Searches for a match when provided with a value
*/
function isSearchStringMatch(searchValue: string, searchText?: string | null, participantNames = new Set<string>(), isReportChatRoom = false): boolean {
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.

Can you please explain changes in this function?
What's this refactor for? Does this improve performance?
And add unit tests

Copy link
Copy Markdown
Contributor Author

@abbasifaizan70 abbasifaizan70 Apr 8, 2026

Choose a reason for hiding this comment

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

@aimane-chnaif This change is mainly a perf cleanup in a hot path, not intended to change behavior. Before, isSearchStringMatch() was creating a new RegExp inside the loop for every search word. Since this function runs across lots of options while typing, that adds unnecessary work on each keystroke.

What I changed:

  • normalize/dedupe the words once
  • compile the regexes once per function call
  • reuse them in the loop
  • return early on first mismatch

So matching logic stays the same, but we avoid repeated regex allocations and reduce JS work during search filtering.

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.

ok, please add unit test (not perf-test) for this function

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.

@aimane-chnaif Added unit test in OptionsListUtilsTest.tsx covering the refactored isSearchStringMatch path (multi-word normalization behavior), and it passes.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e1d2ccc2af

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@abbasifaizan70
Copy link
Copy Markdown
Contributor Author

@aimane-chnaif I added Unit test cases.

@MelvinBot
Copy link
Copy Markdown
Contributor

🤖 Code Review

All CI checks pass. The debounce strategy and regex pre-compilation are correct. Two items worth addressing:

1. Unused debounce timer on textInputValue (line 79)

const [textInputValue, , setTextInputValue] = useDebouncedState('', 500);

The second element (debounced value) is never read — only the immediate value is used. This creates a 500ms debounce timer + state that serves no purpose. Consider using plain useState here instead, or destructure the debounced value if it's needed elsewhere.

2. First-keystroke empty flash (line 350)

autocompleteQueryValue={textInputValue === '' ? '' : debouncedAutocompleteQueryValue}

When the user types the first character, textInputValue becomes non-empty immediately but debouncedAutocompleteQueryValue is still '' (initial value, 300ms hasn't elapsed). The autocomplete list receives '' for 300ms on every typing burst. This is the intended debounce behavior, but please confirm DeferredAutocompleteList handles receiving '' while textInputValue is non-empty gracefully (e.g., shows recent searches rather than flashing empty content).

The isSearchStringMatch refactor is functionally equivalent — .filter(Boolean) correctly strips empty strings, return false early-exit matches the old matching flag semantics, and regex compilation is correctly hoisted out of the per-item loop. Unit test for multi-word normalization looks good.

No blocking issues.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e5e514dcdc

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@abbasifaizan70
Copy link
Copy Markdown
Contributor Author

@aimane-chnaif PR is ready for review. Thanks.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants