Fix: Report- The search doesn't work if display name of user has Double quotes

[codekane]

This is the solution for Issue 57086

Explanation of Change

I've modified the parser, used in the AutocompleteInput on the search bar of the reports feature to support the presence of nested double quotes within quoted strings, to fix name highlighting, and a broken search feature when a user's name has double quotes within it.

Previously, the parser would prematurely closet the string upon encountering a double quote. My solution resolves this by adding a set of rules that indicate the presence of an actual closing quote, and consider any other quotes encountered to instead be a part of the string.

As a fallback, it also looks for the lack of an operator before the end of the line. This rule ensures that existing functional continues to perform as expected, while handling the cases with nested double quotes flawlessly.

Fixed Issues

$ #57086
$ PROPOSAL: #57086 (comment)

Tests

1. Create an account. When asked for your name, riddle it with double quotes. Multiple double quotes at the beginning, and end of the first name. Double quotes between every word of the last name. Aim for the total number of double quotes to be odd.
2. Using that account, create an expense, and send it to another account you control. The name of that account does not matter.
3. Log into the 2nd account.
4. Navigate to the reports page
5. In the search bar, type the following: `status: all type: expense from: [WEIRD QUOTED NAME] to: [NAME ON SECOND ACCOUNT]
6. Accept the autocompletes suggested, for both names. Expect for the names to change colour upon clicking the suggestion, denoting they've been correctly associated with a user
7. Press enter to submit the search
8. Expect to see the expense you posted in step 2 in the results

The expected functionality is for everything to work exactly the same as it does on production - in terms of how this input "feels" to use. The only difference is that if either the from: or to: keys are set to a user who has double quotes in their name, it works successfully, instead of failing to correctly highlight them, and then failing to correctly parse them when you actually execute the search (due to inadequacies within the parser).

Offline tests

If you've already been online, and engaged in a search, and thus populated the datasets, this feature continues to work when offline. The search may, or may not work - it's ultimately dependant on whether that data is retained from when you were online.

QA Steps

To reproduce the bug as it stands, log in to Staging/Production, and perform the same steps.

What you'll find is that, when a double quote is present in the username, the highlighting does not work correctly and the search is non-functional, indicating an error in parsing the strings.

You'll know that the solution works, because this aberrant behaviour is no longer present, after the changes I've made.

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (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
    • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • 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 followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• 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
• I verified that if a function's arguments changed that all usages have also been updated correctly
• 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.
• I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native

Android.Native.Report.Double.Quote.Search.Bug.mp4

Android: mWeb Chrome

Android.Chrome.Report.Double.Quote.Search.Bug.mp4

iOS: Native

iOS.Native.-.Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-03-10.at.12.38.40.mp4

iOS: mWeb Safari

iOS.mWeb.-.Report.Doubel.Quote.Search.Bug.mp4

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot]

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

[github-actions]

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

[dukenv0307]

@codekane Please resolve the conflicts

[dukenv0307]

And complete the checklist as well

[codekane]

I have read the CLA Document and I hereby sign the CLA

[dukenv0307]

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.2025-03-12.at.11.31.48.mov

Android: mWeb Chrome

Screen.Recording.2025-03-12.at.11.29.32.mov

iOS: Native

Screen.Recording.2025-03-12.at.11.30.37.mov

iOS: mWeb Safari

Screen.Recording.2025-03-12.at.11.24.25.mov

MacOS: Chrome / Safari

Screen.Recording.2025-03-12.at.11.13.46.mov

MacOS: Desktop

Screen.Recording.2025-03-12.at.11.36.49.mov

[dukenv0307]

@codekane Code looks good and tests well. Can you please add some tests to cover this case? Thanks

[dukenv0307]

@codekane any updates?

[codekane]

@codekane any updates?

I've got failing tests regarding handling of the atypical double quotes. I'll update you once it's resolved.

[dukenv0307]

@codekane Is it ready for review?

[codekane]

@codekane Is it ready for review?

Yes.

[dukenv0307]

LGTM

[melvin-bot]

We did not find an internal engineer to review this PR, trying to assign a random engineer to #57086 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

[rafecolton]

Just confirming in Slack (internal only) that this is a feature we want to support.

[dukenv0307]

@rafecolton any updates?

[rafecolton]

No response in Slack, thanks for the bump. @luacmartins what do you think of this change?

[luacmartins]

@codekane regex changes lgtm, but you also have to regenerate the search parser by running npm run generate-search-parser.

[codekane]

@codekane regex changes lgtm, but you also have to regenerate the search parser by running npm run generate-search-parser.

It's been done. Doing so broke some tests, so I've reverted the search parser to use the original version of the rule, and given the autocomplete parser the updated one.

[luacmartins]

Nice, looking much better. Left a few small comments on style

[codekane]

@luacmartins Got it - changes have been pushed.

[luacmartins]

@codekane sorry, one final style change request. Rest looks good to me

[codekane]

@luacmartins Done. I found a few other places these fixes could be applied as well.

[luacmartins]

@codekane we have some checks failing

[codekane]

@luacmartins SHOULD be resolved.

• Prettier had flagged a couple of missing commas in the tests.
• Recompiled parsers to remove what I'm GUESSING was a space I took out in my last commit.

Ran ESLint. It returned successfully, so I'm guessing it was flagging on the same thing as Prettier.

[codekane]

Updated: I fixed the imports in the SearchParserTest. esLint check should now pass.

[codekane]

@luacmartins I see that there are failing checks... For files I didn't actually touch.

I get that, if I touch it, and there are things failing the current checks in the file I've touched, that I'll pick that up. But I want to clarify to what extent my responsibility extends here.

[luacmartins]

@codekane ESLint is still failing. Please check that the checks are passing locally by running:

1. Lint npm run prettier
2. Typescript npm run typecheck
3. ESLint npm run lint-changed

[luacmartins]

@codekane sorry, I missed your previous message. I agree that the failure is on an unrelated file, so I don't think we need to fix that as part of this PR. Can you just merge main in this case though? Hopefully the issue was already fixed on main.

[codekane]

@luacmartins - Done... Fingers Crossed.

Although I appreciate the commands to run to do so locally - that'll save me time in the future, rather than going through this process over days.

[luacmartins]

@rafecolton all yours

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/rafecolton in version: 9.1.23-1 🚀

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

[github-actions]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.23-7 🚀

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