Skip to content

fix: force split reimbursable to policy default when field is locked - #99644

Merged
luacmartins merged 4 commits into
Expensify:mainfrom
truph01:fix/99140
Sep 1, 2026
Merged

luacmartins merged 4 commits into
Expensify:mainfrom
truph01:fix/99140

Conversation

@truph01

@truph01 truph01 commented Aug 27, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Problem: Split-seeding sites copied reimbursable unconditionally from the parent transaction, so a pre-rule parent (still reimbursable: true) leaked that value into splits even under "Always non-reimbursable", keeping the toggle visible because the value no longer matched the locked policy default.

Solution: Added getSplitReimbursable(policy, parentReimbursable) — returns policy.defaultReimbursable when the field is locked (disabledFields.reimbursable === true), else the parent value — and applied it at all four seeding sites.

Splits are now initialized to the locked default, and since that equals the policy default the existing shouldShowReimbursable gate hides the toggle automatically; unlocked modes are unchanged.

Fixed Issues

$ #99140
PROPOSAL: #99140 (comment)

Tests

Precondition: Enable Rules.

  1. Go to ND
  2. Go to workspace chat.
  3. Create an expense.
  4. Go to workspace settings > Rules.
  5. Click Cash expense default > select Always non-reimbursable.
  6. Open the expense in Step 3.
  7. Click More > Split.
  8. Open any split.
    → Verify: Reimbursable field isn't present.
  • 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
  • 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 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 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)
  • 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)
  • 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.
  • 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

MacOS: Chrome / Safari
output.mp4

@truph01
truph01 requested review from a team as code owners August 27, 2026 07:59
@melvin-bot
melvin-bot Bot requested review from hoangzinh and removed request for a team August 27, 2026 07:59
@melvin-bot

melvin-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown

@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 flaviadefaria and removed request for a team August 27, 2026 07:59
@truph01

truph01 commented Aug 27, 2026

Copy link
Copy Markdown
Contributor Author

@codex review

*
* When the policy locks the reimbursable field (`disabledFields.reimbursable === true`, i.e. one of the two
* "Always …" cash-expense modes), the split must follow the policy's `defaultReimbursable` regardless of the
* parent expense's stored value — a pre-rule expense can still carry `reimbursable: true` under an

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.

❌ CONSISTENCY-16 (docs)

This newly added JSDoc uses an em dash (—) in its own prose, which makes the comment read less like something a person wrote. Comments should use plain sentences without em dashes.

Split the clause into two sentences (and drop the em dash), for example:

 * When the policy locks the reimbursable field (`disabledFields.reimbursable === true`, i.e. one of the two
 * "Always …" cash-expense modes), the split must follow the policy's `defaultReimbursable` regardless of the
 * parent expense's stored value. A pre-rule expense can still carry `reimbursable: true` under an
 * "Always non-reimbursable" workspace. Seeding the locked default also equals the value the
 * `shouldShowReimbursable` gate compares against, so the toggle hides automatically.

Reviewed at: d59c7d0 | Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Resolved

@codecov

codecov Bot commented Aug 27, 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/IOU/SplitExpenseItems.ts 95.36% <100.00%> (+0.09%) ⬆️
src/libs/actions/SplitExpenses.ts 87.80% <ø> (ø)
... and 220 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: d59c7d0096

ℹ️ 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".

Comment on lines +81 to +82
if (policy?.disabledFields?.reimbursable === true) {
return policy.defaultReimbursable;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Preserve non-reimbursable status for managed-card splits

When a workspace uses the locked “Always reimbursable” cash-expense mode, this returns true even if the parent is a managed-card transaction. Managed-card transactions are explicitly always non-reimbursable (TransactionUtils.getReviewDuplicatesTransactionsData), and the split editor hides the reimbursable control for them, so the user cannot correct the value; SplitTransactionUpdate then submits each child using this seeded value. Pass the transaction/card context into this resolver and retain false for managed cards before applying the cash-expense policy default.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Resolved

@hoangzinh

hoangzinh commented Aug 28, 2026 •

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 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 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)
  • 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)
  • 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 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.
  • 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

Screen.Recording.2026-09-01.at.22.42.34.mov

