[Search v1] Implement policy filter #41769

WojtekBoman · 2024-05-07T14:51:08Z

Details

This PR adds switching between workspaces on the SearchPage.

Fixed Issues

$ #41618
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Log in to New Expensify.
Open the Account Settings.
Go to the Troubleshoot section.
Open the Search Page.
Verify whether the workspace switcher works properly on the Search Page:

Check if deeplinks to the search page with the policyID in the url work fine
Check in the Network tab in the browser if requests have in their params policyID
Check if the icon of the workspace switcher matches with the selected workspace.

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: mWeb Chrome

Screen.Recording.2024-05-08.at.15.50.45.mov

iOS: Native

Screen.Recording.2024-05-08.at.15.13.09.mov

iOS: mWeb Safari

Screen.Recording.2024-05-08.at.15.14.39.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-08.at.15.29.54.mov

MacOS: Desktop

Screen.Recording.2024-05-08.at.15.28.51.mov

Kicu

Left some small comments, the navigation logic is getting pretty complex and hacky IMO :/ but I don't have enough knowledge (yet) to help simplify it.

Kicu · 2024-05-09T07:00:06Z

src/libs/SearchUtils.ts

-function getQueryHash(query: string): number {
- return UserUtils.hashText(query, 2 ** 32);
+function getQueryHash(query: string, policyID?: string): number {
+ const textToHash = policyID ? `${query}_${policyID}` : query;


you can write this as:
const textToHash = [query, policyID].filter(Boolean).join('_');

no conditional logic + whenever we add 3rd or 4th parameter (I believe we will add more params like page or sortBy, right?) it will be easy to expand to more phrases.

Kicu · 2024-05-09T07:04:52Z

src/libs/Navigation/switchPolicyID.ts

@@ -93,8 +102,10 @@ export default function switchPolicyID(navigation: NavigationContainerRef<RootSt
 return;
 }

+ const shouldPushCentralPane = !getIsNarrowLayout() || shouldOpenSearchPage;


I find it hard to understand what does "push" mean in this context. If you think this is obvious to people working with navigation then feel free to leave as is.
If not then perhaps some other name or a comment?

Kicu · 2024-05-09T07:07:10Z

src/libs/actions/Search.ts

- const hash = SearchUtils.getQueryHash(query);
- API.read(READ_COMMANDS.SEARCH, {query, hash});
+function search(query: string, policyID?: string) {
+ const hash = SearchUtils.getQueryHash(query, policyID);


I suggest we only compute hash in the search component and pass it here along with the other arguments.
Feels unnecessary to count hash twice, and it will make this function super simple.

Kicu

LGTM, we have agreed on some naming and comment changes but approving this

melvin-bot · 2024-05-09T14:08:56Z

@ahmedGaber93 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 · 2024-05-09T19:25:39Z

src/libs/Navigation/switchPolicyID.ts

- // Case when the user is on the AllSettingsScreen and selects the specific workspace. The user is redirected then to the specific workspace settings.
- if (screen === SCREENS.ALL_SETTINGS && policyID) {
- screen = SCREENS.WORKSPACE.INITIAL;
- }
-
- // Alternative case when the user is on the specific workspace settings screen and selects "All" workspace.
- else if (!policyID && screen === SCREENS.WORKSPACE.INITIAL) {
- screen = SCREENS.ALL_SETTINGS;


Why did we remove this?

luacmartins · 2024-05-09T19:26:35Z

src/libs/Navigation/switchPolicyID.ts

+
+ // Currently, the search page displayed in the bottom tab has the same URL as the page in the central pane, so we need to redirect to the correct search route.
+ // Here's the configuration: src/libs/Navigation/AppNavigator/createCustomStackNavigator/index.tsx
+ const isOpeningSearchFromBottomTab = newPath.startsWith(CONST.SEARCH_BOTTOM_TAB_URL);


Can we use the screen name instead of creating a new const for it?

luacmartins · 2024-05-09T19:30:07Z

src/libs/Navigation/switchPolicyID.ts

- if (!getIsNarrowLayout()) {
- // Case when the user selects "All" workspace from the specific workspace settings
- if (checkIfActionPayloadNameIsEqual(actionForBottomTabNavigator, SCREENS.ALL_SETTINGS) && !policyID) {
- root.dispatch({
- type: CONST.NAVIGATION.ACTION_TYPE.PUSH,
- payload: {
- name: NAVIGATORS.CENTRAL_PANE_NAVIGATOR,
- params: {
- screen: SCREENS.SETTINGS.WORKSPACES,
- params: undefined,
- },
- },
- });
- } else {
- const topmostCentralPaneRoute = getTopmostCentralPaneRoute(rootState);
- const screen = topmostCentralPaneRoute?.name;
- const params: CentralPaneRouteParams = {...topmostCentralPaneRoute?.params};
- const isWorkspaceScreen = screen && Object.values(SCREENS.WORKSPACE).includes(screen as ValueOf<typeof SCREENS.WORKSPACE>);
-
- // Only workspace settings screens have to store the policyID in the params.
- // In other case, the policyID is read from the BottomTab params.
- if (!isWorkspaceScreen) {
- delete params.policyID;
- } else {
- params.policyID = policyID;
- }
-
- // If the user is on the home page and changes the current workspace, then should be displayed a report from the selected workspace.
- // To achieve that, it's necessary to navigate without the reportID param.
- if (checkIfActionPayloadNameIsEqual(actionForBottomTabNavigator, SCREENS.HOME)) {
- delete params.reportID;
- }
-
- root.dispatch({
- type: CONST.NAVIGATION.ACTION_TYPE.PUSH,
- payload: {
- name: NAVIGATORS.CENTRAL_PANE_NAVIGATOR,
- params: {
- screen,
- params,
- },
- },
- });


I'm not sure that I understand this diff. Would you mind explaining why we can replace this code?

This code is related to the pages that have been already refactored. Previously Workspace Switcher was available on Account Settings and Workspace Initial Page pages, we don't need this anymore since these pages don't display WS :)

luacmartins · 2024-05-09T19:37:50Z

src/libs/API/parameters/Search.ts

@@ -1,5 +1,6 @@
 type SearchParams = {
 query: string;
+ policyID?: string;


We're actually using policyIDs, string containing a comma separated list of policyIDs since in the future users will be able to search for results with search syntax instead of just using the workspace switcher, e.g. type:transaction to:<policy>

I have a question regarding this change. In the design doc we have an url for this page in the format: route: search/:query/:sortBy/:order/:policyID, example: search/all/date/asc/1 and I'm wondering whether storing these filters in route params would be more readable for users: search/all?sortBy=date&order=asc&policyIDs=1. It's also easier to implement optional params in this format. In the situation when we don't have any filters and we select a policy, we have to add also other params to the url which are before the policyID. WDYT?
cc: @adamgrzybowski @Kicu

Yea, I think that makes sense. Would we want to implement those changes in this PR or in a follow up?

ahmedGaber93 · 2024-05-09T20:34:30Z

Bug: switch workspace call search API 3 times.

issue1.mp4

luacmartins · 2024-05-09T20:39:19Z

Ah yea, I noticed that too but forgot to post about it. The first call seems to have no policyIDs param, while the next ones do. We should fix that.

ahmedGaber93 · 2024-05-09T20:40:45Z

I am not sure if this bug or not implemented yet.
Bug: switch workspace not filtering the data, it always displays the whole data without filtering.

20240509233624846.mp4

ahmedGaber93 · 2024-05-09T21:27:54Z

Check if deeplinks to the search page with the policyID in the url work fine

Work fine in web, but not work in iOS native.

20240510002633146.mp4

luacmartins

Looking good. We still need to address the multiple API calls and the deeplink issue

ahmedGaber93 · 2024-05-13T11:40:10Z

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

a.mp4

Android: mWeb Chrome

aw.mp4

iOS: Native

i.mp4

iOS: mWeb Safari

iw.mp4

MacOS: Chrome / Safari

w.mp4

MacOS: Desktop

d.mp4

ahmedGaber93 · 2024-05-13T23:21:23Z

Looks good to me, but we still need to fix this #41769 (review) and clean this #41769 (comment)

luacmartins · 2024-05-14T22:36:04Z

@WojtekBoman I'm gonna go ahead and merge this one since it'll reduce conflicts in the next PRs, but can you please work on this follow up? #42177

OSBotify · 2024-05-14T22:43:50Z

✋ 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-05-15T10:14:29Z

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

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

OSBotify · 2024-05-22T23:59:30Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

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

Handle passing policyID to SearchPage

5bc7f2a

luacmartins self-requested a review May 7, 2024 15:52

WojtekBoman added 3 commits May 8, 2024 12:05

Add policyID to url when SearchPage is displayed

ad29ae5

Adjust customGetPathFromState to SearchPage

9adee7b

Prevent from sending unnecessary requests

aa503df

Kicu suggested changes May 9, 2024

View reviewed changes

WojtekBoman added 3 commits May 9, 2024 11:46

Refactor getQueryHash

9ba01ac

Refactor SearchActions.search method

94580cc

Add comment for shouldPushCentralPane variable

d0a724e

Kicu approved these changes May 9, 2024

View reviewed changes

Refactor switchPolicyID

194a44c

WojtekBoman marked this pull request as ready for review May 9, 2024 14:08

WojtekBoman requested a review from a team as a code owner May 9, 2024 14:08

melvin-bot bot requested review from ahmedGaber93 and removed request for a team May 9, 2024 14:08

luacmartins requested changes May 9, 2024

View reviewed changes

luacmartins self-requested a review May 10, 2024 17:48

luacmartins requested changes May 10, 2024

View reviewed changes

WojtekBoman added 2 commits May 13, 2024 11:34

Merge branch 'main' into search-v1-p2/policy-filter

71204e2

Rename policyID to policyIDs in Search

36edddc

luacmartins approved these changes May 13, 2024

View reviewed changes

luacmartins mentioned this pull request May 14, 2024

[HOLD for payment 2024-06-06] [$250] [Search v1] Remove multiple API calls and clean up const #42177

Closed

luacmartins merged commit 1280049 into Expensify:main May 14, 2024
17 checks passed

github-actions bot mentioned this pull request May 15, 2024

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

iwiznia mentioned this pull request May 15, 2024

Workspace switcher - Workspace icon is displayed when Expensify filter is selected #42190

Closed

6 tasks

ahmedGaber93 mentioned this pull request May 19, 2024

[Search v1] Remove multiple API calls and clean up const #42335

Merged

51 tasks

luacmartins mentioned this pull request May 29, 2024

[HOLD for payment 2024-05-29][Search v1] Implement policy filter #41618

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search v1] Implement policy filter #41769

[Search v1] Implement policy filter #41769

WojtekBoman commented May 7, 2024 •

edited

Loading

Kicu left a comment

Kicu May 9, 2024

Kicu May 9, 2024

Kicu May 9, 2024

Kicu left a comment

melvin-bot bot commented May 9, 2024

luacmartins May 9, 2024

luacmartins May 9, 2024

luacmartins May 9, 2024

WojtekBoman May 10, 2024

luacmartins May 9, 2024

WojtekBoman May 13, 2024 •

edited

Loading

luacmartins May 13, 2024

ahmedGaber93 commented May 9, 2024

luacmartins commented May 9, 2024 •

edited

Loading

ahmedGaber93 commented May 9, 2024

ahmedGaber93 commented May 9, 2024

luacmartins left a comment

ahmedGaber93 commented May 13, 2024 •

edited

Loading

ahmedGaber93 commented May 13, 2024

luacmartins commented May 14, 2024

OSBotify commented May 14, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

[Search v1] Implement policy filter #41769

[Search v1] Implement policy filter #41769

Conversation

WojtekBoman commented May 7, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kicu left a comment

Choose a reason for hiding this comment

melvin-bot bot commented May 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WojtekBoman May 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmedGaber93 commented May 9, 2024

luacmartins commented May 9, 2024 • edited Loading

ahmedGaber93 commented May 9, 2024

ahmedGaber93 commented May 9, 2024

luacmartins left a comment

Choose a reason for hiding this comment

ahmedGaber93 commented May 13, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ahmedGaber93 commented May 13, 2024

luacmartins commented May 14, 2024

OSBotify commented May 14, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

WojtekBoman commented May 7, 2024 •

edited

Loading

WojtekBoman May 13, 2024 •

edited

Loading

luacmartins commented May 9, 2024 •

edited

Loading

ahmedGaber93 commented May 13, 2024 •

edited

Loading