swc-plugin for Next.js Error Code Transformation
Overview
This plugin transforms Next.js source code by:
- Rewriting
new ErrororErrorto include an additional property:Object.defineProperty(new Error(...), "__NEXT_ERROR_CODE", { value: $code, enumerable: false, configurable: true }). Theenumerable: falseensures the error code won't show up in console logs while still being accessible for telemetry. Theconfigurable: trueensures the error code can be overwritten, useful for transforming errors. - This enables anonymous error code reporting for user feedback while keeping the message private.
Error Code Mapping
- File Location:
packages/next/errors.json - Structure: Append-only, increment-based mapping of error codes to messages.
- Automation:
- Running
pnpm buildautomatically updateserrors.jsonif new errors are introduced. - Commit Reminder: Always commit the updated
errors.jsonfile to avoid CI failures.
- Running
Build Process Details
Two-Pass Build:
- First Pass:
- Extracts new errors and temporarily stores them in
packages/next/.errors/*.json. - In CI, a build with new errors will fail.
- Extracts new errors and temporarily stores them in
- Second Pass:
- Updates
packages/next/errors.jsonand reruns the build step to confirm no further new errors. - Inspired by React's error mapping mechanism.
- Updates
- First Pass:
Concurrency Handling: The two-pass system ensures reliable ordering of inserted error codes during concurrent builds.
Modifying the Plugin
WASM Rebuild Required:
- After modifying the plugin, rebuild the WASM file via
pnpm build-error-code-pluginand commit it to the repository. - Reason: Pre-built artifacts simplify the build process (
pnpm buildruns without requiringcargo).
- After modifying the plugin, rebuild the WASM file via
Testing: Run
cargo testinside thecrates/next-error-code-swc-plugindirectory to test the plugin.