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.
301 lines
6.0 KiB
TypeScript
301 lines
6.0 KiB
TypeScript
import path from 'path'
|
|
import {
|
|
SRC_DIR_NAMES,
|
|
TemplateMode,
|
|
TemplateType,
|
|
} from '../../../../packages/create-next-app/templates'
|
|
|
|
export type ProjectSettings = {
|
|
files: string[]
|
|
deps: string[]
|
|
devDeps: string[]
|
|
}
|
|
|
|
export type ProjectSpecification = {
|
|
global: ProjectSettings
|
|
} & {
|
|
[key in TemplateType]: {
|
|
[key in TemplateMode]: ProjectSettings
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Required files for a given project template and mode.
|
|
*/
|
|
export const projectSpecification: ProjectSpecification = {
|
|
global: {
|
|
files: [
|
|
'package.json',
|
|
'eslint.config.mjs',
|
|
'node_modules/next',
|
|
'.gitignore',
|
|
],
|
|
deps: [
|
|
'next',
|
|
'react',
|
|
'react-dom',
|
|
...(process.env.NEXT_RSPACK ? ['next-rspack'] : []),
|
|
],
|
|
devDeps: ['eslint', 'eslint-config-next'],
|
|
},
|
|
default: {
|
|
js: {
|
|
files: [
|
|
'pages/index.js',
|
|
'pages/_app.js',
|
|
'pages/api/hello.js',
|
|
'jsconfig.json',
|
|
],
|
|
deps: [],
|
|
devDeps: [],
|
|
},
|
|
ts: {
|
|
files: [
|
|
'pages/index.tsx',
|
|
'pages/_app.tsx',
|
|
'pages/api/hello.ts',
|
|
'tsconfig.json',
|
|
'next-env.d.ts',
|
|
],
|
|
deps: [],
|
|
devDeps: [
|
|
'@types/node',
|
|
'@types/react',
|
|
'@types/react-dom',
|
|
'typescript',
|
|
],
|
|
},
|
|
},
|
|
'default-empty': {
|
|
js: {
|
|
files: ['pages/index.js', 'pages/_app.js', 'jsconfig.json'],
|
|
deps: [],
|
|
devDeps: [],
|
|
},
|
|
ts: {
|
|
files: [
|
|
'pages/index.tsx',
|
|
'pages/_app.tsx',
|
|
'tsconfig.json',
|
|
'next-env.d.ts',
|
|
],
|
|
deps: [],
|
|
devDeps: [
|
|
'@types/node',
|
|
'@types/react',
|
|
'@types/react-dom',
|
|
'typescript',
|
|
],
|
|
},
|
|
},
|
|
'default-tw': {
|
|
js: {
|
|
files: [
|
|
'jsconfig.json',
|
|
'pages/_app.js',
|
|
'pages/api/hello.js',
|
|
'pages/index.js',
|
|
'postcss.config.mjs',
|
|
],
|
|
deps: [],
|
|
devDeps: ['@tailwindcss/postcss', 'tailwindcss'],
|
|
},
|
|
ts: {
|
|
files: [
|
|
'next-env.d.ts',
|
|
'pages/_app.tsx',
|
|
'pages/api/hello.ts',
|
|
'pages/index.tsx',
|
|
'postcss.config.mjs',
|
|
'tsconfig.json',
|
|
],
|
|
deps: [],
|
|
devDeps: [
|
|
'@types/node',
|
|
'@types/react-dom',
|
|
'@types/react',
|
|
'@tailwindcss/postcss',
|
|
'tailwindcss',
|
|
'typescript',
|
|
],
|
|
},
|
|
},
|
|
'default-tw-empty': {
|
|
js: {
|
|
files: [
|
|
'jsconfig.json',
|
|
'pages/_app.js',
|
|
'pages/index.js',
|
|
'postcss.config.mjs',
|
|
],
|
|
deps: [],
|
|
devDeps: ['@tailwindcss/postcss', 'tailwindcss'],
|
|
},
|
|
ts: {
|
|
files: [
|
|
'next-env.d.ts',
|
|
'pages/_app.tsx',
|
|
'pages/index.tsx',
|
|
'postcss.config.mjs',
|
|
'tsconfig.json',
|
|
],
|
|
deps: [],
|
|
devDeps: [
|
|
'@types/node',
|
|
'@types/react-dom',
|
|
'@types/react',
|
|
'@tailwindcss/postcss',
|
|
'tailwindcss',
|
|
'typescript',
|
|
],
|
|
},
|
|
},
|
|
app: {
|
|
js: {
|
|
deps: [],
|
|
devDeps: [],
|
|
files: ['app/page.js', 'app/layout.js', 'jsconfig.json'],
|
|
},
|
|
ts: {
|
|
deps: [],
|
|
devDeps: [
|
|
'@types/node',
|
|
'@types/react',
|
|
'@types/react-dom',
|
|
'typescript',
|
|
],
|
|
files: [
|
|
'app/page.tsx',
|
|
'app/layout.tsx',
|
|
'tsconfig.json',
|
|
'next-env.d.ts',
|
|
],
|
|
},
|
|
},
|
|
'app-api': {
|
|
js: {
|
|
deps: ['next', ...(process.env.NEXT_RSPACK ? ['next-rspack'] : [])],
|
|
devDeps: [],
|
|
files: ['app/route.js', 'app/[slug]/route.js', 'jsconfig.json'],
|
|
},
|
|
ts: {
|
|
deps: ['next', ...(process.env.NEXT_RSPACK ? ['next-rspack'] : [])],
|
|
devDeps: ['@types/node', '@types/react', 'typescript'],
|
|
files: [
|
|
'app/route.ts',
|
|
'app/[slug]/route.ts',
|
|
'tsconfig.json',
|
|
'next-env.d.ts',
|
|
],
|
|
},
|
|
},
|
|
'app-empty': {
|
|
js: {
|
|
deps: [],
|
|
devDeps: [],
|
|
files: ['app/page.js', 'app/layout.js', 'jsconfig.json'],
|
|
},
|
|
ts: {
|
|
deps: [],
|
|
devDeps: [
|
|
'@types/node',
|
|
'@types/react',
|
|
'@types/react-dom',
|
|
'typescript',
|
|
],
|
|
files: [
|
|
'app/page.tsx',
|
|
'app/layout.tsx',
|
|
'tsconfig.json',
|
|
'next-env.d.ts',
|
|
],
|
|
},
|
|
},
|
|
'app-tw': {
|
|
js: {
|
|
deps: [],
|
|
devDeps: ['@tailwindcss/postcss', 'tailwindcss'],
|
|
files: [
|
|
'app/layout.js',
|
|
'app/page.js',
|
|
'jsconfig.json',
|
|
'postcss.config.mjs',
|
|
],
|
|
},
|
|
ts: {
|
|
deps: [],
|
|
devDeps: [
|
|
'@types/node',
|
|
'@types/react-dom',
|
|
'@types/react',
|
|
'@tailwindcss/postcss',
|
|
'tailwindcss',
|
|
'typescript',
|
|
],
|
|
files: [
|
|
'app/layout.tsx',
|
|
'app/page.tsx',
|
|
'next-env.d.ts',
|
|
'postcss.config.mjs',
|
|
'tsconfig.json',
|
|
],
|
|
},
|
|
},
|
|
'app-tw-empty': {
|
|
js: {
|
|
deps: [],
|
|
devDeps: ['@tailwindcss/postcss', 'tailwindcss'],
|
|
files: [
|
|
'app/layout.js',
|
|
'app/page.js',
|
|
'jsconfig.json',
|
|
'postcss.config.mjs',
|
|
],
|
|
},
|
|
ts: {
|
|
deps: [],
|
|
devDeps: [
|
|
'@types/node',
|
|
'@types/react-dom',
|
|
'@types/react',
|
|
'@tailwindcss/postcss',
|
|
'tailwindcss',
|
|
'typescript',
|
|
],
|
|
files: [
|
|
'app/layout.tsx',
|
|
'app/page.tsx',
|
|
'next-env.d.ts',
|
|
'postcss.config.mjs',
|
|
'tsconfig.json',
|
|
],
|
|
},
|
|
},
|
|
}
|
|
|
|
export type GetProjectSettingsArgs = {
|
|
template: TemplateType
|
|
mode: TemplateMode
|
|
setting: keyof ProjectSettings
|
|
srcDir?: boolean
|
|
}
|
|
|
|
export const mapSrcFiles = (files: string[], srcDir?: boolean) =>
|
|
files.map((file) =>
|
|
srcDir && SRC_DIR_NAMES.some((name) => file.startsWith(name))
|
|
? path.join('src', file)
|
|
: file
|
|
)
|
|
|
|
export const getProjectSetting = ({
|
|
template,
|
|
mode,
|
|
setting,
|
|
srcDir,
|
|
}: GetProjectSettingsArgs) => {
|
|
return [
|
|
...projectSpecification.global[setting],
|
|
...mapSrcFiles(projectSpecification[template][mode][setting], srcDir),
|
|
]
|
|
}
|