Fix: System message about adding tag in Parent: Child

[truph01]

Details

Fixed Issues

$ #43465
PROPOSAL: #43465 (comment)

Tests

1. Open app
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
7. System message about adding tag in Parent: Child format shows as Parent: Child, not Parent\: Child

• Verify that no errors appear in the JS console

Offline tests

QA Steps

• 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 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
    • If any non-english text was added/modified, I verified the translation was requested/reviewed 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.js 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.
• 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

Screen.Recording.2024-06-14.at.19.36.31.mov

Android: mWeb Chrome

Screen.Recording.2024-06-14.at.19.36.31.mov

iOS: Native

Screen.Recording.2024-06-14.at.19.33.50.mov

iOS: mWeb Safari

Screen.Recording.2024-06-14.at.19.35.29.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-14.at.19.27.02.mov

MacOS: Desktop

Screen.Recording.2024-06-14.at.19.32.42.mov

[melvin-bot]

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

[eh2077]

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-06-14.at.10.03.41.PM.mov

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[eh2077]

LGTM and tested well

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/43765/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/43765/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/43765/NewExpensify.dmg	https://43765.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[rlinoz]

If I create a workspace, enable tags, add a Parent: Child tag, and then go to the inbox the LHN still shows the "\", do we know why? After refreshing the "\" is gone.

[eh2077]

@rlinoz Nice catch! I can also reproduced it

@truph01 Can you help to dig into this issue as mentioned above?

[truph01]

@eh2077 I see in the screenshot #43765 (comment), the LHN displays the tag containing \ character, is it our problem, right?

[eh2077]

@eh2077 I see in the screenshot #43765 (comment), the LHN displays the tag containing \ character, is it our problem, right?

Yes, let's figure out why the backslash in LHN isn't fixed initially.

[eh2077]

@truph01 Looking forward to your updates, thanks

[truph01]

Sure. I am investigating it.

[truph01]

@eh2077

• The issue occurs when we add a new tag then, then when API is not successful, we open the LHN.

• In LHN, the LHN option is from getOptionData:
  

  App/src/components/LHNOptionsList/OptionRowLHNData.tsx

  Lines 40 to 42 in b335423

  	const optionItem = useMemo(() => {
  	// Note: ideally we'd have this as a dependent selector in onyx!
  	const item = SidebarUtils.getOptionData({

• And we use update the LHN option once the reportActions from useOnyx changes:
  

  App/src/components/LHNOptionsList/LHNOptionsList.tsx

  Line 36 in b335423

  const [reportActions] = useOnyx(ONYXKEYS.COLLECTION.REPORT_ACTIONS);

• In getOptionData, we use the reportActions data from:
  

  App/src/libs/SidebarUtils.ts

  Lines 28 to 29 in b335423

  	key: ONYXKEYS.COLLECTION.REPORT_ACTIONS,
  	callback: (actions, key) => {

• That can lead to a scenario: Assume the last message in admin room is "Hello". When we add the new tags, then go back to LHN. In here, when the reportActions from useOnyx changed, we call getOptionData. But the getOptionData still uses the stale reportActions data. Using the stale reportActions data in this case lead to this else logic:
  

  App/src/libs/SidebarUtils.ts

  Line 394 in b335423

  } else {

  
  is called instead, so it will display the report.lastMessageText, that will be something like "add the tag "parent: child ..."

[eh2077]

@truph01 Does this issue happen in offline mode? Like add a new tag in offline mode

[truph01]

@eh2077

Does this issue happen in offline mode? Like add a new tag in offline mode

No, because now, we do not have the optimistic data "add the tag "parent: child ..." when creating a new tag.

[eh2077]

@truph01 Do you have an idea to get this issue fixed based on your diagnosis above?

[truph01]

@eh2077 I think rather than using two source of reportActions, we should we only one, which is from useOnyx. But because it is a big change, so I am still considering it.

[rlinoz]

Can you point to the code you are referring to?

[truph01]

@rlinoz

• The RCA I mentioned in the comment above.
  In shortly, the lastAction in this:
  

  App/src/libs/SidebarUtils.ts

  Line 347 in b335423

  const lastAction = visibleReportActionItems[report.reportID];

  
  is wrong, lead to the wrong result.alternativeText is set. This bug occur in staging as well.

[rlinoz]

Oh, sorry I missed the scroll

[truph01]

@eh2077 @rlinoz What do you think about my comment above?

[eh2077]

I think rather than using two source of reportActions, we should we only one, which is from useOnyx.

I agreed

@eh2077 @rlinoz What do you think about my comment above?

You mean use reportActions passed by method getOptionData right? I'm not sure if reportActions is equal to visibleReportActionItems as reportActions may contains optimistic deleted actions while visibleReportActionItems doesn’t according to the comment here

App/src/libs/SidebarUtils.ts

Lines 37 to 43 in b335423

	// The report is only visible if it is the last action not deleted that
	// does not match a closed or created state.
	const reportActionsForDisplay = actionsArray.filter(
	(reportAction) => ReportActionsUtils.shouldReportActionBeVisibleAsLastAction(reportAction) && reportAction.actionName !== CONST.REPORT.ACTIONS.TYPE.CREATED,
	);
	visibleReportActionItems[reportID] = reportActionsForDisplay[reportActionsForDisplay.length - 1];

[rlinoz]

I don't understand why they are different if they are based on the same onyx key, is it a concurrency problem?

[truph01]

@rlinoz I think so

[rlinoz]

Hmmm ideally we would find a way to wait for visibleReportActionItems to be updated I think, since it looks like a nice cache to have instead of having to compute the visibleReportActionItems every time we run getOptionData

[truph01]

I am investigating this #43765 (comment)

[eh2077]

@truph01 Do you have an update on the issue?

[truph01]

@eh2077

• I still find a solution that will:

we would find a way to wait for visibleReportActionItems to be updated

• But now, after merging main, I cannot reproduce the bug anymore. Can you help confirm?

[truph01]

@eh2077 Are you able to reproduce it?

[eh2077]

I'm also not able to reproduce it on Web Chrome.

[truph01]

So what is our next step here @rlinoz? Currently, we cannot reproduce this bug.

[rlinoz]

Can't repro anymore either, let's close the PR and get the payments sorted out.

[truph01]

@rlinoz No. I mean I cannot reproduce the bug you mentioned above. The main issue can still be reproduced.

[rlinoz]

OMG, I mixed things up sorry.

[rlinoz]

I can't either, so I think we can proceed with the PR.

[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.

[OSBotify]

🚀 Deployed to staging by https://github.com/rlinoz in version: 9.0.2-0 🚀

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

[OSBotify]

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

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

[OSBotify]

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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