-
Notifications
You must be signed in to change notification settings - Fork 26.5k
/
devlow-bench.mjs
402 lines (368 loc) · 11.2 KB
/
devlow-bench.mjs
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
import { rm, writeFile, readFile } from 'node:fs/promises'
import { join, resolve } from 'node:path'
import { fileURLToPath } from 'node:url'
import { describe } from '@vercel/devlow-bench'
import * as devlow from '@vercel/devlow-bench'
import { newBrowserSession } from '@vercel/devlow-bench/browser'
import { command } from '@vercel/devlow-bench/shell'
import { waitForFile } from '@vercel/devlow-bench/file'
const REPO_ROOT = fileURLToPath(new URL('..', import.meta.url))
const GIT_SHA =
process.env.GITHUB_SHA ??
(await (async () => {
const cmd = command('git', ['rev-parse', 'HEAD'])
await cmd.ok()
return cmd.output
})())
const GIT_BRANCH =
process.env.GITHUB_REF_NAME ??
(await (async () => {
const cmd = command('git', ['rev-parse', '--abbrev-ref', 'HEAD'])
await cmd.ok()
return cmd.output
})())
const nextDevWorkflow =
(benchmarkName, pages) =>
async ({ turbopack, page }) => {
const pageConfig =
typeof pages[page] === 'string' ? { url: pages[page] } : pages[page]
const cleanupTasks = []
try {
const benchmarkDir = resolve(REPO_ROOT, 'bench', benchmarkName)
// cleanup .next directory to remove persistent cache
await retry(() =>
rm(join(benchmarkDir, '.next'), { recursive: true, force: true })
)
await measureTime('cleanup', {
scenario: benchmarkName,
props: { turbopack: null, page: null },
})
// startup browser
let session = await newBrowserSession({})
const closeSession = async () => {
if (session) {
await session.close()
session = null
}
}
cleanupTasks.push(closeSession)
await measureTime('browser startup', {
props: { turbopack: null, page: null },
})
const env = {
PATH: process.env.PATH,
NODE: process.env.NODE,
HOSTNAME: process.env.HOSTNAME,
PWD: process.env.PWD,
NODE_ENV: 'development',
// Disable otel initialization to prevent pending / hanging request to otel collector
OTEL_SDK_DISABLED: 'true',
NEXT_PUBLIC_OTEL_SENTRY: 'true',
NEXT_PUBLIC_OTEL_DEV_DISABLED: 'true',
NEXT_TRACE_UPLOAD_DISABLED: 'true',
// Enable next.js test mode to get HMR events
__NEXT_TEST_MODE: '1',
}
// run command to start dev server
const args = [turbopack ? 'dev-turbopack' : 'dev-webpack']
let shell = command('pnpm', args, {
cwd: benchmarkDir,
env,
})
const killShell = async () => {
if (shell) {
await shell.kill()
shell = null
}
}
cleanupTasks.push(killShell)
// wait for server to be ready
const START_SERVER_REGEXP = /Local:\s+(?<url>.+)\n/
const {
groups: { url },
} = await shell.waitForOutput(START_SERVER_REGEXP)
await measureTime('server startup', { props: { page: null } })
await shell.reportMemUsage('mem usage after startup', {
props: { page: null },
})
// open page
const pageInstance = await session.hardNavigation(
'open page',
url + pageConfig.url
)
await shell.reportMemUsage('mem usage after open page')
let status = 0
try {
if (
await pageInstance.evaluate(
'!next.appDir && __NEXT_DATA__.page === "/404"'
)
) {
status = 2
}
} catch (e) {
status = 2
}
try {
if (
!(await pageInstance.evaluate(
'next.appDir || __NEXT_DATA__.page && !__NEXT_DATA__.err'
))
) {
status = 1
}
} catch (e) {
status = 1
}
await reportMeasurement('page status', status, 'status code')
// reload page
await session.reload('reload page')
await reportMeasurement(
'console output',
shell.output.split(/\n/).length,
'lines'
)
// HMR
if (pageConfig.hmr) {
let hmrEvent = () => {}
pageInstance.exposeBinding(
'TURBOPACK_HMR_EVENT',
(_source, latency) => {
hmrEvent(latency)
}
)
const { file, before, after } = pageConfig.hmr
const path = resolve(benchmarkDir, file)
const content = await readFile(path, 'utf8')
cleanupTasks.push(async () => {
await writeFile(path, content, 'utf8')
})
let currentContent = content
/* eslint-disable no-await-in-loop */
for (let hmrAttempt = 0; hmrAttempt < 10; hmrAttempt++) {
if (hmrAttempt > 0) {
await new Promise((resolve) => {
setTimeout(resolve, 1000)
})
}
const linesStart = shell.output.split(/\n/).length
let reportedName
if (hmrAttempt < 3) {
reportedName = 'hmr/warmup'
} else {
reportedName = 'hmr'
}
await pageInstance.evaluate(
'window.__NEXT_HMR_CB = (arg) => TURBOPACK_HMR_EVENT(arg); window.__NEXT_HMR_LATENCY_CB = (arg) => TURBOPACK_HMR_EVENT(arg);'
)
// eslint-disable-next-line no-loop-func
const hmrDone = new Promise((resolve) => {
let once = true
const end = async (code) => {
const success = code <= 1
if (!success && !reportedName) reportedName = 'hmr'
if (reportedName) {
await reportMeasurement(
`${reportedName}/status`,
code,
'status code'
)
}
clearTimeout(timeout)
resolve(success)
}
cleanupTasks.push(async () => {
if (!once) return
once = false
await end(3)
})
const timeout = setTimeout(async () => {
if (!once) return
once = false
await end(2)
}, 60000)
hmrEvent = async (latency) => {
if (!once) return
once = false
if (reportedName) {
if (typeof latency === 'number') {
await reportMeasurement(
`${reportedName}/reported latency`,
latency,
'ms'
)
}
await measureTime(reportedName, {
relativeTo: `${reportedName}/start`,
})
}
await end(0)
}
pageInstance.once('load', async () => {
if (!once) return
once = false
if (reportedName) {
await measureTime(reportedName, {
relativeTo: `${reportedName}/start`,
})
}
await end(1)
})
})
const idx = before
? currentContent.indexOf(before)
: currentContent.indexOf(after) + after.length
let newContent = `${currentContent}\n\n/* HMR */`
if (file.endsWith('.tsx')) {
newContent = `${currentContent.slice(
0,
idx
)}<div id="hmr-test">HMR</div>${currentContent.slice(idx)}`
} else if (file.endsWith('.css')) {
newContent = `${currentContent.slice(
0,
idx
)}\n--hmr-test-${hmrAttempt}: 0;\n${currentContent.slice(idx)}`
} else if (file.endsWith('.mdx')) {
newContent = `${currentContent.slice(
0,
idx
)}\n\nHMR\n\n${currentContent.slice(idx)}`
}
if (reportedName) {
await measureTime(`${reportedName}/start`)
}
if (currentContent === newContent) {
throw new Error("HMR didn't change content")
}
await writeFile(path, newContent, 'utf8')
currentContent = newContent
const success = await hmrDone
if (reportedName) {
await reportMeasurement(
`console output/${reportedName}`,
shell.output.split(/\n/).length - linesStart,
'lines'
)
}
if (!success) break
}
/* eslint-enable no-await-in-loop */
}
if (turbopack) {
// close dev server and browser
await killShell()
await closeSession()
} else {
// wait for persistent cache to be written
const waitPromise = new Promise((resolve) => {
setTimeout(resolve, 5000)
})
const cacheLocation = join(
benchmarkDir,
'.next',
'cache',
'webpack',
'client-development'
)
await Promise.race([
waitForFile(join(cacheLocation, 'index.pack')),
waitForFile(join(cacheLocation, 'index.pack.gz')),
])
await measureTime('cache created')
await waitPromise
await measureTime('waiting')
// close dev server and browser
await killShell()
await closeSession()
}
// startup new browser
session = await newBrowserSession({})
await measureTime('browser startup', {
props: { turbopack: null, page: null },
})
// run command to start dev server
shell = command('pnpm', args, {
cwd: benchmarkDir,
env,
})
// wait for server to be ready
const {
groups: { url: url2 },
} = await shell.waitForOutput(START_SERVER_REGEXP)
await shell.reportMemUsage('mem usage after startup with cache')
// open page
await session.hardNavigation(
'open page with cache',
url2 + pageConfig.url
)
await reportMeasurement(
'console output with cache',
shell.output.split(/\n/).length,
'lines'
)
await shell.reportMemUsage('mem usage after open page with cache')
} catch (e) {
console.log('CAUGHT', e)
throw e
} finally {
// This must run in order
// eslint-disable-next-line no-await-in-loop
for (const task of cleanupTasks.reverse()) await task()
await measureTime('shutdown')
}
}
const pages = {
homepage: {
url: '/',
hmr: {
file: 'components/lodash.js',
before: '<h1>Client Component</h1>',
},
},
}
describe(
'heavy-npm-deps dev test',
{
turbopack: true,
page: Object.keys(pages),
},
nextDevWorkflow('heavy-npm-deps', pages)
)
async function retry(fn) {
let lastError
for (let i = 100; i < 2000; i += 100) {
try {
// eslint-disable-next-line no-await-in-loop
await fn()
return
} catch (e) {
lastError = e
// eslint-disable-next-line no-await-in-loop
await new Promise((resolve) => {
setTimeout(resolve, i)
})
}
}
throw lastError
}
function measureTime(name, options) {
return devlow.measureTime(name, {
props: {
git_sha: GIT_SHA,
git_branch: GIT_BRANCH,
...options?.props,
},
...options,
})
}
function reportMeasurement(name, value, unit, options) {
return devlow.reportMeasurement(name, value, unit, {
props: {
git_sha: GIT_SHA,
git_branch: GIT_BRANCH,
...options?.props,
},
...options,
})
}