fix: removing extra pair of quotes in keyword filter #53158

Tony-MK · 2024-11-26T18:35:36Z

Explanation of Change

This PR removes the extra pair of double quotation marks wrapped around keywords that contain special characters to prevent the keywords from being wrapped continuously after every search.

Fixed Issues

$ #52923
PROPOSAL: #52923 (comment)

Tests

Go to search.
Click "Filters".
Click "Has Keywords".
Enter the link as a keyword.
Click on "Save".
Click "View Results".
Verify that the keyword is wrapped with double quotation marks.
Switch tabs numerously to verify that the keyword doesn't get wrapped in extra double quotation marks.

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android.-.Native.webm

Android: mWeb Chrome

Android.-.mWeb.webm

iOS: Native

iOS.-.Native.mp4

iOS: mWeb Safari

iOS.-.mWeb.mp4

MacOS: Chrome / Safari

MacOS.-.Chrome.mov

MacOS: Desktop

MacOS.-.Desktop.mov

melvin-bot · 2024-11-26T18:35:42Z

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

Tony-MK · 2024-11-26T21:07:34Z

I noticed a regression with my proposal when entering keywords which are already wrapped in double quotation marks.

Hence, I deviated from the original proposal and found a better solution.

Should I update my proposal for clafications?

hungvu193 · 2024-11-27T02:10:30Z

Should I update my proposal for clafications?

Yes, please. If you decided to update the regex, What makes your regex better than the first contributor's proposal?

Which regression did you find?

hungvu193 · 2024-11-29T02:22:44Z

little bump @Tony-MK

Tony-MK · 2024-11-29T10:48:54Z

Should I update my proposal for clarifications?

Yes, please. If you decided to update the regex, What makes your regex better than the first contributor's proposal?

Just updated my proposal and it changes the regex to consider the colon as not a special character.

Which regression did you find?

I found a regression when you enter a keyword with quotation marks the app would not allow me to save the search and on pressing view results, the app shows the not found page.

Regression.mov

hungvu193 · 2024-11-29T13:31:58Z

What makes your regex better than the first contributor's proposal?

How about the second part here?

Tony-MK · 2024-11-29T17:37:18Z

What makes your regex better than the first contributor's proposal?

How about the second part here?

Oh, both of the regexes are wrong because they will cause a regression where the keywords don't give search results when known results are present.

This is because the keyword is already wrapped and the colon is a special character used to split the search type and value. E.g. type: all.

So, the regex we currently use is correct and should not be changed.

However, after investigating the regressions, I noticed that we should remove only one pair of quotes, the first and last quotation marks, from filter.right like how the JSON.parse function does but manually with slice and a custom regex.

keywords.map((filter) => 
    /^".*"$/g.test(filter.right) ? 
    filter.right.slice(1, - 1) : 
    filter.right
).flat()

Do you have any thoughts about the explanation?

hungvu193 · 2024-11-30T08:43:17Z

Thanks, can you also add unit tests for this case so we won't face it again?

hungvu193 · 2024-12-03T02:30:37Z

Little bump on the comment above @Tony-MK

…ain special characters

Tony-MK · 2024-12-03T19:59:11Z

Thanks, can you also add unit tests for this case so we won't face it again?

I have added more tests, kindly check.

Thanks

hungvu193 · 2024-12-04T02:29:10Z

Thanks for your update. I'll check it today!

hungvu193 · 2024-12-04T03:33:55Z

I think it failed the first testcase, please check the video below:

Screen.Recording.2024-12-04.at.10.32.58.mov

Tony-MK · 2024-12-05T17:09:58Z

I think it failed the first testcase, please check the video below:

Screen.Recording.2024-12-04.at.10.32.58.mov

You included the single quotation marks (') wrapping the query.

If you remove them, '" " " "' -> " " " ", this should work nicely.

hungvu193 · 2024-12-05T17:11:07Z

If you see in the video, the search query in the first tab is different with other tabs

Tony-MK · 2024-12-05T18:46:31Z

I tried testing some queries wrapped in single quotes.

I noticed it removes the inner double quotation marks for double-quoted whitespaces in queries that are wrapped in single quotes into a one-space character wrapped in single quotations, ' ', Eg:

a) One whitespace : '" "' -> ' ' -> ' '
b) Three whitespaces : '" " " "' -> ' ' -> ' '

It is similar to how queries with empty whitespaces wrapped in single quotes are handled, Eg: ' ' -> ' '.

This doesn't affect queries with characters and if you replace the whitespaces with characters, Eg: '" "' -> '"https://expensify.com"', it won't occur.

Well, let me know if this is an edge case worth fixing since it only involves searching a precise pattern of empty whitespaces.

hungvu193 · 2024-12-06T01:42:50Z

The problem here is the inconsistency when switching between the filter tab

