Skip to content

Migrate useSearchSelector.base.ts from useOptionsList to usePersonalDetailOptions (part 2)#91986

Merged
mountiny merged 3 commits into
Expensify:mainfrom
shubham1206agra:refactor-useSearchSelector-2
Jun 3, 2026
Merged

Migrate useSearchSelector.base.ts from useOptionsList to usePersonalDetailOptions (part 2)#91986
mountiny merged 3 commits into
Expensify:mainfrom
shubham1206agra:refactor-useSearchSelector-2

Conversation

@shubham1206agra

Copy link
Copy Markdown
Contributor

Explanation of Change

Fixed Issues

$ #82191

Tests

  1. Open App
  2. Open any workspace
  3. Go to members and click on invite.
  4. Verify that all options are displayed correctly and searching and selecting works fine.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

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

Screen.Recording.2026-05-28.at.9.03.25.PM.mov

@shubham1206agra shubham1206agra requested review from a team as code owners May 28, 2026 15:38
@melvin-bot melvin-bot Bot requested review from flaviadefaria and hoangzinh and removed request for a team May 28, 2026 15:38
@melvin-bot

melvin-bot Bot commented May 28, 2026

Copy link
Copy Markdown

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

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

Copy link
Copy Markdown

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: fe904c4ab6

ℹ️ 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".

Comment thread src/hooks/usePersonalDetailSearchSelector/base.ts
Comment thread src/pages/workspace/DynamicWorkspaceInvitePage.tsx
@codecov

codecov Bot commented May 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/libs/PersonalDetailOptionsListUtils/index.ts 70.55% <ø> (ø)
src/hooks/usePersonalDetailSearchSelector/base.ts 95.77% <92.85%> (+1.92%) ⬆️
...gWorkspaceInvite/BaseOnboardingWorkspaceInvite.tsx 0.00% <0.00%> (ø)
src/pages/domain/Admins/DomainAddAdminPage.tsx 0.00% <0.00%> (ø)
src/pages/workspace/DynamicWorkspaceInvitePage.tsx 0.00% <0.00%> (ø)
... and 174 files with indirect coverage changes

@shubham1206agra

Copy link
Copy Markdown
Contributor Author

@codex review

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

Copy link
Copy Markdown

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: a84ae33a91

ℹ️ 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".

