Fix opening tag with colon shows not found page while opening for the first time #42381

bernhardoj · 2024-05-20T09:53:26Z

Details

When we create a tag with a colon, the BE response will escape the colon and will make the optimistic tag name mismatch with the tag name from the BE. This PR optimistically escape the colon.

Fixed Issues

$ #41083
PROPOSAL: #41083 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Go to workspace page
Enable tag in More features if not enabled yet
Create a new tag with a colon in the name
Open the tag quickly after creating it
Wait for a few seconds for the request to complete
Verify the not found page doesn't show show
Edit the tag name
Verify the tag name is updated
Repeat step 5-6

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-05-20.at.17.52.00.mov

Android: mWeb Chrome

Screen.Recording.2024-05-20.at.17.46.08.mov

iOS: Native

Screen.Recording.2024-05-20.at.17.45.24.mov

iOS: mWeb Safari

Screen.Recording.2024-05-20.at.17.43.00.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-20.at.17.37.17.mov

MacOS: Desktop

Screen.Recording.2024-05-20.at.17.40.48.mov

melvin-bot · 2024-05-20T09:53:31Z

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

DylanDylann · 2024-05-20T10:21:12Z

src/libs/PolicyUtils.ts

+ * Escape colon from tag name
+ */
+function escapeTagName(tag: string) {
+    return tag?.replaceAll(CONST.COLON, '\\:');


@bernhardoj I see there are many cases the BE replace : by \:

Can you clarify what you are trying to request?

You assume that the BE will replace : with \\: and I see there are some exceptional

@bernhardoj If you enter the tag name is a:b the BE will return a\:b and the optimistic data in your change will return a\\:b

Do you see any pattern in how the BE replaces the colon?

cc @amyevans

Ah, we need double \\ to escape the \. You can expand the object and see the name contains 2 \.

If you do 'a:b'.replaceAll(':', '\:'), nothing is changed.

DylanDylann · 2024-05-21T09:50:50Z

src/libs/actions/Policy.ts

@@ -3649,7 +3650,9 @@ function clearPolicyTagErrors(policyID: string, tagName: string) {

 function renamePolicyTag(policyID: string, policyTag: {oldName: string; newName: string}) {
    const tagListName = Object.keys(allPolicyTags?.[`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`] ?? {})[0];
-    const oldTag = allPolicyTags?.[`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`]?.[tagListName]?.tags?.[policyTag.oldName] ?? {};
+    const oldTagName = PolicyUtils.escapeTagName(policyTag.oldName);


@bernhardoj Why do we need to escape the old tag?

because we escaped the tag name when creating, It means that the old tag is escaped. Unless you want to cover tags created before this PR was merged, in this case, I think it isn't a good way

The tag name that we pass to the old name is the "cleaned" tag name.

App/src/pages/workspace/tags/EditTagPage.tsx

Line 38 in e8ae3c5

const currentTagName = PolicyUtils.getCleanedTagName(route.params.tagName);

App/src/pages/workspace/tags/EditTagPage.tsx

Line 61 in e8ae3c5

Policy.renamePolicyTag(route.params.policyID, {oldName: currentTagName, newName: values.tagName.trim()});

@bernhardoj Should we pass route.params.tagName instead of currentTagName

App/src/pages/workspace/tags/EditTagPage.tsx

Line 61 in e8ae3c5

Policy.renamePolicyTag(route.params.policyID, {oldName: currentTagName, newName: values.tagName.trim()});

I would prefer to keep it as it is. Having 2 different sources of the tag name, route.params.tagName and currentTagName makes it more confusing, IMO.

But we shouldn't make a redundant logic. Currently, we clean tag name and escape again

IMO, we only need to escape new tag

Ok, I have updated it.

DylanDylann · 2024-05-21T09:51:46Z

src/libs/actions/Policy.ts

-        oldName: policyTag.oldName,
-        newName: policyTag.newName,
+        oldName: oldTagName,
+        newName: newTagName,


A bit hesitant when changing the param but everything seems to still work well

DylanDylann · 2024-05-23T10:16:26Z

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-05-23.at.17.32.21.mov

Android: mWeb Chrome

Screen.Recording.2024-05-23.at.17.30.30.mov

iOS: Native

Screen.Recording.2024-05-23.at.17.29.58.mov

iOS: mWeb Safari

Screen.Recording.2024-05-23.at.17.28.02.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-23.at.17.25.20.mov

MacOS: Desktop

Screen.Recording.2024-05-23.at.17.26.33.mov

DylanDylann · 2024-05-23T10:38:00Z

BUG: Can't open tag with tag name including special characters (This is not related to our change, also happen on the main branch)

Screen.Recording.2024-05-23.at.17.36.24.mov

techievivek

Looks good, not merging since we are still on merge freezes and only merging/deploying emergency fixes/PRs.

techievivek · 2024-05-28T20:47:03Z

We should be able to merge this PR now, but we have some conflicts. @bernhardoj Can you please resolve the conflicts, thanks.

bernhardoj · 2024-05-29T02:53:36Z

Done

OSBotify · 2024-05-29T05:01:36Z

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

OSBotify · 2024-05-29T09:44:12Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.4.77-0 🚀

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

OSBotify · 2024-05-30T21:27:01Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

OSBotify · 2024-05-30T22:38:59Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

escape colon from tag name

4b9c913

bernhardoj requested a review from a team as a code owner May 20, 2024 09:53

melvin-bot bot requested review from DylanDylann and removed request for a team May 20, 2024 09:53

lint

e073da2

DylanDylann reviewed May 20, 2024

View reviewed changes

DylanDylann reviewed May 21, 2024

View reviewed changes

bernhardoj added 2 commits May 22, 2024 15:58

pass the escaped tag name

8b0abd5

add missing deps

aafc055

DylanDylann approved these changes May 23, 2024

View reviewed changes

melvin-bot bot requested a review from techievivek May 23, 2024 10:38

DylanDylann mentioned this pull request May 23, 2024

[Payment Due June 21] [$250] Can't open tag with tag name with % special characters #42549

Closed

6 tasks

techievivek previously approved these changes May 27, 2024

View reviewed changes

Merge branch 'main' into fix/41083-escape-colon-from-tag-name

6e97610

bernhardoj dismissed techievivek’s stale review via 6e97610 May 29, 2024 02:52

techievivek assigned bernhardoj May 29, 2024

techievivek approved these changes May 29, 2024

View reviewed changes

techievivek merged commit 1029cd3 into Expensify:main May 29, 2024
16 checks passed

github-actions bot mentioned this pull request May 29, 2024

Deploy Checklist: New Expensify 2024-05-29 #42741

Closed

melvin-bot bot mentioned this pull request May 30, 2024

[HOLD for payment 2024-06-06] [$250] Tags - Opening tag with certain text shows hhm not here while opening for the first time #41083

Closed

6 tasks

bernhardoj mentioned this pull request Jul 19, 2024

[$250] Tag - No error when creating new tag with existing name when tag name has X: Y format #45067

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix opening tag with colon shows not found page while opening for the first time #42381

Fix opening tag with colon shows not found page while opening for the first time #42381

bernhardoj commented May 20, 2024

melvin-bot bot commented May 20, 2024

DylanDylann May 20, 2024

bernhardoj May 20, 2024

DylanDylann May 20, 2024

DylanDylann May 20, 2024

DylanDylann May 20, 2024

bernhardoj May 20, 2024

DylanDylann May 21, 2024

DylanDylann May 21, 2024 •

edited

Loading

bernhardoj May 21, 2024

DylanDylann May 22, 2024

bernhardoj May 22, 2024

DylanDylann May 22, 2024 •

edited

Loading

DylanDylann May 22, 2024

bernhardoj May 22, 2024

DylanDylann May 21, 2024

DylanDylann commented May 23, 2024 •

edited

Loading

DylanDylann commented May 23, 2024 •

edited

Loading

techievivek left a comment

techievivek commented May 28, 2024

bernhardoj commented May 29, 2024

OSBotify commented May 29, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

Fix opening tag with colon shows not found page while opening for the first time #42381

Fix opening tag with colon shows not found page while opening for the first time #42381

Conversation

bernhardoj commented May 20, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 20, 2024

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

DylanDylann May 21, 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

DylanDylann May 22, 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

DylanDylann commented May 23, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

DylanDylann commented May 23, 2024 • edited Loading

techievivek left a comment

Choose a reason for hiding this comment

techievivek commented May 28, 2024

bernhardoj commented May 29, 2024

OSBotify commented May 29, 2024

OSBotify commented May 29, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

DylanDylann May 21, 2024 •

edited

Loading

DylanDylann May 22, 2024 •

edited

Loading

DylanDylann commented May 23, 2024 •

edited

Loading

DylanDylann commented May 23, 2024 •

edited

Loading