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.
265 lines
7.9 KiB
TypeScript
265 lines
7.9 KiB
TypeScript
import { nextTestSetup, isNextDev, isNextStart } from 'e2e-utils'
|
|
import { retry } from 'next-test-utils'
|
|
|
|
describe('404 Page Support', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
skipDeployment: true,
|
|
})
|
|
|
|
const gip404Err =
|
|
/`pages\/404` can not have getInitialProps\/getServerSideProps/
|
|
|
|
it('should use pages/404', async () => {
|
|
const html = await next.render('/abc')
|
|
expect(html).toContain('custom 404 page')
|
|
})
|
|
|
|
it('should set correct status code with pages/404', async () => {
|
|
const res = await next.fetch('/abc')
|
|
expect(res.status).toBe(404)
|
|
})
|
|
|
|
it('should use pages/404 for .d.ts file', async () => {
|
|
const html = await next.render('/invalidExtension')
|
|
expect(html).toContain('custom 404 page')
|
|
})
|
|
|
|
it('should not error when visited directly', async () => {
|
|
const res = await next.fetch('/404')
|
|
expect(res.status).toBe(404)
|
|
expect(await res.text()).toContain('custom 404 page')
|
|
})
|
|
|
|
it('should render _error for a 500 error still', async () => {
|
|
const html = await next.render('/err')
|
|
expect(html).not.toContain('custom 404 page')
|
|
expect(html).toContain(isNextDev ? 'oops' : 'Internal Server Error')
|
|
})
|
|
|
|
if (isNextStart) {
|
|
it('should output 404.html during build', async () => {
|
|
const manifest = await next.readJSON('.next/server/pages-manifest.json')
|
|
const page = manifest['/404']
|
|
expect(page.endsWith('.html')).toBe(true)
|
|
})
|
|
|
|
it('should still output 404.js anyway', async () => {
|
|
expect(await next.hasFile('.next/server/pages/404.js')).toBe(true)
|
|
})
|
|
|
|
it('should add /404 to pages-manifest correctly', async () => {
|
|
const manifest = await next.readJSON('.next/server/pages-manifest.json')
|
|
expect('/404' in manifest).toBe(true)
|
|
})
|
|
}
|
|
|
|
if (isNextDev) {
|
|
it('falls back to _error correctly without pages/404', async () => {
|
|
const original404 = await next.readFile('pages/404.js')
|
|
try {
|
|
await next.deleteFile('pages/404.js')
|
|
await retry(async () => {
|
|
const res = await next.fetch('/abc')
|
|
expect(res.status).toBe(404)
|
|
expect(await res.text()).toContain('This page could not be found')
|
|
})
|
|
} finally {
|
|
await next.patchFile('pages/404.js', original404)
|
|
}
|
|
})
|
|
|
|
it('shows error with getInitialProps in pages/404 dev', async () => {
|
|
const original404 = await next.readFile('pages/404.js')
|
|
try {
|
|
await next.patchFile(
|
|
'pages/404.js',
|
|
`
|
|
const page = () => 'custom 404 page'
|
|
page.getInitialProps = () => ({ a: 'b' })
|
|
export default page
|
|
`
|
|
)
|
|
await next.render('/abc')
|
|
await retry(async () => {
|
|
expect(next.cliOutput).toMatch(gip404Err)
|
|
})
|
|
} finally {
|
|
await next.patchFile('pages/404.js', original404)
|
|
}
|
|
})
|
|
|
|
it('does not show error with getStaticProps in pages/404 dev', async () => {
|
|
const original404 = await next.readFile('pages/404.js')
|
|
const getOutput = next.getCliOutputFromHere()
|
|
try {
|
|
await next.patchFile(
|
|
'pages/404.js',
|
|
`
|
|
const page = () => 'custom 404 page'
|
|
export const getStaticProps = () => ({ props: { a: 'b' } })
|
|
export default page
|
|
`
|
|
)
|
|
await next.render('/abc')
|
|
await retry(async () => {
|
|
const html = await next.render('/abc')
|
|
expect(html).toContain('custom 404 page')
|
|
})
|
|
expect(getOutput()).not.toMatch(gip404Err)
|
|
} finally {
|
|
await next.patchFile('pages/404.js', original404)
|
|
}
|
|
})
|
|
|
|
it('shows error with getServerSideProps in pages/404 dev', async () => {
|
|
const original404 = await next.readFile('pages/404.js')
|
|
try {
|
|
await next.patchFile(
|
|
'pages/404.js',
|
|
`
|
|
const page = () => 'custom 404 page'
|
|
export const getServerSideProps = () => ({ props: { a: 'b' } })
|
|
export default page
|
|
`
|
|
)
|
|
await next.render('/abc')
|
|
await retry(async () => {
|
|
expect(next.cliOutput).toMatch(gip404Err)
|
|
})
|
|
} finally {
|
|
await next.patchFile('pages/404.js', original404)
|
|
}
|
|
})
|
|
}
|
|
})
|
|
;(isNextStart ? describe : describe.skip)('404 Page build validation', () => {
|
|
const { next, skipped } = nextTestSetup({
|
|
files: __dirname,
|
|
skipStart: true,
|
|
skipDeployment: true,
|
|
})
|
|
if (skipped) return
|
|
|
|
const gip404Err =
|
|
/`pages\/404` can not have getInitialProps\/getServerSideProps/
|
|
const original404Content = `const page = () => 'custom 404 page'
|
|
export default page
|
|
`
|
|
|
|
beforeEach(async () => {
|
|
// Restore original 404.js content before each test
|
|
await next.patchFile('pages/404.js', original404Content)
|
|
// Stop server if running
|
|
try {
|
|
await next.stop()
|
|
} catch (e) {
|
|
// Ignore if already stopped
|
|
}
|
|
})
|
|
|
|
it('shows error with getInitialProps in pages/404 build', async () => {
|
|
await next.patchFile(
|
|
'pages/404.js',
|
|
`
|
|
const page = () => 'custom 404 page'
|
|
page.getInitialProps = () => ({ a: 'b' })
|
|
export default page
|
|
`
|
|
)
|
|
const { exitCode } = await next.build()
|
|
expect(exitCode).toBe(1)
|
|
expect(next.cliOutput).toMatch(gip404Err)
|
|
})
|
|
|
|
it('does not show error with getStaticProps in pages/404 build', async () => {
|
|
await next.patchFile(
|
|
'pages/404.js',
|
|
`
|
|
const page = () => 'custom 404 page'
|
|
export const getStaticProps = () => ({ props: { a: 'b' } })
|
|
export default page
|
|
`
|
|
)
|
|
const { exitCode, cliOutput } = await next.build()
|
|
expect(exitCode).toBe(0)
|
|
expect(cliOutput).not.toMatch(gip404Err)
|
|
})
|
|
|
|
it('shows error with getServerSideProps in pages/404 build', async () => {
|
|
await next.patchFile(
|
|
'pages/404.js',
|
|
`
|
|
const page = () => 'custom 404 page'
|
|
export const getServerSideProps = () => ({ props: { a: 'b' } })
|
|
export default page
|
|
`
|
|
)
|
|
const { exitCode } = await next.build()
|
|
expect(exitCode).toBe(1)
|
|
expect(next.cliOutput).toMatch(gip404Err)
|
|
})
|
|
|
|
it('should not cache for custom 404 page with gssp and revalidate disabled', async () => {
|
|
await next.patchFile(
|
|
'pages/404.js',
|
|
`
|
|
const page = () => 'custom 404 page'
|
|
export async function getStaticProps() { return { props: {} } }
|
|
export default page
|
|
`
|
|
)
|
|
const { exitCode } = await next.build()
|
|
expect(exitCode).toBe(0)
|
|
await next.start()
|
|
|
|
const res404 = await next.fetch('/404')
|
|
const resNext = await next.fetch('/_next/abc')
|
|
|
|
expect(res404.headers.get('Cache-Control')).toBe(
|
|
'private, no-cache, no-store, max-age=0, must-revalidate'
|
|
)
|
|
expect(resNext.headers.get('Cache-Control')).toBe(
|
|
'private, no-cache, no-store, max-age=0, must-revalidate'
|
|
)
|
|
})
|
|
|
|
it('should not cache for custom 404 page with gssp and revalidate enabled', async () => {
|
|
await next.patchFile(
|
|
'pages/404.js',
|
|
`
|
|
const page = () => 'custom 404 page'
|
|
export async function getStaticProps() { return { props: {}, revalidate: 1 } }
|
|
export default page
|
|
`
|
|
)
|
|
const { exitCode } = await next.build()
|
|
expect(exitCode).toBe(0)
|
|
await next.start()
|
|
|
|
const res404 = await next.fetch('/404')
|
|
const resNext = await next.fetch('/_next/abc')
|
|
|
|
expect(res404.headers.get('Cache-Control')).toBe(
|
|
'private, no-cache, no-store, max-age=0, must-revalidate'
|
|
)
|
|
expect(resNext.headers.get('Cache-Control')).toBe(
|
|
'private, no-cache, no-store, max-age=0, must-revalidate'
|
|
)
|
|
})
|
|
|
|
it('should not cache for custom 404 page without gssp', async () => {
|
|
const { exitCode } = await next.build()
|
|
expect(exitCode).toBe(0)
|
|
await next.start()
|
|
|
|
const res404 = await next.fetch('/404')
|
|
const resNext = await next.fetch('/_next/abc')
|
|
|
|
expect(res404.headers.get('Cache-Control')).toBe(null)
|
|
expect(resNext.headers.get('Cache-Control')).toBe(
|
|
'private, no-cache, no-store, max-age=0, must-revalidate'
|
|
)
|
|
})
|
|
})
|