Skip to content

Lazy-load contact options: shell first, createOption after getValidOptions - #97087

Merged
mjasikowski merged 50 commits into
Expensify:mainfrom
software-mansion-labs:jmgraa/lazy-contact-searchOptions
Aug 18, 2026
Merged

mjasikowski merged 50 commits into
Expensify:mainfrom
software-mansion-labs:jmgraa/lazy-contact-searchOptions

Conversation

@jmgraa

@jmgraa jmgraa commented Jul 27, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

On large accounts, building a full createOption for every personal detail is expensive (policy/tag/archive lookups, icons, etc.), even though most contacts are discarded by filtering/ranking.

This PR changes contact option construction so createFilteredOptionList always emits lightweight PersonalDetailShells instead of fully built options. Shells only carry the fields needed to filter, rank, and de-dupe (text, login, accountID, participantsList, etc.), plus an isHydrated: false discriminant and a memoized hydrate() that runs buildFullOption / createOption on demand. Display fields are not readable on a shell without narrowing on isHydrated.

How it works:

  1. Build one shell per personal detail in createFilteredOptionList / buildPersonalDetailsOptions.
  2. In getValidOptions, filter and rank on those shells, then hydrate only the top-N survivors with hydrateContactOption. Contacts that never make the cut never pay the full createOption cost.

Callers of getValidOptions / getSearchOptions still receive fully built personal-detail options; the lazy work is internal to the option-list pipeline. hydrateContactOption remains available for any shell that still needs hydration outside that path (e.g. tests or draft restore).

Unit tests check that shells match fully built options for filtering and sorting, and that after hydration the final results match the previous eager path (including search, exclusions, and top-N limits).

ParticipantSearchResults / createFilteredOptionList

Before After
898ms / 812ms 717ms / 624ms
927ms / 838ms 669ms / 588ms
946ms / 855ms 713ms / 618ms

Fixed Issues

$ #97788
PROPOSAL:

Tests

  1. Log in with an account that has many contacts / personal details (ideally a high-traffic account).
  2. Start a money request (or open any flow that uses the participant / people search selector).
  3. Open the participant picker and wait for the initial contact/report list to load.
  4. Verify the list shows expected contacts and recent reports with correct display names, logins, and avatars (no missing icons or blank rows).
  5. Search for a known contact by name and by email/login.
  6. Verify matching contacts appear in the correct order and match pre-change behaviour.
  7. Select one or more participants and confirm selection state, chips, and submit still work.
  8. Clear the search and scroll / load more if available; verify lists remain correct.
  • Verify that no errors appear in the JS console

Offline tests

  1. Open the participant picker while online so options load.
  2. Go offline (disable network).
  3. Search for a contact that is already available locally.
  4. Verify filtering/ranking still works and selected hydrated options still show full details (name, login, avatar).

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 followed proper code patterns (see Reviewing the code)
    • 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 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)
  • 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)
  • 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.
  • 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

@codecov

codecov Bot commented Jul 27, 2026 •

Copy link
Copy Markdown

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 Δ
.../components/Search/FilterComponents/InSelector.tsx 89.18% <ø> (ø)
src/components/Search/SearchAutocompleteList.tsx 92.30% <ø> (ø)
src/hooks/useFilteredOptions.ts 82.60% <100.00%> (-0.73%) ⬇️
src/hooks/useSearchSelector/base.ts 87.50% <100.00%> (+0.43%) ⬆️
src/libs/OptionsListUtils/searchMatchUtils.ts 100.00% <100.00%> (ø)
src/pages/Share/ShareTab.tsx 0.00% <ø> (ø)
src/libs/OptionsListUtils/index.ts 87.52% <96.87%> (+0.21%) ⬆️
... and 4 files with indirect coverage changes

@jmgraa
jmgraa force-pushed the jmgraa/lazy-contact-searchOptions branch from 1768c07 to ea82e46 Compare July 28, 2026 09:13
Comment thread src/libs/OptionsListUtils/types.ts Resolved
Comment thread src/libs/OptionsListUtils/index.ts Resolved
Comment thread config/eslint/eslint.seatbelt.tsv Resolved
Comment thread src/libs/OptionsListUtils/index.ts Resolved
@jmgraa
jmgraa force-pushed the jmgraa/lazy-contact-searchOptions branch from 46770d0 to 44ca202 Compare August 4, 2026 10:34
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

Comment thread src/hooks/useFilteredOptions.ts Resolved
Comment thread src/libs/OptionsListUtils/index.ts Resolved
Comment thread src/libs/OptionsListUtils/index.ts Resolved
Comment thread src/libs/OptionsListUtils/index.ts Resolved
Comment thread src/libs/OptionsListUtils/index.ts Resolved
@quinthar quinthar removed the #quality label Aug 13, 2026
@mjasikowski mjasikowski reopened this Aug 13, 2026
@mjasikowski

Copy link
Copy Markdown
Contributor

@jmgraa need to resolve conflicts

@jmgraa

jmgraa commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

It seems the tests are failing because of a SignInBackButtonTest pulled in from main, not from this PR

@trjExpensify
trjExpensify removed their request for review August 13, 2026 21:18
@trjExpensify

Copy link
Copy Markdown
Contributor

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

@jmgraa

jmgraa commented Aug 14, 2026

Copy link
Copy Markdown
Contributor Author

@mjasikowski conflicts resolved

@mjasikowski

Copy link
Copy Markdown
Contributor

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
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@mjasikowski
mjasikowski merged commit a60a440 into Expensify:main Aug 18, 2026
35 of 37 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

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

@OSBotify

Copy link
Copy Markdown
Contributor

✋ 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 OSBotify mentioned this pull request Aug 18, 2026
66 tasks done
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mjasikowski in version: 9.4.56-0 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 No help site changes required.

I reviewed this PR against the help site articles under docs/articles, and no updates are needed.

Why: This is a purely internal performance optimization. It changes how contact/participant options are built — emitting lightweight PersonalDetailShells from createFilteredOptionList and only running the full createOption/buildFullOption work (hydrateContactOption) on the top-N survivors after filtering and ranking. The change is entirely within the option-list pipeline (src/libs/OptionsListUtils/, related hooks, and callers).

Callers of getValidOptions / getSearchOptions still receive fully built personal-detail options, and the code explicitly keeps shell text "identical to the hydrated option." There are no new or changed feature names, tab names, settings labels, buttons, or user-facing flows — the participant/people search picker behaves exactly as before, just faster. Help site articles document user-facing product behavior, none of which is affected here.

Because no changes are required, I did not create a draft help site PR.


@jmgraa, no help site PR was created since this PR introduces no user-facing behavior changes. If you believe a doc update is warranted, let me know what behavior you'd like documented and I'll draft one.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.4.56-3 🚀

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

Bundle Size Analysis (Sentry):

@jmgraa
jmgraa deleted the jmgraa/lazy-contact-searchOptions branch August 28, 2026 08:52
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.

8 participants