includeRecentReports: false,
shouldInitialize: didScreenTransitionEnd,
});
const {searchTerm, debouncedSearchTerm, setSearchTerm, availableOptions, selectedOptions, toggleSelection, areOptionsInitialized} = usePersonalDetailSearchSelector({

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Normalize phone searches before filtering invitees

This migrated invite flow now uses usePersonalDetailSearchSelector, but that hook passes the raw debounced search text into PersonalDetailOptionsListUtils.getValidOptions; the old useSearchSelector path normalized phone/email input with getSearchValueForPhoneOrEmail before filtering. As a result, when a user searches an existing contact by a formatted/local phone number such as (555) 123-4567, it no longer matches the stored +15551234567@... login and can fall through to the “invite new user” option instead of selecting the existing user. Please normalize phone searches in the new hook (or before this call) to preserve the previous invite behavior.

Useful? React with 👍 / 👎.

@hoangzinh

hoangzinh commented Jun 1, 2026

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
  • 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: HybridApp
Screen.Recording.2026-06-02.at.19.32.22.mov
Android: mWeb Chrome
Screen.Recording.2026-06-02.at.20.18.19.mov
iOS: HybridApp
Screen.Recording.2026-06-02.at.20.33.11.mov
iOS: mWeb Safari
Screen.Recording.2026-06-02.at.20.34.35.mov
MacOS: Chrome / Safari
Screen.Recording.2026-06-02.at.17.48.47.mov
Screen.Recording.2026-06-02.at.20.14.30.mov

Comment on lines -289 to +284
export default withNavigationTransitionEnd(withPolicyAndFullscreenLoading(DynamicWorkspaceInvitePage));
function DynamicWorkspaceInvitePage(props: WorkspaceInvitePageProps) {

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.

Not a blocker: Out of curiosity, why would you like to replace the HOC code?

@hoangzinh

Copy link
Copy Markdown
Contributor

@MelvinBot please review this PR

@MelvinBot

Copy link
Copy Markdown
Contributor

PR Review

Verdict: The migration looks correct and is well-scoped. The section-building in the migrated pages mirrors the already-merged RoomInvitePage pattern (selected-non-existing → contacts → user-to-invite, with shouldKeepSelectedInAvailableOptions), so the availableOptions/selectedNonExistingOptions wiring is consistent with what's in production. I didn't find any blocking bugs. A few things worth confirming below — all low severity.

The only failing check is checklist (Reviewer Checklist), which just needs to be completed; it's not a code failure.

Suggestions (non-blocking)

1. withNavigationTransitionEnd is now dead code on DynamicWorkspaceInvitePage.
The HOC still wraps the outer component (DynamicWorkspaceInvitePage.tsx:304), but it only injects a didScreenTransitionEnd prop that nobody reads — the content component now derives its own didScreenTransitionEnd from ScreenWrapper's onEntryTransitionEnd (:250). The wrapper renders immediately (it doesn't gate rendering), so it's harmless but redundant — consider dropping it to avoid confusion.

2. initialExtraOptions depends on personalDetails, which the loading gate doesn't wait for.
The new wrapper blocks render until policy + invitedEmailsToAccountIDsDraft finish loading (:284-294) — which is the right fix for the "useState only reads the initial value once" problem with initialSelected/initialExtraOptions. But initialExtraOptions also reads personalDetails to decide which drafted emails are "non-existing" (:90-119), and PERSONAL_DETAILS_LIST is not part of the gate. If personal details haven't loaded on the content component's first render, a drafted email that is actually a known user would be misclassified as a non-existing invitee and frozen into extraOptions (the recomputed memo won't update the hook's useState). PERSONAL_DETAILS_LIST loads early so this is unlikely in practice, but worth a quick confirm — or fold it into the gate for safety.

3. excludedUsers is rebuilt as a fresh object every render in DomainAddAdminPage.
:55-63 calls getLoginsByAccountIDs and builds excludedUsers inline on every render (and it's mutated in a loop, so React Compiler won't memoize it). That new excludeLogins reference flows into the hook → getValidOptions each render. DynamicWorkspaceInvitePage already wraps the equivalent in useMemo (:72-81) — consider doing the same here for consistency/perf.

Verified, no change needed
  • isOptimisticAccountisOptimisticPersonalDetail in DomainAddAdminPage.inviteUser (:84) is correct — getUserToInviteOption sets isOptimisticPersonalDetail: true, and the old ReportUtils.OptionData field doesn't exist on the new type.
  • selectedNonExistingOptions rewrite (base.ts:294-303) drops the old option.isSelected guard, but extraOptions only ever holds selected items (added with isSelected: true, removed on deselect), so behavior is unchanged. Switching to filterOption also fixes two real filtering gaps the new unit tests cover (deburr of accented names, multi-word terms split across text+login).
  • getHeaderMessage signature change is handled correctly — the new sections.length > 0 → '' short-circuit means it's only reached with empty sections, and getHeaderMessage returns '' for empty search.
  • canBeMissing — not applicable; this codebase variant doesn't use that useOnyx param (only 1 occurrence repo-wide).

Note: I reviewed statically and didn't run the app, so the manual Tests/QA flows (invite member, draft restore on back-navigation, single-select admin add) still need a human pass on the listed platforms.

@hoangzinh

Copy link
Copy Markdown
Contributor

PR LGTM. I'm seeking help to test invite members in the domain workspace here https://expensify.slack.com/archives/C08CZDJFJ77/p1780404939054139

@melvin-bot melvin-bot Bot requested a review from mountiny June 2, 2026 13:35
@mountiny mountiny merged commit 4e732ae into Expensify:main Jun 3, 2026
36 of 38 checks passed
@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

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

@OSBotify

OSBotify commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

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

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

Bundle Size Analysis (Sentry):

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 No help site changes required.

I reviewed the changes in this PR against App/docs/articles. This is a pure internal refactor with no user-facing behavior change, so no help site (HelpDot) updates are needed.

Why no docs are required

This PR (linked to Expensify/App#82191) migrates the shared search-selector hook from useSearchSelector/useOptionsList to usePersonalDetailSearchSelector to stop unnecessary background recalculations on every personal-details/reports change. It is part of the larger effort to remove OptionListContextProvider.

The changes are limited to:

  • src/hooks/usePersonalDetailSearchSelector/base.ts — adds initialExtraOptions and shouldUpdateSelectedOptionsOnSingleSelect config, refactors selection/filter logic
  • src/libs/PersonalDetailOptionsListUtils/index.ts — exports getUserToInviteOption
  • src/pages/OnboardingWorkspaceInvite/BaseOnboardingWorkspaceInvite.tsx, src/pages/domain/Admins/DomainAddAdminPage.tsx, src/pages/workspace/DynamicWorkspaceInvitePage.tsx — swap the hook, equivalent header-message/section logic
  • cspell.json, tests/unit/usePersonalDetailSearchSelectorTest.tsx — test/config

The user-facing flows (inviting workspace members, onboarding invite, adding a domain admin) keep the same UI, labels, buttons, and behavior — search, select, and invite all work exactly as before. Help articles document product behavior, not the underlying hook implementation, so there is nothing to update.

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

@shubham1206agra, please confirm you agree this is a behavior-preserving refactor with no user-facing changes. If you believe a specific help article is affected, let me know which flow and I'll create the docs PR.

@OSBotify

OSBotify commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/lakchote in version: 9.3.99-9 🚀

platform result
🕸 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

None yet

Development

Successfully merging this pull request may close these issues.

5 participants