skills/vercel__next.js
1
0
Fork 0
mirror of https://github.com/vercel/next.js.git synced 2026-09-20 02:25:18 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
codex/ledgers-react-sync
vercel__next.js/test/e2e/app-dir/rewrite-headers/rewrite-headers.test.ts
T
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

530 lines
13 KiB
TypeScript
Raw Permalink Blame History

import { nextTestSetup } from 'e2e-utils'
import { computeCacheBustingSearchParam } from 'next/dist/shared/lib/router/utils/cache-busting-search-param'
const targets = ['x-nextjs-rewritten-path', 'x-nextjs-rewritten-query'] as const
type Target = (typeof targets)[number]
const cases: {
name: string
pathname: string
only?: boolean
debug?: true
headers?: {
rsc?: '1'
'next-router-prefetch'?: '0' | '1' | '2'
'next-router-segment-prefetch'?: string
}
expected: Record<Target, string | null>
}[] = [
{
name: 'static HTML',
pathname: '/',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'static RSC',
pathname: '/',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'static Prefetch RSC',
pathname: '/',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'prerender HTML',
pathname: '/hello/world',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'prerendered RSC',
pathname: '/hello/world',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'prerendered Prefetch RSC',
pathname: '/hello/world',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite HTML',
pathname: '/hello/wyatt',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite RSC',
pathname: '/hello/wyatt',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/hello/admin',
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'middleware rewrite Prefetch RSC',
pathname: '/hello/wyatt',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
// only: true,
expected: {
'x-nextjs-rewritten-path': '/hello/admin',
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'middleware rewrite dynamic HTML',
pathname: '/hello/bob',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite dynamic RSC',
pathname: '/hello/bob',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/hello/bobby',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite dynamic Prefetch RSC',
pathname: '/hello/bob',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/hello/bobby',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic HTML',
pathname: '/hello/mary',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic RSC',
pathname: '/hello/mary',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic Prefetch RSC',
pathname: '/hello/mary',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic HTML with query',
pathname: '/hello/mary?key=value',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic RSC with query',
pathname: '/hello/mary?key=value',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic Prefetch RSC with query',
pathname: '/hello/mary?key=value',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites HTML',
pathname: '/hello/sam',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites RSC',
pathname: '/hello/sam',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/hello/samantha',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites Prefetch RSC',
pathname: '/hello/sam',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/hello/samantha',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites static HTML',
pathname: '/hello/other',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites static RSC',
pathname: '/hello/other',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites static Prefetch RSC',
pathname: '/hello/other',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites external URL',
pathname: '/hello/google',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite query HTML',
pathname: '/hello/john',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite query RSC',
pathname: '/hello/john',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'middleware rewrite query Prefetch RSC',
pathname: '/hello/john',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'middleware rewrite external HTML',
pathname: '/hello/vercel',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
// TODO: These next two scenarios are dependent on how the Vercel site has
// configured its rewrites, and thus are prone to be flaky. Figure out what
// Next.js logic this is supposed to test.
// {
// name: 'middleware rewrite external RSC',
// pathname: '/hello/vercel',
// headers: {
// rsc: '1',
// },
// expected: {
// // Vercel matches `/` to `/home`
// 'x-nextjs-rewritten-path': '/home',
// 'x-nextjs-rewritten-query': null,
// },
// },
// {
// name: 'middleware rewrite external Prefetch RSC',
// pathname: '/hello/vercel',
// headers: {
// rsc: '1',
// 'next-router-prefetch': '1',
// },
// expected: {
// // Vercel matches `/` to `/home`
// 'x-nextjs-rewritten-path': '/home',
// 'x-nextjs-rewritten-query': null,
// },
// },
{
name: 'next.config.js rewrites with query HTML',
pathname: '/hello/fred',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites with query RSC',
pathname: '/hello/fred',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'next.config.js rewrites with query Prefetch RSC',
pathname: '/hello/fred',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'next.config.js rewrites with path-matched query HTML',
pathname: '/rewrites-to-query/andrew',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites with path-matched query RSC',
pathname: '/rewrites-to-query/andrew',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': 'key=andrew',
},
},
{
name: 'next.config.js rewrites with path-matched query Prefetch RSC',
pathname: '/rewrites-to-query/andrew',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': 'key=andrew',
},
},
]
describe('rewrite-headers', () => {
const { next, skipped } = nextTestSetup({
files: __dirname,
// TODO: re-enable once changes in infrastructure are merged
skipDeployment: true,
})
if (skipped) return
describe.each(cases)(
'$name ($pathname)',
({ pathname, headers = {}, expected }) => {
let response
beforeAll(async () => {
const url = new URL(pathname, 'http://localhost')
// Add cache busting param for RSC requests
if (headers.rsc === '1') {
const cacheBustingParam = await computeCacheBustingSearchParam(
headers['next-router-prefetch'],
headers['next-router-segment-prefetch'],
undefined,
undefined
)
if (cacheBustingParam) {
// Preserve existing search params if any
const existingSearch = url.search
const rawQuery = existingSearch.startsWith('?')
? existingSearch.slice(1)
: existingSearch
const pairs = rawQuery.split('&').filter(Boolean)
pairs.push(`_rsc=${cacheBustingParam}`)
url.search = pairs.length ? `?${pairs.join('&')}` : ''
}
}
response = await next.fetch(url.toString(), { headers })
if (response.status !== 200) {
throw new Error(
`Expected status 200, got ${response.status} for ${pathname}`
)
}
})
it('should have the expected headers', () => {
const headers = Object.fromEntries(response.headers.entries())
// This is so that the following check works. If we expect that the
// header is null, but it's not present, we need to set it to null.
Object.entries(expected).forEach(([key, value]) => {
if (value === null && !headers[key]) {
headers[key] = null
}
})
// Remove any headers that we're not testing for to simplify the test
// output.
Object.keys(headers).forEach((key) => {
if (!targets.includes(key as Target)) {
delete headers[key]
}
})
expect(headers).toEqual(expected)
})
}
)
})
Reference in New Issue View Git Blame Copy Permalink