Highlight autocomplete value on a match #56243

289Adam289 · 2025-02-03T16:17:31Z

Explanation of Change

This pr is a follow up of #54403 and address issues from #50949 (comment).

Current highlighting rules

category, tag, currency, values are highlighted when the string value is present in Onyx.
expenseType, type and status values are highlighted when the string value is present in CONST.ts file.
from, to, in, taxRate, cardID values are highlighted only when AutocompleteList has been used to insert them
(This assures user that query is correct)
User logins should always be highlighted

Fixed Issues

$#50949
PROPOSAL:

Tests

Open Search router in different parts of the App
Input different autocomplete filters
Input filter with current user login or display name ( e.g. from:[email protected])
Verify that filter values are being highlighted only when value is correct
Verify current user is highlighted in different color
Verify that formatting is correctly applied
Verify that keys are different color than normal text
Repeat steps 1-7 on main Search Page

Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2025-02-04.at.16.44.05.mp4

Android: mWeb Chrome

Screen.Recording.2025-02-04.at.16.45.39.mp4

iOS: Native

Screen.Recording.2025-02-04.at.16.38.47.mp4

iOS: mWeb Safari

Screen.Recording.2025-02-04.at.16.41.27.mp4

MacOS: Chrome / Safari

Screen.Recording.2025-02-04.at.16.46.22.mp4

MacOS: Desktop

…atch

Kicu

Nice work 👍
I left some comments, but they are mainly related to naming

src/components/Search/SearchRouter/buildSubstitutionsMap.ts

src/components/Search/SearchRouter/getQueryWithSubstitutions.ts

src/components/Search/SearchRouter/getUpdatedSubstitutionsMap.ts

src/components/Search/SearchAutocompleteInput.tsx

src/libs/SearchAutocompleteUtils.ts

src/libs/runOnLiveMarkdownRuntime/index.native.tsx

tests/perf-test/SearchRouter.perf-test.tsx

Kicu · 2025-02-05T10:13:14Z

src/CONST.ts

@@ -6189,6 +6189,7 @@ const CONST = {
            LOWER_THAN: 'lt',
            LOWER_THAN_OR_EQUAL_TO: 'lte',
        },
+        SYNTAX_KEY: 'syntax',


this name might be confusing for other developers.

However for now I can't come up with a name better than SYNTAX_KEY_NAME. The main problem is that this const is not simply some "syntax key" but the NAME for key representing syntax 😅 which is why I would like it to have a bit longer more descriptive name.

If you can't come up with anything better just leave as is

How about SYNTAX_RANGE_NAME?

src/components/Search/types.ts

melvin-bot · 2025-02-05T13:41:15Z

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

289Adam289 · 2025-02-05T13:41:50Z

@luacmartins it's ready for review. Hopefully we can merge it soon.

luacmartins · 2025-02-05T16:52:26Z

Amazing! @ikevin127 let's prioritize reviewing this one once you're online!

ikevin127 · 2025-02-05T22:34:27Z

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

android.webm

Android: mWeb Chrome

android-mweb.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ikevin127

🚀 LGTM - tests well and I confirm that both follow-up points mentioned in #50949 (comment) are implemented and working as expected 🟢.

luacmartins

LGTM

OSBotify · 2025-02-06T00:10:08Z

✋ 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-02-06T22:02:43Z

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

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

289Adam289 added 9 commits January 23, 2025 15:57

Merge branch 'main' into 289Adam289/50949-highlight-autocomplete-on-m…

0169b8e

…atch

Merge branch 'main' into 289Adam289/50949-highlight-autocomplete-on-m…

29f98af

…atch

working highlighting

0cf5ebb

add syntax highlighting

85d5435

add supporting text

944fbdd

grammar formatting

7eb5861

Merge branch 'main' into 289Adam289/50949-highlight-autocomplete-on-m…

74cade5

…atch

fix merge

68b3262

make emailList shared value

d5acdee

luacmartins self-requested a review February 3, 2025 17:23

289Adam289 added 7 commits February 4, 2025 13:07

fix changed files lint

068f04c

fix parser

62b1617

Merge branch 'main' into 289Adam289/50949-highlight-autocomplete-on-m…

d0f297d

…atch

generate serach parser

56a5c8d

fix types and remove unnecessary ref

568d42f

fix tests for autocomplete parser

ee8297b

fix types and perf-tests

efb018a

luacmartins mentioned this pull request Feb 4, 2025

[Due for payment 2025-02-13] [Search v2.5] [Autocomplete] Highlight autocomplete key and selected value #50949

Open

Merge branch 'main' into 289Adam289/50949-highlight-autocomplete-on-m…

bf5abe0

…atch

Kicu reviewed Feb 5, 2025

View reviewed changes

289Adam289 added 4 commits February 5, 2025 12:26

fix perf tests and changed files lint

f56ae47

fix names and consts

3e3221f

improve readability - extract logic from parser

11b4639

fix type

829f608

289Adam289 marked this pull request as ready for review February 5, 2025 13:41

289Adam289 requested a review from a team as a code owner February 5, 2025 13:41

melvin-bot bot requested review from ikevin127 and removed request for a team February 5, 2025 13:41

ikevin127 approved these changes Feb 5, 2025

View reviewed changes

luacmartins approved these changes Feb 5, 2025

View reviewed changes

luacmartins merged commit 7fa2cb1 into Expensify:main Feb 6, 2025
18 checks passed

github-actions bot mentioned this pull request Feb 6, 2025

Deploy Checklist: New Expensify 2025-02-06 #56482

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Highlight autocomplete value on a match #56243

Highlight autocomplete value on a match #56243

289Adam289 commented Feb 3, 2025 •

edited

Loading

Kicu left a comment

Kicu Feb 5, 2025

289Adam289 Feb 5, 2025

melvin-bot bot commented Feb 5, 2025

289Adam289 commented Feb 5, 2025

luacmartins commented Feb 5, 2025

ikevin127 commented Feb 5, 2025 •

edited

Loading

ikevin127 left a comment

luacmartins left a comment

OSBotify commented Feb 6, 2025

github-actions bot commented Feb 6, 2025

Highlight autocomplete value on a match #56243

Highlight autocomplete value on a match #56243

Conversation

289Adam289 commented Feb 3, 2025 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment

Choose a reason for hiding this comment

Kicu Feb 5, 2025

Choose a reason for hiding this comment

289Adam289 Feb 5, 2025

Choose a reason for hiding this comment

melvin-bot bot commented Feb 5, 2025

289Adam289 commented Feb 5, 2025

luacmartins commented Feb 5, 2025

ikevin127 commented Feb 5, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

ikevin127 left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 6, 2025

github-actions bot commented Feb 6, 2025

289Adam289 commented Feb 3, 2025 •

edited

Loading

ikevin127 commented Feb 5, 2025 •

edited

Loading