fix(search): tag names with colon showed \: instead of :

[jaydamani]

Explanation of Change

Add tag name cleaning for search router list, search header input, advanced search filters page and search filters tag page

Fixed Issues

$ #53465
PROPOSAL: #53465 (comment)

Tests

Precondition:

• Workspace has a tag in A: B format.

1. Go to staging.new.expensify.com
2. Go to workspace chat.
3. Submit an expense with A:B tag.
4. Open search router on the top right.
5. Type tag:
6. Verify that suggestion for A: B tag does not have \ before :
7. Type first few letters of the tag name
8. Verify again that suggestion for A: B tag does not have \ before :
9. Select suggestion for A: B and search
10. Verify the seach header text at top is A: B and not A\: B

• Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

• Verify that no errors appear in the JS console

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

search-tags-android.mp4

Android: mWeb Chrome

search-tags-android.mp4

iOS: Native

ios-web-search-tag.mp4

iOS: mWeb Safari

https://github.com/user-attachments/assets/8abee30b-444c-4b18-8227-708d21493f00

MacOS: Chrome / Safari

web-search-tag-name.mov

MacOS: Desktop

desktop.search-tag.mov

[jaydamani]

@luacmartins can you confirm if this is known issue,
When we search for something like category:Advertising tag:Accounting and after the search if we remove 1 of the filters then search, all the filters are cleared

Screen.Recording.2025-01-17.at.19.33.04.mp4

[luacmartins]

Not that I know of. That's a bug that we should report

[jaydamani]

Not that I know of. That's a bug that we should report

Reproduction steps:

1. Go to Reports page
2. Search for category:"Meals and Entertainment",Advertising
3. Click on search header and edit query to remove Advertising

Expected Result:

• Search query is now type:expense status:all category:"Meals and Entertainment"

Actual Result:

• Search query is cleared

Extra info:
Based on my investigation, submitSearch gets called twice for some reason and on second time the search query is blank so filter resets

[luacmartins]

Reported here

[melvin-bot]

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

[jaydamani]

@luacmartins I found another bug, this is from back-end. It is probably an issue with the OR operator.
query: type:expense status:all tag:Asia,"Project 3" category:Advertising

[ntdiary]

I have two other PRs to review first, and expect to review this PR in about 14 hours. :)

[ntdiary]

When navigating to the search page, the double quotes are missing, which might have potential implications for other parsing processes.

test.mp4

Overall, LGTM, with just one small change left. I personally lean toward not using escapeTagName for displaying tags. However, if you all feel it's unnecessary, we can ignore it. :)

[ntdiary]

Suggested change

	.map(getCleanedTagName)
	.filter((tag) => tag.toLowerCase().includes(autocompleteValue.toLowerCase()) && !alreadyAutocompletedKeys.includes(tag.toLowerCase()))
	.filter((tag) => getCleanedTagName(tag).toLowerCase().includes(autocompleteValue.toLowerCase()) && !alreadyAutocompletedKeys.includes(getCleanedTagName(tag).toLowerCase()))

[luacmartins]

@jaydamani let's address @ntdiary's comments

[jaydamani]

When navigating to the search page, the double quotes are missing, which might have potential implications for other parsing processes.

looking into this

I personally lean toward not using escapeTagName for displaying tags. However, if you all feel it's unnecessary, we can ignore it. :)

I also don't have any strong opinion related to this. Let's go with your changes

[jaydamani]

When navigating to the search page, the double quotes are missing, which might have potential implications for other parsing processes.
I have identified the root cause, the autocompleteParser correctly returns filter values without quotes but due to this, when we added autocompleteId for tags it is added without quotes and when we submit the query, it is substituted by getQueryWithSubstitutions without quotes.

This did not affect other filters because the substituted value for other filters is some form of ID which never has spaces.

We can solve this by sanitizing it here which will add double quotes when tag name has spaces
edit: we will also need to update here

  autocompleteID: sanitizeSearchValue(tagName),

Is this solution okay or should we try to fix this in getQueryWithSubstitutions?
cc: @ntdiary @luacmartins

[jaydamani]

should we try to fix this in getQueryWithSubstitutions?

After more testing, this might be a better solution
we need to update here:
https://github.com/jaydamani/App/blob/7942043354f870fc827d23a9ae7e0911de4b7bf5/src/components/Search/SearchRouter/getQueryWithSubstitutions.ts#L33-L43

Udpated:

            substitutionEntry = sanitizeSearchValue(substitutionEntry) // add this line for sanitization
      
            // generate new query but substituting "user-typed" value with the entity id/email from substitutions
            resultQuery = resultQuery.slice(0, substitutionStart) + substitutionEntry + changedQuery.slice(substitutionEnd);
            lengthDiff = lengthDiff + substitutionEntry.length - range.length;

[luacmartins]

Yea I think updating it in getQueryWithSubstitutions might be a better idea

[ntdiary]

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

55360-android-native.mp4

Android: mWeb Chrome

55360-android-chrome.mp4

iOS: Native

55360-ios-native.mp4

iOS: mWeb Safari

55360-ios-safari.mp4

MacOS: Chrome / Safari

55360-mac-chrome.mp4

MacOS: Desktop

55360-mac-desktop.mp4

[ntdiary]

@jaydamani, Eslint check is failed, can you please fix it? I will fill the checklist soon.
BTW, the step 10 should be: Verify the seach header text at top is A: B and not A\: B. :D

[ntdiary]

Uploaded test videos and left a comment (NAB). :)

[luacmartins]

@jaydamani let's address the ESLint failure

[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/luacmartins in version: 9.0.89-0 🚀

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

[github-actions]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.89-8 🚀

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