Skip to content

[NoQA] Retry failed locale chunk loads to prevent a permanently stuck boot splash - #97491

Merged
mountiny merged 4 commits into
Expensify:mainfrom
callstack-internal:VickyStash/97309-fix-locale-chunk-load-stuck-splash
Aug 10, 2026
Merged

mountiny merged 4 commits into
Expensify:mainfrom
callstack-internal:VickyStash/97309-fix-locale-chunk-load-stuck-splash

Conversation

@VickyStash

@VickyStash VickyStash commented Jul 30, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

On web, when the locale bundle chunk fails to load (typically a stale app shell after a deploy requesting a chunk hash that no longer exists — ChunkLoadError: Loading chunk NNNN failed. (missing: …)), the app is left permanently stuck on the full-screen green boot splash:

  1. The locale bundles in IntlStore are plain dynamic imports, so unlike the lazy component chunks (covered by lazyRetry since Clear stale SW caches before reloading on ChunkLoadError #92339) a failed locale chunk rejected with nothing catching it.
  2. areTranslationsLoading stayed true forever and currentLocale was never set, so preferredLocale never resolved.
  3. The boot splash gate in Expensify.tsx requires a resolved locale (shouldInit = … && !!preferredLocale), so BootSplash.hide() was never called.
  4. Refreshing does not help: the cached shell requests the same missing chunk on every load.

Fix:

  • Extract the retry state machine from lazyRetry into a new generic retryDynamicImport (behavior unchanged for the three component call sites): first failure → plain reload; second failure that is a ChunkLoadError while online → clear service worker caches and reload; anything else → reject.
  • Route IntlStore.load through it, with retry state scoped per locale (locale:<locale>).
  • Guard sessionStorage access in the ladder: if the retry state cannot be read or written (e.g. Safari private browsing), reject instead of reloading — otherwise attempts cannot be counted and the page would reload forever.
  • Telemetry fixes so the failure is finally visible in Sentry:
    • The LocaleTranslationsLoad span used to end cleanly in .finally, reporting a failed load as a fast successful one. It now ends with failed: true on error.
    • When recovery is exhausted, the error is captured with fingerprint locale-load-failed (with the locale in extra). The splash intentionally stays up in that terminal state — with no translations in memory, any screen we could show would render raw translation keys.

Fixed Issues

$ #97309
PROPOSAL: N/A

Tests

  • Verify that no errors appear in the JS console
  1. Normal cold boot on web — app loads, splash hides, language renders correctly.
  2. Change language in Settings → Preferences — translations switch normally (each locale load now goes through the retry wrapper).

Temporary snippet in IntlStore.load — replace loaderPromise in the retryDynamicImport call:

// TEMP DEBUG - do not commit
const attemptLoad = () => {
    const failCount = Number(sessionStorage.getItem('debugLocaleFail') ?? '0');
    if (failCount > 0) {
        sessionStorage.setItem('debugLocaleFail', String(failCount - 1));
        return Promise.reject(Object.assign(new Error('Loading chunk fake failed.'), {name: CONST.CHUNK_LOAD_ERROR}));
    }
    return loaderPromise();
};

return retryDynamicImport(attemptLoad, `${LOCALE_RETRY_KEY_PREFIX}${locale}`)

Then in the browser console (clear the RETRY_LAZY_REFRESHED:locale:<locale> sessionStorage key between runs):

  • sessionStorage.setItem('debugLocaleFail', '2') + reload → must plain-reload, cache-clear-reload, then boot normally on the third attempt (recovery path).
  • sessionStorage.setItem('debugLocaleFail', '99') + reload → three attempts, then the splash stays and the error is captured to Sentry (exhausted path).
  • sessionStorage.removeItem('debugLocaleFail') → off.

Offline tests

Same, as in Tests section

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console
  1. Normal cold boot on web — app loads, splash hides, language renders correctly.
  2. Change language in Settings → Preferences — translations switch normally (each locale load now goes through the retry wrapper).

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 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 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.
  • 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
normal.mp4
send_error_to_sentry.mp4
reload.mp4

@VickyStash

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. You're on a roll.

Reviewed commit: a626ced623

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

@codecov

codecov Bot commented Jul 30, 2026 •

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/CONST/index.ts 94.81% <ø> (ø)
src/utils/lazyRetry.ts 100.00% <100.00%> (ø)
src/utils/retryDynamicImport.ts 91.66% <91.66%> (ø)
... and 9 files with indirect coverage changes

@VickyStash
VickyStash marked this pull request as ready for review July 30, 2026 17:58
@VickyStash
VickyStash requested review from a team as code owners July 30, 2026 17:58
@melvin-bot
melvin-bot Bot requested review from ZhenjaHorbach and removed request for a team July 30, 2026 17:59
@melvin-bot

melvin-bot Bot commented Jul 30, 2026

Copy link
Copy Markdown

@ZhenjaHorbach 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 July 30, 2026 17:59
@mountiny
mountiny self-requested a review July 30, 2026 18:20
@VickyStash

Copy link
Copy Markdown
Contributor Author

I'll be OOO next week (back Aug 10) 🌴
If any adjustments are needed, please ask @TMisiukiewicz so he can help to find someone

@mountiny

Copy link
Copy Markdown
Contributor

@ZhenjaHorbach can you review please

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

No product review required on this one.

@ZhenjaHorbach

Copy link
Copy Markdown
Contributor

I will start today and complete today or Monday morning!

@ZhenjaHorbach

ZhenjaHorbach commented Jul 31, 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

Android: HybridApp
2026-08-03.12.45.18.mov
Android: mWeb Chrome
2026-08-03.12.45.18.mov
iOS: HybridApp
2026-08-03.12.40.05.mov
iOS: mWeb Safari
2026-08-03.12.41.21.mov
MacOS: Chrome / Safari
2026-08-03.12.36.44.mov

@ZhenjaHorbach

Copy link
Copy Markdown
Contributor

LGTM!

@ZhenjaHorbach

Copy link
Copy Markdown
Contributor

@mountiny
I suppose we are ready to merge this PR

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

Nice this one has been quite tricky for the users, thanks for the fix!

@mountiny
mountiny merged commit 7d6d51c into Expensify:main Aug 10, 2026
35 of 36 checks passed
@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.

@IuliiaHerets

Copy link
Copy Markdown

Hi @VickyStash. Can you please explain how to test the console steps here? Or should they be tested internally?

image

cc @JmillsExpensify @mountiny

@OSBotify

Copy link
Copy Markdown
Contributor

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

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

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 No help site changes are required for this PR.

I reviewed the changes and this PR is an entirely internal, technical fix with no user-facing surface that maps to any article under App/docs/articles.

Why no docs changes are needed

The PR adds an error-recovery mechanism for failed locale bundle chunk loads. When a locale chunk 404s (typically a stale app shell after a deploy requesting a chunk hash that no longer exists), the app was left permanently stuck on the boot splash. The fix:

  • Extracts the retry state machine from lazyRetry into a new generic retryDynamicImport and routes IntlStore.load through it (retry → plain reload → cache-clear reload → reject).
  • Adds telemetry/Sentry reporting so an exhausted-recovery failure is diagnosable.

Files changed are all internal code/tests:

  • src/CONST/index.ts — new telemetry attribute constant
  • src/languages/IntlStore.ts — route locale load through the retry wrapper
  • src/utils/lazyRetry.ts / src/utils/retryDynamicImport.ts — shared retry logic
  • tests/unit/chunkLoadErrorRecoveryTest.ts — unit tests

There is no new or changed feature, setting, tab, button, workflow, or product behavior that a help site reader would need documented. Help articles cover customer-facing product functionality, and nothing here changes that.

@VickyStash — no draft help site PR was created since no documentation updates are needed. If you believe a specific article should be updated as a result of this change, let me know which one and I'll take another look.

@VickyStash

Copy link
Copy Markdown
Contributor Author

Hi @VickyStash. Can you please explain how to test the console steps here? Or should they be tested internally?

@IuliiaHerets, It's not possible to follow these steps in staging, that's why in QA steps section I've mentioned more realistic steps, try to follow them please

@mountiny mountiny changed the title Retry failed locale chunk loads to prevent a permanently stuck boot splash [NoQA] Retry failed locale chunk loads to prevent a permanently stuck boot splash Aug 11, 2026
@mountiny

Copy link
Copy Markdown
Contributor

We will monitor in quality

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 9.4.52-11 🚀

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.

8 participants