[AWAITING CHECKLIST] [HOLD for payment 2024-12-12] [$250] Search-Order of the words is reversed when the query is submitted

@garrettmknight

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

Version Number: v9.0.58-2
Reproducible in staging?: Y
Reproducible in production?: Y
Issue reported by: Applause Internal Team

Action Performed:

Navigate to the Search page.
Click on the search bar icon to open the search field.
Enter any search query and press the Enter key to submit the query.

Expected Result:

The order of the words remains without changes when the query is submitted.

Actual Result:

The order of the words is reversed when the query is submitted.

Workaround:

Unknown

Platforms:

Screenshots/Videos

Bug6656086_1730861572948.51314-Web.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~021854577953623256419
Upwork Job ID: 1854577953623256419
Last Price Increase: 2024-11-21
Automatic offers:

Tony-MK | Contributor | 105099831

Issue Owner

Current Issue Owner: @garrettmknight

@garrettmknight

Triggered auto assignment to @garrettmknight (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

Job added to Upwork: https://www.upwork.com/jobs/~021854577953623256419

@rushatgabhane

Triggered auto assignment to Contributor-plus team member for initial proposal review - @rushatgabhane (External)

Edited by proposal-police: This proposal was edited at 2024-11-13 10:36:52 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

Search-Order of the words is reversed when the query is submitted.

What is the root cause of that problem?

The SearchPage uses the SearchQueryUtils.buildSearchQueryJSON function to build a query.

App/src/pages/Search/SearchPage.tsx

Lines 21 to 23 in b5c2c73

    
           const {q} = route.params; 
        
           const queryJSON = useMemo(() => SearchQueryUtils.buildSearchQueryJSON(q), [q]);

However, we end up sorting the query.flatFilters which are the keywords by alphabetical order when calling the getQueryHashes function.

This is because a consistent hash function is needed.

App/src/libs/SearchQueryUtils.ts

Lines 272 to 274 in 494211d

    
           result.flatFilters = flatFilters; 
        
           const {primaryHash, recentSearchHash} = getQueryHashes(result); 
        
           result.hash = primaryHash;

What changes do you think we should make in order to solve the problem?

Instead of sorting the original query.flatFilters array inplace, we should create a new array where we sort the query.flatFilters.

Also, instead of using forEach we can map the query.flatFilters to a function so the original array is not mutated and orderedQuery parsed.

Optionally, I believe it is unnecessary to have two code snippets where we modify the query.flatFilters, seen below, to make orderedQuery so let's join the two code snippets into one.

App/src/libs/SearchQueryUtils.ts

Lines 238 to 240 in 494211d

    
           query.flatFilters.forEach((filter) => { 
        
               filter.filters.sort((a, b) => localeCompare(a.value.toString(), b.value.toString())); 
        
           });

App/src/libs/SearchQueryUtils.ts

Lines 242 to 245 in c24d217

    
           query.flatFilters 
        
               .map((filter) => buildFilterValuesString(filter.key, filter.filters)) 
        
               .sort() 
        
               .forEach((filterString) => (orderedQuery += ` ${filterString}`));

Proposal

Please re-state the problem that we are trying to solve in this issue.

The order of the words is reversed when the query is submitted.

What is the root cause of that problem?

Here is the function that we use to get the hash query. We have two sort functions here

App/src/libs/SearchQueryUtils.ts

Line 233 in 494211d

    
           function getQueryHashes(query: SearchQueryJSON): {primaryHash: number; recentSearchHash: number} {

The first one is used to sort all values in a filters of a filter

App/src/libs/SearchQueryUtils.ts

Lines 238 to 241 in 494211d

    
           query.flatFilters.forEach((filter) => { 
        
               filter.filters.sort((a, b) => localeCompare(a.value.toString(), b.value.toString())); 
        
           });

The second one is used to sort all filters by key

App/src/libs/SearchQueryUtils.ts

Lines 242 to 245 in 494211d

    
           query.flatFilters 
        
               .map((filter) => buildFilterValuesString(filter.key, filter.filters)) 
        
               .sort() 
        
               .forEach((filterString) => (orderedQuery += ` ${filterString}`));

For the case of this issue Test and G are in the same filter with the key being keyword then it's sorted by the first function

What changes do you think we should make in order to solve the problem?

I think for the keyword key filter, we should keep the order of all values. We can skip the sort function here if the key is keyword

query.flatFilters.forEach((filter) => {
    if (filter.key === 'keyword') {
        return;
    }
    filter.filters.sort((a, b) => localeCompare(a.value.toString(), b.value.toString()));
});

App/src/libs/SearchQueryUtils.ts

Lines 238 to 241 in 494211d

    
           query.flatFilters.forEach((filter) => { 
        
               filter.filters.sort((a, b) => localeCompare(a.value.toString(), b.value.toString())); 
        
           });

What alternative solutions did you explore? (Optional)

If we want to keep the order of all filters and all values of the filter we can remove these lines and the sort function here

@garrettmknight

@garrettmknight, @rushatgabhane Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

@rushatgabhane

@rushatgabhane please complete the checklist when you get a chance before submitting for payment.

@rushatgabhane

@rushatgabhane can you complete the checklist when you get a chance?

Still awaiting the checklist

@Tony-MK

Confirming the payment summary:

Contributor: @Tony-MK $250 via Upwork
Reviewer: @rushatgabhane $250 via New Expensify

@rushatgabhane

Still awaiting checklist @rushatgabhane

BugZero Checklist:

[Contributor] Classify the bug:

Bug classification

Source of bug:

1a. Result of the original design (eg. a case wasn't considered)
1b. Mistake during implementation
1c. Backend bug
1z. Other:

Where bug was reported:

2a. Reported on production (eg. bug slipped through the normal regression and PR testing process on staging)
2b. Reported on staging (eg. found during regression or PR testing)
2d. Reported on a PR
2z. Other:

Who reported the bug:

[Contributor] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake.

Link to comment: https://github.com/Expensify/App/pull/50883/files#r1908818356
[Contributor] If the regression was CRITICAL (e.g. interrupts a core flow) A discussion in #expensify-open-source has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner.

Link to discussion: Not critical but we can add test for it.
[Contributor] If it was decided to create a regression test for the bug, please propose the regression test steps using the template below to ensure the same bug will not reach production again.

Regression Test Proposal Template

[BugZero Assignee] Create a GH issue for creating/updating the regression test once above steps have been agreed upon.

Link to issue:

Regression Test Proposal

Precondition:

Test:

Go to the search page.
Click on the search bar.
Type in random letters or words preferably in reverse alphabetical order. E.g.: dog cat bird apple.
Press enter to search the keywords.
Check if the order of the keywords in the search bar is unchanged and exactly as you typed in Step 3.

Do we agree 👍 or 👎

@rushatgabhane

$250 approved for @rushatgabhane

Navigation Menu

Repository navigation

[AWAITING CHECKLIST] [HOLD for payment 2024-12-12] [$250] Search-Order of the words is reversed when the query is submitted #52170

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

What alternative solutions did you explore? (Optional)

45 remaining items

BugZero Checklist:

Regression Test Proposal

Precondition:

Test:

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	const {q} = route.params;

	const queryJSON = useMemo(() => SearchQueryUtils.buildSearchQueryJSON(q), [q]);

	result.flatFilters = flatFilters;
	const {primaryHash, recentSearchHash} = getQueryHashes(result);
	result.hash = primaryHash;

	query.flatFilters.forEach((filter) => {
	filter.filters.sort((a, b) => localeCompare(a.value.toString(), b.value.toString()));
	});

	query.flatFilters
	.map((filter) => buildFilterValuesString(filter.key, filter.filters))
	.sort()
	.forEach((filterString) => (orderedQuery += ` ${filterString}`));

[AWAITING CHECKLIST] [HOLD for payment 2024-12-12] [$250] Search-Order of the words is reversed when the query is submitted #52170

Description

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Activity

melvin-bot commented on Nov 7, 2024

melvin-bot commented on Nov 7, 2024

melvin-bot commented on Nov 7, 2024

Tony-MK commented on Nov 7, 2024

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

nkdengineer commented on Nov 8, 2024

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

What changes do you think we should make in order to solve the problem?

What alternative solutions did you explore? (Optional)

melvin-bot commented on Nov 11, 2024

45 remaining items

garrettmknight commented on Dec 17, 2024

garrettmknight commented on Dec 21, 2024

garrettmknight commented on Dec 30, 2024

JmillsExpensify commented on Dec 30, 2024

garrettmknight commented on Jan 7, 2025

rushatgabhane commented on Jan 9, 2025

BugZero Checklist:

Regression Test Proposal

Precondition:

Test:

garrettmknight commented on Jan 10, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions