Skip to content

Re-resolve beta overrides once the environment settles - #103188

Merged
luacmartins merged 5 commits into
Expensify:mainfrom
arekm213:arekm213/fix/beta-override-environment-race
Oct 7, 2026
Merged

luacmartins merged 5 commits into
Expensify:mainfrom
arekm213:arekm213/fix/beta-override-environment-race

Conversation

@arekm213

@arekm213 arekm213 commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Fixes a beta override being silently dropped on any Android staging cold start.

Permissions.ts kept the environment in a mutable module variable, seeded from CONFIG.ENVIRONMENT and corrected asynchronously by isProduction(). Android ships staging and production from the same binary, so that flag starts true and blocks overrides. The correction mutates a plain module variable, so React never learns about it: usePermissions memoized on [betas, betaConfiguration, betaOverrides], none of which changed.

Why the staleness was permanent. NavigationTabBar computes the beta inline on every render, so "computed once at mount" is not the mechanism. The component is React Compiler memoized and that cache is keyed on the identity of isBetaEnabled, which never changed when the flag flipped — so neither the useMemo nor the compiler cache was invalidated.

The fix deletes the module state and makes the environment explicit data:

  • canApplyBetaOverrides(environment) — new pure named export, true unless the build config and the resolved environment both say production.
  • isBetaEnabled takes environment as a required fifth parameter and applies the gate itself, so no caller can skip it.
  • usePermissions reads environment from useEnvironment(), so it lives in React state and the memo invalidates when it settles — which invalidates the compiler cache too.
  • DynamicBetaOverridesPage gates its not-found view with the same helper. The page and the behaviour could previously disagree: the page required both signals, Permissions.ts only the resolved one.

On the environment dependency. This is the same dependency array that 2a13d7d718 added and 069c7cd218 reverted over a react-hooks/exhaustive-deps "unnecessary dependency" error. It is now used inside the memo body, passed to isBetaEnabled, so it is a genuine dependency. Lint is clean.

One intentional semantic change. Requiring both signals means a build compiled as staging/qa that resolves to production now honours overrides. No App build config produces that combination, and if it ever did, a test build would start honouring overrides — the desired direction.

Tests. BetaOverridesProductionTest.ts tested the module flag and is replaced by BetaOverridesEnvironmentTest.tsx, which drives the hook through the real EnvironmentProvider with a deferred getEnvironment. It pins the behaviour rather than reproducing the original failure: against the pre-fix code the suite cannot load at all, because the old import-time isProduction() runs before the mock exists. It does guard the regression, including an assertion that isBetaEnabled's identity changes once the environment settles — a fix returning the right boolean from a stable callback would still leave the tab missing.

Fixed Issues

$ #102787
PROPOSAL:

Tests

Which builds can show this. The symptom only exists on a build compiled as production whose resolved environment is staging — an Android staging APK installed outside the Play Store, or an iOS TestFlight build. That combination is what makes CONFIG.ENVIRONMENT report production while the native beta check later reports staging. A debug build sets ENVIRONMENT=development and an ad-hoc build sets adhoc, and getEnvironment short-circuits on both before it reaches the beta checker, so neither ever enters the state where the bug exists — before or after this change.

Tested on a debug build and it behaves as expected: overrides apply immediately and clear correctly. That is the expected result either way, since the production gate is never engaged there.

Why there are no screenshots or a video. No build available to us reaches the state where the bug exists. Producing one would mean hand-building a signed productionRelease and installing it outside the Play Store. Steps 1–3 are the actual regression and need a staging build — we'd be grateful if someone with staging access could run them.

  1. On an Android staging build installed outside the Play Store, open Troubleshoot > Beta overrides and switch on a beta your account does not have — InsightsPage adds a visible tab.
  2. Verify the Insights tab appears in the footer.
  3. Force-stop the app and reopen it. Verify the tab is still there, without touching the override. Before this change it was missing while the overrides page still showed the beta as enabled.
  4. On any non-production build, toggle a beta on and verify the feature it gates appears immediately.
  5. Toggle the same beta off and verify the account value is restored and the "Overridden" badge clears.
  6. On a production build, verify Troubleshoot shows no Beta overrides row and that opening /beta-overrides by deep link shows the not-found page.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests. The environment is resolved locally.

QA Steps

Steps 4–6 only. Steps 1–3 need a staging build, which the ad-hoc build attached to this PR is not — see the note above.

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

