[NoQA] Feature: Travel Invoicing - Release 2.2: Toggle Behavior (Enable / Disable Travel Invoicing)

[ikevin127]

Explanation of Change

UX Flow
Toggle ON (first‑time and subsequent)

• Admin toggles Travel Invoicing ON from WorkspaceTravelInvoicingSection.
• We:
  • Immediately show an inline loading state on the toggle (disabled while the request is in flight).
  • Call our Travel Invoicing action to enable the feature.
• Once the backend confirms:
  • If a settlement account for Travel Invoicing is not configured, we route into the settlement account setup flow (see 2.3).
  • If a settlement account is configured, the summary immediately appears (limit, spend, settlement account, frequency).

Toggle OFF (with pending‑balance guard + confirmation modal)

• From the active state, admin attempts to toggle Travel Invoicing OFF.
• Before doing anything else, WorkspaceTravelInvoicingSection checks a derived flag such as hasOutstandingTravelBalance(policy):
  • If hasOutstandingTravelBalance is true:
    • We keep the toggle in the ON state.
    • We do not open the confirmation modal.
    • We show a localized error explaining that Travel Invoicing cannot be turned off until the outstanding travel balance is paid (e.g., “You can’t turn off Travel Invoicing while you still have an outstanding travel balance. Please pay your balance first.”).
  • If hasOutstandingTravelBalance is false:
    • We open a confirmation modal using the standard ConfirmModal component.
    • Only if the admin confirms do we actually call the backend and change the toggle.
• Confirmation modal behavior when shown:
  • Title: “Turn off Travel Invoicing?”
  • Body: “You can’t turn off Travel Invoicing until you’ve paid off your existing balance.”
  • Primary destructive button: “Turn off”.
  • Secondary button: “Cancel”.

Data & Onyx

• The toggle’s visual state is always driven by a selector like getIsTravelInvoicingEnabled(policyID) from ONYXKEYS.COLLECTION.POLICY.
• The toggle handler itself does not mutate policy directly:
  • It calls the backend and then relies on:
    • The server updating private_expensifyCardSettings for PROGRAM_TRAVEL_US, and/or
    • A subsequent policy refresh (via an existing Policy.fetchPolicy(policyID) action) to propagate the newly enabled state into Onyx.
• Summary visibility is computed as:
  • shouldShowSummary = getIsTravelInvoicingEnabled(policyID) && hasTravelInvoicingSettlementAccount(policy)
• When the backend turns off Travel Invoicing, getIsTravelInvoicingEnabled(policyID) becomes false, so shouldShowSummary becomes false and the summary hides automatically. We do not optimistically clear private_expensifyCardSettings in the client.
• The pending‑balance guard uses a selector like hasOutstandingTravelBalance(policyID) to determine whether the OFF flow is even allowed.

Actions
New action function in src/libs/actions/TravelInvoicing.ts:

• toggleTravelInvoicing({policyID, enabled}):
  • Wraps backend command ToggleTravelInvoicing.
  • Accepts enabled: boolean (both ON and OFF go through the same function).
  • Returns a Promise.
  • On success, optionally triggers an existing Policy.fetchPolicy(policyID) or relies on the backend to push the updated policy into Onyx.
  • On failure, it shows a localized error and reverts the toggle UI to its previous state.

Components
WorkspaceTravelInvoicingSection:

• Owns the toggle’s onValueChange handler, which:
  • Checks hasOutstandingTravelBalance(policy) before attempting to toggle OFF.
  • Calls toggleTravelInvoicing({policyID, enabled}) when toggling ON or when toggling OFF is allowed.
• Maintains:
  • isSubmittingToggle to prevent double‑clicks while the request is in flight.
  • isDisableConfirmModalVisible to control rendering of the OFF confirmation modal.
• Renders <ConfirmModal> when isDisableConfirmModalVisible is true, passing:
  • title={translate('travelInvoicing.disableModalTitle')} → “Turn off Travel Invoicing?”
  • prompt={translate('travelInvoicing.disableModalBody')} → explanation text.
  • confirmText={translate('travelInvoicing.disableModalConfirm')} → “Turn off”.
  • cancelText={translate('common.cancel')}.
• Only calls toggleTravelInvoicing({policyID, enabled: false}) in the modal’s confirm handler, and only when there is no outstanding travel balance.

Testing
Component tests for WorkspaceTravelInvoicingSection:

• When the user taps the toggle from OFF to ON, toggleTravelInvoicing({policyID, enabled: true}) is called.
  • If the mock policy has no settlement account configured, after a successful mock response the component navigates into the settlement account flow.
  • If the mock policy already has a settlement account, the summary renders immediately.
• When the user attempts to toggle from ON to OFF:
  • If hasOutstandingTravelBalance(policy) is true, the toggle remains ON and a localized error/toast is shown; ConfirmModal is not rendered and toggleTravelInvoicing is not called.
  • If hasOutstandingTravelBalance(policy) is false, ConfirmModal is rendered instead of calling the action immediately.
  • Pressing “Turn off” in the modal calls toggleTravelInvoicing({policyID, enabled: false}).
  • After the mocked backend disables the feed (by updating the policy passed into the component), getIsTravelInvoicingEnabled(policyID) returns false and the summary is no longer rendered.

Fixed Issues

$ #78674
PROPOSAL:

Tests

TBD

• Verify that no errors appear in the JS console

Offline tests

TBD

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 there are no new alerts related to the canBeMissing param for useOnyx
• 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
    • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it 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 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

TBR

[melvin-bot]

Hey, I noticed you changed src/languages/en.ts in a PR from a fork. For security reasons, translations are not generated automatically for PRs from forks.

If you want to automatically generate translations for other locales, an Expensify employee will have to:

1. Look at the code and make sure there are no malicious changes.
2. Run the Generate static translations GitHub workflow. If you have write access and the K2 extension, you can simply click: [this button]

Alternatively, if you are an external contributor, you can run the translation script locally with your own OpenAI API key. To learn more, try running:

npx ts-node ./scripts/generateTranslations.ts --help

Typically, you'd want to translate only what you changed by running npx ts-node ./scripts/generateTranslations.ts --compare-ref main