mirror of
https://github.com/hanzoai/next.js.git
synced 2026-09-24 17:00:51 +00:00
Tim NeutkensandGitHub
8141dcf12e
### What?
Converts every test under `test/integration/` to an isolated test
running through `nextTestSetup` (under `test/e2e/`, `test/production/`,
`test/development/`, or `test/unit/`), then deletes `test/integration/`
along with the legacy CI orchestration that was specific to it.
- `test/integration/` removed entirely (~327 test suites)
- New isolated suites added across the existing folders:
- `test/e2e/` — 175
- `test/production/` — 130
- `test/development/` — 43
- `test/unit/` — 1
- `.github/workflows/build_and_test.yml` and `run-tests.js` no longer
have any `integration` branches
- `nextTestSetup` gained a `baseUrl` option on `next.browser()` so a
small number of tests that drive their own proxy/static-export server
can keep using `next.browser(...)` instead of importing `next-webdriver`
directly
### Why?
`test/integration/` predated `nextTestSetup` and ran tests directly
against the source checkout via custom helpers (`launchApp`,
`nextBuild`, `nextStart`, `runNextCommand`, `webdriver`, `fetchViaHTTP`,
…). Each suite hand-rolled its own dev/start/build orchestration,
fixture mutation, and process management.
The isolated test model used by the rest of the repo gives each suite an
isolated working directory containing a packed `next.tgz` install, a
uniform `next.start()` / `next.build()` / `next.fetch()` /
`next.browser()` API, and the same lifecycle for dev, start, and deploy
modes — so a single set of assertions covers all three. Deploy-mode
skips and per-feature gates are expressed declaratively
(`skipDeployment`, `disableAutoSkewProtection`, `if (skipped) return`)
instead of branching on `process.env`.
Removing `test/integration/` lets us:
- Delete the bespoke orchestration code in the CI workflow and
`run-tests.js`
- Run every converted suite consistently in dev, start, and deploy modes
(where applicable)
- Reproduce every test locally with the same `pnpm
test-{dev,start}-{turbo,webpack}` commands; no separate `integration`
path
- Open the door to running `test/production` against deployments in the
future (the converted suites already declare `skipDeployment` so they
can be flipped on)
### How?
Mechanical conversion per suite, with targeted clean-ups:
1. **Per-suite conversion.** Each
`test/integration/<name>/test/index.test.{js,ts}` was rewritten into a
single `<name>.test.ts` under the right folder based on what the
original exercised:
- `launchApp` / dev-only assertions → `test/development/`
- `nextBuild` + `nextStart` / start-only assertions → `test/production/`
- Both → `test/e2e/`
- The one pure jsdom render check (`link-without-router`) → `test/unit/`
2. **API mapping.** Custom helpers were replaced by `nextTestSetup`
equivalents: `launchApp` → `next.start()`, `nextBuild` → `next.build()`,
`runNextCommand` → `next.runCommand`, `fetchViaHTTP` → `next.fetch`,
`webdriver(...)` → `next.browser(...)`. Fixture mutations switched from
raw `fs.writeFile`/`fs.rename` to `next.patchFile` (with the 3-arg
`runWithTempContent` callback when the change has a defined scope) and
`next.deleteFile`.
3. **Deploy-mode handling.** Suites that can't run in deploy mode (use
`patchFile` / `next.build()` / depend on local CLI output) declare
`skipDeployment: true` and early-return on the `skipped` boolean. Suites
where Vercel's edge mutates URLs (`&dpl=`, immutable assets) declare
`disableAutoSkewProtection: true`.
4. **`next.browser({ baseUrl })`.** A handful of tests
(`prerender-export`, `cdn-cache-busting`, `preload-viewport`, both
`react-virtualized` suites) need to drive a separate server (a
static-export server or an `http-proxy` instance) rather than the
Next.js process. Instead of importing `next-webdriver` directly, those
tests now pass `{ baseUrl: <port|url> }` to `next.browser()`. For the
proxy cases, the proxy was moved into `server.js` inside the fixture and
`http-proxy` declared via the `dependencies` option of `nextTestSetup`,
so the test runs with a fully isolated dependency graph.
5. **CI clean-up.** With `test/integration` gone, the `test
integration*` jobs and `integration-tests-manifest`-related logic in
`.github/workflows/build_and_test.yml` were removed, and `run-tests.js`
no longer has the `integration` test-folder branch.
6. **Validation.** The PR was iterated against multiple full CI runs;
the remaining failures on the latest run are pre-existing flakes
(segment-cache 60s `act` timeouts in turbopack-prod) or transient
infrastructure issues unrelated to the conversion.
425 lines
12 KiB
TypeScript
425 lines
12 KiB
TypeScript
import { nextTestSetup } from 'e2e-utils'
|
|
import {
|
|
waitForRedbox,
|
|
waitForNoRedbox,
|
|
getRedboxHeader,
|
|
retry,
|
|
} from 'next-test-utils'
|
|
|
|
const reactDependencies = {
|
|
react: '19.3.0-canary-fef12a01-20260413',
|
|
'react-dom': '19.3.0-canary-fef12a01-20260413',
|
|
}
|
|
|
|
const blogIsr = `export default function Blog({ posts }) {
|
|
return posts.map(p => (<div key={p}>{p}</div>))
|
|
}
|
|
|
|
export async function getStaticProps() {
|
|
return {
|
|
props: { posts: ["my isr post"] },
|
|
revalidate: 10,
|
|
}
|
|
}`
|
|
|
|
const blogGspRevalidateFalse = `export default function Blog({ posts }) {
|
|
return posts.map(p => (<div key={p}>{p}</div>))
|
|
}
|
|
|
|
export async function getStaticProps() {
|
|
return {
|
|
props: { posts: ["my gsp post"] },
|
|
revalidate: false,
|
|
}
|
|
}`
|
|
|
|
const blogGspNoRevalidate = `export default function Blog({ posts }) {
|
|
return posts.map(p => (<div key={p}>{p}</div>))
|
|
}
|
|
|
|
export async function getStaticProps() {
|
|
return {
|
|
props: { posts: ["my gsp post"] },
|
|
}
|
|
}`
|
|
|
|
const blogGssp = `export default function Blog({ posts }) {
|
|
return posts.map(p => (<div key={p}>{p}</div>))
|
|
}
|
|
|
|
export async function getServerSideProps() {
|
|
return {
|
|
props: { posts: ["my ssr post"] },
|
|
}
|
|
}`
|
|
|
|
const postsSlug = (fallback: string) =>
|
|
`export default function Post(props) {
|
|
return <h1>Hello from {props.slug}</h1>
|
|
}
|
|
|
|
export async function getStaticPaths({ params }) {
|
|
return {
|
|
paths: [
|
|
{ params: { slug: 'one' } },
|
|
],
|
|
fallback: ${fallback},
|
|
}
|
|
}
|
|
|
|
export async function getStaticProps({ params }) {
|
|
return {
|
|
props: { slug: params.slug },
|
|
}
|
|
}`
|
|
|
|
describe('config-output-export', () => {
|
|
describe('static homepage', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
})
|
|
|
|
it('should work with static homepage', async () => {
|
|
const response = await next.fetch('/')
|
|
expect(response.status).toBe(200)
|
|
expect(await response.text()).toContain(
|
|
'<div id="__next">Hello World</div>'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('"i18n" config', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'next.config.js': `module.exports = ${JSON.stringify({
|
|
output: 'export',
|
|
i18n: { locales: ['en'], defaultLocale: 'en' },
|
|
})}`,
|
|
},
|
|
})
|
|
|
|
it('should error with "i18n" config', async () => {
|
|
await retry(async () => {
|
|
expect(next.cliOutput).toContain(
|
|
'Specified "i18n" cannot be used with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('when hasNextSupport = false', () => {
|
|
describe('"rewrites" config', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'next.config.js': `module.exports = ${JSON.stringify({
|
|
output: 'export',
|
|
rewrites: [{ source: '/from', destination: '/to' }],
|
|
})}`,
|
|
},
|
|
})
|
|
|
|
it('should error with "rewrites" config', async () => {
|
|
await retry(async () => {
|
|
expect(next.cliOutput).toContain(
|
|
'Specified "rewrites" will not automatically work with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('"redirects" config', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'next.config.js': `module.exports = ${JSON.stringify({
|
|
output: 'export',
|
|
redirects: [
|
|
{ source: '/from', destination: '/to', permanent: true },
|
|
],
|
|
})}`,
|
|
},
|
|
})
|
|
|
|
it('should error with "redirects" config', async () => {
|
|
await retry(async () => {
|
|
expect(next.cliOutput).toContain(
|
|
'Specified "redirects" will not automatically work with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('"headers" config', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'next.config.js': `module.exports = ${JSON.stringify({
|
|
output: 'export',
|
|
headers: [
|
|
{
|
|
source: '/foo',
|
|
headers: [{ key: 'x-foo', value: 'val' }],
|
|
},
|
|
],
|
|
})}`,
|
|
},
|
|
})
|
|
|
|
it('should error with "headers" config', async () => {
|
|
await retry(async () => {
|
|
expect(next.cliOutput).toContain(
|
|
'Specified "headers" will not automatically work with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('api routes function', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'pages/api/wow.js': 'export default (_, res) => res.end("wow")',
|
|
},
|
|
})
|
|
|
|
it('should error with api routes function', async () => {
|
|
const response = await next.fetch('/api/wow')
|
|
expect(response.status).toBe(404)
|
|
await retry(async () => {
|
|
expect(next.cliOutput).toContain(
|
|
'API Routes cannot be used with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('middleware function', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'middleware.js':
|
|
'export function middleware(req) { console.log("[mw]",request.url) }',
|
|
},
|
|
})
|
|
|
|
it('should error with middleware function', async () => {
|
|
const response = await next.fetch('/api/mw')
|
|
expect(response.status).toBe(404)
|
|
expect(next.cliOutput).not.toContain('[mw]')
|
|
await retry(async () => {
|
|
expect(next.cliOutput).toContain(
|
|
'Middleware cannot be used with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('getStaticProps with revalidate 10 (ISR)', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'pages/blog.js': blogIsr,
|
|
},
|
|
})
|
|
|
|
it('should error with getStaticProps and revalidate 10 seconds (ISR)', async () => {
|
|
const browser = await next.browser('/blog')
|
|
await waitForRedbox(browser)
|
|
expect(await getRedboxHeader(browser)).toContain(
|
|
'ISR cannot be used with "output: export".'
|
|
)
|
|
expect(next.cliOutput).toContain(
|
|
'ISR cannot be used with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('getStaticProps with revalidate false', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'pages/blog.js': blogGspRevalidateFalse,
|
|
},
|
|
})
|
|
|
|
it('should work with getStaticProps and revalidate false', async () => {
|
|
const browser = await next.browser('/blog')
|
|
await waitForNoRedbox(browser)
|
|
})
|
|
})
|
|
|
|
describe('getStaticProps without revalidate', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'pages/blog.js': blogGspNoRevalidate,
|
|
},
|
|
})
|
|
|
|
it('should work with getStaticProps and without revalidate', async () => {
|
|
const browser = await next.browser('/blog')
|
|
await waitForNoRedbox(browser)
|
|
})
|
|
})
|
|
|
|
describe('getServerSideProps', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'pages/blog.js': blogGssp,
|
|
},
|
|
})
|
|
|
|
it('should error with getServerSideProps without fallback', async () => {
|
|
const browser = await next.browser('/blog')
|
|
await waitForRedbox(browser)
|
|
expect(await getRedboxHeader(browser)).toContain(
|
|
'getServerSideProps cannot be used with "output: export".'
|
|
)
|
|
expect(next.cliOutput).toContain(
|
|
'getServerSideProps cannot be used with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('getStaticPaths with fallback true', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'pages/posts/[slug].js': postsSlug('true'),
|
|
},
|
|
})
|
|
|
|
it('should error with getStaticPaths and fallback true', async () => {
|
|
const browser = await next.browser('/posts/one')
|
|
await waitForRedbox(browser)
|
|
expect(await getRedboxHeader(browser)).toContain(
|
|
'getStaticPaths with "fallback: true" cannot be used with "output: export".'
|
|
)
|
|
expect(next.cliOutput).toContain(
|
|
'getStaticPaths with "fallback: true" cannot be used with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('getStaticPaths with fallback blocking', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'pages/posts/[slug].js': postsSlug("'blocking'"),
|
|
},
|
|
})
|
|
|
|
it('should error with getStaticPaths and fallback blocking', async () => {
|
|
const browser = await next.browser('/posts/one')
|
|
await waitForRedbox(browser)
|
|
expect(await getRedboxHeader(browser)).toContain(
|
|
'getStaticPaths with "fallback: blocking" cannot be used with "output: export".'
|
|
)
|
|
expect(next.cliOutput).toContain(
|
|
'getStaticPaths with "fallback: blocking" cannot be used with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('getStaticPaths with fallback false', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
overrideFiles: {
|
|
'pages/posts/[slug].js': postsSlug('false'),
|
|
},
|
|
})
|
|
|
|
it('should work with getStaticPaths and fallback false', async () => {
|
|
const browser = await next.browser('/posts/one')
|
|
const h1 = await browser.elementByCss('h1')
|
|
expect(await h1.text()).toContain('Hello from one')
|
|
await waitForNoRedbox(browser)
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('config-output-export with hasNextSupport', () => {
|
|
describe('"rewrites" config', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
env: { NOW_BUILDER: '1' },
|
|
overrideFiles: {
|
|
'next.config.js': `module.exports = ${JSON.stringify({
|
|
output: 'export',
|
|
rewrites: [{ source: '/from', destination: '/to' }],
|
|
})}`,
|
|
},
|
|
})
|
|
|
|
it('should not error with "rewrites" config', async () => {
|
|
expect(next.cliOutput).not.toContain(
|
|
'Specified "rewrites" will not automatically work with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('"redirects" config', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
env: { NOW_BUILDER: '1' },
|
|
overrideFiles: {
|
|
'next.config.js': `module.exports = ${JSON.stringify({
|
|
output: 'export',
|
|
redirects: [{ source: '/from', destination: '/to', permanent: true }],
|
|
})}`,
|
|
},
|
|
})
|
|
|
|
it('should not error with "redirects" config', async () => {
|
|
expect(next.cliOutput).not.toContain(
|
|
'Specified "redirects" will not automatically work with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('"headers" config', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
dependencies: reactDependencies,
|
|
env: { NOW_BUILDER: '1' },
|
|
overrideFiles: {
|
|
'next.config.js': `module.exports = ${JSON.stringify({
|
|
output: 'export',
|
|
headers: [
|
|
{
|
|
source: '/foo',
|
|
headers: [{ key: 'x-foo', value: 'val' }],
|
|
},
|
|
],
|
|
})}`,
|
|
},
|
|
})
|
|
|
|
it('should not error with "headers" config', async () => {
|
|
expect(next.cliOutput).not.toContain(
|
|
'Specified "headers" will not automatically work with "output: export".'
|
|
)
|
|
})
|
|
})
|
|
})
|