Files
vercel__next.js/test/production/create-next-app/biome-config.test.ts
Tim Neutkens 8141dcf12e Convert test/integration to isolated tests (#93247)
### 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.
2026-05-11 13:55:47 +02:00

215 lines
5.2 KiB
TypeScript

import execa from 'execa'
import { readFile, writeFile } from 'fs/promises'
import { join } from 'path'
import { resolveNextTgzFilename, run, useTempDir } from './utils'
describe('create-next-app Biome configuration', () => {
let nextTgzFilename: string
beforeAll(() => {
nextTgzFilename = resolveNextTgzFilename()
})
it('should match biome.json snapshot', async () => {
await useTempDir(async (cwd) => {
const projectName = 'test-biome-snapshot'
const { exitCode } = await run(
[
projectName,
'--ts',
'--biome',
'--no-tailwind',
'--no-src-dir',
'--app',
'--no-import-alias',
'--no-react-compiler',
'--no-agents-md',
'--skip-install',
],
nextTgzFilename,
{ cwd }
)
expect(exitCode).toBe(0)
const projectDir = join(cwd, projectName)
const biomeConfig = await readFile(join(projectDir, 'biome.json'), 'utf8')
expect(biomeConfig).toMatchSnapshot()
})
})
it('should run biome check successfully on generated TypeScript project', async () => {
await useTempDir(async (cwd) => {
const projectName = 'test-biome-ts-check'
const { exitCode } = await run(
[
projectName,
'--ts',
'--biome',
'--no-tailwind',
'--no-src-dir',
'--app',
'--no-import-alias',
'--no-react-compiler',
'--no-agents-md',
],
nextTgzFilename,
{ cwd }
)
expect(exitCode).toBe(0)
const projectDir = join(cwd, projectName)
// Run biome check on the generated project
const { exitCode: biomeExitCode, stdout } = await execa(
'npm',
['run', 'lint'],
{
cwd: projectDir,
}
)
expect(biomeExitCode).toBe(0)
expect(stdout).toContain('Checked')
})
})
it('should run biome check successfully on generated JavaScript project', async () => {
await useTempDir(async (cwd) => {
const projectName = 'test-biome-js-check'
const { exitCode } = await run(
[
projectName,
'--js',
'--biome',
'--no-tailwind',
'--no-src-dir',
'--app',
'--no-import-alias',
'--no-react-compiler',
'--no-agents-md',
],
nextTgzFilename,
{ cwd }
)
expect(exitCode).toBe(0)
const projectDir = join(cwd, projectName)
// Run biome check on the generated project
const { exitCode: biomeExitCode, stdout } = await execa(
'npm',
['run', 'lint'],
{
cwd: projectDir,
}
)
expect(biomeExitCode).toBe(0)
expect(stdout).toContain('Checked')
})
})
it('should format code with biome successfully', async () => {
await useTempDir(async (cwd) => {
const projectName = 'test-biome-format'
const { exitCode } = await run(
[
projectName,
'--ts',
'--biome',
'--no-tailwind',
'--no-src-dir',
'--app',
'--no-import-alias',
'--no-react-compiler',
'--no-agents-md',
],
nextTgzFilename,
{ cwd }
)
expect(exitCode).toBe(0)
const projectDir = join(cwd, projectName)
// Run biome format on the generated project
const { exitCode: biomeFormatCode, stdout } = await execa(
'npm',
['run', 'format'],
{
cwd: projectDir,
}
)
expect(biomeFormatCode).toBe(0)
expect(stdout).toContain('Formatted')
})
})
it('should show errors when biome detects issues', async () => {
await useTempDir(async (cwd) => {
const projectName = 'test-biome-errors'
const { exitCode } = await run(
[
projectName,
'--ts',
'--biome',
'--no-tailwind',
'--no-src-dir',
'--app',
'--no-import-alias',
'--no-react-compiler',
'--no-agents-md',
],
nextTgzFilename,
{ cwd }
)
expect(exitCode).toBe(0)
const projectDir = join(cwd, projectName)
// Add a file with linting issues
const problematicFile = join(projectDir, 'app', 'problematic.tsx')
await writeFile(
problematicFile,
`export default function Component() {
var unusedVar = 5;
const a = 1
const b = 2
// Double equals instead of triple
if (a == b) {
console.log("test")
}
// Debugger statement
debugger;
return <div>Test</div>
}`
)
// Run biome check on the project with the problematic file
try {
await execa('npm', ['run', 'lint'], {
cwd: projectDir,
})
// If we get here, the command succeeded when it shouldn't have
expect(true).toBe(false) // Force test to fail
} catch (error) {
// The command should fail with exit code 1
expect(error.exitCode).toBe(1)
expect(error.stdout + error.stderr).toContain('problematic.tsx')
// Check for specific error messages
const output = error.stdout + error.stderr
expect(output).toMatch(/debugger|no-debugger/)
}
})
})
})