Skip to content

Fix required tags state after switching tag levels#92338

Open
nabi-ebrahimi wants to merge 2 commits into
Expensify:mainfrom
nabi-ebrahimi:fix/delete-tags-when-toggling-required-tags
Open

Fix required tags state after switching tag levels#92338
nabi-ebrahimi wants to merge 2 commits into
Expensify:mainfrom
nabi-ebrahimi:fix/delete-tags-when-toggling-required-tags

Conversation

@nabi-ebrahimi
Copy link
Copy Markdown
Contributor

@nabi-ebrahimi nabi-ebrahimi commented Jun 2, 2026

Explanation of Change

When a workspace switches between single-level and multi-level tags, the backend clears the existing tags and disables Members must tag all expenses if keeping it enabled would leave the workspace in an invalid state.

The problem is that the frontend did not reflect that backend change immediately. This created a confusing experience where the switch flow completed successfully, but the UI still showed Members must tag all expenses as enabled until the user left and revisited the workspace settings. In other words, the workspace state was valid on the backend, but the frontend temporarily showed stale information.

This PR fixes that inconsistency by updating the frontend after the tag cleanup request succeeds, so users see the correct required-tags state right away and the UI stays aligned with the backend during the tag-level switching flow.

Fixed Issues

$ #87472
PROPOSAL: #87472 (comment)

Tests

  1. Open the NewDot app.
  2. Go to Workspace Settings for a Control Workspace → Tags.
  3. Click Add tags, enter any name, and click Save.
  4. Navigate to MoreSettings, then enable Members must tag all expenses.
  5. Go to MoreImport SpreadsheetMulti-level tags.
  6. Verify the Switch Tag Levels warning modal appears, then click Switch Tag Levels.
  7. Navigate back to MoreSettings.
  8. Verify Members must tag all expenses is automatically disabled after the switch succeeds.
  9. Click Add tags, enter a tag name, and click Save.
  10. Wait for the tag change to finish and verify the Members must tag all expenses toggle update automatically.
  11. Go to More > Settings and confirm the toggle reflects the new state.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests.

QA Steps

Same as Tests.

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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
  • 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
    • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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/snabi-ebrahimi:fix/delete-tags-when-toggling-required-tagspacing/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
Screen.Recording.2026-06-02.at.10.52.27.PM.mov
Android: mWeb Chrome
screen-recorder-unlimited-2026-06-02-23-45-13.mp4
iOS: Native
Screen.Recording.2026-06-03.at.12.50.22.AM.mp4
iOS: mWeb Safari
Screen.Recording.2026-06-03.at.1.11.07.AM.mov
MacOS: Chrome / Safari
Screencast.From.2026-06-02.18-57-49.mp4

@nabi-ebrahimi
Copy link
Copy Markdown
Contributor Author

Root Cause of the Tags Toggle Regression:
The root cause is that the tags settings flow was relying on stale Onyx policy data after switching tag levels, so the UI did not pick up the updated requiresTag and areTagsEnabled state until the screen was remounted or manually refreshed.

More specifically:

  • src/pages/workspace/tags/ImportTagsOptionsPage.tsx triggers cleanPolicyTags() when the user confirms switching from single-level to multi-level tags.
  • cleanPolicyTags() was clearing requiresTag too early, before the backend finished the cleanup, which left the policy in a half-updated state during the transition.
  • src/pages/workspace/tags/WorkspaceTagsSettingsPage.tsx and src/pages/workspace/tags/TagSettingsPage.tsx were only reading from usePolicyData(policyID) and were not re-fetching tag data on focus or reconnect, so the screens could stay stuck on the old disabled state until refresh.

Solution:
The fix is to make both the backend state transition and the screen refresh explicit.

The changes are:

This keeps the normal tags flow unchanged, while ensuring the settings UI reflects the backend state without needing a hard refresh.

Fixed Demo:

Screencast.From.2026-06-02.10-47-22.mp4

