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.
345 lines
8.8 KiB
TypeScript
345 lines
8.8 KiB
TypeScript
import { retry } from 'next-test-utils'
|
|
import { join } from 'path'
|
|
import {
|
|
createNextApp,
|
|
projectFilesShouldExist,
|
|
resolveNextTgzFilename,
|
|
useTempDir,
|
|
} from './utils'
|
|
|
|
describe('create-next-app prompts', () => {
|
|
let nextTgzFilename: string
|
|
|
|
beforeAll(() => {
|
|
nextTgzFilename = resolveNextTgzFilename()
|
|
})
|
|
|
|
it('should prompt user for choice if directory name is absent', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'no-dir-name'
|
|
const childProcess = createNextApp(
|
|
[
|
|
'--ts',
|
|
'--app',
|
|
'--eslint',
|
|
'--no-src-dir',
|
|
'--no-tailwind',
|
|
'--no-import-alias',
|
|
'--no-react-compiler',
|
|
'--no-agents-md',
|
|
],
|
|
{
|
|
cwd,
|
|
},
|
|
nextTgzFilename
|
|
)
|
|
|
|
await new Promise<void>((resolve) => {
|
|
childProcess.on('exit', async (exitCode) => {
|
|
expect(exitCode).toBe(0)
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files: ['package.json'],
|
|
})
|
|
resolve()
|
|
})
|
|
|
|
// enter project name
|
|
childProcess.stdin.write(`${projectName}\n`)
|
|
})
|
|
|
|
const pkg = require(join(cwd, projectName, 'package.json'))
|
|
expect(pkg.name).toBe(projectName)
|
|
})
|
|
})
|
|
|
|
it('should use default for --ts when other flags are provided', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'ts-js'
|
|
const childProcess = createNextApp(
|
|
[
|
|
projectName,
|
|
'--app',
|
|
'--eslint',
|
|
'--no-tailwind',
|
|
'--no-src-dir',
|
|
'--no-import-alias',
|
|
'--no-react-compiler',
|
|
'--no-agents-md',
|
|
],
|
|
{
|
|
cwd,
|
|
},
|
|
nextTgzFilename
|
|
)
|
|
|
|
// No stdin interaction needed - defaults are used automatically
|
|
await new Promise<void>((resolve) => {
|
|
childProcess.on('exit', async (exitCode) => {
|
|
expect(exitCode).toBe(0)
|
|
// Default is TypeScript
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files: ['tsconfig.json'],
|
|
})
|
|
resolve()
|
|
})
|
|
})
|
|
})
|
|
})
|
|
|
|
it('should use default for --tailwind when other flags are provided', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'tw'
|
|
const childProcess = createNextApp(
|
|
[
|
|
projectName,
|
|
'--ts',
|
|
'--app',
|
|
'--eslint',
|
|
'--no-src-dir',
|
|
'--no-import-alias',
|
|
'--no-react-compiler',
|
|
'--no-agents-md',
|
|
],
|
|
{
|
|
cwd,
|
|
},
|
|
nextTgzFilename
|
|
)
|
|
|
|
// No stdin interaction needed - defaults are used automatically
|
|
await new Promise<void>((resolve) => {
|
|
childProcess.on('exit', async (exitCode) => {
|
|
expect(exitCode).toBe(0)
|
|
// Default is Tailwind enabled
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files: ['postcss.config.mjs'],
|
|
})
|
|
resolve()
|
|
})
|
|
})
|
|
})
|
|
})
|
|
|
|
it('should use default import alias when other flags are provided', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'import-alias'
|
|
const childProcess = createNextApp(
|
|
[
|
|
projectName,
|
|
'--ts',
|
|
'--app',
|
|
'--eslint',
|
|
'--no-tailwind',
|
|
'--no-src-dir',
|
|
'--no-react-compiler',
|
|
'--no-agents-md',
|
|
],
|
|
{
|
|
cwd,
|
|
},
|
|
nextTgzFilename
|
|
)
|
|
|
|
// No stdin interaction needed - default import alias @/* is used
|
|
await new Promise<void>((resolve) => {
|
|
childProcess.on('exit', async (exitCode) => {
|
|
expect(exitCode).toBe(0)
|
|
resolve()
|
|
})
|
|
})
|
|
|
|
const tsConfig = require(join(cwd, projectName, 'tsconfig.json'))
|
|
expect(tsConfig.compilerOptions.paths).toMatchInlineSnapshot(`
|
|
{
|
|
"@/*": [
|
|
"./*",
|
|
],
|
|
}
|
|
`)
|
|
})
|
|
})
|
|
|
|
it('should not prompt user for choice and use defaults if --yes is defined', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'yes-we-can'
|
|
const childProcess = createNextApp(
|
|
[projectName, '--yes'],
|
|
{
|
|
cwd,
|
|
},
|
|
nextTgzFilename
|
|
)
|
|
|
|
await new Promise<void>((resolve) => {
|
|
childProcess.on('exit', async (exitCode) => {
|
|
expect(exitCode).toBe(0)
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files: [
|
|
'app',
|
|
'package.json',
|
|
'postcss.config.mjs',
|
|
'tsconfig.json',
|
|
'AGENTS.md',
|
|
'CLAUDE.md',
|
|
],
|
|
})
|
|
resolve()
|
|
})
|
|
})
|
|
|
|
const pkg = require(join(cwd, projectName, 'package.json'))
|
|
expect(pkg.name).toBe(projectName)
|
|
const tsConfig = require(join(cwd, projectName, 'tsconfig.json'))
|
|
expect(tsConfig.compilerOptions.paths).toMatchInlineSnapshot(`
|
|
{
|
|
"@/*": [
|
|
"./*",
|
|
],
|
|
}
|
|
`)
|
|
})
|
|
})
|
|
|
|
it('should use recommended defaults when user selects that option', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const projectName = 'recommended-defaults'
|
|
const childProcess = createNextApp(
|
|
[projectName],
|
|
{
|
|
cwd,
|
|
},
|
|
nextTgzFilename
|
|
)
|
|
|
|
await new Promise<void>((resolve) => {
|
|
childProcess.on('exit', async (exitCode) => {
|
|
expect(exitCode).toBe(0)
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files: [
|
|
'app',
|
|
'package.json',
|
|
'postcss.config.mjs', // tailwind
|
|
'tsconfig.json', // typescript
|
|
'AGENTS.md', // agent files
|
|
'CLAUDE.md',
|
|
],
|
|
})
|
|
resolve()
|
|
})
|
|
|
|
// Select "Yes, use recommended defaults" (default option, just press enter)
|
|
childProcess.stdin.write('\n')
|
|
})
|
|
|
|
const pkg = require(join(cwd, projectName, 'package.json'))
|
|
expect(pkg.name).toBe(projectName)
|
|
})
|
|
})
|
|
|
|
it('should show reuse previous settings option when preferences exist', async () => {
|
|
const Conf = require('next/dist/compiled/conf')
|
|
|
|
await useTempDir(async (cwd) => {
|
|
// Manually set preferences to simulate a previous run
|
|
const conf = new Conf({ projectName: 'create-next-app' })
|
|
conf.set('preferences', {
|
|
typescript: false,
|
|
eslint: true,
|
|
linter: 'eslint',
|
|
tailwind: false,
|
|
app: false,
|
|
srcDir: false,
|
|
importAlias: '@/*',
|
|
customizeImportAlias: false,
|
|
reactCompiler: false,
|
|
})
|
|
|
|
const projectName = 'reuse-prefs-project'
|
|
const childProcess = createNextApp(
|
|
[projectName],
|
|
{
|
|
cwd,
|
|
},
|
|
nextTgzFilename,
|
|
false // Don't clear preferences
|
|
)
|
|
|
|
await new Promise<void>(async (resolve) => {
|
|
let output = ''
|
|
childProcess.stdout.on('data', (data) => {
|
|
output += data
|
|
process.stdout.write(data)
|
|
})
|
|
|
|
// Select "reuse previous settings" (cursor down once, then enter)
|
|
childProcess.stdin.write('\u001b[B\n')
|
|
|
|
await retry(async () => {
|
|
expect(output).toMatch(/No, reuse previous settings/)
|
|
})
|
|
|
|
childProcess.on('exit', async (exitCode) => {
|
|
expect(exitCode).toBe(0)
|
|
projectFilesShouldExist({
|
|
cwd,
|
|
projectName,
|
|
files: [
|
|
'pages', // pages router (not app)
|
|
'package.json',
|
|
'jsconfig.json', // javascript
|
|
],
|
|
})
|
|
resolve()
|
|
})
|
|
})
|
|
|
|
const pkg = require(join(cwd, projectName, 'package.json'))
|
|
expect(pkg.name).toBe(projectName)
|
|
})
|
|
})
|
|
|
|
it('should prompt user to confirm reset preferences', async () => {
|
|
await useTempDir(async (cwd) => {
|
|
const childProcess = createNextApp(
|
|
['--reset'],
|
|
{
|
|
cwd,
|
|
},
|
|
nextTgzFilename
|
|
)
|
|
|
|
await new Promise<void>(async (resolve) => {
|
|
childProcess.on('exit', async (exitCode) => {
|
|
expect(exitCode).toBe(0)
|
|
resolve()
|
|
})
|
|
let output = ''
|
|
childProcess.stdout.on('data', (data) => {
|
|
output += data
|
|
process.stdout.write(data)
|
|
})
|
|
await retry(async () => {
|
|
expect(output).toMatch(
|
|
/Would you like to reset the saved preferences/
|
|
)
|
|
})
|
|
// cursor forward, choose 'Yes' for reset preferences
|
|
childProcess.stdin.write('\u001b[C\n')
|
|
await retry(async () => {
|
|
expect(output).toMatch(/The preferences have been reset successfully/)
|
|
})
|
|
})
|
|
})
|
|
})
|
|
})
|