Search router polish #50921

SzymczakJ · 2024-10-16T16:02:58Z

Details

This PR fixes following issues:

Searching with filters that match a saved search should open the saved search in the LHN

Fixed Issues

$ #50250
$ #50977
$ #50993
$ #50998
PROPOSAL:

Tests

As for [Search v2.4] Search Router Polish Issues #50250:
Create a search from advanced filters site and save it.(you have to use a newly created one because only then you will have saved query hash created with new method)
Reset search, create the same search from advanced filters and apply it.
Make sure that it is recognised as saved search and corresponding saved search tab is highlighted.
Reset search, go on settings or chats page and open Search Router
Write the same query manually, accept it and make sure it is recognised as saved search and corresponding saved search tab is highlighted.
As for [HOLD for payment 2024-10-29] [$250] Search - No tooltip when hovering over the search icon #50977: Make sure the tooltip is popping up when hovering over Search magnifying glass icon(on every page that has it)
As for [HOLD for payment 2024-10-29] Attachment - Extra space between download and close button #50993: Make sure gap between search button and all other touchable elements is 8px:

As for [HOLD for payment 2024-10-29] Search - Contacts with no chat history are also categorized under "Recent chats" #50998: Have fairly new account (with under 10 recent chats)
Make sure that only those recent chats are shown in "recent chats" section of Search Router when nothing is typed in Search input(when something is typed in, then we also add contacts).

Offline tests

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android.web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

iosweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

…earching from searchRouter

…input

SzymczakJ · 2024-10-17T16:50:28Z

FYI I'll prepare videos as first thing in the morning

SzymczakJ · 2024-10-17T21:54:10Z

Actually managed to do this today @luacmartins 😄 Maybe we'll manage to merge it today, if @rayane-djouah is still up.

luacmartins · 2024-10-17T21:55:13Z

Is the PR ready for review?

melvin-bot · 2024-10-17T21:55:27Z

@rayane-djouah 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

Found some small tweaks, please take a look

Kicu · 2024-10-18T06:20:49Z

src/components/Search/SearchRouter/SearchRouter.tsx

