[Search v1] Implement Search navigation logic #40280

WojtekBoman · 2024-04-16T10:14:21Z

Details

This PR introduces changes in navigation logic connected with a new search tab. The src/libs/Navigation/AppNavigator/createCustomStackNavigator/index.tsx file has been modified to share one url between two pages (SearchPageBottomTab and SearchPage display the same url).

Fixed Issues

$ #40245
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Open the Account Settings tab.
Go to the Troubleshoot screen.
Scroll to the bottom of the screen and navigate to the Search page.
Verify that:

the page is displayed correctly
the url is the same on small and wide screen
the url is changed when filters are switched
deeplinks to this page works correctly

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-04-17.at.18.38.56.mov

Android: mWeb Chrome

Screen.Recording.2024-04-17.at.18.42.13.mov

iOS: Native

Screen.Recording.2024-04-17.at.18.54.25.mov

iOS: mWeb Safari

Screen.Recording.2024-04-17.at.18.55.25.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-17.at.18.37.46.mov

MacOS: Desktop

Screen.Recording.2024-04-17.at.18.45.18.mov

New search tab poc

…b v2

luacmartins · 2024-04-17T15:28:44Z

@WojtekBoman what's the status on this PR? When do you think you'll be able to get it in review?

adamgrzybowski · 2024-04-17T15:49:04Z

src/ROUTES.ts

    // This is a utility route used to go to the user's concierge chat, or the sign-in page if the user's not authenticated
    CONCIERGE: 'concierge',
    FLAG_COMMENT: {
        route: 'flag/:reportID/:reportActionID',
        getRoute: (reportID: string, reportActionID: string) => `flag/${reportID}/${reportActionID}` as const,
    },
-    SEARCH: 'search',


I guess this will be changed after resolving the conflicts

adamgrzybowski · 2024-04-17T15:50:23Z

src/components/TabSelector/TabSelector.tsx

@@ -33,6 +33,16 @@ function getIconAndTitle(route: string, translate: LocaleContextProps['translate
            return {icon: Expensicons.Hashtag, title: translate('tabSelector.room')};
        case CONST.TAB_REQUEST.DISTANCE:
            return {icon: Expensicons.Car, title: translate('common.distance')};
+        case CONST.TAB_SEARCH.ALL:


This was only for the POC with onyxTab I assume

adamgrzybowski · 2024-04-17T16:04:54Z

src/pages/Search/SearchPage.tsx

+    useCustomBackHandler();
+
+    return (
+        <ScreenWrapper testID="testPage">


Please updatetestID to the proper one

adamgrzybowski · 2024-04-17T16:05:52Z

src/pages/Search/SearchPageBottomTab.tsx

+    );
+}
+
+SearchPageBottomTab.displayName = 'SearchPage';


Please update name here as well

melvin-bot · 2024-04-17T16:56:51Z

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

WojtekBoman · 2024-04-17T16:57:06Z

@WojtekBoman what's the status on this PR? When do you think you'll be able to get it in review?

It's ready for review :)

luacmartins · 2024-04-17T21:02:43Z

Nice one! I asked C+ for an expedited review.

luacmartins

@WojtekBoman just to confirm, on small screens I should only see the filters for now, right? We'll style the filters differently for small screens and also render the search results as part of a separate PR?

Screen.Recording.2024-04-17.at.3.22.41.PM.mov

luacmartins · 2024-04-17T21:18:27Z

src/pages/Search/SearchResults.tsx

+    query: string;
+};
+
+function SearchResults({query}: SearchResultsProps) {


This component should be called just Search

src/pages/Search/SearchPageBottomTab.tsx

WojtekBoman · 2024-04-18T07:04:55Z

@WojtekBoman just to confirm, on small screens I should only see the filters for now, right? We'll style the filters differently for small screens and also render the search results as part of a separate PR?

Screen.Recording.2024-04-17.at.3.22.41.PM.mov

Yes, the content of this page will be added in separate PR :)

rushatgabhane · 2024-04-18T14:52:32Z

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

