Make autocomplete work with entity ids

[Kicu]

Details

• this PR implements autocomplete for every filter that is not "plain text" but requires saving some ids of the entity the user actually chosen (from, to, in, tax, cardID)
• we save the user autocomplete choice and later substitute query with the entity id before sending request to backend (details below)
• contains very small change to autocomplete parser, and 2 functions which I put into separate files to write tests for them
• important: this is only expected to work in SearchRouter, SearchPageHeader will still work using old code; I will make this autocomplete work also on Results page in SearchPageHeader but in a separate PR. Doing it in here would make this PR grow way over 1k loc

---

Detailed autocomplete description

• Previously we were storing the full query that user typed verbatim
• For example user would type test from:john@expensify.com, then when submitting we would run a function standardizeQueryJSON to traverse the parsed tree and substitue all plain text values with id values for specific filters. (this helper fn did the job: https://github.com/Expensify/App/blob/main/src/libs/SearchQueryUtils.ts#L169)
• However this breaks for any case where the plain text value is non-unique. That is the case for chat/report names. For example when I type in:adm into my autocomplete I get more than 5 different rooms all named #admins. Previous solution couldn't handle a string like this in:#admins hello because we don't know which room #admins room it might be. This is the source of bug [HOLD for payment 2024-12-07] [$250] [HOLD for payment 2024-11-18] [HOLD Search autocomplete][Search v2.5] - Input shows report ID instead of report name when selecting "Search in" #50976.

new implementation

• the main source of truth is still the "plain text" text input value that the users sees
• in addition any time a user picks (clicks) a choice from autocomplete list, we save data in a substitutionsMap object
• when we need to process the query we can always correctly substitute a string that user sees in his query with an autocompleteID of the entity that can be stored in URL and sent to backend; these ids can be accountID for a user or reportID for chat/room/report, and some other ids for tags and cards
• old standardizeQueryJSON function can soon be removed, but this mechanism described above now only works for SearchRouter, whereas input inside SearchHeaderPage still uses the old substitution mechanism, and thus needs the function
• tests for getQueryWithSubstitutions and getUpdatedSubstitutionsMap should help understand this

Fixed Issues

$ #50976
$ #50947
$ #50944
$ #50943
PROPOSAL:

Tests

• open SearchRouter via clicking on 🔎 icon or cmd +k shortcut
• verify that when using contextual search (inside a room) room name is correctly displayed
• test autocomplete for from:..., to:..., cardID:... and tax:...
• in every case user should see plain text display name, but backend should receive id instead

Offline tests

QA Steps

• open SearchRouter via clicking on 🔎 icon or cmd +k shortcut
• verify that when using contextual search (inside a room) room name is correctly displayed
• test autocomplete for from:..., to:..., cardID:... and tax:...
• in every case user should see plain text display name and the search should work

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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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 verified the translation was requested/reviewed 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.js 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.
• 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

rec-autocomplete-andr.mp4

Android: mWeb Chrome

iOS: Native

rec-autocomplete-ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

rec-autocomplete-web.mp4

MacOS: Desktop

[melvin-bot]

@rayane-djouah 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]

[SzymczakJ]

LGTM

[luacmartins]

Looking great! Left a few small comments.

NAB: @Expensify/design we might wanna find a way to differentiate between some of these reports. When I search for in:#admin I get a list of different reports, but I have no way of knowing which one is which. Maybe we can append the policy name to it?

[luacmartins]

I think this is ok for now, but we might have to add some more details to the name to help users differentiate multiple reports with the same name, e.g. admin rooms

[Kicu]

I am following the slack thread for this and will ask there

[luacmartins]

TLDR this will be implemented as a holistic approach throughout the app, so we decided to do nothing for now.

[dannymcclain]

@luacmartins I definitely think we should distinguish those somehow. Right now that list is basically unusable. There's a million ways we could do that, here are a few ideas:

I think I lean towards the simple dot separator pattern: in:#admins • Danny's Donuts. But let's see what @Expensify/design thinks or if they have any other/better ideas.

[luacmartins]

^ is being discussed here

[Kicu]

@luacmartins @rayane-djouah I addressed I believe all the comments, with 2 special notes:

• about report/room names, there is a conversation on slack where it was decided to leave them as they are for now, because they will get a better display in future across the app, @JmillsExpensify confirmed this
• about something looking differently in SearchPage - my next (and hopefully last) step is to move all this functionality to SearchPage results as well and share the code, so that in there everything looks and behaves the same in regards to autocomplete. That will come in a separate PR

Please re-check.

[rayane-djouah]

This sort order is already merged on main and I didn't really change the logic of how the options are generated.

Yes, I agree that this is not a blocker for this PR, as it stems from #51237. I just wanted to mention it in case you'd like to address it now. Otherwise, it seems fine to handle it in a follow-up PR.

[luacmartins]

I think those are NAB and we can address them in a follow up. Up to you @Kicu

[Kicu]

@rayane-djouah will be looking into your comments tomorrow, for now I added a missing toLowerCase and now the matching is slightly better. It should now match your "You" user better if you type in, butI think it won't match by email. Because we use only 1 field: name so it might be either an email or displayName but not both.

Will try to figure out tomorrow if we can do it better, but I would also like to try to push forward this PR

[Kicu]

@luacmartins if you're happy with how this works then I'd prefer to merge and then start a new PR that will fix everything together and improve the code.

[luacmartins]

Sounds good. Let's push this PR forward then and address those in a follow up. @rayane-djouah

[luacmartins]

Reviewing it again now

[rayane-djouah]

Reviewing again...

[luacmartins]

LGTM and tests well

[rayane-djouah]

Bug (Reproducible on Staging, Not a Blocker for This PR):

1. Type cardID: or in: and select the first option
2. Type ,
3. Observe that the selected option remains visible in the autocomplete list.

Screen.Recording.2024-11-06.at.7.37.32.PM.mov

Note: This issue does not occur with from, to, or taxRate:

Screen.Recording.2024-11-06.at.7.38.12.PM.mov

Note: The issue also occurs with "tag":

Screen.Recording.2024-11-06.at.7.39.35.PM.mov

[rayane-djouah]

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.js 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.
• 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.2024-11-06.at.7.55.27.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-11-06.at.7.53.26.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-06.at.19.51.30.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-06.at.19.53.04.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-11-06.at.7.32.37.PM.mov

MacOS: Desktop

Untitled.mov

[luacmartins]

Gonna merge this one. @Kicu let's address the comments above in a follow up!

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[Kicu]

will link when I have a PR fixing all these things 👍

[github-actions]

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

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

[ntdiary]

Hi, a great PR!
After this new implementation, I guess it's ready to add a !alreadyAutocompletedKeys.includes(chat.text?.toLowerCase()) condition into the filter, so that we can exclude already-selected in item, similar to how we handle categories/tags, we created #52213 for this expected result.

App/src/components/Search/SearchRouter/SearchRouter.tsx

Lines 250 to 252 in c658375

	case CONST.SEARCH.SYNTAX_FILTER_KEYS.IN: {
	const filteredChats = searchOptions.recentReports
	.filter((chat) => chat.text?.toLowerCase()?.includes(autocompleteValue.toLowerCase()))

will link when I have a PR fixing all these things 👍

I haven’t looked over all the pending minor bugs here yet, so not sure if the follow up PR will address this case.
Please feel free to let me know If you have other plans. 😄
cc @Kicu @luacmartins

[github-actions]

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.59-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

[Kicu]

@ntdiary I will keep this in mind when doing the next PR with some polish items 👍

[Kicu]

FYI #52568 is still a draft but it fixes several small issues form this PR. It will be ready for review soon.