61f56f997c
Some checks failed
Test examples / Test Examples (20) (push) Has been cancelled
Test examples / Test Examples (22) (push) Has been cancelled
Lock Threads / action (push) Has been cancelled
Trigger Release / start (push) Has been cancelled
Stale issue handler / stale (push) Has been cancelled
Update Font Data / create-pull-request (push) Has been cancelled
build-and-deploy / deploy-target (push) Has been cancelled
build-and-deploy / build (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / build-wasm (nodejs) (push) Has been cancelled
build-and-deploy / build-wasm (web) (push) Has been cancelled
build-and-deploy / Deploy preview tarball (push) Has been cancelled
build-and-deploy / Potentially publish release (push) Has been cancelled
build-and-deploy / publish-turbopack-npm-packages (push) Has been cancelled
build-and-deploy / Deploy examples (push) Has been cancelled
build-and-deploy / thank you, build (push) Has been cancelled
build-and-deploy / Upload Turbopack Bytesize metrics to Datadog (push) Has been cancelled
Rspack Next.js development integration tests / Rspack integration tests (push) Has been cancelled
Rspack Next.js production integration tests / Rspack integration tests (push) Has been cancelled
Turbopack Next.js development integration tests / Next.js integration tests (push) Has been cancelled
Turbopack Next.js production integration tests / Next.js integration tests (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack development test manifest (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack production test manifest (push) Has been cancelled
Upload bundler test manifests to areweturboyet.com / Upload test results (push) Has been cancelled
Update React / create-pull-request (push) Has been cancelled
test-e2e-project-reset-cron / reset-test-project (push) Has been cancelled
Notify about the top 15 issues/PRs/feature requests (most reacted) in the last 90 days / run (push) Has been cancelled
39 lines
1.9 KiB
Markdown
39 lines
1.9 KiB
Markdown
# `swc-plugin` for Next.js Error Code Transformation
|
|
|
|
## Overview
|
|
|
|
This plugin transforms Next.js source code by:
|
|
|
|
- Rewriting `new Error` or `Error` to include an additional property: `Object.defineProperty(new Error(...), "__NEXT_ERROR_CODE", { value: $code, enumerable: false, configurable: true })`. The `enumerable: false` ensures the error code won't show up in console logs while still being accessible for telemetry. The `configurable: true` ensures 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 build` automatically updates `errors.json` if new errors are introduced.
|
|
- **Commit Reminder:** Always commit the updated `errors.json` file to avoid CI failures.
|
|
|
|
## Build Process Details
|
|
|
|
- **Two-Pass Build:**
|
|
|
|
1. **First Pass:**
|
|
- Extracts new errors and temporarily stores them in `packages/next/.errors/*.json`.
|
|
- In CI, a build with new errors will fail.
|
|
2. **Second Pass:**
|
|
- Updates `packages/next/errors.json` and reruns the build step to confirm no further new errors.
|
|
- Inspired by React's [error mapping mechanism](https://github.com/facebook/react/tree/main/scripts/error-codes).
|
|
|
|
- **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-plugin` and commit it to the repository.
|
|
- **Reason:** Pre-built artifacts simplify the build process (`pnpm build` runs without requiring `cargo`).
|
|
|
|
- **Testing:** Run `cargo test` inside the `crates/next-error-code-swc-plugin` directory to test the plugin.
|