Screen.Recording.2024-04-18.at.20.39.21.mov

iOS: Native

Screen.Recording.2024-04-18.at.20.48.10.mov

iOS: mWeb Safari

Screen.Recording.2024-04-18.at.20.38.00.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-18.at.20.29.05.mov

MacOS: Desktop

Screen.Recording.2024-04-18.at.20.50.30.mov

OSBotify · 2024-04-23T23:43:28Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.64-6 🚀

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

s77rt · 2024-05-08T04:06:12Z

src/libs/Navigation/linkTo.ts

+        const isTargetScreenDifferentThanCurrent = Boolean(topmostCentralPaneRoute && topmostCentralPaneRoute.name !== action.payload.params?.screen);
+        const areParamsDifferent = !shallowCompare(topmostCentralPaneRoute?.params, action.payload.params?.params);
+


Is there a specific case this is fixing? This is causing #41198

This change has been introduced to handle changing filters on the new SearchPage, on this page we can navigate to the same page with a different value of the query param, so that's why we added it. To me, we should create a custom method to compare params. Report ids should be compared as before but in other cases we can use shallowCompare.
WDYT?

Makes sense! Thanks for the context!

eh2077 · 2024-05-14T23:00:39Z

src/libs/Navigation/linkTo.ts

@@ -152,16 +152,15 @@ export default function linkTo(navigation: NavigationContainerRef<RootStackParam
        const topRouteName = rootState?.routes?.at(-1)?.name;
        const isTargetNavigatorOnTop = topRouteName === action.payload.name;

+        const isTargetScreenDifferentThanCurrent = Boolean(topmostCentralPaneRoute && topmostCentralPaneRoute.name !== action.payload.params?.screen);
+        const areParamsDifferent = !shallowCompare(topmostCentralPaneRoute?.params, action.payload.params?.params);


This also caused #40743

The fix for that has been already merged. Could you check if it still occurs in dev environment?

ikevin127 · 2024-06-27T22:22:15Z

src/pages/Search/SearchPage.tsx

+    useCustomBackHandler();
+
+    return (
+        <ScreenWrapper testID={SearchPage.displayName}>


When this page was created, the offline pattern was omitted which led to this issue:

[HOLD for payment 2024-06-28] [$250] Search - Missing offline indicator on web, offline indicator appears below card on mobile #43556

adamgrzybowski and others added 17 commits April 5, 2024 06:41

migrate search page to find page v1

c96e516

add new search tab

1e5150b

Add search page template components

eef26cc

Add new search pages

3c74507

remove native.tsx for createCustomStackNavigator

a707c28

add check for search page in getAdaptedStateFromPath

3afd0b9

Handle passing params to useActiveRoute

2206c1d

Merge branch 'new-search-tab' into new-search-tab-poc

e7de7ea

Merge pull request #85 from software-mansion-labs/new-search-tab-poc

b9d88d9

New search tab poc

Adjust getAdaptedStateFromPath to new search routes

a1b228a

fix linnkTo

a72d221

remove waitForNavigation and OnyxTabNavigator from SearchPageBottomTab

633d881

remove waitForNavigation and OnyxTabNavigator from SearchPageBottomTa…

2d78c11

…b v2

add customBackHandler

b57d456

remove unused imports

2fcae18

Merge branch 'main' into new-search-tab

18ed94f

Add a tooltip for the search icon in the bottom tab

1de5ce3

WojtekBoman force-pushed the search-v1/nav-logic branch from 1997168 to 1de5ce3 Compare April 16, 2024 11:06

WojtekBoman and others added 5 commits April 16, 2024 15:38

Add SEARCH_QUERIES consts, hide new features

f84911b

Remove SEARCH_QUERIES const

8ea25e3

Remove test page

5ea4a9f

add comment for useCustomBackHandler

2e38d66

Exclude shallowCompare function

f724761

WojtekBoman changed the title ~~Search v1/nav logic~~ [Search v1] Implement Search navigation logic Apr 17, 2024

luacmartins self-requested a review April 17, 2024 15:28

Merge branch 'main' into search-v1/nav-logic

f28c388

adamgrzybowski reviewed Apr 17, 2024

View reviewed changes

Remove redundant const

1b33065

adamgrzybowski reviewed Apr 17, 2024

View reviewed changes

WojtekBoman added 3 commits April 17, 2024 18:08

Refactor search pages

3cb9dbe

Remove unused code

faf9a69

Remove unused code

87a4076

WojtekBoman marked this pull request as ready for review April 17, 2024 16:56

WojtekBoman requested a review from a team as a code owner April 17, 2024 16:56

melvin-bot bot requested review from sobitneupane and removed request for a team April 17, 2024 16:56

luacmartins requested review from rushatgabhane and removed request for sobitneupane April 17, 2024 21:12

luacmartins requested changes Apr 17, 2024

View reviewed changes

Handle displaying FAB on the new search page

3b7a83d

rushatgabhane approved these changes Apr 18, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins April 18, 2024 15:20

luacmartins approved these changes Apr 18, 2024

View reviewed changes

luacmartins merged commit 13a01fb into Expensify:main Apr 18, 2024
16 checks passed

github-actions bot mentioned this pull request Apr 22, 2024

Deploy Checklist: New Expensify 2024-04-22 #40702

Closed

95 tasks

eh2077 mentioned this pull request Apr 24, 2024

[$500] Chat - When navigating to chat via URL, user has to tap on back arrow twice to return to LHN #40743

Closed

6 tasks

bernhardoj mentioned this pull request Apr 29, 2024

[Awaiting Payment 30th May] [Search v1] Chat - "From" link in IOU report details page navigates to the main chat twice #41198

Closed

6 tasks

s77rt reviewed May 8, 2024

View reviewed changes

eh2077 reviewed May 14, 2024

View reviewed changes

ikevin127 reviewed Jun 27, 2024

View reviewed changes

ikevin127 mentioned this pull request Jun 27, 2024

[HOLD for payment 2024-06-28] [$250] Search - Missing offline indicator on web, offline indicator appears below card on mobile #43556

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search v1] Implement Search navigation logic #40280

[Search v1] Implement Search navigation logic #40280

WojtekBoman commented Apr 16, 2024 •

edited

Loading

luacmartins commented Apr 17, 2024

adamgrzybowski Apr 17, 2024

adamgrzybowski Apr 17, 2024

adamgrzybowski Apr 17, 2024

adamgrzybowski Apr 17, 2024

melvin-bot bot commented Apr 17, 2024

WojtekBoman commented Apr 17, 2024

luacmartins commented Apr 17, 2024

luacmartins left a comment

luacmartins Apr 17, 2024

WojtekBoman commented Apr 18, 2024

rushatgabhane commented Apr 18, 2024 •

edited

Loading

OSBotify commented Apr 23, 2024

s77rt May 8, 2024

WojtekBoman May 8, 2024

s77rt May 9, 2024

eh2077 May 14, 2024

WojtekBoman May 15, 2024

ikevin127 Jun 27, 2024

		const isTargetScreenDifferentThanCurrent = Boolean(topmostCentralPaneRoute && topmostCentralPaneRoute.name !== action.payload.params?.screen);
		const areParamsDifferent = !shallowCompare(topmostCentralPaneRoute?.params, action.payload.params?.params);

[Search v1] Implement Search navigation logic #40280

[Search v1] Implement Search navigation logic #40280

Conversation

WojtekBoman commented Apr 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

luacmartins commented Apr 17, 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

melvin-bot bot commented Apr 17, 2024

WojtekBoman commented Apr 17, 2024

luacmartins commented Apr 17, 2024

luacmartins left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WojtekBoman commented Apr 18, 2024

rushatgabhane commented Apr 18, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Apr 23, 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

Choose a reason for hiding this comment

WojtekBoman commented Apr 16, 2024 •

edited

Loading

rushatgabhane commented Apr 18, 2024 •

edited

Loading