Add card advanced filter for Search #46666

289Adam289 · 2024-08-01T13:14:05Z

Details

Fixed Issues

$46042
PROPOSAL:

Tests

add cards to account
visit route /search/filters
test card filter and whether navigation behaves correctly
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.mov

Android: mWeb Chrome

web_and.mov

iOS: Native

IOS.mov

iOS: mWeb Safari

web_ios.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

Kicu

Looks good, left you small comments

src/pages/Search/SearchFiltersCardPage.tsx

Kicu · 2024-08-01T15:13:24Z

src/pages/Search/SearchFiltersCardPage.tsx

+            .filter((card) => card.cardID)
+            .sort((a, b) => a.bank.localeCompare(b.bank))
+            .map((card) => {
+                const icon = getBankIcon({bankName: card.bank as BankName, isCard: true, styles});


This cast as BankName looks fishy and I'd rather we didn't have it. But I also did a search in the project and it seems that it is done similarly in a few places so maybe thats ok.
Leaving this comment for other people to see

src/pages/Search/SearchFiltersCardPage.tsx

melvin-bot · 2024-08-02T10:22:59Z

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

ikevin127 · 2024-08-02T19:44:03Z

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

android.webm

Android: mWeb Chrome

android-mweb.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

ikevin127 · 2024-08-02T23:08:22Z

@Kicu Navigation and selection of the cards is pristine 🚀

⚠️ I completed the PR Reviewer Checklist, with the mention that I found possibly one / two potential issues during testing:

1. Missing design for when no cards are present (empty state)

Note: Not sure if we're supposed to even show the empty card filter page if cards don't exist as in this case we could not show the Card filtering category at all / or show it grayed-out Card filtering category with an ℹ️ You don't have any cards added yet. kind of tooltip / message.

Empty card filter RHP

2. Card filter labels are not added in the Filters section even though they are present in the URL

Note: Not sure if this is because I added the cards via Onyx or this happens regardless if the cards are actually added.

Missing Card filter labels

@luacmartins @Expensify/design If you guys think these are not within the immediate scope of this PR and will be handled in a follow-up / or when all the filters will be linked together then let me know and I'll 🟢 Approve right away.

dubielzyk-expensify · 2024-08-04T22:27:49Z

I think both of these needs to be fixed. I'm a bit unsure if we want an empty state for the card or if we wanna remove the filter option altogether when there are no cards. If we did the empty state route, we could do something like this:

Perhaps it's nice to have the filter option in there purely for education purposes, but I'm not sure it makes sense. cc @Expensify/design and @JmillsExpensify for thoughts

luacmartins · 2024-08-05T07:55:11Z

I agree that we need to fix both issues. I like the idea of simplifying the UI and only showing relevant filters to the user, so I'd be in favor of removing the card filter if the user doesn't have any cards.

Kicu · 2024-08-05T08:17:34Z

Are guys suggestion that we remove the very option of card filter from the main "advanced filters" page?

289Adam289 · 2024-08-05T09:11:11Z

The issue with card labels in the filters section, I believe, is a result of a discrepancy between the key in the search parser grammar: "card", and the key in the CONST.ts file: "cardID". Changing the key in the grammar to "cardID" should fix the issue.

luacmartins · 2024-08-05T09:20:22Z

Remind the option from the advanced filter page if the user doesn't have any cards would be my preference, but we should wait on more input from the design team.

289Adam289 · 2024-08-05T10:16:24Z

The parser wasn't regenerated after the last grammar change, which is why the searchParser.js file has changed significantly. cc @Kicu @adamgrzybowski

Kicu

I left just 1 tiny comment :D

src/ROUTES.ts

shawnborton · 2024-08-05T13:33:42Z

I think I lean towards just removing the filter option entirely if there are no cards to filter on.

dannymcclain · 2024-08-05T14:57:55Z

I think I lean towards just removing the filter option entirely if there are no cards to filter on.

I'm down with this approach.

ikevin127

🟢 Thanks for addressing the issues!

1. Missing design for when no cards are present (empty state)

Addressed by the team and decided to go with removing the Card category from the filters list when no cards are present. Fixed by commit 1f000e4.

2. Card filter labels are not added in the Filters section even though they are present in the URL

Addressed by author and fixed by commit f26e0d9. This is how it looks now (comma in-between cards):

melvin-bot · 2024-08-05T18:34:32Z

🎯 @ikevin127, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #46827.

ikevin127 · 2024-08-05T18:40:04Z

Regarding the commas in-between the cardID, this might be addressed in another issue / PR as per #46566 (comment). I wouldn't consider it a blocker for this PR.

@Kicu should be able to confirm if the fix mentioned in the comment will cover all filters (including Card).

luacmartins

LGTM

OSBotify · 2024-08-05T19:11:39Z

✋ 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-08-06T04:29:20Z

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

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

OSBotify · 2024-08-07T22:05:10Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

OSBotify · 2024-08-08T04:54:47Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

OSBotify · 2024-08-08T20:06:11Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

jjcoffee · 2024-09-11T09:00:57Z

Coming from #48075, we missed adding SCREENS.SEARCH.ADVANCED_FILTERS_CARD_RHP to CENTRAL_PANE_TO_RHP_MAPPING here so on refresh and back-button taps there was an incorrect screen showing up.

289Adam289 added 3 commits August 1, 2024 15:03

Add card advanced filter for Search

86a4564

Add cardID filter to query

1fb5b2a

Improve card filter title and query

8ab2d74

Kicu approved these changes Aug 1, 2024

View reviewed changes

ikevin127 mentioned this pull request Aug 2, 2024

[$250] [Search v2.1] [App] Create Card filter #46042

Closed

289Adam289 added 2 commits August 2, 2024 10:01

review suggestions

fc519ab

Merge branch 'main' into 289Adam289/46042-advanced-filters-card

cef8804

289Adam289 marked this pull request as ready for review August 2, 2024 10:22

289Adam289 requested a review from a team as a code owner August 2, 2024 10:22

melvin-bot bot requested review from cristipaval and removed request for a team August 2, 2024 10:22

cristipaval requested review from luacmartins and removed request for cristipaval August 2, 2024 13:11

luacmartins requested a review from ikevin127 August 2, 2024 13:56

Fix grammar card key

f26e0d9

Kicu reviewed Aug 5, 2024

View reviewed changes

src/ROUTES.ts Show resolved Hide resolved

Add feature to hide card page when no cards are available

1f000e4

ikevin127 approved these changes Aug 5, 2024

View reviewed changes

melvin-bot bot mentioned this pull request Aug 5, 2024

[$250] [Due payment 2024-08-14] Payment issue for E/App PR#46666 #46827

Closed

luacmartins approved these changes Aug 5, 2024

View reviewed changes

luacmartins merged commit 41a84a0 into Expensify:main Aug 5, 2024
15 checks passed

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

Deploy Checklist: New Expensify 2024-08-06 #46849

Closed

83 tasks

jjcoffee mentioned this pull request Sep 11, 2024

[$250] Web- Search - Central pane is Search while LHN is inbox after clicking back button on card RHP #48075

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add card advanced filter for Search #46666

Add card advanced filter for Search #46666

289Adam289 commented Aug 1, 2024 •

edited

Loading

Kicu left a comment

Kicu Aug 1, 2024

melvin-bot bot commented Aug 2, 2024

ikevin127 commented Aug 2, 2024 •

edited

Loading

ikevin127 commented Aug 2, 2024

dubielzyk-expensify commented Aug 4, 2024

luacmartins commented Aug 5, 2024

Kicu commented Aug 5, 2024 •

edited

Loading

289Adam289 commented Aug 5, 2024

luacmartins commented Aug 5, 2024

289Adam289 commented Aug 5, 2024

Kicu left a comment

shawnborton commented Aug 5, 2024

dannymcclain commented Aug 5, 2024

ikevin127 left a comment

melvin-bot bot commented Aug 5, 2024

ikevin127 commented Aug 5, 2024 •

edited

Loading

luacmartins left a comment

OSBotify commented Aug 5, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 8, 2024

OSBotify commented Aug 8, 2024

jjcoffee commented Sep 11, 2024 •

edited

Loading

Add card advanced filter for Search #46666

Add card advanced filter for Search #46666

Conversation

289Adam289 commented Aug 1, 2024 • edited Loading

Details

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 1, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Aug 2, 2024

ikevin127 commented Aug 2, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ikevin127 commented Aug 2, 2024

dubielzyk-expensify commented Aug 4, 2024

luacmartins commented Aug 5, 2024

Kicu commented Aug 5, 2024 • edited Loading

289Adam289 commented Aug 5, 2024

luacmartins commented Aug 5, 2024

289Adam289 commented Aug 5, 2024

Kicu left a comment

Choose a reason for hiding this comment

shawnborton commented Aug 5, 2024

dannymcclain commented Aug 5, 2024

ikevin127 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 5, 2024

ikevin127 commented Aug 5, 2024 • edited Loading

luacmartins left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 5, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 8, 2024

OSBotify commented Aug 8, 2024

jjcoffee commented Sep 11, 2024 • edited Loading

289Adam289 commented Aug 1, 2024 •

edited

Loading

ikevin127 commented Aug 2, 2024 •

edited

Loading

Kicu commented Aug 5, 2024 •

edited

Loading

ikevin127 commented Aug 5, 2024 •

edited

Loading

jjcoffee commented Sep 11, 2024 •

edited

Loading