* would be submitted as reimbursable with no way for the user to correct it.
*/
function getSplitReimbursable(policy: OnyxEntry<OnyxTypes.Policy>, parentReimbursable: boolean | undefined, transaction: OnyxEntry<OnyxTypes.Transaction>): boolean | undefined {
if (isManagedCardTransaction(transaction)) {

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.

can we add tests for this new util? getSplitReimbursable

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I added test

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

🚢

@melvin-bot
melvin-bot Bot requested a review from luacmartins September 1, 2026 15:45
Comment on lines +70 to +84
/**
* Resolve the `reimbursable` value to seed a split with.
*
* When the policy locks the reimbursable field (`disabledFields.reimbursable === true`, i.e. one of the two
* "Always …" cash-expense modes), the split must follow the policy's `defaultReimbursable` regardless of the
* parent expense's stored value. A pre-rule expense can still carry `reimbursable: true` under an
* "Always non-reimbursable" workspace. Seeding the locked default also equals the value the
* `shouldShowReimbursable` gate compares against, so the toggle hides automatically.
*
* When the field is not locked (the two "default" modes), the split keeps inheriting the parent's value.
*
* Managed-card transactions are always non-reimbursable and their reimbursable control is hidden in the split
* editor, so they must stay `false` even under a locked "Always reimbursable" policy. Otherwise the split
* would be submitted as reimbursable with no way for the user to correct it.
*/

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.

NAB this comment is very verbose. Please keep it shorter going forward.

@luacmartins
luacmartins merged commit 592fc3d into Expensify:main Sep 1, 2026
35 of 37 checks passed
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

@OSBotify

OSBotify commented Sep 1, 2026

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 OSBotify mentioned this pull request Sep 2, 2026
82 tasks done
@OSBotify

OSBotify commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.4.66-0 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 Help site changes are required. Draft PR: #100109

This PR makes a split follow the workspace's locked reimbursable value instead of inheriting a stale parent value. The user-visible result — the Reimbursable toggle disappearing from split rows — wasn't documented anywhere, so members hitting it have nothing to read.

Two articles updated:

Article Change
docs/articles/new-expensify/workspaces/Workspace-Rules.md The Cash expense default bullet only said "choose whether cash expenses are reimbursable by default" — it never named the four options or explained that the two Always modes fix the value. Expanded it to cover all four options and to state that an Always option hides the Reimbursable toggle on the expense and on every split created from it.
docs/articles/new-expensify/reports-and-expenses/Split-Expenses.md Added the FAQ entry Why don't I see the Reimbursable toggle on a split?. Also covers imported company card expenses, which your isManagedCardTransaction branch keeps non-reimbursable regardless of the rule.
How I verified the labels against the live UI

Drove NewDot on web with Rules enabled on a Control workspace:

  • The setting is Cash expense default.
  • Its four options are Reimbursable, Non-reimbursable, Always reimbursable, and Always non-reimbursable.
  • Split is reached via More > Split; the control is labeled Reimbursable.
  • With Always non-reimbursable selected, a split row showed only Description, Category, Date, and Report — no Reimbursable field.
  • With Reimbursable selected, the toggle was present on the split row.
Cash expense default options list showing Reimbursable, Non-reimbursable, Always reimbursable, and Always non-reimbursable Split row edit screen with Always non-reimbursable selected, showing no Reimbursable field Split row edit screen with Reimbursable selected, showing the Reimbursable toggle

Written against docs/HELPSITE_NAMING_CONVENTIONS.md, docs/HELP_AUTHORING_GUIDELINES.md, and docs/TEMPLATE.md.

The docs PR is a draft, labeled HelpDot, and assigned to truph01.

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


view run

@OSBotify

OSBotify commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.4.68-0 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor

Yes — help site changes are required. Draft PR: #100224

This PR changed user-visible behavior that the help site never documented: splits now take their reimbursable status from the workspace Cash expense default rule, so under Always reimbursable or Always non-reimbursable the Reimbursable toggle is hidden on every split row.

Two files updated:

File Change
docs/articles/new-expensify/workspaces/Workspace-Rules.md:37 The Cash expense default bullet named no options. Now names all four and states that the two Always … options lock the value and hide the Reimbursable toggle on the expense and its splits.
docs/articles/new-expensify/reports-and-expenses/Split-Expenses.md:75-91 New ## How the Cash expense default rule sets Reimbursable on each split section covering the unlocked case, the locked case, company card splits, and the pre-rule parent expense case this PR fixed.
Live UI verification and why these two files

I verified every label against the live web UI rather than reading them out of the code:

  • Rules tab row label and page header are both Cash expense default.
  • The four options read exactly Reimbursable, Non-reimbursable, Always reimbursable, Always non-reimbursable.
  • With the rule set to Always non-reimbursable, a split row shows only Description, Category, Date, Report — no Reimbursable field.
  • With the rule set back to plain Reimbursable, the same split row gains a Reimbursable toggle.
Cash expense default page showing the four options Split row with no Reimbursable field under Always non-reimbursable Split row showing the Reimbursable toggle under the plain Reimbursable default

No other article needed a change. The Split Expenses FAQ already answers "Will workspace rules apply to split expenses?" generically, but it did not explain the reimbursable field specifically, which is the part members would search for after the toggle disappears. Workspace-Merchant-Rules.md covers per-merchant reimbursable status, which this PR does not touch. Both edits follow HELPSITE_NAMING_CONVENTIONS.md, HELP_AUTHORING_GUIDELINES.md, and TEMPLATE.md — task-based ## heading, no ###, bolded UI-exact labels, relative cross-link, and a non-rendered screenshot placeholder.

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


view run

@OSBotify

OSBotify commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.4.68-1 🚀

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

Bundle Size Analysis (Sentry):

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.

6 participants