@nabi-ebrahimi nabi-ebrahimi changed the title Refetch policy tags on focus to avoid stale toggle state Fix required tags state after switching tag levels Jun 2, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 2, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/libs/actions/Policy/Tag.ts 68.19% <80.00%> (+0.69%) ⬆️
src/pages/workspace/tags/ImportTagsOptionsPage.tsx 0.00% <0.00%> (ø)
src/pages/workspace/tags/TagSettingsPage.tsx 0.00% <0.00%> (ø)
...pages/workspace/tags/WorkspaceTagsSettingsPage.tsx 0.00% <0.00%> (ø)
... and 20 files with indirect coverage changes

@nabi-ebrahimi nabi-ebrahimi marked this pull request as ready for review June 2, 2026 20:43
@nabi-ebrahimi nabi-ebrahimi requested review from a team as code owners June 2, 2026 20:43
@melvin-bot melvin-bot Bot requested review from hoangzinh and joekaufmanexpensify and removed request for a team June 2, 2026 20:43
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Jun 2, 2026

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

@melvin-bot melvin-bot Bot requested review from a team and robertjchen and removed request for a team June 2, 2026 20:43
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Jun 2, 2026

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

@hoangzinh
Copy link
Copy Markdown
Contributor

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

@hoangzinh
Copy link
Copy Markdown
Contributor

@nabi-ebrahimi can you quickly explain the root cause of the previous deploy blocker? And your solution to fix it?

@nabi-ebrahimi
Copy link
Copy Markdown
Contributor Author

nabi-ebrahimi commented Jun 3, 2026

@nabi-ebrahimi can you quickly explain the root cause of the previous deploy blocker? And your solution to fix it?

@hoangzinh, thank you for taking the time to review this. I appreciate your feedback.

Root Cause of The Previous Deploy Blocker:

the tags settings screens were reading from stale Onyx policy data and did not refresh the tag state when returning from the import flow. After the tag cleanup completed, the UI still had the old requiresTag / areTagsEnabled snapshot, so the Tags toggle stayed disabled until a manual refresh remounted the screen.

Solution: keep cleanPolicyTags() updating requiresTag only on success, and add a focus/reconnect refetch via openPolicyTagsPage(policyID) in both WorkspaceTagsSettingsPage and TagSettingsPage so the screens always pick up the latest backend state.

Reproduced Deploy Blocker Demo:

Screencast.From.2026-06-03.05-41-44.mp4

Copy link
Copy Markdown
Contributor

@joekaufmanexpensify joekaufmanexpensify left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second attempt on the PR

@nabi-ebrahimi
Copy link
Copy Markdown
Contributor Author

@hoangzinh, friendly bump. thanks.

@hoangzinh
Copy link
Copy Markdown
Contributor

After the tag cleanup completed, the UI still had the old requiresTag / areTagsEnabled snapshot, so the Tags toggle stayed disabled until a manual refresh remounted the screen.

The RCA doesn't seem strong to me. Let me check

@hoangzinh
Copy link
Copy Markdown
Contributor

@robertjchen Could you help me verify the value of policy.requiredTag in the database in the following scenario?

  1. Go to a workspace and select "Tags."
  2. Add at least one tag.
  3. In "Tags Settings," enable "Members must tag all expenses"
  4. Navigate to "More" and select "Import spreadsheet" then switch to any tag level.
  5. Verify that all tags are clear.
  6. Open "Tags Settings" — the FE still displays "Members must tag all expenses" as enabled

=> @robertjchen Can you check the current value of policy.requiredTag in the database in this step?

  1. Reload the page — the FE now shows "Members must tag all expenses" as disabled.
  2. Add a new tag.
  3. Open "Tags Settings" again — the FE still shows "Members must tag all expenses" as disabled

=> @robertjchen Can you verify the current value of policy.requiredTag in the database in this step?

If in step 6, the value of policy.requiredTag in the database is disabled, and in step 9 it is enabled, then I believe there is a BE issue. After step 8, the BE should send a PusherEvent if policy.requiredTag value has changed.

Screen.Recording.2026-06-05.at.21.53.25.mov

Cc @nabi-ebrahimi, I would like to hear your thoughts too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants