mirror of
https://github.com/vercel/next.js.git
synced 2026-09-20 02:25:18 +08:00
Tim Neutkens
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.
220 lines
7.5 KiB
TypeScript
220 lines
7.5 KiB
TypeScript
import { nextTestSetup } from 'e2e-utils'
|
|
import { retry } from 'next-test-utils'
|
|
|
|
describe('Link Component with Encoding', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
})
|
|
|
|
describe('spaces', () => {
|
|
it('should have correct query on SSR', async () => {
|
|
const browser = await next.browser(encodeURI('/single/hello world '))
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello world "}"`)
|
|
})
|
|
|
|
it('should have correct query on Router#push', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.eval(
|
|
`window.next.router.push(
|
|
{ pathname: '/single/[slug]' },
|
|
{ pathname: encodeURI('/single/hello world ') }
|
|
)`
|
|
)
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello world "}"`)
|
|
})
|
|
|
|
it('should have correct query on simple client-side <Link>', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.elementByCss('#single-spaces').click()
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello world "}"`)
|
|
})
|
|
})
|
|
|
|
describe('percent', () => {
|
|
it('should have correct query on SSR', async () => {
|
|
const browser = await next.browser(encodeURI('/single/hello%world'))
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello%world"}"`)
|
|
})
|
|
|
|
it('should have correct query on Router#push', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.eval(
|
|
`window.next.router.push(
|
|
{ pathname: '/single/[slug]' },
|
|
{ pathname: encodeURI('/single/hello%world') }
|
|
)`
|
|
)
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello%world"}"`)
|
|
})
|
|
|
|
it('should have correct query on simple client-side <Link>', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.elementByCss('#single-percent').click()
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello%world"}"`)
|
|
})
|
|
})
|
|
|
|
describe('forward slash', () => {
|
|
it('should have correct query on SSR', async () => {
|
|
const browser = await next.browser(
|
|
`/single/hello${encodeURIComponent('/')}world`
|
|
)
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello/world"}"`)
|
|
})
|
|
|
|
it('should have correct query on Router#push', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.eval(
|
|
`window.next.router.push(
|
|
{ pathname: '/single/[slug]' },
|
|
{ pathname: '/single/hello${encodeURIComponent('/')}world' }
|
|
)`
|
|
)
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello/world"}"`)
|
|
})
|
|
|
|
it('should have correct query on simple client-side <Link>', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.elementByCss('#single-slash').click()
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello/world"}"`)
|
|
})
|
|
})
|
|
|
|
describe('double quote', () => {
|
|
it('should have correct query on SSR', async () => {
|
|
const browser = await next.browser(
|
|
`/single/hello${encodeURIComponent('"')}world`
|
|
)
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(JSON.parse(text)).toMatchInlineSnapshot(`
|
|
{
|
|
"slug": "hello"world",
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should have correct query on Router#push', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.eval(
|
|
`window.next.router.push(
|
|
{ pathname: '/single/[slug]' },
|
|
{ pathname: '/single/hello${encodeURIComponent('"')}world' }
|
|
)`
|
|
)
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(JSON.parse(text)).toMatchInlineSnapshot(`
|
|
{
|
|
"slug": "hello"world",
|
|
}
|
|
`)
|
|
})
|
|
|
|
it('should have correct query on simple client-side <Link>', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.elementByCss('#single-double-quote').click()
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(JSON.parse(text)).toMatchInlineSnapshot(`
|
|
{
|
|
"slug": "hello"world",
|
|
}
|
|
`)
|
|
})
|
|
})
|
|
|
|
describe('colon', () => {
|
|
it('should have correct query on SSR', async () => {
|
|
const browser = await next.browser(
|
|
`/single/hello${encodeURIComponent(':')}world`
|
|
)
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello:world"}"`)
|
|
})
|
|
|
|
it('should have correct query on Router#push', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.eval(
|
|
`window.next.router.push(
|
|
{ pathname: '/single/[slug]' },
|
|
{ pathname: '/single/hello${encodeURIComponent(':')}world' }
|
|
)`
|
|
)
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello:world"}"`)
|
|
})
|
|
|
|
it('should have correct query on simple client-side <Link>', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.elementByCss('#single-colon').click()
|
|
await retry(async () => {
|
|
expect(await browser.hasElementByCssSelector('#query-content')).toBe(
|
|
true
|
|
)
|
|
})
|
|
const text = await browser.elementByCss('#query-content').text()
|
|
expect(text).toMatchInlineSnapshot(`"{"slug":"hello:world"}"`)
|
|
})
|
|
|
|
it('should have correct parsing of url query params', async () => {
|
|
const browser = await next.browser('/')
|
|
await browser.waitForElementByCss('#url-param').click()
|
|
const content = await browser.waitForElementByCss('#query-content').text()
|
|
const query = JSON.parse(content)
|
|
expect(query).toHaveProperty('id', 'http://example.com/')
|
|
})
|
|
})
|
|
})
|