[HOLD for payment 2024-07-10] [$250] Chat - System message about adding tag in Parent: Child format shows Parent\: Child

[lanitochka17]

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: 1.4.81-4
Reproducible in staging?: Y
Reproducible in production?: Y
If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
Issue reported by: Applause - Internal Team

Issue found when executing PR #43392

Action Performed:

1. Go to URL https://staging.new.expensify.com/
2. Log with any account
3. Go to account settings -> Workspaces -> Create WS if needed
4. Enabled Tags
5. Add a tag in Parent: Child format
6. Go to #admins room and check the system message

Expected Result:

System message about adding tag in Parent: Child format shows as Parent: Child, not Parent\: Child

Actual Result:

System message about adding tag in Parent: Child format shows Parent\: Child

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Add any screenshot/video evidence

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~014a67ec2b09731f24
• Upwork Job ID: 1800543159428158713
• Last Price Increase: 2024-06-11
• Automatic offers:
• eh2077 | Reviewer | 102720454

Issue Owner

Current Issue Owner: @eh2077

[melvin-bot]

Triggered auto assignment to @sakluger (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.

[lanitochka17]

@sakluger FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

[sakluger]

FYI @lanitochka17 - GitHub was removing the \ from your comment because it's a Markdown formatting character in GH - it's an escape character used to ignore other markdown formatting (more details here).

I updated your comment to add that character back. 😄

[melvin-bot]

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

[melvin-bot]

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

[devguest07]

Proposal

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

System message about adding tag in Parent: Child format shows Parent: Child

What is the root cause of that problem?

When displaying messages inside ReportActionItemFragment and TextCommentFragment, we do not clean the tag message escaping of colons (used to create multi-level tags, e.g., "Parent: Child") in the tag name received from the backend.

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

We need to clean up the message from the colons before displaying it. This can be done at multiple levels before being displayed. One way is by editing the fragment inside ReportActionItemFragment.

App/src/pages/home/report/ReportActionItemFragment.tsx

Lines 77 to 78 in 4acd9d2

	actionName,
	fragment,

We can use if (actionName === 'POLICYCHANGELOG_ADD_TAG') to check if it's a tag message. If so, we can use the utility PolicyUtils.getCleanedTagName to return a clean tag message.

if (actionName === 'POLICYCHANGELOG_ADD_TAG') {
  tagFragment = PolicyUtils.getCleanedTagName(fragment.html); // we can use fragment.text too
}

If we have a new value, we can display it and pass it to the component TextCommentFragment.

[truph01]

Proposal

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

• System message about adding tag in Parent: Child format shows Parent: Child

What is the root cause of that problem?

• With the system message about adding tag, BE returns a message like:

{
    "actionName": "POLICYCHANGELOG_ADD_TAG",
    "message": [
        {
            "html": "added the tag \"name\\: age\" to the list \"Tag\"",
            "text": "added the tag \"name\\: age\" to the list \"Tag\""
        }
    ]
}

• And we display this message by using ReportActionItemMessage:
  

  App/src/pages/home/report/ReportActionItem.tsx

  Line 647 in 8d11d0b

  <ReportActionItemMessage

  
  that will display a message base on raw reportAction.message data.
• So that leads to the bug.

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

• We need to add an additional else logic to this:
  

  App/src/pages/home/report/ReportActionItem.tsx

  Line 638 in 8d11d0b

  } else {

 else if (action.actionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.ADD_TAG){
            children = <ReportActionItemBasicMessage message={PolicyUtils.getCleanedTagName(action.message?.[0]?.text ?? '')} />;

• Then, we add an additional else logic to this:
  

  App/src/libs/SidebarUtils.ts

  Line 378 in 8d11d0b

  } else {

else if (lastAction?.actionName === CONST.REPORT.ACTIONS.TYPE.POLICY_CHANGE_LOG.ADD_TAG) {
            result.alternateText = PolicyUtils.getCleanedTagName(lastAction?.message?.[0]?.text ?? '');

to fix the LHN issue.

What alternative solutions did you explore? (Optional)

• There are a few component where we have the same issue, for example, copy to clipboard action and we need to address them as well.