Permissions kept the environment in a mutable module variable, seeded from
CONFIG.ENVIRONMENT and corrected asynchronously. Android ships staging and
production from the same binary, so the flag started as production and the
correction, being a plain module variable, never reached React. Every beta
check made before the native check resolved kept its answer for the session.

Replace it with canApplyBetaOverrides(environment), take the environment as a
required parameter of isBetaEnabled, and read it in usePermissions from the
environment context so the memo invalidates when it settles.
@arekm213

arekm213 commented Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

@MelvinBot review

@MelvinBot

Copy link
Copy Markdown
Contributor

Review: looks good, with one CI fix needed

The approach is sound. Making the environment an argument removes the stale module variable. Adding it to the useMemo dependencies changes the isBetaEnabled identity, which also clears the React Compiler cache in consumers like NavigationTabBar. I found no logic bugs.

Blocking:

Nit (optional):

  • The var and ?. fallback in that test guard against getEnvironment running at import time. This PR removes the only import-time caller, the module-level isProduction(). If nothing else calls it at import time, you can use a plain let and drop the eslint-disable.
What I checked
  • Callers: Only usePermissions and DynamicBetaOverridesPage call Permissions.isBetaEnabled in src/. Both pass environment. The required parameter means typecheck catches any new caller that skips it.
  • Provider order: EnvironmentProvider (src/App.tsx:119) wraps <Expensify />. None of the providers above it call usePermissions, so every consumer gets the resolved environment rather than the default production context value.
  • Startup window: The context starts as production (default.ts:6). A production-compiled build therefore ignores overrides until getEnvironment() resolves, then re-renders with them. This matches the old first-render behavior, and the new test asserts it.
  • Not-found gate: !canApplyBetaOverrides(environment) gives the same result as the old isResolvedProduction && CONFIG.ENVIRONMENT === PRODUCTION, so the page behavior is unchanged.
  • No-argument loop: usePermissions skips isBetaEnabled when it calls every default export with no arguments. Keeping canApplyBetaOverrides as a named export keeps it out of that loop. The new comment explains this.
  • CI: All checks pass except spellcheck (above) and Check independent approval (expected before review). I could not run Jest locally in this environment, so I relied on the CI test jobs, which pass.

cspell rejects the British spelling. The var was guarding against an
import-time getEnvironment call, which this change removes.
@arekm213

arekm213 commented Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

@MelvinBot review

@MelvinBot

Copy link
Copy Markdown
Contributor

Re-review: ready for human review

Both points from my last review are fixed, and all CI checks pass except Check independent approval, which needs a reviewer. I found no new issues.

  • Spelling: spellcheck passes now that the deferred comment is gone.
  • var and fallback: BetaOverridesEnvironmentTest.tsx:23-31 now uses a plain const with no fallback. If a future import calls getEnvironment() at load time, the suite throws instead of silently resolving dev.

Optional nit: Several modules call getEnvironment() or getEnvironmentURL() at load time, for example ApiUtils.ts and ReportUtils.ts. If one of them joins this suite's imports, the error will read Cannot access 'mockEnvironmentDeferred' before initialization. A one-line comment above the const saying that this error is intended would save the next person some digging.

@arekm213
arekm213 marked this pull request as ready for review October 6, 2026 14:34
@arekm213
arekm213 requested review from a team as code owners October 6, 2026 14:34
@melvin-bot
melvin-bot Bot requested review from truph01 and removed request for a team October 6, 2026 14:34
@melvin-bot

melvin-bot Bot commented Oct 6, 2026

Copy link
Copy Markdown

@truph01 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 October 6, 2026 14:34
@truph01

truph01 commented Oct 7, 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 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 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 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.
  • 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
Screen.Recording.2026-10-07.at.17.08.31.mov
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2026-10-07.at.17.07.46.mov

@luacmartins luacmartins 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

@luacmartins
luacmartins merged commit f5b2357 into Expensify:main Oct 7, 2026
42 of 44 checks passed
@OSBotify

OSBotify commented Oct 7, 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.

@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

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

@OSBotify OSBotify mentioned this pull request Oct 7, 2026
68 tasks done
@OSBotify

OSBotify commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

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

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

@MelvinBot

Copy link
Copy Markdown
Contributor

No help site update is needed. This PR fixes how beta overrides apply on internal non-production builds, and no article in docs/articles mentions Beta overrides.


view run

@OSBotify

OSBotify commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 9.5.5-2 🚀

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.

7 participants