Tony-MK · 2024-12-06T02:24:27Z

I updated the regex. Check if the problem persists.

Tony-MK · 2024-12-07T21:50:05Z

Please update the screenshots/video based on your new changes

I retested the changes and updated the videos.

make sure the original issue + the issue I commented above don't appear.

I am not sure what you meant.

Can you explain further?

hungvu193 · 2024-12-09T07:14:30Z

@Tony-MK I think we're still facing the same issue. Please look at the video below:

Screen.Recording.2024-12-09.at.13.47.47.mov

I'm still seeing extra " was added into our string.

Tony-MK · 2024-12-10T09:11:23Z

Can you give the steps to replicate this issue?

I tried to replicate it but failed.

Screen.Recording.2024-12-10.at.10.08.16.mov

hungvu193 · 2024-12-10T15:09:05Z

I think in the above video that you posted when you enter "https://facebook.com" and press Save Search, the filter text returned ""https://facebook.com""which had extra doule quote mark.

Tony-MK · 2024-12-13T00:39:43Z

I think in the above video that you posted when you enter "https://facebook.com" and press Save Search, the filter text returned ""https://facebook.com""which had extra doule quote mark.

Yeah, but it only adds double quotes, not more than that.

That's by design.

The sanitizeSearchValue function will add the extra double quotes if the keyword already has special characters, and then searchParser.parse will remove them.

App/src/libs/SearchQueryUtils.ts

