Add new SearchButton to all pages and tweak SearchRouter #49379

Kicu · 2024-09-18T11:04:21Z

Details

This PR both implements issue xxx and also introduces some followups after merging SearchRouter (Add SearchRouter component and context to display it #48785)
SearchButton is added to almost every page (as listed in the design doc)
there is one exception: rooms list on mobile - because we still have the ChatFinder there, so this time I'm avoiding two search icons; ChatFinder will be removed in a separate issue
I had to add 1 prop to SelectionList to pass it to useKeyboardShortcut hook, since you can trigger search from router via Enter key, but useKeyboardShortcut consumed the ENTER keypress event

misc notes:

[tweaks] standardised naming of some SearchUtils functions; dropped one function that was only used in once place
WorkspacesListPage and TroubleShootPage were migrated to useOnyx in compliance with new CI check

Fixed Issues

$ #49122
$ #49118
PROPOSAL:

Tests

verify that the button to trigger new search is displayed on every page
verify that clicking the button opens new search router
verify that search router works - it should navigate to search with specific query

Offline tests

QA Steps

verify that the button to trigger new search is displayed on every page
verify that clicking the button opens new search router
verify that search router works - it should navigate to search with specific query

PR Author Checklist

Screenshots/Videos

Android: Native

rec-andr-searchb.mp4

Android: mWeb Chrome

iOS: Native

rec-ios-searchb.mp4

iOS: mWeb Safari

https://github.com/user-attachments/assets/e9eb66ff-03af-4fde-a497-8770b7c6dff5

MacOS: Chrome / Safari

rec-web-searchb.mp4

MacOS: Desktop

Kicu · 2024-09-20T13:43:09Z

src/libs/SearchUtils.ts

@@ -407,6 +397,20 @@ function getQueryHashFromString(query: SearchQueryString): number {
    return UserUtils.hashText(query, 2 ** 32);
 }

+function getExpenseTypeTranslationKey(expenseType: ValueOf<typeof CONST.SEARCH.TRANSACTION_TYPE>): TranslationPaths {


Kicu · 2024-09-20T13:43:20Z

src/libs/SearchUtils.ts

+ * @private
+ * traverses the AST and returns filters as a QueryFilters object
+ */
+function getFilters(queryJSON: SearchQueryJSON) {


melvin-bot · 2024-09-20T13:43:47Z

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

Kicu · 2024-09-20T13:44:12Z

@luacmartins originally I planned for this PR to be something else, but now the scope changed a bit.
Ready for review

I'll check why reassure tests fail on Monday

ikevin127 · 2024-09-21T00:21:07Z

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

Uploading android-mweb.mov…

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ikevin127 · 2024-09-21T00:21:12Z

Note

Observations

Missing 🔍 in Settings > Subscription page (probably on purpose ?).
When search input was performed and user is navigated to search page with specific query > 🔍 is missing from Filters button right side on wide layout devices (web / desktop).
(already present on staging) When search input was performed and user is navigated to search page with specific query > LHN Expenses menu item is not highlighted.

Please confirm whether all of the above are expected.
Once addressed and the reassure tests are fixed, I'll be able to 🟢 Approve.

luacmartins · 2024-09-23T00:12:19Z

Missing 🔍 in Settings > Subscription page (probably on purpose ?).

I think it should be present there too.

When search input was performed and user is navigated to search page with specific query > 🔍 is missing from Filters button right side on wide layout devices (web / desktop).

I think this one is expected for now, since those pages will have a full width search bar instead of the magnifying glass icon

(already present on staging) When search input was performed and user is navigated to search page with specific query > LHN Expenses menu item is not highlighted.

This is expected since at that point the user is seeing a custom search

luacmartins · 2024-09-23T00:13:25Z

@Expensify/design should the magnifying glass icon be to the left or right of existing header buttons? example:

src/components/HeaderWithBackButton/types.ts

dubielzyk-expensify · 2024-09-23T05:26:07Z

@Expensify/design should the magnifying glass icon be to the left or right of existing header buttons? example:

Great question. I think we'll always want it on the right to ensure the router stays consistently in the top right corner when it opens.

Kicu · 2024-09-23T11:15:32Z

I think we'll always want it on the right to ensure the router stays consistently in the top right corner when it opens.

Yeah I made a similar assumption and I'm always putting it furthest to the right on all the views.

Kicu · 2024-09-23T11:20:25Z

@ikevin127 @luacmartins icon added to Subscription page

As for the other two like Carlos said they are expected. LHN items are only highglighted when you are on the exact query that the buttons link to, so type:Expenses status:all etc.

There is a separate PR to add full width input to Search Results page, and that is why we don't need 🔍 there. (See #49462)

ikevin127

🟢 This is looking good, I just verified that the search button was added to the Subscription page.

@Kicu ⚠️ The only thing left to do here is address the failing performance tests, which from what I can see the issue might come from the permissions check in SearchButton which does not seem to be mocked given the error message of the failing performance test:

● [ReportScreen] should render report list

    TypeError: _Permissions.default.canUseNewSearchRouter is not a function

      15 |     const {openSearchRouter} = useSearchRouterContext();
      16 |
    > 17 |     if (!Permissions.canUseNewSearchRouter()) {
         |                      ^
      18 |         return;
      19 |     }
      20 |

luacmartins

LGTM

luacmartins · 2024-09-24T01:04:00Z

Unrelated jest tests are failing on main too. Gonna wait for a fix before we merge this PR.

Kicu · 2024-09-24T07:42:03Z

Main merged and the missing mock in perf tests fixed, thanks for pointing this out @ikevin127

Now the Changed files ESLint check is failing, but we can ignore this one. It fails on the deprecation of measurePerformance (because I touched *.perf-test file) which is not something we are concerned with right now.

If nothing else fails then I think we're good to go.

luacmartins · 2024-09-24T07:45:11Z

Failing tests are unrelated to the changes in this PR, merging.

melvin-bot · 2024-09-24T07:45:30Z

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2024-09-24T07:56:03Z

✋ 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-09-24T19:30:11Z

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

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

github-actions · 2024-09-27T17:45:06Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.40-6 🚀

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

rayane-djouah · 2024-10-28T19:00:27Z

FYI, We should remove the magnifying glass button from the report header when the report is opened in the RHP. Issue: #50963

rayane-djouah · 2024-10-28T19:13:01Z

src/pages/AddressPage.tsx

@@ -85,6 +85,7 @@ function AddressPage({title, address, updateAddress, isLoadingApp = true, backTo
                title={title}
                shouldShowBackButton
                onBackButtonPress={() => Navigation.goBack(backTo)}
+                shouldDisplaySearchRouter


FYI, This caused this issue: #51009

rayane-djouah · 2024-10-28T19:14:45Z

src/components/HeaderWithBackButton/index.tsx

@@ -261,6 +263,7 @@ function HeaderWithBackButton({
                            </PressableWithoutFeedback>
                        </Tooltip>
                    )}
+                    {shouldDisplaySearchRouter && <SearchButton />}


FYI, This caused this issue: #51077

Kicu force-pushed the kicu/search-router-query branch from c5ca3b4 to 584ac31 Compare September 19, 2024 15:00

luacmartins self-requested a review September 19, 2024 23:44

Kicu added 5 commits September 20, 2024 11:03

Prefill Search Router with existing Search query

a8236c7

Stop merging user query with Search query after prefill

c2cb908

Cleanup display SearchButton component on all Pages

d11bfe1

Fix SearchRouter submit not working on Search Page

0df5b82

Drop usage of withOnyx on modified pages

6cdeaae

Kicu force-pushed the kicu/search-router-query branch from bbc400e to 6cdeaae Compare September 20, 2024 09:35

Add updates to Search Button positioning

83fab84

Kicu force-pushed the kicu/search-router-query branch from 3825dfe to 83fab84 Compare September 20, 2024 13:04

Kicu changed the title ~~WIP prefill Search Router with existing Search query~~ Add new SearchButton to all pages and tweak SearchRouter Sep 20, 2024

Kicu commented Sep 20, 2024

View reviewed changes

Kicu marked this pull request as ready for review September 20, 2024 13:43

Kicu requested a review from a team as a code owner September 20, 2024 13:43

melvin-bot bot requested review from ikevin127 and removed request for a team September 20, 2024 13:43

luacmartins reviewed Sep 23, 2024

View reviewed changes

src/components/HeaderWithBackButton/types.ts Outdated Show resolved Hide resolved

Kicu added 2 commits September 23, 2024 13:20

Add updates after code review

37888d7

Merge branch 'main' into kicu/search-router-query

c393603

ikevin127 approved these changes Sep 23, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins September 23, 2024 21:41

luacmartins previously approved these changes Sep 24, 2024

View reviewed changes

Kicu added 2 commits September 24, 2024 09:24

Fix missing mock in perf tests

81bf90c

Merge branch 'main' into kicu/search-router-query

0f58dd9

Kicu dismissed luacmartins’s stale review via 0f58dd9 September 24, 2024 07:24

luacmartins approved these changes Sep 24, 2024

View reviewed changes

luacmartins merged commit 2ea2b15 into Expensify:main Sep 24, 2024
16 of 17 checks passed

melvin-bot bot added the Emergency label Sep 24, 2024

luacmartins removed the Emergency label Sep 24, 2024

github-actions bot mentioned this pull request Sep 24, 2024

Deploy Checklist: New Expensify 2024-09-24 #49662

Closed

67 tasks

lanitochka17 mentioned this pull request Sep 26, 2024

Search-New SearchButton has not been added #49785

Closed

6 tasks

luacmartins mentioned this pull request Sep 27, 2024

[HOLD for Payment 2024-10-04] [$250] [Search v2.4] [App] Introduce <SearchRouter> component #49118

Closed

rayane-djouah mentioned this pull request Oct 17, 2024

[HOLD for payment 2024-11-01] [$250] Book travel - Search icon is present on Company address RHP #51009

Closed

8 tasks

rayane-djouah mentioned this pull request Oct 28, 2024

[$250] [HOLD for payment 2024-10-29] [Search v2.4] Remove search router button from the RHP report screen #50963

Closed

rayane-djouah reviewed Oct 28, 2024

View reviewed changes

rayane-djouah mentioned this pull request Oct 28, 2024

[$250] [HOLD for payment 2024-11-01] Search - Down caret icon and search icon are close to each other #51077

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new SearchButton to all pages and tweak SearchRouter #49379

Add new SearchButton to all pages and tweak SearchRouter #49379

Kicu commented Sep 18, 2024 •

edited

Loading

Kicu Sep 20, 2024

Kicu Sep 20, 2024

melvin-bot bot commented Sep 20, 2024

Kicu commented Sep 20, 2024 •

edited

Loading

ikevin127 commented Sep 21, 2024

ikevin127 commented Sep 21, 2024

Observations

luacmartins commented Sep 23, 2024

luacmartins commented Sep 23, 2024

dubielzyk-expensify commented Sep 23, 2024

Kicu commented Sep 23, 2024

Kicu commented Sep 23, 2024

ikevin127 left a comment

luacmartins left a comment

luacmartins commented Sep 24, 2024 •

edited

Loading

Kicu commented Sep 24, 2024 •

edited

Loading

luacmartins commented Sep 24, 2024

melvin-bot bot commented Sep 24, 2024

OSBotify commented Sep 24, 2024

OSBotify commented Sep 24, 2024

github-actions bot commented Sep 27, 2024

rayane-djouah commented Oct 28, 2024

rayane-djouah Oct 28, 2024

rayane-djouah Oct 28, 2024

Add new SearchButton to all pages and tweak SearchRouter #49379

Add new SearchButton to all pages and tweak SearchRouter #49379

Conversation

Kicu commented Sep 18, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu Sep 20, 2024

Choose a reason for hiding this comment

Kicu Sep 20, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Sep 20, 2024

Kicu commented Sep 20, 2024 • edited Loading

ikevin127 commented Sep 21, 2024

Reviewer Checklist

Screenshots/Videos

ikevin127 commented Sep 21, 2024

Observations

luacmartins commented Sep 23, 2024

luacmartins commented Sep 23, 2024

dubielzyk-expensify commented Sep 23, 2024

Kicu commented Sep 23, 2024

Kicu commented Sep 23, 2024

ikevin127 left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Sep 24, 2024 • edited Loading

Kicu commented Sep 24, 2024 • edited Loading

luacmartins commented Sep 24, 2024

melvin-bot bot commented Sep 24, 2024

OSBotify commented Sep 24, 2024

OSBotify commented Sep 24, 2024

github-actions bot commented Sep 27, 2024

rayane-djouah commented Oct 28, 2024

rayane-djouah Oct 28, 2024

Choose a reason for hiding this comment

rayane-djouah Oct 28, 2024

Choose a reason for hiding this comment

Kicu commented Sep 18, 2024 •

edited

Loading

Kicu commented Sep 20, 2024 •

edited

Loading

luacmartins commented Sep 24, 2024 •

edited

Loading

Kicu commented Sep 24, 2024 •

edited

Loading