Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Highlight autocomplete value #54403

Merged
merged 31 commits into from
Jan 31, 2025
Merged

Highlight autocomplete value #54403

merged 31 commits into from
Jan 31, 2025

Conversation

289Adam289
Copy link
Contributor

@289Adam289 289Adam289 commented Dec 20, 2024 •
edited
Loading

Explanation of Change

This PR implements Search syntax highlighting using latest version of react-native-live-markdown library.
Autocomplete parser is currently parametrized with current user and workletized to be passed as parser prop to RNLMTextInput component.

Fixed Issues

$#50949
PROPOSAL:

Tests

  1. Open Search router in different parts of the App
  2. Input different autocomplete filters
  3. Input filter with current user login or display name ( e.g. from:user@user.com)
  4. Verify that filter values are being highlighted
  5. Verify current user is highlighted in different color
  6. Verify that formatting is correctly applied
  7. Repeat steps 1-6 on main Search Page
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Open Search router in different parts of the App
  2. Input different autocomplete filters
  3. Input filter with current user login or display name ( e.g. from:user@user.com)
  4. Verify that filter values are being highlighted
  5. Verify current user is highlighted in different color
  6. Verify that formatting is correctly applied
  7. Repeat steps 1-6 on main Search Page
  • 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
    • 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 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 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.2025-01-08.at.12.39.39.mp4
Android: mWeb Chrome
Screen.Recording.2025-01-28.at.15.09.25.mp4
iOS: Native
Screen.Recording.2025-01-08.at.12.32.46.mp4
iOS: mWeb Safari
Screen.Recording.2025-01-28.at.15.07.13.mp4
MacOS: Chrome / Safari
Screen.Recording.2025-01-28.at.15.10.55.mp4
MacOS: Desktop

@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Dec 20, 2024

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

Kicu
Kicu reviewed Jan 7, 2025
View reviewed changes
src/libs/SearchAutocompleteUtils.ts Outdated
@@ -131,6 +132,15 @@ function getAutocompleteQueryWithComma(prevQuery: string, newQuery: string) {
return newQuery;
}

function workletizedParser(input: string) {
Copy link
Member

Choose a reason for hiding this comment

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

Just noticed that this name is rather weird sounding, so I hope we can change it.

@luacmartins luacmartins self-requested a review January 7, 2025 21:13
@luacmartins
Copy link
Contributor

This is shaping up really nicely! Great work so far!

Kicu
Kicu reviewed Jan 9, 2025
View reviewed changes
Copy link
Member

@Kicu Kicu left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Went over the PR for the final time and it looks great 👍

I just have 2 last thoughts to improve this:

  1. my comment about duplication in SearchRouterInput
  2. actually I think this is a great time to rename this component, since we are doing some refactoring on it anyways. It's used both on Search results page and in the router, I think we could name it something much more generic. Perhaps simply SearchInput or SearchAutocompleteInput is a better name?
    I want other devs to associate this component with searching in general, not specifically with the router

@Kicu Kicu mentioned this pull request Jan 16, 2025
Merged
48 tasks
@luacmartins
Copy link
Contributor

Nice! Thanks for addressing my comments. I agree that we can leave the border radius out for now so things are consistent across platforms. Additionally, a follow up to handle both syntax key styles and the exact query match highlights sounds good!

@luacmartins
Copy link
Contributor

I'll review again shortly!

luacmartins
luacmartins previously approved these changes Jan 29, 2025
View reviewed changes
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Nice! Code LGTM and tests well! Thanks for the hard work!

@luacmartins
Copy link
Contributor

@ikevin127 all yours

@luacmartins luacmartins mentioned this pull request Jan 29, 2025
Closed
@ikevin127
Copy link
Contributor

🎉 LGTM, good work on this one! Thanks for promptly addressing all issues 👍

@289Adam289 Can you please resolve the conflicts ? Then I'll do a final check before 🟢 Approving.

@289Adam289
Copy link
Contributor Author

Everything should work now. cc @luacmartins @ikevin127

@luacmartins
Copy link
Contributor

@289Adam289 we have conflicts again

ikevin127
ikevin127 approved these changes Jan 30, 2025
View reviewed changes
Copy link
Contributor

@ikevin127 ikevin127 left a comment

Choose a reason for hiding this comment

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

♻️ Reviewed the latest updates and it LGTM 🚀

Given that the conflicts can be cleanly merged, I approved.

@luacmartins feel free to merge this as soon as the conflicts are resolved, but keep an eye on this merge freeze Slack announcement from Rory before merging.

ℹ️ I noticed this thing, which is probably not a blocker but wanted to mention it:

  • now both primary and secondary account emails (contact methods) are highlighted with green when inputted which is great, but when pressing Enter to actually perform search based in the input values, only the primary email will transform into {displayName}, while the secondary email remains as the email address.

    See video
    WEB.mov

@melvin-bot melvin-bot bot requested a review from luacmartins January 30, 2025 23:56
@289Adam289 289Adam289 force-pushed the 289Adam289/50949-highlight-autocomplete branch from e4b4a9d to 601aeb9 Compare January 31, 2025 09:36
@289Adam289
Copy link
Contributor Author

I believe original conflicts were caused by #55078 merge but that pr has been reverted in #56053. I force pushed to the last approved commit so that I don't have to struggle with conflicts.

luacmartins
luacmartins approved these changes Jan 31, 2025
View reviewed changes
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM

@luacmartins
Copy link
Contributor

Failing checks are for hybrid with message:

Error: Input required and not supplied: token

@luacmartins luacmartins merged commit 80f1e44 into Expensify:main Jan 31, 2025
19 of 21 checks passed
@melvin-bot melvin-bot bot added the Emergency label Jan 31, 2025
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Jan 31, 2025

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@OSBotify
Copy link
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.

@ikevin127
Copy link
Contributor

@luacmartins QA still ongoing on this one or how come it wasn't deployed yet ? 🤔

@luacmartins
Copy link
Contributor

The last checklist was created on Jan 31st, before this PR was merged. We're waiting for the next deploy for it to hit staging.

@github-actions github-actions bot mentioned this pull request Feb 3, 2025
Closed
95 tasks
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 3, 2025

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

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

@289Adam289 289Adam289 mentioned this pull request Feb 4, 2025
Merged
50 tasks
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.94-25 🚀

platform result
🤖 android 🤖 true ❌
🖥 desktop 🖥 cancelled 🔪
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 failure ❌

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.94-25 🚀

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

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

@Kicu Kicu Kicu left review comments

@luacmartins luacmartins luacmartins approved these changes

@ikevin127 ikevin127 ikevin127 approved these changes

Assignees

@289Adam289 289Adam289

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@289Adam289 @luacmartins @ikevin127 @OSBotify @Kicu