[Search v2.1] Create In filter #46030

[Guccio163]

Details

This PR adds the In filter - part of Search v2.1 milestone

Fixed Issues

$ #46030
PROPOSAL:

Tests

1. Open search/filters, no options selected should show in In filter section
2. Open In filter page, all options should remain unchecked
3. Check some options, they should propagate on the top of list with selected checkmark ✅ Also selected options should not be visible in default propositions (recent reports)
4. Try to search for an (non-selected) option in search bar; it should come up, search results should replace default propositions (recent reports) for the time of searching
5. Select searched option; selected option should be displayed with the rest on top of list, search phrase should reset, search results should be replaced back by default propositions (recent reports)
6. Search for the same option once again, it should come up but this time with selected checkmark ✅
7. Click on the selected option, it should uncheck and disappear from selected list; If it was previously in recent reports, it should pop up back there

• Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

• 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

Screen.Recording.2024-08-27.at.11.32.55.mov

Android: mWeb Chrome

mWeb-android.mov

iOS: Native

Screen.Recording.2024-08-27.at.11.18.11.mov

iOS: mWeb Safari

Screen.Recording.2024-08-27.at.11.20.51.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-27.at.11.12.04.mov

MacOS: Desktop

Screen.Recording.2024-08-27.at.11.26.17.mov

[Kicu]

Quick review about 1 thing

[Kicu]

very good job with this quite problematic filter 😅
I think the final code looks pretty good, I left several comments but most are minor name and codestyle changes

[Kicu]

One small fix

[Guccio163]

All comments from review included and applied 👌

[Kicu]

Hey I found 2 more renames to fix, but other than that the PR looks good.

I'm leaving an approve and feel free to open the PR to external review, just fix these 2 small renames first.

[rayane-djouah]

The In filter is a type=chat specific filter, so the UI should only render it if the user is currently viewing the chat type, but it's is rendered if the user is currently viewing the expense type. This will be fixed when #47918 is merged, which will introduce type-specific filters logic.

[rayane-djouah]

https://dev.new.expensify.com:8082/search?q=type%3Achat%20status%3Aall%20in%3A7411610335045130&isCustomQuery=true

Payload is correct:

And we're getting a correct response from backend:

But the result page is showing empty results because we're not handling ReportActionListItemType which will be added as part of #47690

but we don't need to hold for #47690 because the filter will only be displayed if we're viewing the type=chat (after #47918 is merged)

[rayane-djouah]

Unread recent reports are displayed with bold text. But this is also the behaviour on "start chat" and "submit expense" flows, so I think this is expected.

Screenshot

[rayane-djouah]

Bug on Android Native App: The display title is truncated even though there is available space. Same thing with the dropdown button title:

Screenshots

[rayane-djouah]

Screenshots/Videos

Android: Native

Screen.Recording.2024-08-30.at.3.48.44.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-08-30.at.3.45.58.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-30.at.15.45.26.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-30.at.15.43.20.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-08-30.at.3.29.50.PM.mov

MacOS: Desktop

Screen.Recording.2024-08-30.at.3.41.57.PM.mov

[Guccio163]

Unread recent reports are displayed with bold text. But this is also the behaviour on "start chat" and "submit expense" flows, so I think this is expected.

Yeah, it works like that in chat-finder too and In should base on it so I think it's by design

Bug on Android Native App: The display title is truncated even though there is available space. Same thing with the dropdown button title:

This is bigger than this filter (funny that no-one caught it in previous filters, huh), it works like that with most of (if not all) filters:

I really want to close and merge this issue, because it took a lot to make it work, but if it won't be merged on Monday I can take a look if I can fix it for all filters right away.

[luacmartins]

I think we can merge this as is and address the UI issues in a follow up.

[rayane-djouah]

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.

[rayane-djouah]

@luacmartins all yours!

[Guccio163]

I think we can merge this as is and address the UI issues in a follow up.

I'm all for it, we're not working until the end of the week, but I'll take that UI follow-up first thing on monday ⚡️

[luacmartins]

@Guccio163 conflicts

[luacmartins]

LGTM

[Guccio163]

Godspeed ⚡️ Ready to merge 👌

There is a problem because logic of filters have changed a bit since I've done it; I need to come home now but if you'll be online it should be ready in about an hour ;)

[Guccio163]

Tests look like they're all about to pass; I couldn't find in which report type filter In should be visible, but from what I remember only in Chats - that's where it's added ✅

Everything ready, @luacmartins let's wrap this up 🔥

[luacmartins]

Thanks for pushing this to the finish line @Guccio163 @rayane-djouah

[OSBotify]

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

[mvtglobally]

@luacmartins Steps say NO QA, but seems like we can QA it. Can you pls confirm if we need to run the tests

[rayane-djouah]

@mvtglobally - The page of this filter is not accessible by users for now. It will be accessible once #48312 and #47690 are merged/deployed

[OSBotify]

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

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.28-3 🚀

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