mirror of
https://github.com/hanzoai/next.js.git
synced 2026-10-30 14:46:38 +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.
145 lines
4.7 KiB
TypeScript
145 lines
4.7 KiB
TypeScript
import { isNextDev, isNextStart, nextTestSetup } from 'e2e-utils'
|
|
import { join } from 'path'
|
|
import stripAnsi from 'strip-ansi'
|
|
|
|
const pagePath = 'pages/index.jsx'
|
|
const apiPath = 'pages/api/edge.js'
|
|
|
|
;(process.env.IS_TURBOPACK_TEST ? describe.skip.each : describe.each)([
|
|
{ appDir: join(__dirname, './app/src'), title: 'src/pages and API routes' },
|
|
{ appDir: join(__dirname, './app'), title: 'pages and API routes' },
|
|
])('Configurable runtime for $title', ({ appDir }) => {
|
|
if (isNextDev) {
|
|
describe('In development mode', () => {
|
|
const { next } = nextTestSetup({
|
|
files: appDir,
|
|
skipStart: true,
|
|
})
|
|
|
|
let originalPage: string
|
|
let originalApi: string
|
|
|
|
beforeAll(async () => {
|
|
originalPage = await next.readFile(pagePath)
|
|
originalApi = await next.readFile(apiPath)
|
|
})
|
|
|
|
afterEach(async () => {
|
|
await next.stop()
|
|
await next.patchFile(pagePath, originalPage)
|
|
await next.patchFile(apiPath, originalApi)
|
|
})
|
|
|
|
it('runs with no warning API route on the edge runtime', async () => {
|
|
await next.start()
|
|
const res = await next.fetch(`/api/edge`)
|
|
expect(res.status).toEqual(200)
|
|
expect(next.cliOutput).not.toInclude('error')
|
|
expect(next.cliOutput).not.toInclude('warn')
|
|
})
|
|
|
|
it('warns about API route using experimental-edge runtime', async () => {
|
|
await next.patchFile(
|
|
apiPath,
|
|
`
|
|
export default () => new Response('ok');
|
|
export const config = { runtime: 'experimental-edge' };
|
|
`
|
|
)
|
|
await next.start()
|
|
const res = await next.fetch(`/api/edge`)
|
|
expect(res.status).toEqual(200)
|
|
expect(next.cliOutput).not.toInclude('error')
|
|
expect(stripAnsi(next.cliOutput)).toInclude(
|
|
`/api/edge provided runtime 'experimental-edge'. It can be updated to 'edge' instead.`
|
|
)
|
|
})
|
|
it('warns about page using edge runtime', async () => {
|
|
await next.patchFile(
|
|
pagePath,
|
|
`
|
|
export default () => (<p>hello world</p>);
|
|
export const runtime = 'experimental-edge';
|
|
`
|
|
)
|
|
await next.start()
|
|
const res = await next.fetch(`/`)
|
|
expect(res.status).toEqual(200)
|
|
expect(next.cliOutput).not.toInclude('error')
|
|
expect(stripAnsi(next.cliOutput)).toInclude(
|
|
`You are using an experimental edge runtime, the API might change.`
|
|
)
|
|
})
|
|
|
|
it('errors about page using edge runtime', async () => {
|
|
await next.patchFile(
|
|
pagePath,
|
|
`
|
|
export default () => (<p>hello world</p>);
|
|
export const runtime = 'edge';
|
|
`
|
|
)
|
|
await next.start()
|
|
const res = await next.fetch(`/`)
|
|
expect(res.status).toEqual(200)
|
|
expect(stripAnsi(next.cliOutput)).toInclude(
|
|
`Page / provided runtime 'edge', the edge runtime for rendering is currently experimental. Use runtime 'experimental-edge' instead.`
|
|
)
|
|
expect(next.cliOutput).not.toInclude('warn')
|
|
})
|
|
})
|
|
} else if (isNextStart) {
|
|
describe('In start mode', () => {
|
|
const { next } = nextTestSetup({
|
|
files: appDir,
|
|
skipStart: true,
|
|
})
|
|
|
|
let originalPage: string
|
|
let originalApi: string
|
|
|
|
beforeAll(async () => {
|
|
originalPage = await next.readFile(pagePath)
|
|
originalApi = await next.readFile(apiPath)
|
|
})
|
|
|
|
afterEach(async () => {
|
|
await next.patchFile(pagePath, originalPage)
|
|
await next.patchFile(apiPath, originalApi)
|
|
})
|
|
|
|
it('builds with API route on the edge runtime and page on the experimental edge runtime', async () => {
|
|
await next.patchFile(
|
|
pagePath,
|
|
`
|
|
export default () => (<p>hello world</p>);
|
|
export const runtime = 'experimental-edge';
|
|
`
|
|
)
|
|
const { exitCode, cliOutput } = await next.build()
|
|
expect(exitCode).toBe(0)
|
|
expect(cliOutput).not.toContain(`error`)
|
|
expect(cliOutput).not.toContain(`warn`)
|
|
})
|
|
|
|
it('does not build with page on the edge runtime', async () => {
|
|
await next.patchFile(
|
|
pagePath,
|
|
`
|
|
export default () => (<p>hello world</p>);
|
|
export const runtime = 'edge';
|
|
`
|
|
)
|
|
const { exitCode, cliOutput } = await next.build()
|
|
expect(exitCode).toBe(1)
|
|
expect(cliOutput).not.toContain(`Build failed`)
|
|
expect(stripAnsi(cliOutput)).toContain(
|
|
`Error: Page / provided runtime 'edge', the edge runtime for rendering is currently experimental. Use runtime 'experimental-edge' instead.`
|
|
)
|
|
})
|
|
})
|
|
} else {
|
|
it.skip('no deploy tests', () => {})
|
|
}
|
|
})
|