-
Notifications
You must be signed in to change notification settings - Fork 159
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
Open
MikitasK
wants to merge
5
commits into
callstack:main
Choose a base branch
from
MikitasK:fix/chunk-load-error-boundary
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 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 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 | ||
| --- | ||
|
|
||
| Allow chunk loading failures to reject dynamic imports without bypassing React Error Boundaries. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MikitasK hey, ChunkLoadError is not the only error that can cause this issue. For example, we encountered Module Federation errors containing a #RUNTIME-\d+ code that also crashed the app, so we added a check for them in our code as well. Could we check for and handle these errors here too?