9a41ba9ac4
When the RSC compiler error was caused by an external package, make the error message display which import caused the error. Also don't show node_module files in the import trace. Continuation of https://github.com/vercel/next.js/pull/45484 Before ![image](https://user-images.githubusercontent.com/25056922/224032476-6811a1d5-d690-48be-9602-781f459edc70.png) After ![image](https://user-images.githubusercontent.com/25056922/224032177-2d0b2977-098f-46bd-8e30-9e6bc21b9153.png) Updates the format of the files, from `app/page.js` to `./app/page.js` to align it with other import traces. ![image](https://user-images.githubusercontent.com/25056922/224030420-1d3ff0ba-5747-4ed3-8b0b-9c4deace54ea.png) Closes NEXT-523
232 lines
6 KiB
TypeScript
232 lines
6 KiB
TypeScript
/* eslint-env jest */
|
|
import { sandbox } from './helpers'
|
|
import { createNextDescribe, FileRef } from 'e2e-utils'
|
|
import path from 'path'
|
|
|
|
createNextDescribe(
|
|
'Error Overlay invalid imports',
|
|
{
|
|
files: new FileRef(path.join(__dirname, 'fixtures', 'default-template')),
|
|
dependencies: {
|
|
react: 'latest',
|
|
'react-dom': 'latest',
|
|
'server-only': 'latest',
|
|
'client-only': 'latest',
|
|
},
|
|
skipStart: true,
|
|
},
|
|
({ next }) => {
|
|
it('should show error when using styled-jsx in server component', async () => {
|
|
const { session, cleanup } = await sandbox(
|
|
next,
|
|
new Map([
|
|
[
|
|
'app/comp1.js',
|
|
`
|
|
import { Comp2 } from './comp2'
|
|
|
|
export function Comp1() {
|
|
return <Comp2 />
|
|
}
|
|
`,
|
|
],
|
|
[
|
|
'app/comp2.js',
|
|
`
|
|
export function Comp2() {
|
|
return (
|
|
<div>
|
|
<style jsx>{\`
|
|
p {
|
|
color: red;
|
|
}
|
|
\`}</style>
|
|
</div>
|
|
)
|
|
}
|
|
|
|
`,
|
|
],
|
|
[
|
|
'app/page.js',
|
|
`'use client'
|
|
import { Comp1 } from './comp1'
|
|
|
|
export default function Page() {
|
|
return <Comp1 />
|
|
}
|
|
`,
|
|
],
|
|
])
|
|
)
|
|
|
|
const pageFile = 'app/page.js'
|
|
const content = await next.readFile(pageFile)
|
|
const withoutUseClient = content.replace("'use client'", '')
|
|
await session.patch(pageFile, withoutUseClient)
|
|
|
|
expect(await session.hasRedbox(true)).toBe(true)
|
|
expect(await session.getRedboxSource()).toMatchInlineSnapshot(`
|
|
"./app/comp2.js
|
|
'client-only' cannot be imported from a Server Component module. It should only be used from a Client Component.
|
|
|
|
The error was caused by using 'styled-jsx' in './app/comp2.js'. It only works in a Client Component but none of its parents are marked with \\"use client\\", so they're Server Components by default.
|
|
|
|
Import trace for requested module:
|
|
./app/comp2.js
|
|
./app/comp1.js
|
|
./app/page.js"
|
|
`)
|
|
|
|
await cleanup()
|
|
})
|
|
|
|
it('should show error when external package imports client-only in server component', async () => {
|
|
const { session, cleanup } = await sandbox(
|
|
next,
|
|
new Map([
|
|
[
|
|
'node_modules/client-only-package/index.js',
|
|
`
|
|
require("client-only")
|
|
`,
|
|
],
|
|
[
|
|
'node_modules/client-only-package/package.json',
|
|
`
|
|
{
|
|
"name": "client-only-package",
|
|
"main": "index.js"
|
|
}
|
|
`,
|
|
],
|
|
[
|
|
'app/comp1.js',
|
|
`
|
|
import { Comp2 } from './comp2'
|
|
|
|
export function Comp1() {
|
|
return <Comp2 />
|
|
}
|
|
`,
|
|
],
|
|
[
|
|
'app/comp2.js',
|
|
`
|
|
import "client-only-package"
|
|
export function Comp2() {
|
|
return (
|
|
<div>Hello world</div>
|
|
)
|
|
}
|
|
|
|
`,
|
|
],
|
|
[
|
|
'app/page.js',
|
|
`'use client'
|
|
import { Comp1 } from './comp1'
|
|
|
|
export default function Page() {
|
|
return <Comp1 />
|
|
}
|
|
`,
|
|
],
|
|
])
|
|
)
|
|
|
|
const pageFile = 'app/page.js'
|
|
const content = await next.readFile(pageFile)
|
|
const withoutUseClient = content.replace("'use client'", '')
|
|
await session.patch(pageFile, withoutUseClient)
|
|
|
|
expect(await session.hasRedbox(true)).toBe(true)
|
|
expect(await session.getRedboxSource()).toMatchInlineSnapshot(`
|
|
"./app/comp2.js
|
|
'client-only' cannot be imported from a Server Component module. It should only be used from a Client Component.
|
|
|
|
The error was caused by importing 'client-only-package/index.js' in './app/comp2.js'.
|
|
|
|
Import trace for requested module:
|
|
./app/comp2.js
|
|
./app/comp1.js
|
|
./app/page.js"
|
|
`)
|
|
|
|
await cleanup()
|
|
})
|
|
|
|
it('should show error when external package imports server-only in client component', async () => {
|
|
const { session, cleanup } = await sandbox(
|
|
next,
|
|
new Map([
|
|
[
|
|
'node_modules/server-only-package/index.js',
|
|
`
|
|
require("server-only")
|
|
`,
|
|
],
|
|
[
|
|
'node_modules/server-only-package/package.json',
|
|
`
|
|
{
|
|
"name": "server-only-package",
|
|
"main": "index.js"
|
|
}
|
|
`,
|
|
],
|
|
[
|
|
'app/comp1.js',
|
|
`
|
|
import { Comp2 } from './comp2'
|
|
|
|
export function Comp1() {
|
|
return <Comp2 />
|
|
}
|
|
`,
|
|
],
|
|
[
|
|
'app/comp2.js',
|
|
`
|
|
import 'server-only-package'
|
|
export function Comp2() {
|
|
return (
|
|
<div>Hello world</div>
|
|
)
|
|
}
|
|
|
|
`,
|
|
],
|
|
[
|
|
'app/page.js',
|
|
`import { Comp1 } from './comp1'
|
|
|
|
export default function Page() {
|
|
return <Comp1 />
|
|
}
|
|
`,
|
|
],
|
|
])
|
|
)
|
|
|
|
const file = 'app/page.js'
|
|
const content = await next.readFile(file)
|
|
await session.patch(file, "'use client'\n" + content)
|
|
|
|
expect(await session.hasRedbox(true)).toBe(true)
|
|
expect(await session.getRedboxSource()).toMatchInlineSnapshot(`
|
|
"./app/comp2.js
|
|
'server-only' cannot be imported from a Client Component module. It should only be used from a Server Component.
|
|
|
|
The error was caused by importing 'server-only-package/index.js' in './app/comp2.js'.
|
|
|
|
Import trace for requested module:
|
|
./app/comp2.js
|
|
./app/comp1.js
|
|
./app/page.js"
|
|
`)
|
|
|
|
await cleanup()
|
|
})
|
|
}
|
|
)
|