mirror of
https://github.com/hanzoai/next.js.git
synced 2026-10-30 14:46:38 +00:00
1287f9a027
### What?
Changes Turbopack's error overlay to show specific SWC diagnostic
messages as the error title instead of generic messages like "Parsing
ecmascript source code failed" or "Ecmascript file had an error".
### Why?
Previously, all SWC parse/analysis errors in Turbopack showed a generic
title (e.g. "Parsing ecmascript source code failed") in the redbox
header, with the actual specific error message buried in the description
below the code frame. This made it harder for developers to quickly
understand what went wrong.
**Before:**
```
Parsing ecmascript source code failed
> 1 | export default () => <div/
| ^
Expected '>', got '<eof>'
```
**After:**
```
Expected '>', got '<eof>'
> 1 | export default () => <div/
| ^
Parsing ecmascript source code failed
```
### How?
**Core change** in
`turbopack/crates/turbopack-swc-utils/src/emitter.rs`:
When the `IssueEmitter` has a `self.title` set (the generic title like
"Parsing ecmascript source code failed"), the SWC diagnostic message is
now used as the issue title, and the generic title is demoted to the
description. When `self.title` is not set, the existing behavior is
preserved (first line of message becomes title, rest becomes
description).
**Test updates** across ~15 test files:
Updated all `isTurbopack` branches in test expectations to reflect the
swapped title/description. Only Turbopack-specific branches were
modified; webpack and rspack expectations are unchanged.
**New test suite** (`test/development/app-dir/ecmascript-error-title/`):
Dedicated tests verifying that both syntax errors (e.g. `Expected '>',
got '<eof>'`) and analysis errors (e.g. `the name 'Table' is defined
multiple times`) show the specific SWC message as the redbox title.
**Turbopack snapshot updates:**
4 snapshot files renamed to reflect new titles (e.g. `Parsing ecmascript
source code failed-*.txt` → `Expression expected-*.txt`).
---------
Co-authored-by: Claude <[email protected]>
140 lines
4.9 KiB
TypeScript
140 lines
4.9 KiB
TypeScript
import { nextTestSetup } from 'e2e-utils'
|
||
import {
|
||
waitForRedbox,
|
||
waitForNoRedbox,
|
||
getRedboxSource,
|
||
retry,
|
||
} from 'next-test-utils'
|
||
|
||
describe('app-dir - error-on-next-codemod-comment', () => {
|
||
const { next, isNextDev } = nextTestSetup({
|
||
files: __dirname,
|
||
skipStart: true,
|
||
skipDeployment: true,
|
||
})
|
||
|
||
if (isNextDev) {
|
||
beforeAll(async () => {
|
||
await next.start()
|
||
})
|
||
|
||
it('should error with swc if you have codemod comments left', async () => {
|
||
const browser = await next.browser('/')
|
||
|
||
await waitForRedbox(browser)
|
||
|
||
if (process.env.IS_TURBOPACK_TEST) {
|
||
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
|
||
"./app/page.tsx (2:2)
|
||
You have an unresolved @next/codemod comment "remove jsx of next line" that needs review.
|
||
After review, either remove the comment if you made the necessary changes or replace "@next-codemod-error" with "@next-codemod-ignore" to bypass the build error if no action at this line can be taken.
|
||
1 | export default function Page() {
|
||
> 2 | // @next-codemod-error remove jsx of next line
|
||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||
3 | return <p>hello world</p>
|
||
4 | }
|
||
5 |
|
||
|
||
Ecmascript file had an error"
|
||
`)
|
||
} else if (process.env.NEXT_RSPACK) {
|
||
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
|
||
"./app/page.tsx
|
||
╰─▶ × Error: x You have an unresolved @next/codemod comment "remove jsx of next line" that needs review.
|
||
│ | After review, either remove the comment if you made the necessary changes or replace "@next-codemod-error" with "@next-codemod-ignore" to bypass the build error if no action at this line can be taken.
|
||
│
|
||
│ ,-[2:1]
|
||
│ 1 | export default function Page() {
|
||
│ 2 | // @next-codemod-error remove jsx of next line
|
||
│ : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||
│ 3 | return <p>hello world</p>
|
||
│ 4 | }
|
||
│ \`----
|
||
│"
|
||
`)
|
||
} else {
|
||
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
|
||
"./app/page.tsx
|
||
Error: x You have an unresolved @next/codemod comment "remove jsx of next line" that needs review.
|
||
| After review, either remove the comment if you made the necessary changes or replace "@next-codemod-error" with "@next-codemod-ignore" to bypass the build error if no action at this line can be taken.
|
||
|
||
,-[2:1]
|
||
1 | export default function Page() {
|
||
2 | // @next-codemod-error remove jsx of next line
|
||
: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||
3 | return <p>hello world</p>
|
||
4 | }
|
||
\`----"
|
||
`)
|
||
}
|
||
})
|
||
|
||
it('should error with inline comment as well', async () => {
|
||
let originFileContent
|
||
await next.patchFile('app/page.tsx', (code) => {
|
||
originFileContent = code
|
||
return code.replace(
|
||
'// @next-codemod-error remove jsx of next line',
|
||
'/* @next-codemod-error remove jsx of next line */'
|
||
)
|
||
})
|
||
|
||
const browser = await next.browser('/')
|
||
|
||
await waitForRedbox(browser)
|
||
|
||
// Recover the original file content
|
||
await next.patchFile('app/page.tsx', originFileContent)
|
||
})
|
||
|
||
it('should disappear the error when you rre the codemod comment', async () => {
|
||
const browser = await next.browser('/')
|
||
|
||
await waitForRedbox(browser)
|
||
|
||
let originFileContent
|
||
await next.patchFile('app/page.tsx', (code) => {
|
||
originFileContent = code
|
||
return code.replace(
|
||
'// @next-codemod-error remove jsx of next line',
|
||
''
|
||
)
|
||
})
|
||
|
||
await retry(async () => {
|
||
await waitForNoRedbox(browser)
|
||
})
|
||
|
||
// Recover the original file content
|
||
await next.patchFile('app/page.tsx', originFileContent)
|
||
})
|
||
|
||
it('should disappear the error when you replace with bypass comment', async () => {
|
||
const browser = await next.browser('/')
|
||
|
||
await waitForRedbox(browser)
|
||
|
||
let originFileContent
|
||
await next.patchFile('app/page.tsx', (code) => {
|
||
originFileContent = code
|
||
return code.replace('@next-codemod-error', '@next-codemod-bypass')
|
||
})
|
||
|
||
await retry(async () => {
|
||
await waitForNoRedbox(browser)
|
||
})
|
||
|
||
// Recover the original file content
|
||
await next.patchFile('app/page.tsx', originFileContent)
|
||
})
|
||
} else {
|
||
it('should fail the build with next build', async () => {
|
||
const res = await next.build()
|
||
expect(res.exitCode).toBe(1)
|
||
expect(res.cliOutput).toContain(
|
||
'You have an unresolved @next/codemod comment "remove jsx of next line" that needs review.'
|
||
)
|
||
})
|
||
}
|
||
})
|