-
-
Notifications
You must be signed in to change notification settings - Fork 55
/
utils.ts
635 lines (587 loc) · 17.1 KB
/
utils.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
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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
import path from 'path'
import fs from 'fs'
import { fileURLToPath, pathToFileURL } from 'url'
import { execaCommand } from 'execa'
import type {
PackageInfo,
EnvironmentData,
Overrides,
ProcessEnv,
RepoOptions,
RunOptions,
Task,
} from './types.d.ts'
//eslint-disable-next-line n/no-unpublished-import
import { detect, AGENTS, Agent, getCommand } from '@antfu/ni'
import actionsCore from '@actions/core'
// eslint-disable-next-line n/no-unpublished-import
import * as semver from 'semver'
const isGitHubActions = !!process.env.GITHUB_ACTIONS
let vitePath: string
let cwd: string
let env: ProcessEnv
function cd(dir: string) {
cwd = path.resolve(cwd, dir)
}
export async function $(literals: TemplateStringsArray, ...values: any[]) {
const cmd = literals.reduce(
(result, current, i) =>
result + current + (values?.[i] != null ? `${values[i]}` : ''),
'',
)
if (isGitHubActions) {
actionsCore.startGroup(`${cwd} $> ${cmd}`)
} else {
console.log(`${cwd} $> ${cmd}`)
}
const proc = execaCommand(cmd, {
env,
stdio: 'pipe',
cwd,
})
proc.stdin && process.stdin.pipe(proc.stdin)
proc.stdout && proc.stdout.pipe(process.stdout)
proc.stderr && proc.stderr.pipe(process.stderr)
let result
try {
result = await proc
} catch (error) {
// Since we already piped the io to the parent process, we remove the duplicated
// messages here so it's easier to read the error message.
if (error.stdout) error.stdout = 'value removed by vite-ecosystem-ci'
if (error.stderr) error.stderr = 'value removed by vite-ecosystem-ci'
if (error.stdio) error.stdio = ['value removed by vite-ecosystem-ci']
throw error
}
if (isGitHubActions) {
actionsCore.endGroup()
}
return result.stdout
}
export async function setupEnvironment(): Promise<EnvironmentData> {
const root = dirnameFrom(import.meta.url)
const workspace = path.resolve(root, 'workspace')
vitePath = path.resolve(workspace, 'vite')
cwd = process.cwd()
env = {
...process.env,
CI: 'true',
TURBO_FORCE: 'true', // disable turbo caching, ecosystem-ci modifies things and we don't want replays
YARN_ENABLE_IMMUTABLE_INSTALLS: 'false', // to avoid errors with mutated lockfile due to overrides
NODE_OPTIONS: '--max-old-space-size=6144', // GITHUB CI has 7GB max, stay below
ECOSYSTEM_CI: 'true', // flag for tests, can be used to conditionally skip irrelevant tests.
}
initWorkspace(workspace)
return { root, workspace, vitePath, cwd, env }
}
function initWorkspace(workspace: string) {
if (!fs.existsSync(workspace)) {
fs.mkdirSync(workspace, { recursive: true })
}
const eslintrc = path.join(workspace, '.eslintrc.json')
if (!fs.existsSync(eslintrc)) {
fs.writeFileSync(eslintrc, '{"root":true}\n', 'utf-8')
}
const editorconfig = path.join(workspace, '.editorconfig')
if (!fs.existsSync(editorconfig)) {
fs.writeFileSync(editorconfig, 'root = true\n', 'utf-8')
}
const tsconfig = path.join(workspace, 'tsconfig.json')
if (!fs.existsSync(tsconfig)) {
fs.writeFileSync(tsconfig, '{}\n', 'utf-8')
}
}
export async function setupRepo(options: RepoOptions) {
if (options.branch == null) {
options.branch = 'main'
}
if (options.shallow == null) {
options.shallow = true
}
let { repo, commit, branch, tag, dir, shallow } = options
if (!dir) {
throw new Error('setupRepo must be called with options.dir')
}
if (!repo.includes(':')) {
repo = `https://github.com/${repo}.git`
}
let needClone = true
if (fs.existsSync(dir)) {
const _cwd = cwd
cd(dir)
let currentClonedRepo: string | undefined
try {
currentClonedRepo = await $`git ls-remote --get-url`
} catch {
// when not a git repo
}
cd(_cwd)
if (repo === currentClonedRepo) {
needClone = false
} else {
fs.rmSync(dir, { recursive: true, force: true })
}
}
if (needClone) {
await $`git -c advice.detachedHead=false clone ${
shallow ? '--depth=1 --no-tags' : ''
} --branch ${tag || branch} ${repo} ${dir}`
}
cd(dir)
await $`git clean -fdxq`
await $`git fetch ${shallow ? '--depth=1 --no-tags' : '--tags'} origin ${
tag ? `tag ${tag}` : `${commit || branch}`
}`
if (shallow) {
await $`git -c advice.detachedHead=false checkout ${
tag ? `tags/${tag}` : `${commit || branch}`
}`
} else {
await $`git checkout ${branch}`
await $`git merge FETCH_HEAD`
if (tag || commit) {
await $`git reset --hard ${tag || commit}`
}
}
}
function toCommand(
task: Task | Task[] | void,
agent: Agent,
): ((scripts: any) => Promise<any>) | void {
return async (scripts: any) => {
const tasks = Array.isArray(task) ? task : [task]
for (const task of tasks) {
if (task == null || task === '') {
continue
} else if (typeof task === 'string') {
if (scripts[task] != null) {
const runTaskWithAgent = getCommand(agent, 'run', [task])
await $`${runTaskWithAgent}`
} else {
await $`${task}`
}
} else if (typeof task === 'function') {
await task()
} else if (task?.script) {
if (scripts[task.script] != null) {
const runTaskWithAgent = getCommand(agent, 'run', [
task.script,
...(task.args ?? []),
])
await $`${runTaskWithAgent}`
} else {
throw new Error(
`invalid task, script "${task.script}" does not exist in package.json`,
)
}
} else {
throw new Error(
`invalid task, expected string or function but got ${typeof task}: ${task}`,
)
}
}
}
}
export async function runInRepo(options: RunOptions & RepoOptions) {
if (options.verify == null) {
options.verify = true
}
if (options.skipGit == null) {
options.skipGit = false
}
if (options.branch == null) {
options.branch = 'main'
}
const {
build,
test,
repo,
branch,
tag,
commit,
skipGit,
verify,
beforeInstall,
beforeBuild,
beforeTest,
} = options
const dir = path.resolve(
options.workspace,
options.dir || repo.substring(repo.lastIndexOf('/') + 1),
)
if (!skipGit) {
await setupRepo({ repo, dir, branch, tag, commit })
} else {
cd(dir)
}
if (options.agent == null) {
const detectedAgent = await detect({ cwd: dir, autoInstall: false })
if (detectedAgent == null) {
throw new Error(`Failed to detect packagemanager in ${dir}`)
}
options.agent = detectedAgent
}
if (!AGENTS[options.agent]) {
throw new Error(
`Invalid agent ${options.agent}. Allowed values: ${Object.keys(
AGENTS,
).join(', ')}`,
)
}
const agent = options.agent
const beforeInstallCommand = toCommand(beforeInstall, agent)
const beforeBuildCommand = toCommand(beforeBuild, agent)
const beforeTestCommand = toCommand(beforeTest, agent)
const buildCommand = toCommand(build, agent)
const testCommand = toCommand(test, agent)
const pkgFile = path.join(dir, 'package.json')
const pkg = JSON.parse(await fs.promises.readFile(pkgFile, 'utf-8'))
await beforeInstallCommand?.(pkg.scripts)
if (verify && test) {
const frozenInstall = getCommand(agent, 'frozen')
await $`${frozenInstall}`
await beforeBuildCommand?.(pkg.scripts)
await buildCommand?.(pkg.scripts)
await beforeTestCommand?.(pkg.scripts)
await testCommand?.(pkg.scripts)
}
let overrides = options.overrides || {}
if (options.release) {
if (overrides.vite && overrides.vite !== options.release) {
throw new Error(
`conflicting overrides.vite=${overrides.vite} and --release=${options.release} config. Use either one or the other`,
)
} else {
overrides.vite = options.release
}
} else {
overrides.vite ||= `${options.vitePath}/packages/vite`
overrides[`@vitejs/plugin-legacy`] ||=
`${options.vitePath}/packages/plugin-legacy`
const vitePackageInfo = await getVitePackageInfo(options.vitePath)
// skip if `overrides.rollup` is `false`
if (
vitePackageInfo.dependencies.rollup?.version &&
overrides.rollup !== false
) {
overrides.rollup = vitePackageInfo.dependencies.rollup.version
}
// build and apply local overrides
const localOverrides = await buildOverrides(pkg, options, overrides)
cd(dir) // buildOverrides changed dir, change it back
overrides = {
...overrides,
...localOverrides,
}
}
await applyPackageOverrides(dir, pkg, overrides)
await beforeBuildCommand?.(pkg.scripts)
await buildCommand?.(pkg.scripts)
if (test) {
await beforeTestCommand?.(pkg.scripts)
await testCommand?.(pkg.scripts)
}
return { dir }
}
export async function setupViteRepo(options: Partial<RepoOptions>) {
const repo = options.repo || 'vitejs/vite'
await setupRepo({
repo,
dir: vitePath,
branch: 'main',
shallow: true,
...options,
})
try {
const rootPackageJsonFile = path.join(vitePath, 'package.json')
const rootPackageJson = JSON.parse(
await fs.promises.readFile(rootPackageJsonFile, 'utf-8'),
)
const viteMonoRepoNames = ['@vitejs/vite-monorepo', 'vite-monorepo']
const { name } = rootPackageJson
if (!viteMonoRepoNames.includes(name)) {
throw new Error(
`expected "name" field of ${repo}/package.json to indicate vite monorepo, but got ${name}.`,
)
}
const needsWrite = await overridePackageManagerVersion(
rootPackageJson,
'pnpm',
)
if (needsWrite) {
fs.writeFileSync(
rootPackageJsonFile,
JSON.stringify(rootPackageJson, null, 2),
'utf-8',
)
if (rootPackageJson.devDependencies?.pnpm) {
await $`pnpm install -Dw pnpm --lockfile-only`
}
}
} catch (e) {
throw new Error(`Failed to setup vite repo`, { cause: e })
}
}
export async function getPermanentRef() {
cd(vitePath)
try {
const ref = await $`git log -1 --pretty=format:%H`
return ref
} catch (e) {
console.warn(`Failed to obtain perm ref. ${e}`)
return undefined
}
}
export async function buildVite({ verify = false }) {
cd(vitePath)
const frozenInstall = getCommand('pnpm', 'frozen')
const runBuild = getCommand('pnpm', 'run', ['build'])
const runTest = getCommand('pnpm', 'run', ['test'])
await $`${frozenInstall}`
await $`${runBuild}`
if (verify) {
await $`${runTest}`
}
}
export async function bisectVite(
good: string,
runSuite: () => Promise<Error | void>,
) {
// sometimes vite build modifies files in git, e.g. LICENSE.md
// this would stop bisect, so to reset those changes
const resetChanges = async () => $`git reset --hard HEAD`
try {
cd(vitePath)
await resetChanges()
await $`git bisect start`
await $`git bisect bad`
await $`git bisect good ${good}`
let bisecting = true
while (bisecting) {
const commitMsg = await $`git log -1 --format=%s`
const isNonCodeCommit = commitMsg.match(/^(?:release|docs)[:(]/)
if (isNonCodeCommit) {
await $`git bisect skip`
continue // see if next commit can be skipped too
}
const error = await runSuite()
cd(vitePath)
await resetChanges()
const bisectOut = await $`git bisect ${error ? 'bad' : 'good'}`
bisecting = bisectOut.substring(0, 10).toLowerCase() === 'bisecting:' // as long as git prints 'bisecting: ' there are more revisions to test
}
} catch (e) {
console.log('error while bisecting', e)
} finally {
try {
cd(vitePath)
await $`git bisect reset`
} catch (e) {
console.log('Error while resetting bisect', e)
}
}
}
function isLocalOverride(v: string): boolean {
if (!v.includes('/') || v.startsWith('@')) {
// not path-like (either a version number or a package name)
return false
}
try {
return !!fs.lstatSync(v)?.isDirectory()
} catch (e) {
if (e.code !== 'ENOENT') {
throw e
}
return false
}
}
/**
* utility to override packageManager version
*
* @param pkg parsed package.json
* @param pm package manager to override eg. `pnpm`
* @returns {boolean} true if pkg was updated, caller is responsible for writing it to disk
*/
async function overridePackageManagerVersion(
pkg: { [key: string]: any },
pm: string,
): Promise<boolean> {
const versionInUse = pkg.packageManager?.startsWith(`${pm}@`)
? pkg.packageManager.substring(pm.length + 1)
: await $`${pm} --version`
let overrideWithVersion: string | null = null
if (pm === 'pnpm') {
if (semver.eq(versionInUse, '7.18.0')) {
// avoid bug with absolute overrides in pnpm 7.18.0
overrideWithVersion = '7.18.1'
}
}
if (overrideWithVersion) {
console.warn(
`detected ${pm}@${versionInUse} used in ${pkg.name}, changing pkg.packageManager and pkg.engines.${pm} to enforce use of ${pm}@${overrideWithVersion}`,
)
// corepack reads this and uses pnpm @ newVersion then
pkg.packageManager = `${pm}@${overrideWithVersion}`
if (!pkg.engines) {
pkg.engines = {}
}
pkg.engines[pm] = overrideWithVersion
if (pkg.devDependencies?.[pm]) {
// if for some reason the pm is in devDependencies, that would be a local version that'd be preferred over our forced global
// so ensure it here too.
pkg.devDependencies[pm] = overrideWithVersion
}
return true
}
return false
}
export async function applyPackageOverrides(
dir: string,
pkg: any,
overrides: Overrides = {},
) {
const useFileProtocol = (v: string) =>
isLocalOverride(v) ? `file:${path.resolve(v)}` : v
// remove boolean flags
overrides = Object.fromEntries(
Object.entries(overrides)
//eslint-disable-next-line @typescript-eslint/no-unused-vars
.filter(([key, value]) => typeof value === 'string')
.map(([key, value]) => [key, useFileProtocol(value as string)]),
)
await $`git clean -fdxq` // remove current install
const agent = await detect({ cwd: dir, autoInstall: false })
if (!agent) {
throw new Error(`failed to detect packageManager in ${dir}`)
}
// Remove version from agent string:
// yarn@berry => yarn
// pnpm@6, pnpm@7 => pnpm
const pm = agent?.split('@')[0]
await overridePackageManagerVersion(pkg, pm)
if (pm === 'pnpm') {
if (!pkg.devDependencies) {
pkg.devDependencies = {}
}
pkg.devDependencies = {
...pkg.devDependencies,
...overrides, // overrides must be present in devDependencies or dependencies otherwise they may not work
}
if (!pkg.pnpm) {
pkg.pnpm = {}
}
pkg.pnpm.overrides = {
...pkg.pnpm.overrides,
...overrides,
}
} else if (pm === 'yarn') {
pkg.resolutions = {
...pkg.resolutions,
...overrides,
}
} else if (pm === 'npm') {
pkg.overrides = {
...pkg.overrides,
...overrides,
}
// npm does not allow overriding direct dependencies, force it by updating the blocks themselves
for (const [name, version] of Object.entries(overrides)) {
if (pkg.dependencies?.[name]) {
pkg.dependencies[name] = version
}
if (pkg.devDependencies?.[name]) {
pkg.devDependencies[name] = version
}
}
} else {
throw new Error(`unsupported package manager detected: ${pm}`)
}
const pkgFile = path.join(dir, 'package.json')
await fs.promises.writeFile(pkgFile, JSON.stringify(pkg, null, 2), 'utf-8')
// use of `ni` command here could cause lockfile violation errors so fall back to native commands that avoid these
if (pm === 'pnpm') {
await $`pnpm install --prefer-frozen-lockfile --strict-peer-dependencies false`
} else if (pm === 'yarn') {
await $`yarn install`
} else if (pm === 'npm') {
await $`npm install`
}
}
export function dirnameFrom(url: string) {
return path.dirname(fileURLToPath(url))
}
export function parseViteMajor(vitePath: string): number {
const content = fs.readFileSync(
path.join(vitePath, 'packages', 'vite', 'package.json'),
'utf-8',
)
const pkg = JSON.parse(content)
return parseMajorVersion(pkg.version)
}
export function parseMajorVersion(version: string) {
return parseInt(version.split('.', 1)[0], 10)
}
async function buildOverrides(
pkg: any,
options: RunOptions,
repoOverrides: Overrides,
) {
const { root } = options
const buildsPath = path.join(root, 'builds')
const buildFiles: string[] = fs
.readdirSync(buildsPath)
.filter((f: string) => !f.startsWith('_') && f.endsWith('.ts'))
.map((f) => path.join(buildsPath, f))
const buildDefinitions: {
packages: { [key: string]: string }
build: (options: RunOptions) => Promise<{ dir: string }>
dir?: string
}[] = await Promise.all(buildFiles.map((f) => import(pathToFileURL(f).href)))
const deps = new Set([
...Object.keys(pkg.dependencies ?? {}),
...Object.keys(pkg.devDependencies ?? {}),
...Object.keys(pkg.peerDependencies ?? {}),
])
const needsOverride = (p: string) =>
repoOverrides[p] === true || (deps.has(p) && repoOverrides[p] == null)
const buildsToRun = buildDefinitions.filter(({ packages }) =>
Object.keys(packages).some(needsOverride),
)
const overrides: Overrides = {}
for (const buildDef of buildsToRun) {
const { dir } = await buildDef.build({
root: options.root,
workspace: options.workspace,
vitePath: options.vitePath,
viteMajor: options.viteMajor,
skipGit: options.skipGit,
release: options.release,
verify: options.verify,
// do not pass along scripts
})
for (const [name, path] of Object.entries(buildDef.packages)) {
if (needsOverride(name)) {
overrides[name] = `${dir}/${path}`
}
}
}
return overrides
}
/**
* use pnpm ls to get information about installed dependency versions of vite
* @param vitePath - workspace vite root
*/
async function getVitePackageInfo(vitePath: string): Promise<PackageInfo> {
try {
// run in vite dir to avoid package manager mismatch error from corepack
const current = cwd
cd(`${vitePath}/packages/vite`)
const lsOutput = $`pnpm ls --json`
cd(current)
const lsParsed = JSON.parse(await lsOutput)
return lsParsed[0] as PackageInfo
} catch (e) {
console.error('failed to retrieve vite package infos', e)
throw e
}
}