[Search v2.3] [App] Implement Saved Search feature

[lakchote]

Details

Video test for desktop:

Screen.Recording.2024-09-09.at.16.01.22.mov

Translations have been asked here

Note: I've decided to fix all the frontend issues in one PR, since all of them are tightly intertwined.

Fixed Issues

$ #48453
$ #48454
$ #48458
$ #48457
$ #48455

Tests

• Verify that no errors appear in the JS console

Saving a New Search

1. Go to the search page.
2. Click the Filters button.
3. Apply filters to create a search query (e.g., filter by merchant).
4. Click Save search.
5. Verify the saved search appears in the LHN on desktop.
6. Verify the saved search appears in the type button on mobile.
7. On desktop, verify that an educational tooltip appears, instructing on renaming the saved search using the three-dot menu.

Renaming a Saved Search

1. Locate the saved search in the LHN (desktop) or the type button (mobile).
2. Click the three dots next to the saved search.
3. Select Rename from the menu.
4. Enter a new name and save it.
5. Verify that the saved search is renamed on both desktop and mobile.

Deleting a Saved Search

1. Locate the saved search in the LHN (desktop) or the type button (mobile).
2. Click the three dots next to the saved search.
3. Select Delete from the menu and confirm the deletion.
4. Verify that the saved search is removed from the LHN on desktop.
5. Verify that the saved search is removed from the type button on mobile.
6. Confirm that after deletion, you are navigated back to the default Search page (Expenses / All).

Viewing and Saving Filtered Results

1. Open an existing saved search.
2. Modify the filters to change the search criteria.
3. Click View results.
4. Verify that the results page is updated with the new query.
5. On desktop, ensure that no saved search is selected in the LHN.
6. On mobile, verify that the results page displays with a Cancel button.
7. On mobile, when clicking on the Cancel button, it should redirect the user to the search page with default filters.

Creating Multiple Saved Searches

1. Open an existing saved search.
2. Modify the filters to change the search criteria.
3. Click Save search.
4. Verify that a new saved search is created with an automatically generated name.
5. Confirm that the new saved search appears in the LHN on desktop.
6. Confirm that the new saved search appears in the type button on mobile.

Accessing Saved Searches

1. Navigate to the search page.
2. Locate the saved search and click on it.
3. Verify that the selected saved search loads with the correct filters applied.
4. On desktop, ensure the saved search is highlighted in the LHN.
5. On mobile, confirm that the selected saved search is displayed at the top of the search page.

Review the Search Results

• Verify that the search results align with the filters applied in the saved search.

Offline tests

NA

QA Steps

• Verify that no errors appear in the JS console

QA Steps

• Verify that no errors appear in the JS console

Same as in 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
  • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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 form input styles:

  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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 verified that similar component doesn't exist in the codebase

• I verified that all props are defined accurately and each prop has a /** comment above it */

• I verified that each file is named correctly

• I verified that each component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone

• I verified that the only data being stored in component state is data necessary for rendering and nothing else

• In component if we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes

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

• I verified that component 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)

• I verified that all JSX used for rendering exists in the render method

• I verified that each 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

• I verified that similar component doesn't exist in the codebase

• I verified that all props are defined accurately and each prop has a /** comment above it */

• I verified that each file is named correctly

• I verified that each component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone

• I verified that the only data being stored in component state is data necessary for rendering and nothing else

• In component if we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes

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

• I verified that component 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)

• I verified that all JSX used for rendering exists in the render method

• I verified that each 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

Screenshots/Videos

Android: Native

Screen.Recording.2024-09-10.at.11.55.03.mov

Android: mWeb Chrome

Screen.Recording.2024-09-10.at.12.00.37.mov

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-09-10.at.10.54.54.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-09.at.16.01.22.mov

MacOS: Desktop

Screen.Recording.2024-09-10.at.11.59.15.mov

[OSBotify]

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

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

[s77rt]

We are looking to do something similar here but we want the scrollview to exclude the title (title should be fixed). We will move this ScrollView to wrap only currentMenuItems. Let us know if you see a reason not to do so.

[OSBotify]

🚀 Deployed to production by https://github.com/grgia in version: 9.0.35-7 🚀

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

[paultsimura]

We've ended up adding additional logic – to show the educational tooltip only if we're saving the first search: #49473

[rayane-d]

FYI, using item.name here caused these issues: #49216 and #49739

[dukenv0307]

We need to filter out the pending action here, link to the issue: #51028

[dukenv0307]

We need to trigger dismissModal before navigating to SEARCH_CENTRAL_PANE, coming from #49943

[mollfpr]

✋ Coming from #50225

The newName state can be filled with an empty string and the BE will fall back to the query. So we doing something but in the FE newName?.trim() || q, this will make the saveSearch offline work.

[allgandalf]

We only wrapped the saved search list with a scroll view, so it's only the saved search that was scrollable, But the design team expected that the whole menu to be scrollable, I don't have access to design doc to determine if this was expected or a missed case. But this caused #52910

[allroundexperts]

Coming from #57749, we should have cleared this only if the current hash was equal to the hash to delete.