[Search v2.3] [Saved Searches] Fix duplicate saved searches by lakchote · Pull Request #49243 · Expensify/App

lakchote · 2024-09-16T06:54:27Z

Details

When we open the search page there are no filters applied.
Then, when we open the advanced search filters, the filters type: expense status: all are automatically applied.

If we set a new filter, such as Merchant, the query string for the search will become type: expense status: all merchant:test.

Once we save the search, and make it the one currently selected, if we edit its filters however the type and status filters will be appended at the end of the array. As such the query string will become merchant: test type: expense status: all.

Since the query strings are different, if we save the search again, we'll have different hashes and as such duplicate saved searches.

This PR aims to make sure these filters are always applied at the beginning of the query string.

Fixed Issues

$ #49205

Tests

Verify that no errors appear in the JS console

Go to Search.
Click Filters.
Select Merchant and add search query (issue is reproducible with Merchant filter and not Date, Total filter).
Click Save search.
Click 3-dot menu next to the saved search > Rename.
Enter a custom name and save it.
Click Filters > Save search.
It should not create another saved search.

Offline tests

NA

QA Steps

Verify that no errors appear in the JS console

Same as in tests

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

luacmartins

LGTM but do we have this consistency issue with other filters too? cc @Kicu

lakchote · 2024-09-16T07:02:24Z

LGTM but do we have this consistency issue with other filters too? cc @Kicu

Yes with the expense type, just like in the video test of the related issue.

melvin-bot · 2024-09-16T07:02:42Z

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

allroundexperts · 2024-09-16T07:28:32Z

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

Screen.Recording.2024-09-18.at.12.47.03.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-09-18.at.12.43.43.PM.mov

Screen.Recording.2024-09-18.at.12.45.28.PM.mov

iOS: Native

Screen.Recording.2024-09-18.at.12.41.07.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-09-18.at.12.33.36.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-18.at.12.22.19.PM.mov

MacOS: Desktop

Screen.Recording.2024-09-18.at.12.24.41.PM.mov

Kicu

IMO it will be safer if we slightly rewrite the buildQueryStringFromFilterValues function to achieved a desirable effect

allroundexperts · 2024-09-16T08:12:05Z

BUG

The filter name resets when you save again.

Screen.Recording.2024-09-16.at.1.03.12.PM.mov

lakchote · 2024-09-17T13:26:39Z

@allroundexperts I've fixed this

@Kicu I've handled your comments

Feel free to re-review, cc @luacmartins

Kicu

Found a typo, this code looks much cleaner 👍

luacmartins · 2024-09-17T22:42:06Z

@allroundexperts can you please re-review?

allroundexperts · 2024-09-18T06:42:20Z

@lakchote Are we supposed to create a new search whenever a merchant is edited? I would just edit the existing one.

Screen.Recording.2024-09-18.at.11.40.14.AM.mov

lakchote · 2024-09-18T06:56:09Z

@lakchote Are we supposed to create a new search whenever a merchant is edited? I would just edit the existing one.

Yes.

luacmartins · 2024-09-18T07:00:32Z

Correct, we should create new searches if any of the values are changed

melvin-bot · 2024-09-18T07:49:51Z

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

OSBotify · 2024-09-18T08:03:23Z

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

OSBotify · 2024-09-18T22:53:43Z

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

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

OSBotify · 2024-09-19T23:34:57Z

🚀 Deployed to production by https://github.com/grgia in version: 9.0.38-4 🚀

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

eh2077 · 2025-01-23T15:39:26Z

+        const savedSearchKeys = Object.keys(savedSearches ?? {});
+        if (savedSearches && savedSearchKeys.includes(String(queryJSON.hash))) {
+            // If the search is already saved, return early to prevent unnecessary API calls
+            Navigation.dismissModal();


This caused a regression #53880. We should call applyFiltersAndNavigate here, so we only display the results as we don't need to save it.

dominictb · 2025-04-04T11:01:36Z

    filtersString.push(amountFilter);

-    return filtersString.filter(Boolean).join(' ');
+    return filtersString.join(' ').trim();


filtersString can be falsy, joining these falsy values by spaces will cause redundant spaces between the queries. Regression: #57696.

fix duplicate saved searches

6faf27b

lakchote requested a review from luacmartins September 16, 2024 06:54

lakchote self-assigned this Sep 16, 2024

luacmartins previously approved these changes Sep 16, 2024

View reviewed changes

lakchote marked this pull request as ready for review September 16, 2024 07:02

lakchote requested a review from a team as a code owner September 16, 2024 07:02

melvin-bot Bot requested review from suneox and removed request for a team September 16, 2024 07:02

lakchote requested review from allroundexperts and removed request for suneox September 16, 2024 07:26

Kicu suggested changes Sep 16, 2024

View reviewed changes

Comment thread src/libs/SearchUtils.ts Outdated

Comment thread src/libs/SearchUtils.ts Outdated

lakchote added 4 commits September 17, 2024 14:30

Merge branch 'main' into lucien/fix-duplicate-savedSearches

114865a

update logic for buildQueryStringFromFilterValues()

0be3fcc

prevent saving search when hash is identical

6339f05

fix lint

8abfc5c

lakchote dismissed luacmartins’s stale review via 8abfc5c September 17, 2024 13:23

Kicu reviewed Sep 17, 2024

View reviewed changes

Comment thread src/libs/SearchUtils.ts

fix typo

d823cca

allroundexperts approved these changes Sep 18, 2024

View reviewed changes

melvin-bot Bot requested a review from blimpich September 18, 2024 07:49

luacmartins approved these changes Sep 18, 2024

View reviewed changes

luacmartins merged commit 448ca57 into main Sep 18, 2024

luacmartins deleted the lucien/fix-duplicate-savedSearches branch September 18, 2024 07:53

github-actions Bot mentioned this pull request Sep 18, 2024

Deploy Checklist: New Expensify 2024-09-18 #49427

Closed

43 tasks

eh2077 reviewed Jan 23, 2025

View reviewed changes

dominictb reviewed Apr 4, 2025

View reviewed changes

Uh oh!

Conversation

lakchote commented Sep 16, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

luacmartins left a comment

Choose a reason for hiding this comment

Uh oh!

lakchote commented Sep 16, 2024

Uh oh!

melvin-bot Bot commented Sep 16, 2024

Uh oh!

allroundexperts commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Kicu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

allroundexperts commented Sep 16, 2024

Uh oh!

lakchote commented Sep 17, 2024

Uh oh!

Kicu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

luacmartins commented Sep 17, 2024

Uh oh!

allroundexperts commented Sep 18, 2024

Uh oh!

lakchote commented Sep 18, 2024

Uh oh!

luacmartins commented Sep 18, 2024

Uh oh!

melvin-bot Bot commented Sep 18, 2024

Uh oh!

OSBotify commented Sep 18, 2024

Uh oh!

OSBotify commented Sep 18, 2024

Uh oh!

OSBotify commented Sep 19, 2024

Uh oh!

eh2077 Jan 23, 2025

Choose a reason for hiding this comment

Uh oh!

dominictb Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

allroundexperts commented Sep 16, 2024 •

edited

Loading

dominictb Apr 4, 2025 •

edited

Loading