forked from vitejs/vite-ecosystem-ci
-
Notifications
You must be signed in to change notification settings - Fork 0
/
utils.ts
341 lines (317 loc) · 8.7 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
import path from 'path'
import fs from 'fs'
import { fileURLToPath } from 'url'
import { execaCommand } from 'execa'
import {
EnvironmentData,
Overrides,
ProcessEnv,
RepoOptions,
RunOptions,
Task
} from './types'
//eslint-disable-next-line node/no-unpublished-import
import { detect } from '@antfu/ni'
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]}` : ''),
''
)
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)
const result = await proc
return result.stdout
}
export async function setupEnvironment(): Promise<EnvironmentData> {
// @ts-expect-error import.meta
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',
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
}
return { root, workspace, vitePath, cwd, env }
}
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`
}
if (!fs.existsSync(dir)) {
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
): ((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') {
const scriptOrBin = task.trim().split(/\s+/)[0]
await (scripts?.[scriptOrBin] != null ? $`nr ${task}` : $`${task}`)
} else if (typeof task === 'function') {
await task()
} 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,
useCopyForOverrides
} = options
const beforeInstallCommand = toCommand(beforeInstall)
const beforeBuildCommand = toCommand(beforeBuild)
const beforeTestCommand = toCommand(beforeTest)
const buildCommand = toCommand(build)
const testCommand = toCommand(test)
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)
}
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) {
await $`ni --frozen`
await beforeBuildCommand?.(pkg.scripts)
await buildCommand?.(pkg.scripts)
await beforeTestCommand?.(pkg.scripts)
await testCommand?.(pkg.scripts)
}
const 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 {
const protocol = useCopyForOverrides ? 'file:' : ''
overrides.vite ||= `${protocol}${options.vitePath}/packages/vite`
overrides[
`@vitejs/plugin-vue`
] ||= `${protocol}${options.vitePath}/packages/plugin-vue`
overrides[
`@vitejs/plugin-vue-jsx`
] ||= `${protocol}${options.vitePath}/packages/plugin-vue-jsx`
overrides[
`@vitejs/plugin-react`
] ||= `${protocol}${options.vitePath}/packages/plugin-react`
overrides[
`@vitejs/plugin-legacy`
] ||= `${protocol}${options.vitePath}/packages/plugin-legacy`
const typesNodePath = fs.realpathSync(
`${options.vitePath}/node_modules/@types/node`
)
overrides[`@types/node`] ||= `${protocol}${typesNodePath}`
}
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>) {
await setupRepo({
repo: 'vitejs/vite',
dir: vitePath,
branch: 'main',
shallow: true,
...options
})
}
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)
await $`ni --frozen`
await $`nr build`
if (verify) {
await $`nr test`
}
}
export async function bisectVite(
good: string,
runSuite: () => Promise<Error | void>
) {
try {
cd(vitePath)
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)
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)
}
}
}
export async function applyPackageOverrides(
dir: string,
pkg: any,
overrides: Overrides = {}
) {
await $`git clean -fdxq` // remove current install
const agent = await detect({ cwd: dir, autoInstall: false })
// Remove version from agent string:
// yarn@berry => yarn
// pnpm@6, pnpm@7 => pnpm
const pm = agent?.split('@')[0]
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 --prefer-offline --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))
}