Skip to content

[NoQA] Fix missing areXEnabled defaults in new workspace optimistic Onyx data#91818

Merged
mountiny merged 1 commit into
mainfrom
mountiny/fix-missing-areXEnabled-new-workspace
May 27, 2026
Merged

[NoQA] Fix missing areXEnabled defaults in new workspace optimistic Onyx data#91818
mountiny merged 1 commit into
mainfrom
mountiny/fix-missing-areXEnabled-new-workspace

Conversation

@mountiny
Copy link
Copy Markdown
Contributor

@mountiny mountiny commented May 27, 2026

Problem

When a new workspace is created from NewDot, three areXEnabled policy properties were missing entirely from Onyx until the async Pusher update from Auth arrived:

  • arePerDiemRatesEnabled
  • areInvoicesEnabled
  • areRulesEnabled

This caused these features to appear as undefined instead of false in the client, which could cause incorrect UI behavior (e.g. a toggle appearing enabled because undefined is treated as true by some fallbacks). The bug was reported for arePerDiemRatesEnabled on fresh staging accounts.

Root Cause

buildPolicyData in Policy.ts sets most areXEnabled properties optimistically when creating a workspace, but these three were never included. The backend (getDefaultPaidPolicyContents in Generator.php) correctly stores all of them as false, and Auth's getAsOnyxUpdate queues the full policy payload to the owner's Pusher channel — but there was a window between workspace creation and the Pusher update landing where these three fields were absent from Onyx.

Fixed issues

$ #91820

Add the three missing properties with their correct false defaults to the buildPolicyData optimistic payload, matching what the API stores. The comment above this block already calls this out:

// WARNING: The data below should be kept in sync with the API so we create the policy with the correct configuration.

Testing

Added assertions to the existing creates a new workspace test in PolicyTest.ts to verify all disabled-by-default areXEnabled properties are present in the optimistic Onyx state immediately after workspace creation.

Fixed Issues

N/A

Tests

  • tests/actions/PolicyTest.tscreates a new workspace now asserts areInvoicesEnabled, areRulesEnabled, and arePerDiemRatesEnabled are false in the optimistic policy data.

QA Notes

Create a fresh workspace from NewDot on staging. Before this fix, checking Onyx state (policy_<ID>) immediately after creation would show arePerDiemRatesEnabled, areInvoicesEnabled, and areRulesEnabled as missing keys. After this fix they should all be present as false.

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/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.
  • 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: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

Made with Cursor

@mountiny mountiny requested review from a team as code owners May 27, 2026 10:10
@melvin-bot melvin-bot Bot requested review from MariaHCD and heyjennahay and removed request for a team May 27, 2026 10:10
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 27, 2026

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

@mountiny mountiny changed the title Fix missing areXEnabled defaults in new workspace optimistic Onyx data [NoQA] Fix missing areXEnabled defaults in new workspace optimistic Onyx data May 27, 2026
@mountiny mountiny requested a review from Copilot May 27, 2026 10:20
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Fixes a workspace-creation race where some areXEnabled policy flags were absent from the optimistic Onyx policy payload (showing up as undefined until the Auth/Pusher update arrives), by explicitly defaulting them to false and adding test coverage to prevent regressions.

Changes:

  • Add areInvoicesEnabled, areRulesEnabled, and arePerDiemRatesEnabled default false values to the optimistic policy data built during workspace creation.
  • Extend the existing “creates a new workspace” test to assert disabled-by-default feature flags are present and false immediately after creation.
  • Remove reimbursableTotal and unheldReimbursableTotal from the stable Report projection (they are not part of the Report Onyx type).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/libs/actions/Policy/Policy.ts Ensures missing areXEnabled keys are included in optimistic workspace policy payload with false defaults.
tests/actions/PolicyTest.ts Adds assertions validating the new defaults in optimistic Onyx state right after workspace creation.
src/selectors/Report.ts Aligns the stable report selector’s projection with the Report type by removing non-existent fields.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

New workspaces were missing areInvoicesEnabled, areRulesEnabled, and
arePerDiemRatesEnabled from their Onyx state until the async Pusher
update from Auth arrived, because buildPolicyData never included these
three properties in its optimistic payload.

Co-authored-by: Cursor <cursoragent@cursor.com>
@mountiny mountiny force-pushed the mountiny/fix-missing-areXEnabled-new-workspace branch from 41ca6f4 to 7c4ab16 Compare May 27, 2026 10:24
@mjasikowski
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
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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
MacOS: Desktop

@mountiny mountiny merged commit 6d4424f into main May 27, 2026
39 of 42 checks passed
@mountiny mountiny deleted the mountiny/fix-missing-areXEnabled-new-workspace branch May 27, 2026 11:14
@github-actions
Copy link
Copy Markdown
Contributor

🚧 @mountiny has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify
Copy link
Copy Markdown
Contributor

✋ 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
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.3.84-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor

No help site changes are required for this PR.

This is a purely internal/technical fix that adds three missing boolean defaults (areInvoicesEnabled, areRulesEnabled, arePerDiemRatesEnabled) to the optimistic Onyx data when creating a new workspace. No user-facing behavior, feature functionality, UI labels, or settings changed — the features themselves are unaffected. The fix only ensures the client-side optimistic state matches what the backend already stores.

@mountiny, please review the linked help site PR and confirm it reflects the current behavior. Then mark the linked help site PR Ready for review

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.3.86-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 cancelled 🔪

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor

I reviewed the changes in this PR. It adds three missing areXEnabled boolean defaults (areInvoicesEnabled, areRulesEnabled, arePerDiemRatesEnabled) to the optimistic Onyx payload in buildPolicyData. This is a purely internal fix that eliminates a brief undefined window between workspace creation and the Pusher update — it does not change any user-facing behavior, feature names, UI labels, or flows.

No help site changes are required.

@mountiny, no help site PR is needed for this change since it's an internal-only fix with no user-facing impact.

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.3.88-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor

No help site changes are required for this PR.

This PR adds missing false defaults for three areXEnabled properties (areInvoicesEnabled, areRulesEnabled, arePerDiemRatesEnabled) to the optimistic Onyx data during workspace creation. It's a purely internal timing fix — no user-facing behavior, UI labels, feature names, or workflows changed.

I reviewed the existing help site articles covering per diem, invoices, rules, and workspace creation, and they all remain accurate as-is.

@mountiny, please review the linked help site PR and confirm it reflects the current behavior. Then mark the linked help site PR Ready for review

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.3.88-2 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 failure ❌

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.

5 participants