import path from 'path'
import fs from 'fs-extra'
import { NextInstance, type NextInstanceOpts } from './base'
import spawn from 'cross-spawn'
import { Span } from 'next/dist/trace'
import stripAnsi from 'strip-ansi'
import { quote as shellQuote } from 'shell-quote'
import { shouldUseTurbopack } from 'next-test-utils'
export class NextStartInstance extends NextInstance {
private _buildId: string
private _deploymentId: string | undefined
private _supportsImmutableAssets: boolean = false
private _cliOutput: string = ''
private _prerenderFinishedTimeMS: number | null = null
constructor(opts: NextInstanceOpts) {
super(opts)
if (!opts.disableAutoSkewProtection && shouldUseTurbopack()) {
this.env.NEXT_DEPLOYMENT_ID = 'test-dpl-id-1234'
this.env.__NEXT_SUPPORTS_IMMUTABLE_ASSETS = '1'
}
}
public get buildId() {
return this._buildId
}
public get deploymentId() {
return this._deploymentId
}
public get supportsImmutableAssets() {
return process.env.IS_TURBOPACK_TEST ? this._supportsImmutableAssets : false
}
public get cliOutput() {
return this._cliOutput
}
public async setup(parentSpan: Span) {
super.setup(parentSpan)
await super.createTestDir({ parentSpan })
}
private handleStdio = (childProcess) => {
childProcess.stdout.on('data', (chunk) => {
const msg = chunk.toString()
process.stdout.write(chunk)
this._cliOutput += msg
this.emit('stdout', [msg])
})
childProcess.stderr.on('data', (chunk) => {
const msg = chunk.toString()
process.stderr.write(chunk)
this._cliOutput += msg
this.emit('stderr', [msg])
})
}
public async start(options: { skipBuild?: boolean } = {}) {
if (this.childProcess) {
throw new Error('next already started')
}
this._cliOutput = ''
const spawnOpts = this.getSpawnOpts()
let startArgs = ['pnpm', 'next', 'start']
if (this.startCommand) {
startArgs = this.startCommand.split(' ')
}
if (this.startArgs) {
startArgs.push(...this.startArgs)
}
if (process.env.NEXT_SKIP_ISOLATE) {
// without isolation yarn can't be used and pnpm must be used instead
if (startArgs[0] === 'yarn') {
startArgs[0] = 'pnpm'
}
}
if (!options.skipBuild) {
const buildArgs = this.getBuildArgs()
console.log('running', shellQuote(buildArgs))
await new Promise<void>((resolve, reject) => {
try {
this.childProcess = spawn(buildArgs[0], buildArgs.slice(1), spawnOpts)
this.handleStdio(this.childProcess)
this.childProcess.on('exit', (code, signal) => {
this.childProcess = undefined
if (code || signal)
reject(
new Error(
`next build failed with code/signal ${code || signal}`
)
)
else resolve()
})
const prerenderedCallback = (msg: string) => {
const colorStrippedMsg = stripAnsi(msg)
// This stage happens after all prerenders have finished.
const prerenderFinishedPattern = /Finalizing page optimization/
if (prerenderFinishedPattern.test(colorStrippedMsg)) {
this._prerenderFinishedTimeMS = performance.now()
this.off('stdout', prerenderedCallback)
}
}
this.on('stdout', prerenderedCallback)
} catch (err) {
require('console').error(
`Failed to run ${shellQuote(buildArgs)}`,
err
)
setTimeout(() => process.exit(1), 0)
}
})
this._buildId = (
await fs
.readFile(
path.join(
this.testDir,
this.nextConfig?.distDir || '.next',
'BUILD_ID'
),
'utf8'
)
.catch(() => '')
).trim()
try {
const requiredServerFiles = JSON.parse(
await fs.readFile(
path.join(
this.testDir,
this.nextConfig?.distDir || '.next',
'required-server-files.json'
),
'utf8'
)
)
this._deploymentId =
requiredServerFiles.config?.deploymentId || undefined
this._supportsImmutableAssets =
requiredServerFiles.config?.experimental?.supportsImmutableAssets ||
false
} catch {}
}
console.log('running', shellQuote(startArgs))
await new Promise<void>((resolve, reject) => {
try {
this.childProcess = spawn(startArgs[0], startArgs.slice(1), spawnOpts)
this.handleStdio(this.childProcess)
this.childProcess.on('close', (code, signal) => {
this.childProcess = undefined
if (code || signal) {
let message = `next start exited unexpectedly with code/signal ${
code || signal
}`
if (!this.isStopping) {
require('console').error(message)
}
reject(new Error(message))
}
})
const serverReadyTimeoutId = this.setServerReadyTimeout(
reject,
this.startServerTimeout
)
const readyCb = (msg) => {
const colorStrippedMsg = stripAnsi(msg)
if (colorStrippedMsg.includes('- Local:')) {
this._url = msg
.split('\n')
.find((line) => line.includes('- Local:'))
.split(/\s*- Local:/)
.pop()
.trim()
this._parsedUrl = new URL(this._url)
}
if (this.serverReadyPattern!.test(colorStrippedMsg)) {
clearTimeout(serverReadyTimeoutId)
resolve()
this.off('stdout', readyCb)
}
}
this.on('stdout', readyCb)
} catch (err) {
require('console').error(`Failed to run ${shellQuote(startArgs)}`, err)
setTimeout(() => process.exit(1), 0)
}
})
}
private getBuildArgs(args?: string[]) {
let buildArgs = ['pnpm', 'next', 'build']
if (this.buildCommand) {
buildArgs = this.buildCommand.split(' ')
}
if (this.buildArgs) {
buildArgs.push(...this.buildArgs)
}
if (args) {
buildArgs.push(...args)
}
if (process.env.NEXT_SKIP_ISOLATE) {
// without isolation yarn can't be used and pnpm must be used instead
if (buildArgs[0] === 'yarn') {
buildArgs[0] = 'pnpm'
}
}
return buildArgs
}
private getSpawnOpts(
env?: Record<string, string>
): import('child_process').SpawnOptions {
return {
cwd: this.testDir,
stdio: ['ignore', 'pipe', 'pipe'],
shell: false,
env: {
...process.env,
...this.env,
...env,
NODE_ENV: this.env.NODE_ENV || ('' as any),
PORT: this.forcedPort ?? '0',
__NEXT_TEST_MODE: 'e2e',
},
}
}
public async build(
options: { env?: Record<string, string>; args?: string[] } = {}
) {
if (this.childProcess) {
throw new Error(
`can not run export while server is running, use next.stop() first`
)
}
let result = await new Promise<{
exitCode: NodeJS.Signals | number | null
cliOutput: string
}>((resolve) => {
const curOutput = this._cliOutput.length
const spawnOpts = this.getSpawnOpts(options.env)
const buildArgs = this.getBuildArgs(options.args)
console.log('running', shellQuote(buildArgs))
this.childProcess = spawn(buildArgs[0], buildArgs.slice(1), spawnOpts)
this.handleStdio(this.childProcess)
this.childProcess.on('exit', (code, signal) => {
this.childProcess = undefined
resolve({
exitCode: signal || code,
cliOutput: this.cliOutput.slice(curOutput),
})
})
})
this._buildId = (
await fs
.readFile(
path.join(
this.testDir,
this.nextConfig?.distDir || '.next',
'BUILD_ID'
),
'utf8'
)
.catch(() => '')
).trim()
try {
const requiredServerFiles = JSON.parse(
await fs.readFile(
path.join(
this.testDir,
this.nextConfig?.distDir || '.next',
'required-server-files.json'
),
'utf8'
)
)
this._deploymentId = requiredServerFiles.config?.deploymentId || undefined
this._supportsImmutableAssets =
requiredServerFiles.config?.experimental?.supportsImmutableAssets ||
false
} catch {}
return result
}
public async waitForMinPrerenderAge(minAgeMS: number): Promise<void> {
if (this._prerenderFinishedTimeMS === null) {
throw new Error(
'Could not determine when prerender finished. ' +
`Cannot guarantee a minimum prerender age of ${minAgeMS}ms.`
)
}
const prerenderAge = performance.now() - this._prerenderFinishedTimeMS
const minWaitTime = minAgeMS - prerenderAge
if (minWaitTime > 0) {
console.log(
'Need to wait %dms to guarantee prerender age of %dms',
minWaitTime,
minAgeMS
)
await new Promise((resolve) => {
setTimeout(resolve, minWaitTime)
})
}
}
}