Fix - Multilevel tags - "no longer valid" violation is shown after selecting all the tags

[FitseTLT]

Details

Fixed Issues

$ #38044
PROPOSAL: #38044 (comment)

Tests

Precondition:

• User is an employee of Collect workspaces.
• Tag requirement is toggled on.
• Upload a new set of independent multilevel tags.
• One last thing change the order of the tags (for instance push the second tag up into the first spot)

1. Go to staging.new.expensify.com
2. Go to workspace chat.
3. Create a manual request without tags.
4. Go to request details page.
5. Select all the tags.
6. Verify that no longer valid violation is not displayed

• Verify that no errors appear in the JS console

Offline tests

same

QA Steps

same

• 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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(themeColors.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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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

nativ.mp4

Android: mWeb Chrome

and.we.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.web.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

d.mp4

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

[dukenv0307]

@FitseTLT Pls use getSortedTagKeys in other places as well

[FitseTLT]

@FitseTLT Pls use getSortedTagKeys in other places as well

No other place that fits with the function. The closest is this one

App/src/libs/PolicyUtils.ts

Lines 196 to 198 in e72e186

	return Object.values(policyTagList)
	.filter((policyTagListValue) => policyTagListValue !== null)
	.sort((tagA, tagB) => tagA.orderWeight - tagB.orderWeight);

But it is taking a policy object and returning ordered policy array.

[dukenv0307]

@FitseTLT I believe we need to update other places as well. You can search const policyTagKeys = to find them. If not we can face with the following bug:

Screen.Recording.2024-03-25.at.22.26.19.mov

[dukenv0307]

will review in a few hours

[dukenv0307]

@FitseTLT What about that place

App/src/libs/Violations/ViolationsUtils.ts

Lines 19 to 20 in 9d9757f

	const policyTagKeys = Object.keys(policyTagList);
	const policyTagListName = policyTagKeys[0];

We're getting the first tag key, so I think it should be sorted

We also need to sort policyTagKeys here

App/src/libs/ModifiedExpenseMessage.ts

Line 197 in 9d9757f

Object.keys(policyTags).forEach((policyTagKey, index) => {

to preserve the sort order

[FitseTLT]

First one is a single level tag no need for sorting
Second place also not necessary the logic BTW policyTagKey is unused variable. and the loop is there only to find the tag that has changed. So as the ordering exists in getTagListName

App/src/libs/PolicyUtils.ts

Lines 189 to 190 in 9012606

	const policyTagKeys = getSortedTagKeys(policyTagList ?? {});
	const policyTagKey = policyTagKeys[tagIndex] ?? '';

It gets the right tag name ,and the other place it uses the index is on splittedTag splittedOldTag which are also ordered.

[FitseTLT]

For the second one you pointed I have applied it for logic clarity but it wasn't necessary as I explained it ^

[dukenv0307]

For the second one you pointed I have applied it for logic clarity but it wasn't necessary as I explained it ^

@FitseTLT Thanks for your explanation, I didn't realize that policyTagKey is unused variable. Our target is to get the value, but I don't know why we have to do that logic below while we can get the value directly

App/src/libs/ModifiedExpenseMessage.ts

Line 198 in 9d9757f

const policyTagListName = PolicyUtils.getTagListName(policyTags, index) || localizedTagListName;

Even though you fixed the order problem, it seems redundant to me since we have to sort the tagKeys 2 times and there's a unused variable. Here's my suggestion

        PolicyUtils.getSortedTagKeys(policyTags).forEach((policyTagKey, index) => {
            const policyTagListName = policyTags[policyTagKey].name || localizedTagListName

[dukenv0307]

There's only one point that needs to improve. The rest looks good to me

[FitseTLT]

U can proceed

[dukenv0307]

code looks good, starting to record videos now

[dukenv0307]

@FitseTLT Pls update Offline test and QA tests. We can simply add Same as above

[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

web-resize.mp4

Android: mWeb Chrome

web-resize.mp4

iOS: Native

web-resize.mp4

iOS: mWeb Safari

web-resize.mp4

MacOS: Chrome / Safari

web-resize.mp4

MacOS: Desktop

web-resize.mp4

[dukenv0307]

@FitseTLT Pls ping/tag C+ whenever you need to review again. Thanks

[JmillsExpensify]

@cead22 You're up when you get a chance!

[cead22]

Why this change?

[FitseTLT]

I got another bug and fixed. spreading tag means every letter in the tag will be included in the list that's why recently used tags now doesn't work BTW.

[melvin-bot]

@cead22 looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

[cead22]

This is the second time this has happened to me this week, so I think we may have a bug and maybe we should mark approveAndMerge as passed, and not as skipped. All the checks than ran passed, and this is not an emergency change

[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/cead22 in version: 1.4.59-0 🚀

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

[OSBotify]

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

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