Search - Add Reset filters button to Advanced Filters page #48243

cdOut · 2024-08-29T08:32:16Z

Details

Added a button to reset selected filters in the header of AdvancedFiltersPage.

Design update

The design of the button has been updated, you can refer to it over on this slack conversation.

Fixed Issues

$ #48136
PROPOSAL:

Tests

Log in and go into the search tab
Press on the filters button in the top-right corner
Select any number of filters to test
Confirm that a Reset filters button appears in the header of the page / modal when any filter is selected, press on it and confirm that it resets the filters to none.

Verify that no errors appear in the JS console

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.NATIVE.mov

Android: mWeb Chrome

ANDROID.CHROME.mov

iOS: Native

IOS.NATIVE.mov

iOS: mWeb Safari

IOS.SAFARI.mov

MacOS: Chrome / Safari

CHROME.mov

MacOS: Desktop

DESKTOP.mov

Kicu

LGTM, left a small suggestion

Kicu · 2024-08-29T08:40:58Z

src/pages/Search/SearchAdvancedFiltersPage.tsx

 import AdvancedSearchFilters from './AdvancedSearchFilters';

 function SearchAdvancedFiltersPage() {
    const styles = useThemeStyles();
    const {translate} = useLocalize();
+    const [searchAdvancedFilters = {} as SearchAdvancedFiltersForm] = useOnyx(ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM);
+
+    const shouldShowResetFilters = Object.values(searchAdvancedFilters).some((value) => (Array.isArray(value) ? value.length !== 0 : value !== ''));


very small nitpick, but instead of this check value !== '' I would just check something like !!value. Just feels safer and more generalised to check if a value is truthy.

I agree, it's more readable that way - corrected 👍

…error

melvin-bot · 2024-08-29T10:51:44Z

@rayane-djouah 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]

rayane-djouah · 2024-08-29T11:58:50Z

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-08-29.at.11.27.42.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-08-29.at.11.26.04.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-29.at.23.16.28.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-29.at.23.25.40.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-08-29.at.11.08.39.PM.mov

MacOS: Desktop

Screen.Recording.2024-08-29.at.11.24.20.PM.mov

rayane-djouah · 2024-08-29T22:21:58Z

@Expensify/design - Does this look good?

Screenshots

rayane-djouah

LGTM and tests well

luacmartins

LGTM

OSBotify · 2024-08-29T22:58:26Z

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

shawnborton · 2024-08-29T23:36:03Z

Interesting, I would think after resetting the filters we'd just go back to a standard Expenses > All bucket? Rather than displaying a query like so:

Thoughts?

Kicu · 2024-08-30T06:53:42Z

@shawnborton your assumption makes sense 👍
I think we want to clean up a bit of logic around whether you get to see the "canned" (what you called the standard bucket) or the Search Results page with the query description.

This was discussed here on slack: https://swmansion.slack.com/archives/C036QM0SLJK/p1724857996895799?thread_ts=1724745439.819019&cid=C036QM0SLJK (not sure if this link will work for you.

But I will remind @luacmartins to create an issue for it, and we'll clean this edge case along with it

luacmartins · 2024-08-30T13:52:00Z

@Kicu created here

OSBotify · 2024-08-30T18:50:21Z

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

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

OSBotify · 2024-09-02T23:28:03Z

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.27-1 🚀

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

cdOut added 3 commits August 29, 2024 10:16

add reset filters header button to advanced search

4c1dd13

fix prettier

7912c21

Merge branch 'main' into @cdOut/search-reset-filters

a5319d5

Kicu approved these changes Aug 29, 2024

View reviewed changes

cdOut added 3 commits August 29, 2024 10:57

use boolean cast to assert if value is truthy

e04fc69

change value length check

2a46548

declare default value outside of destructuring to fix react compiler …

ec716ad

…error

cdOut marked this pull request as ready for review August 29, 2024 10:51

cdOut requested a review from a team as a code owner August 29, 2024 10:51

melvin-bot bot requested review from rayane-djouah and removed request for a team August 29, 2024 10:51

rayane-djouah approved these changes Aug 29, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins August 29, 2024 22:33

luacmartins approved these changes Aug 29, 2024

View reviewed changes

luacmartins merged commit 6d70b10 into Expensify:main Aug 29, 2024
18 of 19 checks passed

github-actions bot mentioned this pull request Aug 30, 2024

Deploy Checklist: New Expensify 2024-08-30 #48360

Closed

45 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Search - Add Reset filters button to Advanced Filters page #48243

Search - Add Reset filters button to Advanced Filters page #48243

cdOut commented Aug 29, 2024 •

edited

Loading

Kicu left a comment

Kicu Aug 29, 2024

cdOut Aug 29, 2024

melvin-bot bot commented Aug 29, 2024

rayane-djouah commented Aug 29, 2024 •

edited

Loading

rayane-djouah commented Aug 29, 2024

rayane-djouah left a comment

luacmartins left a comment

OSBotify commented Aug 29, 2024

shawnborton commented Aug 29, 2024

Kicu commented Aug 30, 2024 •

edited

Loading

luacmartins commented Aug 30, 2024

OSBotify commented Aug 30, 2024

OSBotify commented Sep 2, 2024

Search - Add Reset filters button to Advanced Filters page #48243

Search - Add Reset filters button to Advanced Filters page #48243

Conversation

cdOut commented Aug 29, 2024 • edited Loading

Details

Design update

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment

Choose a reason for hiding this comment

Kicu Aug 29, 2024

Choose a reason for hiding this comment

cdOut Aug 29, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Aug 29, 2024

rayane-djouah commented Aug 29, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rayane-djouah commented Aug 29, 2024

rayane-djouah left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 29, 2024

shawnborton commented Aug 29, 2024

Kicu commented Aug 30, 2024 • edited Loading

luacmartins commented Aug 30, 2024

OSBotify commented Aug 30, 2024

OSBotify commented Sep 2, 2024

cdOut commented Aug 29, 2024 •

edited

Loading

rayane-djouah commented Aug 29, 2024 •

edited

Loading

Kicu commented Aug 30, 2024 •

edited

Loading