-        if (currentSearchOptions.userToInvite) {
-            reports.push(currentSearchOptions.userToInvite);
+        if (debouncedInputValue === '') {
+            return searchOptions.recentReports.slice(0, 10);


I'm curious if that doesn't change previous logic.

Originally we had debouncedInputValue === '' ? searchOptions - so it meant that if the input is empty, we push in the searchOptions (so I guess contextual search?).

But now we only show recent reports? Is that the change we want?

Contextual search is added independently earlier in the code. This block of code was only responsible for adding recent chats section(which consisted of recentReports, personalDetails and userToInvite). Right now in case when text input is empty, we are limiting the recent chats section to only recentReports.

Kicu · 2024-10-18T06:22:13Z

src/libs/SearchUtils.ts

+    orderedQuery += `type ${query.type} `;
+    orderedQuery += ` status ${query.status}`;
+    orderedQuery += ` sortBy ${query.sortBy} `;
+    orderedQuery += ` sortOrder ${query.sortOrder} `;


please use consts here, eg. SYNTAX_ROOT_KEYS.TYPE etc

Kicu · 2024-10-18T06:22:32Z

src/libs/SearchUtils.ts

@@ -541,12 +567,13 @@ function getFilters(queryJSON: SearchQueryJSON) {
 function buildSearchQueryJSON(query: SearchQueryString) {
    try {
        const result = searchParser.parse(query) as SearchQueryJSON;
+        // console.log('%%%%%\n', 'result', result);


remove this :)

Haste makes waste 😄

rayane-djouah · 2024-10-18T09:15:17Z

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

Screen.Recording.2024-10-18.at.7.06.01.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-10-18.at.7.08.00.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-10-18.at.19.02.57.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-10-18.at.19.04.54.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-10-18.at.6.58.21.PM.mov

Screen.Recording.2024-10-18.at.6.55.41.PM.mov

MacOS: Desktop

Screen.Recording.2024-10-18.at.6.59.28.PM.mov

Screen.Recording.2024-10-18.at.7.00.17.PM.mov

rayane-djouah · 2024-10-18T09:45:17Z

src/libs/SearchUtils.ts

+    orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY}: ${query.sortBy} `;
+    orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER}: ${query.sortOrder} `;


Shouldn't we exclude contextual filters (sortBy, sortOrder, policyID) when we calculate the query hash?

EDIT: I think that including them is necessary here, but I suggested a solution for related issues here: #50921 (comment)

I think this will cause duplicate recent searches options

This is reproducible also on main. I think we can fix it in a separate PR

I think a potential solution is to create two hashes for the query: one that includes sortBy, sortOrder, and policyID, and one that does not.

Hmm I think this should be fixed on BE, because recentSearches are generated on BE. In case when we are searching for some query twice, then it should be renewed in history and not duplicated.

I also gave one argument for having sortOrder etc. here #50921 (comment).

WDYT @rayane-djouah

@SzymczakJ The duplication of the query isn't due to it being searched twice, but because the queries differ in sortBy, sortOrder, or policyID. For instance, in this case: #51044 (comment), there are two queries: one with sortBy and sortOrder, and another without these filters, resulting in different hashes. I agree that we should always include these filters when sending the query to the backend and when calculating the hash. However, we need to filter out duplicate queries in saved searches and recent searches that differ only by sortBy, sortOrder, or policyID. This can be achieved by computing a secondary hash that excludes these filters, and using this secondary hash to determine whether to display or exclude the query in saved and recent searches and whether to highlight the saved search item.

We have a separate issue for this, so let's treat it as NAB for this PR and keep the discussion in that issue.

rayane-djouah · 2024-10-18T09:45:29Z

src/libs/SearchUtils.ts

+    if (query.policyID) {
+        orderedQuery += `${CONST.SEARCH.SYNTAX_ROOT_KEYS.POLICY_ID} ${query.policyID} `;
+    }


rayane-djouah · 2024-10-18T10:10:43Z

src/libs/SearchUtils.ts

+    filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY}:${CONST.SEARCH.TABLE_COLUMNS.DATE}`);
+    filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER}:${CONST.SEARCH.SORT_ORDER.DESC}`);


This will cause the saved query name to include sortBy and sortOrder, and the highlight on the saved search item will be lost when we change the sort order.

Screen.Recording.2024-10-18.at.11.06.40.AM.mov

The highlight on the saved search item will be lost when we change the sort order bug is reproducible on main and can be fixed in a separate PR. But the saved query name include sortBy and sortOrder bug is specific to this PR

Do you know why the saved query name includes sortBy and sortOrder but not policyID?

highlight on the saved search item will be lost when we change the sort order

I tend to lean toward idea that this is not a bug. For me searches differing only with sortBy or sortOrder are two different queries. Reason:

There might be a user which has about 1000 expenses with category 'Advertising'

When he queries for category 'Advertising' he will get a paginated result with only 50 of newest expenses

When we will change sortOrder then he will get 50 oldest expenses. These two queries are giving us different responses

Good point. However, we are not including sortBy, sortOrder, and policyID in the displayed query (in the header input and recent searches) because we want users to rely on the contextual filters rather than manually typing these parameters. Therefore, it doesn't make sense to include them in the saved search item name.

Also, please see this comment: #50921 (comment)

I agree that those are different queries. We should treat these params the same way we do with status, since to @rayane-djouah's point, we use the contextual filters to change these values instead of manually typing them in.

rayane-djouah · 2024-10-18T11:18:32Z

src/libs/SearchUtils.ts

+function getQueryHash(query: SearchQueryJSON): number {
+    let orderedQuery = '';
+    if (query.policyID) {
+        orderedQuery += `${CONST.SEARCH.SYNTAX_ROOT_KEYS.POLICY_ID} ${query.policyID} `;


Suggested change

orderedQuery += `${CONST.SEARCH.SYNTAX_ROOT_KEYS.POLICY_ID} ${query.policyID} `;

orderedQuery += `${CONST.SEARCH.SYNTAX_ROOT_KEYS.POLICY_ID}:${query.policyID}`;

rayane-djouah · 2024-10-18T11:20:47Z

src/libs/SearchUtils.ts

+    orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.TYPE}: ${query.type} `;
+    orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.STATUS}: ${query.status}`;
+    orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY}: ${query.sortBy} `;
+    orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER}: ${query.sortOrder} `;


Suggested change

orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.TYPE}: ${query.type} `;

orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.STATUS}: ${query.status}`;

orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY}: ${query.sortBy} `;

orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER}: ${query.sortOrder} `;

orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.TYPE}:${query.type}`;

orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.STATUS}:${query.status}`;

orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY}:${query.sortBy}`;

orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER}:${query.sortOrder}`;

rayane-djouah · 2024-10-18T11:25:46Z

src/libs/SearchUtils.ts

+            orderedQuery += ` ${key}:`;
+            filterValues
+                ?.sort((queryFilter1, queryFilter2) => {
+                    if (queryFilter1.value > queryFilter2.value) {
+                        return 1;
+                    }
+                    return -1;
+                })
+                ?.forEach((queryFilter) => {
+                    orderedQuery += ` ${queryFilter.operator} ${queryFilter.value}`;
+                });


Suggested change

orderedQuery += ` ${key}:`;

filterValues

?.sort((queryFilter1, queryFilter2) => {

if (queryFilter1.value > queryFilter2.value) {

return 1;

}

return -1;

})

?.forEach((queryFilter) => {

orderedQuery += ` ${queryFilter.operator} ${queryFilter.value}`;

});

const sortedFilterValues = filterValues

?.sort((queryFilter1, queryFilter2) => {

if (queryFilter1.value > queryFilter2.value) {

return 1;

}

return -1;

});

orderedQuery += ` ${SearchUtils.buildFilterString(key, sortedFilterValues)}`;

rayane-djouah · 2024-10-18T14:32:13Z

src/libs/SearchUtils.ts

+                }
+                return -1;
+            });
+            orderedQuery += `${buildFilterString(key, sortedFilterValues ?? [])}`;


NAB

Suggested change

