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.

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

Provide autocomplete suggestions in SearchRouterList #51237

Conversation

SzymczakJ
Copy link
Contributor

@SzymczakJ SzymczakJ commented Oct 22, 2024

Details

This PR adds autocomplete in SearchRouter for simple keys like categories, tags, etc.. Searching with 'in:' keyword is not yet fully supported(reportIDs instead of full names will be visible in text input)

Fixed Issues

$ #50942
$ #50947
$ #50957
$ #50952
$ #50953
$ #50954
$ #50955
$ #50956
$ #50948
$ #50945
PROPOSAL:

Tests

  1. Open SearchRouter and test these autocomplete keys: category, tag, taxRate, type, expenseType, card, from, to, status, and currency.
  2. Verify that when category, tag or currency keys are working the way this comment specified it.
  3. Verify that after clearing input or single autocomplete key the autocomplete suggestions are cleared.
  4. Verify that after clicking on autocomplete suggestion it is added correctly to text input.

Offline tests

QA Steps

  • 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 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
android.mov
Android: mWeb Chrome
androidweb.mov
iOS: Native
ios.mov
iOS: mWeb Safari
iosweb.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@SzymczakJ SzymczakJ changed the title Autocomplete search router draft Provide autocomplete suggestions in SearchRouterList Oct 22, 2024
@SzymczakJ
Copy link
Contributor Author

Should we somehow limit the list of autosuggestions @luacmartins? This is POC implementation of autosuggestions for some of filters(the ones linked in description)

poc.mov

I don't see much designs connected to autocomplete.

@luacmartins
Copy link
Contributor

@SzymczakJ I think we should only offer suggestions once the user typed at least one character after the filter key, e.g. currency:A. tagging @trjExpensify @JmillsExpensify for your thoughts as well.

@JmillsExpensify
Copy link

Agree with Carlos that we'd suggest on the first character after the filter key.

@luacmartins
Copy link
Contributor

@SzymczakJ we discussed internally and the behavior we want for this is:

  1. category: would show a list of 10 "recently used" across all policies, from the RecentlyUsedTags, etc Onyx key. This can be an empty list.
  2. category:a would filter results from all policyCategories for categories starting with a and show those suggestions.

Does that make sense?

Copy link
Contributor

@Kicu Kicu left a comment

Choose a reason for hiding this comment

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

On a quick glance the logic and data flow looks good 👌

I hope that in future we can somehow split the logic so that SearchRouter does not become a "god component"

