mirror of
https://github.com/hanzoai/next.js.git
synced 2026-09-24 17:00:51 +00:00
### 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.
217 lines
6.2 KiB
JavaScript
217 lines
6.2 KiB
JavaScript
// taskr babel plugin with Babel 7 support
|
|
// https://github.com/lukeed/taskr/pull/305
|
|
|
|
const MODERN_BROWSERSLIST_TARGET = require('./src/shared/lib/modern-browserslist-target')
|
|
|
|
const path = require('path')
|
|
|
|
const transform = require('@swc/core').transform
|
|
|
|
module.exports = function (task) {
|
|
task.plugin(
|
|
'swc',
|
|
{},
|
|
function* (
|
|
file,
|
|
serverOrClient,
|
|
{ stripExtension, interopClientDefaultExport = false, esm = false } = {}
|
|
) {
|
|
// Don't compile .d.ts
|
|
if (
|
|
file.base.endsWith('.d.ts') ||
|
|
file.base.endsWith('.json') ||
|
|
file.base.endsWith('.jsonc') ||
|
|
file.base.endsWith('.woff2')
|
|
)
|
|
return
|
|
|
|
const plugins = [
|
|
...(file.base.includes('.test.') || file.base.includes('.stories.')
|
|
? []
|
|
: [[path.join(__dirname, 'next_error_code_swc_plugin.wasm'), {}]]),
|
|
]
|
|
|
|
const isClient = serverOrClient === 'client'
|
|
/** @type {import('@swc/core').Options} */
|
|
const swcClientOptions = {
|
|
module: esm
|
|
? {
|
|
type: 'es6',
|
|
}
|
|
: {
|
|
type: 'commonjs',
|
|
ignoreDynamic: true,
|
|
exportInteropAnnotation: true,
|
|
},
|
|
env: {
|
|
targets: MODERN_BROWSERSLIST_TARGET,
|
|
},
|
|
jsc: {
|
|
loose: true,
|
|
externalHelpers: true,
|
|
parser: {
|
|
syntax: 'typescript',
|
|
dynamicImport: true,
|
|
importAttributes: true,
|
|
tsx: file.base.endsWith('.tsx'),
|
|
},
|
|
experimental: {
|
|
keepImportAttributes: esm,
|
|
plugins,
|
|
},
|
|
transform: {
|
|
react: {
|
|
runtime: 'automatic',
|
|
pragmaFrag: 'React.Fragment',
|
|
throwIfNamespace: true,
|
|
development: false,
|
|
useBuiltins: true,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
/** @type {import('@swc/core').Options} */
|
|
const swcServerOptions = {
|
|
module: esm
|
|
? {
|
|
type: 'es6',
|
|
}
|
|
: {
|
|
type: 'commonjs',
|
|
ignoreDynamic: true,
|
|
exportInteropAnnotation: true,
|
|
},
|
|
env: {
|
|
targets: {
|
|
// Ideally, should be same version defined in packages/next/package.json#engines
|
|
// Currently a few minors behind due to babel class transpiling
|
|
// which fails "test/production/mixed-ssg-serverprops-error/test/index.test.js"
|
|
node: '16.8.0',
|
|
},
|
|
},
|
|
jsc: {
|
|
loose: true,
|
|
// Do not enable external helpers on server-side files build
|
|
// _is_native_function helper is not compatible with edge runtime (need investigate)
|
|
externalHelpers: false,
|
|
parser: {
|
|
syntax: 'typescript',
|
|
dynamicImport: true,
|
|
importAttributes: true,
|
|
tsx: file.base.endsWith('.tsx'),
|
|
},
|
|
experimental: {
|
|
keepImportAttributes: esm,
|
|
plugins,
|
|
},
|
|
transform: {
|
|
react: {
|
|
runtime: 'automatic',
|
|
pragmaFrag: 'React.Fragment',
|
|
throwIfNamespace: true,
|
|
development: false,
|
|
useBuiltins: true,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
const swcOptions = isClient ? swcClientOptions : swcServerOptions
|
|
|
|
const filePath = path.join(file.dir, file.base)
|
|
const fullFilePath = path.join(__dirname, filePath)
|
|
const distFilePath = path.dirname(
|
|
// we must strip src from filePath as it isn't carried into
|
|
// the dist file path
|
|
path.join(
|
|
__dirname,
|
|
esm ? 'dist/esm' : 'dist',
|
|
filePath.replace(/^src[/\\]/, '')
|
|
)
|
|
)
|
|
|
|
const options = {
|
|
filename: path.join(file.dir, file.base),
|
|
sourceMaps: true,
|
|
inlineSourcesContent: true,
|
|
sourceFileName: path.relative(distFilePath, fullFilePath),
|
|
|
|
...swcOptions,
|
|
}
|
|
|
|
const source = file.data.toString('utf-8')
|
|
const output = yield transform(source, options)
|
|
const ext = path.extname(file.base)
|
|
|
|
// Replace `.ts|.tsx` with `.js` in files with an extension
|
|
if (ext) {
|
|
const extRegex = new RegExp(ext.replace('.', '\\.') + '$', 'i')
|
|
// Remove the extension if stripExtension is enabled or replace it with `.js`
|
|
file.base = file.base.replace(
|
|
extRegex,
|
|
stripExtension ? '' : `.${ext === '.mts' ? 'm' : ''}js`
|
|
)
|
|
}
|
|
|
|
if (output.map) {
|
|
if (interopClientDefaultExport && !esm) {
|
|
output.code += `
|
|
if ((typeof exports.default === 'function' || (typeof exports.default === 'object' && exports.default !== null)) && typeof exports.default.__esModule === 'undefined') {
|
|
Object.defineProperty(exports.default, '__esModule', { value: true });
|
|
Object.assign(exports.default, exports);
|
|
module.exports = exports.default;
|
|
}
|
|
`
|
|
}
|
|
|
|
const map = `${file.base}.map`
|
|
|
|
output.code += Buffer.from(`\n//# sourceMappingURL=${map}`)
|
|
|
|
const sourceMapPayload = JSON.parse(output.map)
|
|
if ('ignoreList' in sourceMapPayload) {
|
|
throw new Error(
|
|
'SWC already sets an ignoreList. We may no longer need to manually set ignoreList.'
|
|
)
|
|
}
|
|
// ignore-list everything
|
|
sourceMapPayload.ignoreList = sourceMapPayload.sources.map(
|
|
(source, sourceIndex) => {
|
|
return sourceIndex
|
|
}
|
|
)
|
|
|
|
// add sourcemap to `files` array
|
|
this._.files.push({
|
|
base: map,
|
|
dir: file.dir,
|
|
data: Buffer.from(JSON.stringify(sourceMapPayload)),
|
|
})
|
|
}
|
|
|
|
file.data = Buffer.from(setNextVersion(output.code))
|
|
}
|
|
)
|
|
}
|
|
|
|
function setNextVersion(code) {
|
|
return code
|
|
.replace(
|
|
/process\.env\.__NEXT_VERSION/g,
|
|
`"${require('./package.json').version}"`
|
|
)
|
|
.replace(
|
|
/process\.env\.__NEXT_REQUIRED_NODE_VERSION_RANGE/g,
|
|
`"${require('./package.json').engines.node}"`
|
|
)
|
|
.replace(
|
|
/process\.env\.REQUIRED_APP_REACT_VERSION/,
|
|
`"${
|
|
require('../../package.json').devDependencies[
|
|
'react-server-dom-webpack'
|
|
]
|
|
}"`
|
|
)
|
|
}
|