Skip to content

Part 3 - Fix review workspace settings onboarding task completion - #104364

Open
FitseTLT wants to merge 9 commits into
Expensify:mainfrom
FitseTLT:fix-review-workspace-settings-update-part-3
Open

FitseTLT wants to merge 9 commits into
Expensify:mainfrom
FitseTLT:fix-review-workspace-settings-update-part-3

Conversation

@FitseTLT

Copy link
Copy Markdown
Contributor

Explanation of Change

Several category-related write commands that the backend confirms complete the "Review your workspace settings" onboarding task weren't threading the optimistic completedTaskReportActionID through to their real, reachable UI entry points — some were wired to orphaned legacy pages instead, and others (category tax rate set/delete, create/rename/enable/disable/delete category) weren't wired at all, so the task's checked state only caught up after the next full sync instead of flipping immediately.

This PR wires reviewWorkspaceSettingsTaskData through each backend-confirmed function and its actual reachable entry point, draining the completion payload to {} after the first write whenever a single save fires more than one API.write call (bulk actions, multi-field rule saves), so only one optimistic completion ever fires per save.

Fixed Issues

$ #67648
PROPOSAL:

Tests

Precondition: use an account/workspace where the Concierge "Review your workspace settings" onboarding task is still outstanding (visible unchecked in the LHN/Concierge chat).

  1. Enable the Categories and Rules features on the workspace (Workspace Settings > More features) if not already enabled.
  2. Go to Workspace Settings > Categories > tap a category to open its settings page > scroll down to the "Category rules" section at the bottom > tap "+ Create new rule" (or tap an existing rule row to edit it) > choose "Require fields" > toggle "Require description" on > Save. Verify the task ticks immediately (no delay/refresh needed). With a fresh outstanding task, repeat on that same rule page for require receipts, require itemized receipts, and require attendees — verify each ticks the task.
  3. With a fresh outstanding task, set the description hint: go to the category's settings page itself and tap the "Description hint" field directly (it's its own menu item at the top, not inside "Category rules"), enter a hint, and Save. Verify the task ticks.
  4. With a fresh outstanding task, set the max amount: Category settings > Category rules > "+ Create new rule" > choose "Flag for review", set a max amount, and Save. Verify the task ticks.
  5. With a fresh outstanding task, create a new category (Workspace Settings > Categories > Add category). Verify the task ticks.
  6. With a fresh outstanding task, rename an existing category. Verify the task ticks.
  7. With a fresh outstanding task, toggle a single category enabled/disabled from its row. Verify the task ticks.
  8. With a fresh outstanding task, bulk-enable or bulk-disable multiple categories from the Categories table. Verify the task ticks exactly once (not once per category).
  9. With a fresh outstanding task, delete a single category from its settings page. Verify the task ticks.
  10. With a fresh outstanding task, bulk-delete multiple categories from the Categories table. Verify the task ticks exactly once.
  11. With a fresh outstanding task, set a category's default tax rate: Category settings > Category rules > "+ Create new rule" > choose "Apply expense defaults" (category-scoped rule creation only offers the tax-rate flow here, not the Merchant/Category picker) > pick a tax rate > Save. Verify the task ticks.
  12. With a fresh outstanding task, delete a category's tax rate rule from its rule details view: Category settings > Category rules > tap the existing tax-rate rule row > tap the trash icon in the header. Verify the task ticks.
  13. With a fresh outstanding task, bulk-delete category tax rate rules: Workspace Settings > Rules > Expense Defaults tab > select one or more category tax rules > Delete. Verify the task ticks exactly once.
  • Verify that no errors appear in the JS console

Offline tests

Same as tests.

QA Steps

Same as tests.

  • 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 verified any copy / text that was added to the app 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)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • 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)
  • 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/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 the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
2026-10-19.16-28-19.mp4

@FitseTLT
FitseTLT requested review from a team as code owners October 19, 2026 14:57
@melvin-bot
melvin-bot Bot requested review from situchan and removed request for a team October 19, 2026 14:57
@melvin-bot

melvin-bot Bot commented Oct 19, 2026

Copy link
Copy Markdown

@situchan 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 JmillsExpensify and removed request for a team October 19, 2026 14:57
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-19T15:15:20.220086Z 46a790a PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Comment thread src/libs/FlagForReviewRulesUtils.ts
Comment thread src/libs/RequireFieldsRulesUtils.ts
Comment thread src/libs/actions/Policy/Category.ts
@codecov