Lines 39 to 42 in 7be9987

    
           function sanitizeSearchValue(str: string) { 
        
               const regexp = /[^A-Za-z0-9_@./#&+\-\\';,"]/g; 
        
               if (regexp.test(str)) { 
        
                   return `"${str}"`;

It's like how http://facebook.com returns "http://facebook.com".

Therefore, "http://facebook.com" returns ""http://facebook.com"".

hungvu193 · 2024-12-15T07:55:27Z

Therefore, "http://facebook.com" returns ""http://facebook.com"".

Hmm, I'm afraid I have to disagree with you at this point, if our keyword's already wrapped inside ", I think we shouldn't add ".

Tony-MK · 2024-12-16T11:49:29Z

Hmm, I'm afraid I have to disagree with you at this point, if our keyword's already wrapped inside ", I think we shouldn't add "

That's okay, I understand.

However, I am a bit scared that search regressions will arise like getting unexpected or no search results, since the double quote is specifically used in the regex in sanitizeSearchValue to wrap any keyword with special characters even if has it has double quotes itself.

WDYT?

Nevertheless, before I push the new changes, I would like to ensure that this is an issue I need to correct.

After saving or viewing the results, if you entered a link that is already wrapped once, "https://google.com", on the filters page, the keyword is displayed as https://google.com without the double quotes instead of "https://google.com".

Hence, a user can not search for the exact keyword if it has a single pair of double quotes wrapping it such as "https://google.com" because it will change to https://google.com and are treated as identical keywords.

Screen.Recording.2024-12-16.at.13.55.30.mov

hungvu193 · 2024-12-17T11:32:59Z

Thanks for your update. I'll take a look today!

hungvu193 · 2024-12-19T08:08:55Z

Look like serrver is down, I can't test it atm

hungvu193 · 2024-12-25T06:31:15Z

Nevertheless, before I push the new changes, I would like to ensure that this is an issue I need to correct.

After saving or viewing the results, if you entered a link that is already wrapped once, "https://google.com", on the filters page, the keyword is displayed as https://google.com without the double quotes instead of "https://google.com".

Hence, a user can not search for the exact keyword if it has a single pair of double quotes wrapping it such as "https://google.com" because it will change to https://google.com and are treated as identical keywords.

After taking tests, I agree with you at this point

hungvu193 · 2024-12-25T06:31:31Z

@Tony-MK Can you merge main please?

hungvu193 · 2024-12-25T06:52:50Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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-12-25.at.13.52.19.mov

Android: mWeb Chrome

androidmandroid.mov

iOS: Native

Screen.Recording.2024-12-25.at.13.44.11.mov

iOS: mWeb Safari

Screen.Recording.2024-12-25.at.13.46.29.mov

MacOS: Chrome / Safari

Chrome.mov

MacOS: Desktop

Desk.mov

srikarparsi · 2024-12-29T20:08:49Z

Hey, I'll take a look at this tomorrow

srikarparsi

lgtm thanks for the tests :)

OSBotify · 2024-12-30T20:23:07Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-12-31T22:17:16Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.80-1 🚀

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

github-actions · 2025-01-06T18:16:49Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.80-6 🚀

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

hungvu193 · 2025-01-14T10:44:33Z

just realized we shouldn't update searchParser.js file, we should update searchParser.peggy instead. Since searchParser.js is generated by searchParser.peggyfile.
@Tony-MK Can you raise a PR to fix it?

Tony-MK · 2025-01-15T13:44:06Z

@hungvu193, What about the keyword tests?

They will fail so where should move them?

hungvu193 · 2025-01-15T13:46:00Z

@hungvu193, What about the keyword tests?

They will fail so where should move them?

You will need to regenerate searchParser.js file if you changed peggy file. So our tests wont be failed

hungvu193 · 2025-01-15T13:46:51Z

We have the command to generate searchParser.js in our package.json

Tony-MK · 2025-01-15T13:51:55Z

Thanks

Tony-MK · 2025-01-15T15:26:39Z

I opened the PR.

fix: adding a colon to the regex parser to sanitize link

4b3bea4

Tony-MK requested a review from a team as a code owner November 26, 2024 18:35

melvin-bot bot requested review from hungvu193 and removed request for a team November 26, 2024 18:35

Merge branch 'Expensify:main' into fix/52923

77b5f6d

Tony-MK added 2 commits November 29, 2024 20:24

Update SearchQueryUtils.ts

65e846e

fix: remove extra pair of quotes

444870b

Tony-MK added 3 commits December 3, 2024 22:53

test: adding test cases for search queries wrapped in quotes and cont…

cb1fd22

…ain special characters

refactoring...

b240ee4

Merge branch 'Expensify:main' into fix/52923

799c00f

Tony-MK changed the title ~~fix: adding a colon to the regex parser to sanitize link~~ fix: removing extra pair of quotes in keyword filter Dec 3, 2024

Merge branch 'Expensify:main' into fix/52923

b469998

updated regex ...

82e5a98

hungvu193 approved these changes Dec 25, 2024

View reviewed changes

melvin-bot bot requested a review from srikarparsi December 25, 2024 06:53

Merge branch 'Expensify:main' into fix/52923

67eeedf

srikarparsi approved these changes Dec 30, 2024

View reviewed changes

srikarparsi merged commit 483d287 into Expensify:main Dec 30, 2024
16 checks passed

github-actions bot mentioned this pull request Dec 31, 2024

Deploy Checklist: New Expensify 2024-12-31 #54686

Closed

68 tasks

melvin-bot bot mentioned this pull request Jan 6, 2025

[HOLD for payment 2025-02-04] [HOLD for payment 2025-01-13] [$250] Search - Quotation marks in search query increase each time when switching status #52923

Closed

8 tasks

hungvu193 mentioned this pull request Jan 16, 2025

[No QA] Applying changes to searchParser.peggy #55284

Merged

50 tasks

fix: removing extra pair of quotes in keyword filter #53158

fix: removing extra pair of quotes in keyword filter #53158

Conversation

Tony-MK commented Nov 26, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 26, 2024

Tony-MK commented Nov 26, 2024

hungvu193 commented Nov 27, 2024 • edited Loading

hungvu193 commented Nov 29, 2024

Tony-MK commented Nov 29, 2024

hungvu193 commented Nov 29, 2024

Tony-MK commented Nov 29, 2024

hungvu193 commented Nov 30, 2024

hungvu193 commented Dec 3, 2024

Tony-MK commented Dec 3, 2024

hungvu193 commented Dec 4, 2024

hungvu193 commented Dec 4, 2024

Tony-MK commented Dec 5, 2024

hungvu193 commented Dec 5, 2024

Tony-MK commented Dec 5, 2024

hungvu193 commented Dec 6, 2024

Tony-MK commented Dec 6, 2024

Tony-MK commented Dec 7, 2024

hungvu193 commented Dec 9, 2024

Tony-MK commented Dec 10, 2024

hungvu193 commented Dec 10, 2024

Tony-MK commented Dec 13, 2024 • edited Loading

hungvu193 commented Dec 15, 2024

Tony-MK commented Dec 16, 2024

hungvu193 commented Dec 17, 2024

hungvu193 commented Dec 19, 2024

hungvu193 commented Dec 25, 2024

hungvu193 commented Dec 25, 2024

hungvu193 commented Dec 25, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

srikarparsi commented Dec 29, 2024

srikarparsi left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 30, 2024

github-actions bot commented Dec 31, 2024

github-actions bot commented Jan 6, 2025

hungvu193 commented Jan 14, 2025

Tony-MK commented Jan 15, 2025

hungvu193 commented Jan 15, 2025

hungvu193 commented Jan 15, 2025

Tony-MK commented Jan 15, 2025

Tony-MK commented Jan 15, 2025

Tony-MK commented Nov 26, 2024 •

edited

Loading

hungvu193 commented Nov 27, 2024 •

edited

Loading

Tony-MK commented Dec 13, 2024 •

edited

Loading

hungvu193 commented Dec 25, 2024 •

edited

Loading