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.
151 lines
4.8 KiB
TypeScript
151 lines
4.8 KiB
TypeScript
import { nextTestSetup, isNextDev, isNextStart } from 'e2e-utils'
|
|
import { listClientChunks } from 'next-test-utils'
|
|
import fs from 'fs-extra'
|
|
import path from 'path'
|
|
|
|
const warningText = `You are using a non-standard "NODE_ENV" value in your environment`
|
|
|
|
describe('Non-Standard NODE_ENV', () => {
|
|
;(isNextDev ? describe : describe.skip)('dev mode', () => {
|
|
describe('no NODE_ENV set', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
})
|
|
|
|
it('should not show the warning with no NODE_ENV set', async () => {
|
|
expect(next.cliOutput).not.toContain(warningText)
|
|
})
|
|
})
|
|
|
|
describe('NODE_ENV=development', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
env: { NODE_ENV: 'development' },
|
|
})
|
|
|
|
it('should not show the warning with NODE_ENV set to valid value', async () => {
|
|
expect(next.cliOutput).not.toContain(warningText)
|
|
})
|
|
})
|
|
|
|
describe('NODE_ENV=development (custom server)', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
startCommand: 'node server.js',
|
|
serverReadyPattern: /- Local:/,
|
|
dependencies: { 'get-port': '5.1.1' },
|
|
env: { NODE_ENV: 'development' },
|
|
})
|
|
|
|
it('should not show the warning with NODE_ENV set to valid value (custom server)', async () => {
|
|
expect(next.cliOutput).not.toContain(warningText)
|
|
})
|
|
})
|
|
|
|
describe('NODE_ENV=abc', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
env: { NODE_ENV: 'abc' },
|
|
})
|
|
|
|
it('should show the warning with NODE_ENV set to invalid value', async () => {
|
|
expect(next.cliOutput).toContain(warningText)
|
|
})
|
|
})
|
|
|
|
describe('NODE_ENV=abc (custom server)', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
startCommand: 'node server.js',
|
|
serverReadyPattern: /- Local:/,
|
|
dependencies: { 'get-port': '5.1.1' },
|
|
env: { NODE_ENV: 'abc' },
|
|
})
|
|
|
|
it('should show the warning with NODE_ENV set to invalid value (custom server)', async () => {
|
|
expect(next.cliOutput).toContain(warningText)
|
|
})
|
|
})
|
|
|
|
describe('NODE_ENV=production', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
env: { NODE_ENV: 'production' },
|
|
})
|
|
|
|
it('should show the warning with NODE_ENV set to production with next dev', async () => {
|
|
expect(next.cliOutput).toContain(warningText)
|
|
})
|
|
})
|
|
})
|
|
;(isNextStart ? describe : describe.skip)('production mode', () => {
|
|
describe('DCE with NODE_ENV=test', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
skipStart: true,
|
|
env: { NODE_ENV: 'test' },
|
|
})
|
|
|
|
it('should still DCE NODE_ENV specific code', async () => {
|
|
await next.build()
|
|
|
|
const distDir = path.join(next.testDir, next.distDir)
|
|
const staticFiles = (await listClientChunks(distDir)).filter((f) =>
|
|
f.endsWith('.js')
|
|
)
|
|
expect(staticFiles.length).toBeGreaterThan(0)
|
|
|
|
let foundProductionValue = false
|
|
let foundOtherValue = false
|
|
for (const file of staticFiles) {
|
|
const content = await fs.readFile(path.join(distDir, file), 'utf8')
|
|
|
|
if (content.includes('Hello Production')) {
|
|
foundProductionValue = true
|
|
}
|
|
if (content.includes('Hello Other')) {
|
|
foundOtherValue = true
|
|
}
|
|
}
|
|
|
|
expect(foundProductionValue).toBeTrue()
|
|
expect(foundOtherValue).toBeFalse()
|
|
})
|
|
})
|
|
|
|
describe('build warning with NODE_ENV=development', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
skipStart: true,
|
|
env: { NODE_ENV: 'development' },
|
|
})
|
|
|
|
it('should show the warning with NODE_ENV set to development with next build', async () => {
|
|
const start = next.cliOutput.length
|
|
await next.build()
|
|
expect(next.cliOutput.slice(start)).toContain(warningText)
|
|
})
|
|
})
|
|
|
|
describe('start warning with NODE_ENV=development', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
skipStart: true,
|
|
})
|
|
|
|
it('should show the warning with NODE_ENV set to development with next start', async () => {
|
|
// Build without NODE_ENV=development. Matches the original integration
|
|
// test, which only sets NODE_ENV=development for `next start` (not
|
|
// `next build`). Building with NODE_ENV=development additionally
|
|
// triggers unrelated turbopack production-build issues.
|
|
await next.build()
|
|
next.env.NODE_ENV = 'development'
|
|
// `next.start()` resets `cliOutput` to '' so we do not need to slice
|
|
// from a pre-start index.
|
|
await next.start({ skipBuild: true })
|
|
expect(next.cliOutput).toContain(warningText)
|
|
})
|
|
})
|
|
})
|
|
})
|