codecov Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/libs/actions/Policy/InlineEdit.ts 49.01% <100.00%> (+0.50%) ⬆️
...space/rules/MerchantRules/MerchantRulePageBase.tsx 63.33% <100.00%> (+0.13%) ⬆️
...quest/step/DynamicIOURequestStepCategoryCreate.tsx 0.00% <0.00%> (ø)
...ages/workspace/categories/CategorySettingsPage.tsx 0.00% <0.00%> (ø)
.../categories/DynamicCategoryDescriptionHintPage.tsx 0.00% <0.00%> (ø)
...workspace/categories/DynamicCreateCategoryPage.tsx 0.00% <0.00%> (ø)
...s/workspace/categories/DynamicEditCategoryPage.tsx 0.00% <0.00%> (ø)
...s/workspace/categories/WorkspaceCategoriesPage.tsx 75.89% <50.00%> (+0.12%) ⬆️
...s/RequireFieldsRules/RequireFieldsRulePageBase.tsx 56.49% <50.00%> (+0.24%) ⬆️
...s/FlagForReviewRules/FlagForReviewRulePageBase.tsx 76.85% <33.33%> (+0.19%) ⬆️
... and 4 more
... and 12 files with indirect coverage changes

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 46a790a5cb

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

if (activeTab === RULES_TAB.REQUIRE_FIELDS) {
for (const ruleKey of filteredSelectedRequireFieldsRuleKeys) {
deleteRequireFieldsRule(policyData, ruleKey, isVendorMatchingBetaEnabled);
deleteRequireFieldsRule(policyData, ruleKey, isVendorMatchingBetaEnabled, getReviewWorkspaceSettingsTaskCompletion());

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Reuse one completion payload across bulk rule deletes

When an outstanding Review your workspace settings task exists and multiple Require fields or Flag for review rules are selected, each loop iteration calls getReviewWorkspaceSettingsTaskCompletion(), whose hook mints a fresh report action ID on every call. Thus each delete carries a separate optimistic task completion; this produces duplicate “marked as complete” actions, and if a later delete fails its failureData can reopen the task after an earlier delete succeeded. Build the payload once for the bulk action and pass {} after the first emitted write, including the flag-for-review loop below.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is valid.

Bug: Bulk deleting Field requirements or Flag for review rules adds one "marked as complete" action per rule

Preconditions: workspace admin, Categories and Rules enabled, "Review your workspace settings" task still open, two categories each with a field requirements rule (e.g. Require description), desktop, offline.

  1. Workspaces > your workspace > Rules > Field requirements
  2. Tick both rules
  3. Click "2 selected" > Delete rules > Delete
  4. Open the "Review your workspace settings" task from Concierge

Expected: the task is checked with a single "marked as complete" action.

Actual: the task is checked with two "marked as complete" actions. The Flag for review tab behaves the same.

bug.mov

const [policyTags] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyId}`);

const policyHasTags = hasTags(policyTags);
const getReviewWorkspaceSettingsTaskCompletion = useReviewWorkspaceSettingsTaskCompletion();

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Pass completion data through inline category renames

When a category is renamed from the editable Categories table rather than its edit page, categoryRows.onRenameName still calls renameCategoryInline, and Policy/InlineEdit.ts calls renamePolicyCategory without the new completion argument. The default {} therefore drops both completedTaskReportActionID and the task Onyx updates, so an outstanding Review task does not tick immediately for that reachable rename flow. Thread this getter's payload through the inline helper as well.

Useful? React with 👍 / 👎.

} else {
// The command is per-category, so a bulk selection saves one rule for each category picked.
setPolicyCategoryTaxes(policy, categoriesToMatch, categoryTaxID);
setPolicyCategoryTaxes(policy, categoriesToMatch, categoryTaxID, getReviewWorkspaceSettingsTaskCompletion());

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Complete the review task when moving category tax rules

When an existing category tax rule is edited by changing its category, this block takes the movePolicyCategoryTax branch instead of the newly wired setPolicyCategoryTaxes branch. The move helper emits two SET_POLICY_CATEGORY_TAX writes without either the task action ID or its Onyx data, so an outstanding Review task has no optimistic completion for the move. Accept the payload in movePolicyCategoryTax and attach it only to its first write.

Useful? React with 👍 / 👎.

@JmillsExpensify JmillsExpensify left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@situchan

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 any copy / text that was added to the app 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)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • 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)
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately
    • 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
    • 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 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 the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • 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

@situchan

Copy link
Copy Markdown
Contributor

Please check above comments including #104364 (comment)

@FitseTLT

Copy link
Copy Markdown
Contributor Author

Addressed

This branch has not been deployed

No deployments
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