orderedQuery += `${buildFilterString(key, sortedFilterValues ?? [])}`;

orderedQuery += ` ${buildFilterString(key, sortedFilterValues ?? [])}`;

rayane-djouah · 2024-10-18T14:56:35Z

@luacmartins What do you think about #50921 (comment) and #50921 (comment)?

luacmartins · 2024-10-18T16:16:46Z

I left comments on both of those threads. I think we can handle both of those cases as part of #51044 since they'd likely have the same or similar solutions.

luacmartins

We have a few pending comments to resolve

SzymczakJ · 2024-10-18T17:29:45Z

Just resolved them @luacmartins

rayane-djouah

LGTM and tests well. @luacmartins all yours!

github-actions · 2024-10-18T19:05:36Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.51-1 🚀

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

github-actions · 2024-10-22T04:38:52Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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

github-actions · 2024-10-22T17:21:16Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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

SzymczakJ added 6 commits October 16, 2024 14:45

fix query hash so it returns the same value for the same query when s…

12bfe36

…earching from searchRouter

Merge branch 'main' into @szymczak/search-router-polish

3aecfd0

add tooltip

4a61a45

SearchButton paddings

56cdff8

show contacts in recent chats list only when user types something in …

bf869b2

…input

Merge branch 'main' into @szymczak/search-router-polish

2093e69

clean up code

3fd262d

SzymczakJ marked this pull request as ready for review October 17, 2024 21:55

SzymczakJ requested a review from a team as a code owner October 17, 2024 21:55

melvin-bot bot requested a review from rayane-djouah October 17, 2024 21:55

melvin-bot bot removed the request for review from a team October 17, 2024 21:55

Kicu reviewed Oct 18, 2024

View reviewed changes

Kicu mentioned this pull request Oct 18, 2024

[No QA] Split SearchUtils into two files #50866

Merged

48 tasks

SzymczakJ added 2 commits October 18, 2024 11:19

fix PR comments

8782a51

fix orderedQuery structure

0687b54

rayane-djouah suggested changes Oct 18, 2024

View reviewed changes

rayane-djouah reviewed Oct 18, 2024

View reviewed changes

rayane-djouah suggested changes Oct 18, 2024

View reviewed changes

fix pr comments

f61b280

rayane-djouah reviewed Oct 18, 2024

View reviewed changes

rayane-djouah mentioned this pull request Oct 18, 2024

[$250] [HOLD for payment 2024-11-14] [Search v2.4] - Same search query appears twice in Recent searches #51044

Closed

8 tasks

luacmartins self-requested a review October 18, 2024 15:59

luacmartins reviewed Oct 18, 2024

View reviewed changes

fix PR comments

6dc170c

rayane-djouah approved these changes Oct 18, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins October 18, 2024 18:11

luacmartins approved these changes Oct 18, 2024

View reviewed changes

luacmartins merged commit 9cee393 into Expensify:main Oct 18, 2024
17 checks passed

github-actions bot mentioned this pull request Oct 18, 2024

Deploy Checklist: New Expensify 2024-10-18 #51106

Closed

59 tasks

		orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY}: ${query.sortBy} `;
		orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER}: ${query.sortOrder} `;

		filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY}:${CONST.SEARCH.TABLE_COLUMNS.DATE}`);
		filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER}:${CONST.SEARCH.SORT_ORDER.DESC}`);

	orderedQuery += `${CONST.SEARCH.SYNTAX_ROOT_KEYS.POLICY_ID} ${query.policyID} `;
	orderedQuery += `${CONST.SEARCH.SYNTAX_ROOT_KEYS.POLICY_ID}:${query.policyID}`;

	orderedQuery += `${buildFilterString(key, sortedFilterValues ?? [])}`;
	orderedQuery += ` ${buildFilterString(key, sortedFilterValues ?? [])}`;

Search router polish #50921

Search router polish #50921

Conversation

SzymczakJ commented Oct 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

SzymczakJ commented Oct 17, 2024

SzymczakJ commented Oct 17, 2024

luacmartins commented Oct 17, 2024

melvin-bot bot commented Oct 17, 2024

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rayane-djouah commented Oct 18, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rayane-djouah Oct 18, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rayane-djouah Oct 18, 2024 • edited Loading

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

rayane-djouah Oct 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rayane-djouah Oct 18, 2024 • edited Loading

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

rayane-djouah commented Oct 18, 2024 • edited Loading

luacmartins commented Oct 18, 2024

luacmartins left a comment

Choose a reason for hiding this comment

SzymczakJ commented Oct 18, 2024

rayane-djouah left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 22, 2024

github-actions bot commented Oct 22, 2024

SzymczakJ commented Oct 16, 2024 •

edited

Loading

rayane-djouah commented Oct 18, 2024 •

edited

Loading

rayane-djouah Oct 18, 2024 •

edited

Loading

rayane-djouah Oct 18, 2024 •

edited

Loading

rayane-djouah Oct 18, 2024 •

edited

Loading

rayane-djouah Oct 18, 2024 •

edited

Loading

rayane-djouah commented Oct 18, 2024 •

edited

Loading