src/libs/SearchAutocompleteUtils.ts Outdated Show resolved Hide resolved
src/libs/SearchAutocompleteUtils.ts Outdated Show resolved Hide resolved
src/libs/SearchAutocompleteUtils.ts Outdated Show resolved Hide resolved
src/libs/SearchAutocompleteUtils.ts Outdated Show resolved Hide resolved
const singlePolicyTagsList: PolicyTagLists | undefined = allPoliciesTagsLists?.[`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`];
if (!singlePolicyTagsList) {
const uniqueTagNames = new Set<string>();
const tagListsUnpacked = Object.values(allPoliciesTagsLists ?? {}).filter((item) => !!item) as PolicyTagLists[];
Copy link
Contributor

Choose a reason for hiding this comment

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

is possible to use default argument instead, and do

getAutoCompleteTagsList(allPoliciesTagsLists: OnyxCollection<PolicyTagLists> = {}, policyID?: string)

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe our hands are tied by OnyxCollection which can be undefined.

src/libs/SearchAutocompleteUtils.ts Outdated Show resolved Hide resolved
const [cardList = {}] = useOnyx(ONYXKEYS.CARD_LIST);
const cardsAutocompleteList = Object.values(cardList ?? {}).map((card) => card.bank);
const personalDetails = usePersonalDetails();
const participantsAutocompleteList = Object.values(personalDetails)
Copy link
Contributor

Choose a reason for hiding this comment

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

Good job, but still:
image

😆 but seriously NAB and if we need all this data then we need it

Copy link
Contributor

Choose a reason for hiding this comment

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

Yea, I'm not sure there's a way around it. Maybe we can create a custom hook, useAutocomplete so the logic lives outside the component?

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.

I know this is still WIP so maybe you might be aware of these issues already, but I wanted to point them out anyways so we can get ahead and make sure they don't make to the final version of the PR:

  1. I think we should limit the number of suggestions to maybe 10 sorted alphabetically. You can see on the list that if I type from, a full list of all personalDetails comes up, which seems a bit useless.
  2. Cycling through the options should update the query string, e.g. when I press the arrow keys to select a different option, the query in the router should update to include the currently active suggestion.
  3. Selecting an autocomplete suggestion runs the query, but it drops the filter key. Note in the video how I selected from:[email protected] but the final search dropped the from: part
Screen.Recording.2024-10-23.at.9.49.14.AM.mov

Copy link
Contributor

@Kicu Kicu left a comment

Choose a reason for hiding this comment

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

very small stuff, feel free to open PR when you're ready.

src/components/Search/SearchRouter/SearchRouterList.tsx Outdated Show resolved Hide resolved
src/components/Search/SearchRouter/SearchRouter.tsx Outdated Show resolved Hide resolved
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.

Let's address the variable reaming/typos above

@ikevin127
Copy link
Contributor

ikevin127 commented Oct 28, 2024

⚠️ Found two issues while reviewing:

  1. Multiple options for 1 autocomplete key results in infinite loading

Note

Explanation

When selecting 2 or more options and performing search we're stuck with infinite loading for the following keys: type, taxRate and status.

Note: I want to mention that since I don't have cards for testing I wasn't able to test the card key autocomplete but I'm assuming it works as expected 🤞

Below video demonstrates the behaviour for the type key.

multipleTypetaxRate-infinite-loading.mov
  1. [UX] Selecting 1 autocomplete option adds [space] then when comma is added after space, no autocomplete options are shown

Note

Explanation

The issue here is that when selecting 1 autocomplete option, [space] is added in the input after the option which if we type , (comma) after the space, other autocomplete options don't show up. The only way options continue to show up is if we delete the space that is added automatically, then type , (comma) right after the first selected option.

Important: Same thing happens when trying to chain multiple keys, not only key options - if the space is not removed first, the options for the second key won't show up:

Screenshot 2024-10-28 at 15 29 44

Below video demonstrates the behaviour.

all-spacing-comaSeparator.mov

cc @SzymczakJ @luacmartins

I'll move forward with the reviewer checklist in the meantime, and will approve once the above issues are addressed and conflicts resolved.

@Kicu
Copy link
Contributor

Kicu commented Oct 29, 2024

@ikevin127 @luacmartins @SzymczakJ
In order to speed implementing things up, I'm already branched from this PR and working on the next steps of autocomplete. Mainly the accountID/reportID <---> user login/chatname substitution, so that the query the user sees is always correct.

Because of that I would like to suggest any NAB's and other improvements are not done here, but I will instead do them in my PR 😁 it will greatly help me.
Let's fix only critical and problematic bugs here.

@SzymczakJ
Copy link
Contributor Author

SzymczakJ commented Oct 29, 2024

  1. Multiple options for 1 autocomplete key results in infinite loading

It results in infinite loading, because it doesn't make sense from UI point of view(we cannot be on an Expense tab and on Chat tab on the same moment). On the other hand I think that we shouldn't limit the user, even though his query may produce something that doesn't make sense. Maybe we could provide some modal on SearchResultsPage that tells user that 'This query doesn't make sense'. WDYT @luacmartins

  1. [UX] Selecting 1 autocomplete option adds [space] then when comma is added after space, no autocomplete options are shown

No autocomplete was added for input "category:X ," because of the limitations of our parser. Here is my solution for this: when user adds "," to add another autocomplete then the spaces before "," are trimmed so our parser can parse it properly. Please check it out @luacmartins @ikevin127 and tell me WDYT

proposal.mov

@luacmartins
Copy link
Contributor

It results in infinite loading, because it doesn't make sense from UI point of view(we cannot be on an Expense tab and on Chat tab on the same moment). On the other hand I think that we shouldn't limit the user, even though his query may produce something that doesn't make sense. Maybe we could provide some modal on SearchResultsPage that tells user that 'This query doesn't make sense'. WDYT @luacmartins

Yea, I agree that this is an issue, but it also happens on main today because a user can type that. So NAB for this PR. I think ultimately, we need to improve the parser to validate some of these keys, like type, status, sortBy, sortOrder, etc so we handle this more gracefully. NAB for now though

No autocomplete was added for input "category:X ," because of the limitations of our parser. Here is my solution for this: when user adds "," to add another autocomplete then the spaces before "," are trimmed so our parser can parse it properly. Please check it out @luacmartins @ikevin127 and tell me WDYT

I like it! Thanks for fixing that!

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.

Looks great, thanks to everybody for addressing and the issues! :shipit:

@melvin-bot melvin-bot bot requested a review from luacmartins October 29, 2024 18:01
@luacmartins
Copy link
Contributor

NAB I think we can get smarter with the suggested statuses and only suggest statuses that apply to the current type
Screenshot 2024-10-29 at 12 21 47 PM

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 and tests well. Just waiting on final approval from the product team!

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
❌ FAILED ❌ https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/51237/index.html
The QR code can't be generated, because the android build failed iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/51237/NewExpensify.dmg https://51237.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@luacmartins luacmartins merged commit 94fd9b5 into Expensify:main Oct 29, 2024
17 checks passed
@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.

Copy link
Contributor

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

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

Copy link
Contributor

github-actions bot commented Nov 4, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.56-9 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants