forked from vercel/next.js
/
base.ts
274 lines (249 loc) · 7.23 KB
/
base.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
import os from 'os'
import path from 'path'
import fs from 'fs-extra'
import treeKill from 'tree-kill'
import { NextConfig } from 'next'
import { FileRef } from '../e2e-utils'
import { ChildProcess } from 'child_process'
import { createNextInstall } from '../create-next-install'
type Event = 'stdout' | 'stderr' | 'error' | 'destroy'
export type InstallCommand =
| string
| ((ctx: { dependencies: { [key: string]: string } }) => string)
export type PackageJson = {
[key: string]: unknown
}
export class NextInstance {
protected files: {
[filename: string]: string | FileRef
}
protected nextConfig?: NextConfig
protected installCommand?: InstallCommand
protected buildCommand?: string
protected startCommand?: string
protected dependencies?: { [name: string]: string }
protected events: { [eventName: string]: Set<any> }
public testDir: string
protected isStopping: boolean
protected isDestroyed: boolean
protected childProcess: ChildProcess
protected _url: string
protected _parsedUrl: URL
protected packageJson: PackageJson
constructor({
files,
dependencies,
nextConfig,
installCommand,
buildCommand,
startCommand,
packageJson = {},
}: {
files: {
[filename: string]: string | FileRef
}
dependencies?: {
[name: string]: string
}
packageJson?: PackageJson
nextConfig?: NextConfig
installCommand?: InstallCommand
buildCommand?: string
startCommand?: string
}) {
this.files = files
this.dependencies = dependencies
this.nextConfig = nextConfig
this.installCommand = installCommand
this.buildCommand = buildCommand
this.startCommand = startCommand
this.packageJson = packageJson
this.events = {}
this.isDestroyed = false
this.isStopping = false
}
protected async createTestDir() {
if (this.isDestroyed) {
throw new Error('next instance already destroyed')
}
console.log(`Creating test directory with isolated next...`)
const skipIsolatedNext = !!process.env.NEXT_SKIP_ISOLATE
const tmpDir = skipIsolatedNext
? path.join(__dirname, '../../tmp')
: process.env.NEXT_TEST_DIR || (await fs.realpath(os.tmpdir()))
this.testDir = path.join(
tmpDir,
`next-test-${Date.now()}-${(Math.random() * 1000) | 0}`
)
if (
process.env.NEXT_TEST_STARTER &&
!this.dependencies &&
!this.installCommand
) {
await fs.copy(process.env.NEXT_TEST_STARTER, this.testDir)
} else if (!skipIsolatedNext) {
this.testDir = await createNextInstall(
{
react: 'latest',
'react-dom': 'latest',
...this.dependencies,
...((this.packageJson.dependencies as object | undefined) || {}),
},
this.installCommand,
this.packageJson
)
}
console.log('created next.js install, writing test files')
for (const filename of Object.keys(this.files)) {
const item = this.files[filename]
const outputfilename = path.join(this.testDir, filename)
if (typeof item === 'string') {
await fs.ensureDir(path.dirname(outputfilename))
await fs.writeFile(outputfilename, item)
} else {
await fs.copy(item.fsPath, outputfilename)
}
}
if (this.nextConfig) {
const functions = []
await fs.writeFile(
path.join(this.testDir, 'next.config.js'),
'module.exports = ' +
JSON.stringify(
{
...this.nextConfig,
} as NextConfig,
(key, val) => {
if (typeof val === 'function') {
functions.push(
val
.toString()
.replace(new RegExp(`${val.name}[\\s]{0,}\\(`), 'function(')
)
return `__func_${functions.length - 1}`
}
return val
},
2
).replace(/"__func_[\d]{1,}"/g, function (str) {
return functions.shift()
})
)
}
console.log(`Test directory created at ${this.testDir}`)
}
public async clean() {
if (this.childProcess) {
throw new Error(`stop() must be called before cleaning`)
}
const keptFiles = ['node_modules', 'package.json', 'yarn.lock']
for (const file of await fs.readdir(this.testDir)) {
if (!keptFiles.includes(file)) {
await fs.remove(path.join(this.testDir, file))
}
}
}
public async export(): Promise<{ exitCode?: number; cliOutput?: string }> {
return {}
}
public async setup(): Promise<void> {}
public async start(): Promise<void> {}
public async stop(): Promise<void> {
this.isStopping = true
if (this.childProcess) {
let exitResolve
const exitPromise = new Promise((resolve) => {
exitResolve = resolve
})
this.childProcess.addListener('exit', () => {
exitResolve()
})
await new Promise<void>((resolve) => {
treeKill(this.childProcess.pid, 'SIGKILL', (err) => {
if (err) {
console.error('tree-kill', err)
}
resolve()
})
})
this.childProcess.kill('SIGKILL')
await exitPromise
this.childProcess = undefined
console.log(`Stopped next server`)
}
}
public async destroy(): Promise<void> {
if (this.isDestroyed) {
throw new Error(`next instance already destroyed`)
}
this.isDestroyed = true
this.emit('destroy', [])
await this.stop()
if (process.env.TRACE_PLAYWRIGHT) {
await fs
.copy(
path.join(this.testDir, '.next/trace'),
path.join(
__dirname,
'../../traces',
`${path
.relative(
path.join(__dirname, '../../'),
process.env.TEST_FILE_PATH
)
.replace(/\//g, '-')}`,
`next-trace`
)
)
.catch(() => {})
}
if (!process.env.NEXT_TEST_SKIP_CLEANUP) {
await fs.remove(this.testDir)
}
console.log(`destroyed next instance`)
}
public get url() {
return this._url
}
public get appPort() {
return this._parsedUrl.port
}
public get buildId(): string {
return ''
}
public get cliOutput(): string {
return ''
}
// TODO: block these in deploy mode
public async readFile(filename: string) {
return fs.readFile(path.join(this.testDir, filename), 'utf8')
}
public async patchFile(filename: string, content: string) {
const outputPath = path.join(this.testDir, filename)
await fs.ensureDir(path.dirname(outputPath))
return fs.writeFile(outputPath, content)
}
public async renameFile(filename: string, newFilename: string) {
return fs.rename(
path.join(this.testDir, filename),
path.join(this.testDir, newFilename)
)
}
public async deleteFile(filename: string) {
return fs.remove(path.join(this.testDir, filename))
}
public on(event: Event, cb: (...args: any[]) => any) {
if (!this.events[event]) {
this.events[event] = new Set()
}
this.events[event].add(cb)
}
public off(event: Event, cb: (...args: any[]) => any) {
this.events[event]?.delete(cb)
}
protected emit(event: Event, args: any[]) {
this.events[event]?.forEach((cb) => {
cb(...args)
})
}
}