-
Notifications
You must be signed in to change notification settings - Fork 165
fix: let error boundaries handle chunk loading failures #1440
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
dannyhw
merged 10 commits into
callstack:main
from
MikitasK:fix/chunk-load-error-boundary
Sep 13, 2026
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
a975576
fix: let chunk loading errors reject dynamic imports
MikitasK d152965
test: add federation v2 chunk loading error reproduction
MikitasK fa9b23b
Merge branch 'main' into fix/chunk-load-error-boundary
dannyhw 5b86570
revert: keep guarded require property copying unchanged
MikitasK 4b946c9
Merge branch 'main' into fix/chunk-load-error-boundary
MikitasK 93d9c08
Merge branch 'main' into fix/chunk-load-error-boundary
MikitasK a148b0a
Merge branch 'main' into fix/chunk-load-error-boundary
dannyhw bf857d1
Merge branch 'main' into fix/chunk-load-error-boundary
dannyhw 69a7612
chore: scope changeset to ChunkLoadError
dannyhw 95079b1
Merge branch 'main' into fix/chunk-load-error-boundary
dannyhw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@callstack/repack': patch | ||
| --- | ||
|
|
||
| Let `ChunkLoadError` propagate through the guarded `__webpack_require__` instead of reporting it as fatal, so a failed dynamic import (including a missing Module Federation exposed chunk) rejects the import promise and can be handled by a React Error Boundary. Other remote loading failures, such as an unreachable remote entry, are not affected by this change. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
147 changes: 147 additions & 0 deletions
147
tests/integration/src/plugins/RepackTargetPlugin.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| import { createContext, runInContext } from 'node:vm'; | ||
| import { plugins } from '@callstack/repack'; | ||
| import type { Configuration } from '@rspack/core'; | ||
| import { describe, expect, it } from 'vitest'; | ||
| import { | ||
| compile, | ||
| createCompiler, | ||
| createVirtualModulePlugin, | ||
| } from '../helpers.js'; | ||
|
|
||
| class ForceModuleFactoriesPlugin { | ||
| apply(compiler: any) { | ||
| compiler.hooks.compilation.tap( | ||
| 'ForceModuleFactoriesPlugin', | ||
| (compilation: any) => { | ||
| compilation.hooks.additionalTreeRuntimeRequirements.tap( | ||
| 'ForceModuleFactoriesPlugin', | ||
| (_chunk: unknown, runtimeRequirements: Set<string>) => { | ||
| runtimeRequirements.add(compiler.webpack.RuntimeGlobals.require); | ||
| runtimeRequirements.add( | ||
| compiler.webpack.RuntimeGlobals.moduleFactories | ||
| ); | ||
| } | ||
| ); | ||
| } | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| async function compileRuntime( | ||
| virtualModules: Record<string, string>, | ||
| entry = './index.js' | ||
| ) { | ||
| const virtualPlugin = await createVirtualModulePlugin(virtualModules); | ||
| const compiler = await createCompiler({ | ||
| context: __dirname, | ||
| mode: 'development', | ||
| devtool: false, | ||
| entry, | ||
| output: { | ||
| path: '/out', | ||
| filename: 'main.js', | ||
| }, | ||
| plugins: [ | ||
| virtualPlugin, | ||
| new ForceModuleFactoriesPlugin(), | ||
| new plugins.RepackTargetPlugin(), | ||
| ], | ||
| } satisfies Configuration); | ||
|
|
||
| return compile(compiler); | ||
| } | ||
|
|
||
| function executeBundle(code: string) { | ||
| const fatalErrors: unknown[] = []; | ||
| const context = createContext({ | ||
| ErrorUtils: { | ||
| reportFatalError(error: unknown) { | ||
| fatalErrors.push(error); | ||
| }, | ||
| }, | ||
| }); | ||
|
|
||
| runInContext(code, context); | ||
|
|
||
| return { context, fatalErrors }; | ||
| } | ||
|
|
||
| describe('RepackTargetPlugin guarded require', () => { | ||
| it('reports an uncaught startup module error as fatal', async () => { | ||
| const { code } = await compileRuntime( | ||
| { | ||
| './index.cjs': 'throw new Error("startup module failed");', | ||
| }, | ||
| './index.cjs' | ||
| ); | ||
|
|
||
| const { fatalErrors } = executeBundle(code); | ||
|
|
||
| expect(fatalErrors).toHaveLength(1); | ||
| expect(fatalErrors[0]).toMatchObject({ | ||
| name: 'Error', | ||
| message: 'startup module failed', | ||
| }); | ||
| }); | ||
|
|
||
| it('preserves optional require and regular module error behavior', async () => { | ||
| const { code } = await compileRuntime( | ||
| { | ||
| './index.cjs': ` | ||
| try { | ||
| require('./optional.cjs'); | ||
| } catch (error) { | ||
| globalThis.optionalRequireError = error.message; | ||
| } | ||
|
|
||
| globalThis.requireRegularModuleLater = function () { | ||
| return require('./regular.cjs'); | ||
| }; | ||
| `, | ||
| './optional.cjs': 'throw new Error("optional module failed");', | ||
| './regular.cjs': 'throw new Error("regular module failed");', | ||
| }, | ||
| './index.cjs' | ||
| ); | ||
|
|
||
| const { context, fatalErrors } = executeBundle(code); | ||
|
|
||
| expect(context.optionalRequireError).toBe('optional module failed'); | ||
| expect(fatalErrors).toHaveLength(0); | ||
|
|
||
| expect(context.requireRegularModuleLater()).toBeUndefined(); | ||
| expect(fatalErrors).toHaveLength(1); | ||
| expect(fatalErrors[0]).toMatchObject({ | ||
| name: 'Error', | ||
| message: 'regular module failed', | ||
| }); | ||
| }); | ||
|
|
||
| it('propagates ChunkLoadError to an asynchronous caller', async () => { | ||
| const { code } = await compileRuntime( | ||
| { | ||
| './index.cjs': ` | ||
| globalThis.importChunkLater = function () { | ||
| return Promise.resolve().then(function () { | ||
| return require('./chunk.cjs'); | ||
| }); | ||
| }; | ||
| `, | ||
| './chunk.cjs': ` | ||
| var error = new Error('Loading chunk test failed'); | ||
| error.name = 'ChunkLoadError'; | ||
| throw error; | ||
| `, | ||
| }, | ||
| './index.cjs' | ||
| ); | ||
|
|
||
| const { context, fatalErrors } = executeBundle(code); | ||
|
|
||
| await expect(context.importChunkLater()).rejects.toMatchObject({ | ||
| name: 'ChunkLoadError', | ||
| message: 'Loading chunk test failed', | ||
| }); | ||
| expect(fatalErrors).toHaveLength(0); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.