Preserve policyID when navigating to canned search queries

[Kicu]

Details

• previously when building a "canned Search" we would only use static, hardcoded type and status
• with this PR we will now preserve policyID if it was chosen via Workspace Switcher and when navigating to a canned search the policyID will not be reset

Fixed Issues

$ #49637
PROPOSAL:

Tests

• go to Search
• select a policy using workspace switcher
• check that when clicking on LHN canned search buttons (expense, trips, chats) and on Status Nav buttons (All, draft, unread etc) the workspace switcher is not reset to all

Offline tests

QA Steps

• go to Search
• select a policy using workspace switcher
• check that when clicking on LHN canned search buttons (expense, trips, chats) and on Status Nav buttons (All, draft, unread etc) the workspace switcher is not reset to all

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

rec-policyid-andr.mp4

Android: mWeb Chrome

iOS: Native

rec-policyid-ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

rec-policyid-web.mp4

MacOS: Desktop

[melvin-bot]

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

[luacmartins]

LGTM

[Kicu]

@rushatgabhane can you take a look?

[rushatgabhane]

yea eta 30 mins

[rushatgabhane]

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

soon

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-09-27.at.14.54.26.mov

iOS: mWeb Safari

Screen.Recording.2024-09-30.at.08.27.02.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-27.at.14.55.14.mov

Screen.Recording.2024-09-30.at.08.24.21.mov

MacOS: Desktop

[rushatgabhane]

Hello @Kicu @luacmartins @JmillsExpensify

I think that we should preserve the workspace selection when selecting an item from saved search too. I feel the original Problem solution applies here too. What do you think?

The filters used in saved search does not have workspace. There is a from and to filter tho.

Will users expect saved search to show results from all workspaces? Or they expect the applied filters to apply for the selected workspace only?

Screen.Recording.2024-09-27.at.14.48.20.mov

[Kicu]

Fair point 👍
Then let me preface my response with a bit of summary of how we got here:

Sometimes we treat policyID as another filter field in Search. That means:

• we have policyID param inside search query (and grammar:

  App/src/components/Search/types.ts

  Line 67 in 3dbc34d

  policyID?: string;

  ) NOT as a separate param
• any interaction with policyID on search pages means changing it inside the search query
• query is the single source of truth for all currently chosen filters

But sometimes we also treat policyID in a special way, via workspaceSwitcher, and preserve it on page changes - which was also requested in here.

So technically (from code logic perspective) I think the behaviour is correct now - when you click on a saved search you are redirected to exactly the query that was saved, with all the filters.
If we think it would be better for the user to "preserve" the chosen workspace, then I argue that we should be saving the original chosen policyID into the saved search and use this one, while ignoring the currently chosen policyID.

Here is what this would mean:

1. I'm on search, I use workspace switcher to change to policyID PolicyA
2. I open advanced filters, I chose filters amount>2000 and I created a saved search
3. in reality here is the saved search that I created: type:Expense status:all policyID:PolicyA amount>2000
4. whenever I click this ☝️ saved search I get redirected to this exact query, even if currently I set workspace switcher to a different policy or "All"

Otherwise, we will be mixing the query from saved searches with current context value of policyID which I think might add further confusion.

@luacmartins @JmillsExpensify please share your opinions

[rushatgabhane]

So technically (from code logic perspective) I think the behaviour is correct now - when you click on a saved search you are redirected to exactly the query that was saved, with all the filters.
If we think it would be better for the user to "preserve" the chosen workspace, then I argue that we should be saving the original chosen policyID into the saved search and use this one, while ignoring the currently chosen policyID.

Otherwise, we will be mixing the query from saved searches with current context value of policyID which I think might add further confusion.

i agree with you 👍 💯

okay so @JmillsExpensify @luacmartins need to decide what would be a clean UX for the product.

It kind of boils down to if we want to add a new workspace filter to saved search. And we do not care which workspace is selected using workspace switcher.

A (current): saved search is independent of workspace and it always shows results from all workspaces regardless of which workspace is selected from the switcher.

B: Add a new filter for workspace when saving search. When you click this saved search, you will see results for the workspace in the saved search. If there is no workspace, you will see the result for all workspaces.

[JmillsExpensify]

I think what @mateuuszzzzz is saying for A (current) is a bit different from @rushatgabhane's summary. Basically for option A (current), if you're on a specific policy in the workspace switcher when you save a search, that policy is also saved in the saved search and we always respect it. Otherwise, it's "all policies" and no specific policyID is saved. Right? If that's the case, I agree with that approach.

[luacmartins]

Yea, that's my understanding as well.

[Kicu]

Okey, so I will move forward with following:

• when a user is on a specific workspace when creating a new saved search, then that policyID gets saved into the search and when clicking on this saved search we always show the specific policy saved
• otherwise we will always show "All policies" when clicking on a saved search

Shouldn't be too complex.

[Kicu]

Alright pushed a commit with the aforementioned functionality - it feels quite nice from a UX standpoint.

Here's how this looks:

rec-web-saved.mp4

[JmillsExpensify]

Yes, that looks really great!

[rushatgabhane]

Looks great!

[Kicu]

@luacmartins please take a look

[luacmartins]

LGTM Thanks for working on this!

[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.

[github-actions]

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

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

[github-actions]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.42-3 🚀

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