run-gates.ts 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418
  1. /**
  2. * Run local and CI quality gates with bounded in-process scheduling.
  3. *
  4. * The gate vocabulary stays in package.json; this runner only decides which
  5. * independent commands can overlap and which commands wait for built artifacts.
  6. */
  7. import { spawn } from 'node:child_process'
  8. import { readdir, rm } from 'node:fs/promises'
  9. import { availableParallelism } from 'node:os'
  10. import { join, resolve } from 'node:path'
  11. import { performance } from 'node:perf_hooks'
  12. type Mode =
  13. | 'ci-primary'
  14. | 'ci-static'
  15. | 'ci-lint'
  16. | 'ci-coverage'
  17. | 'ci-snapshot'
  18. | 'ci-artifacts'
  19. | 'node-compat'
  20. | 'pre-push'
  21. type GateStatus = 'pending' | 'running' | 'passed' | 'failed' | 'skipped'
  22. interface Gate {
  23. id: string
  24. label: string
  25. command: string
  26. args: string[]
  27. needs?: string[]
  28. env?: Record<string, string | undefined>
  29. input?: string
  30. verify?: (result: GateResult) => Promise<void>
  31. }
  32. interface GateResult {
  33. gate: Gate
  34. status: GateStatus
  35. durationMs: number
  36. stdout: string
  37. stderr: string
  38. exitCode: number | null
  39. error?: string
  40. }
  41. interface RunningGate {
  42. gate: Gate
  43. promise: Promise<GateResult>
  44. }
  45. const root = resolve(import.meta.dirname, '..')
  46. const mode = parseMode(process.argv[2])
  47. const gates = gatesForMode(mode)
  48. const maxConcurrency = concurrencyFromEnv('DSH_GATE_CONCURRENCY', defaultConcurrency(gates.length))
  49. const startedAt = performance.now()
  50. console.log(`run-gates: ${mode} running ${gates.length} gate(s) with ${maxConcurrency} worker(s).`)
  51. const results = await runGates(gates, maxConcurrency)
  52. printSummary(results, performance.now() - startedAt)
  53. if (results.some(result => result.status === 'failed' || result.status === 'skipped')) process.exit(1)
  54. function parseMode(raw: string | undefined): Mode {
  55. switch (raw) {
  56. case 'ci-primary':
  57. case 'ci-static':
  58. case 'ci-lint':
  59. case 'ci-coverage':
  60. case 'ci-snapshot':
  61. case 'ci-artifacts':
  62. case 'node-compat':
  63. case 'pre-push':
  64. return raw
  65. default:
  66. throw new Error(
  67. `run-gates: expected mode ci-primary | ci-static | ci-lint | ci-coverage | ci-snapshot | ci-artifacts | node-compat | pre-push, got ${JSON.stringify(raw)}.`,
  68. )
  69. }
  70. }
  71. function defaultConcurrency(total: number): number {
  72. return Math.min(total, Math.max(4, availableParallelism()))
  73. }
  74. function concurrencyFromEnv(name: string, fallback: number): number {
  75. const raw = process.env[name]
  76. if (raw === undefined || raw === '') return fallback
  77. const parsed = Number.parseInt(raw, 10)
  78. if (!Number.isSafeInteger(parsed) || parsed < 1) {
  79. throw new Error(`run-gates: ${name} must be a positive integer, got ${JSON.stringify(raw)}.`)
  80. }
  81. return parsed
  82. }
  83. function pnpmScript(id: string, script: string, options: Partial<Gate> = {}): Gate {
  84. return {
  85. id,
  86. label: options.label ?? script,
  87. command: pnpmBin(),
  88. args: ['run', script],
  89. ...options,
  90. }
  91. }
  92. function pnpmExec(id: string, args: string[], options: Partial<Gate> = {}): Gate {
  93. return {
  94. id,
  95. label: options.label ?? `pnpm exec ${args.join(' ')}`,
  96. command: pnpmBin(),
  97. args: ['exec', ...args],
  98. ...options,
  99. }
  100. }
  101. function pnpmBin(): string {
  102. return process.platform === 'win32' ? 'pnpm.cmd' : 'pnpm'
  103. }
  104. function nodeOptions(...options: string[]): string {
  105. return [process.env.NODE_OPTIONS, ...options].filter(option => option !== undefined && option !== '').join(' ')
  106. }
  107. function gatesForMode(selected: Mode): Gate[] {
  108. switch (selected) {
  109. case 'ci-primary':
  110. return ciPrimaryGates()
  111. case 'ci-static':
  112. return ciStaticGates()
  113. case 'ci-lint':
  114. return [
  115. lintGate(),
  116. ]
  117. case 'ci-coverage':
  118. return [
  119. coverageGate(),
  120. ]
  121. case 'ci-snapshot':
  122. return [
  123. pnpmScript('snapshot', 'test:snapshot'),
  124. ]
  125. case 'ci-artifacts':
  126. return ciArtifactGates()
  127. case 'node-compat':
  128. return [
  129. pnpmScript('typecheck', 'typecheck'),
  130. ]
  131. case 'pre-push':
  132. return [
  133. pnpmScript('test', 'test'),
  134. pnpmScript('snapshot', 'test:snapshot'),
  135. pnpmScript('build', 'build'),
  136. ...hygieneLeafGates({ artifactNeeds: ['build'] }),
  137. ...docSyncLeafGates(),
  138. pnpmScript('module-graph', 'verify-module-graph', { label: 'module graph' }),
  139. ]
  140. }
  141. }
  142. function ciPrimaryGates(): Gate[] {
  143. return [
  144. pnpmScript('constraints', 'constraints'),
  145. pnpmScript('typecheck', 'typecheck'),
  146. lintGate(),
  147. coverageGate(),
  148. pnpmScript('snapshot', 'test:snapshot'),
  149. demoSmokeGate({ needs: ['lint'] }),
  150. ...docSyncLeafGates(),
  151. pnpmScript('module-graph', 'verify-module-graph', { label: 'module graph' }),
  152. pnpmScript('knip', 'knip'),
  153. pnpmScript('build', 'build', { needs: ['typecheck'] }),
  154. pnpmScript('publint', 'publint', { needs: ['build'] }),
  155. pnpmScript('node-next-types', 'verify-node-next-types', {
  156. label: 'node-next types',
  157. needs: ['build'],
  158. }),
  159. builtBinSmokeGate(),
  160. ]
  161. }
  162. function ciStaticGates(): Gate[] {
  163. return [
  164. pnpmScript('constraints', 'constraints'),
  165. pnpmScript('typecheck', 'typecheck'),
  166. demoSmokeGate(),
  167. ...docSyncLeafGates(),
  168. pnpmScript('module-graph', 'verify-module-graph', { label: 'module graph' }),
  169. pnpmScript('knip', 'knip'),
  170. ]
  171. }
  172. function ciArtifactGates(): Gate[] {
  173. return [
  174. pnpmScript('build', 'build'),
  175. pnpmScript('publint', 'publint', { needs: ['build'] }),
  176. pnpmScript('node-next-types', 'verify-node-next-types', {
  177. label: 'node-next types',
  178. needs: ['build'],
  179. }),
  180. builtBinSmokeGate(),
  181. ]
  182. }
  183. function lintGate(): Gate {
  184. return pnpmScript('lint', 'lint', {
  185. env: { NODE_OPTIONS: nodeOptions('--max-old-space-size=8192') },
  186. })
  187. }
  188. function coverageGate(): Gate {
  189. return pnpmExec('coverage', [
  190. 'vitest',
  191. 'run',
  192. '--coverage',
  193. ...positiveIntArg('DSH_COVERAGE_MAX_WORKERS', '--maxWorkers'),
  194. ], {
  195. label: 'test:coverage',
  196. })
  197. }
  198. function positiveIntArg(envName: string, flag: string): string[] {
  199. const raw = process.env[envName]
  200. if (raw === undefined || raw === '') return []
  201. const parsed = Number.parseInt(raw, 10)
  202. if (!Number.isSafeInteger(parsed) || parsed < 1 || String(parsed) !== raw) {
  203. throw new Error(`run-gates: ${envName} must be a positive integer, got ${JSON.stringify(raw)}.`)
  204. }
  205. return [`${flag}=${raw}`]
  206. }
  207. function hygieneLeafGates(options: { artifactNeeds?: string[] } = {}): Gate[] {
  208. const artifactOptions = options.artifactNeeds === undefined ? {} : { needs: options.artifactNeeds }
  209. return [
  210. pnpmScript('knip', 'knip'),
  211. pnpmScript('publint', 'publint', artifactOptions),
  212. pnpmScript('constraints', 'constraints'),
  213. pnpmScript('node-next-types', 'verify-node-next-types', {
  214. label: 'node-next types',
  215. ...artifactOptions,
  216. }),
  217. ]
  218. }
  219. function docSyncLeafGates(): Gate[] {
  220. return [
  221. pnpmScript('doc-typecheck', 'doc-typecheck'),
  222. pnpmScript('cordis-catalog', 'verify-cordis-catalog', { label: 'cordis catalog' }),
  223. pnpmScript('tool-catalog', 'verify-tool-catalog', { label: 'tool catalog' }),
  224. pnpmScript('persistence-catalog', 'verify-persistence-catalog', { label: 'persistence catalog' }),
  225. pnpmScript('doc-graphs', 'verify-doc-graphs', { label: 'doc graphs' }),
  226. pnpmScript('markdown-wrap', 'verify-md-wrap', { label: 'markdown wrap' }),
  227. pnpmScript('markdown-links', 'verify-md-links', { label: 'markdown links' }),
  228. pnpmScript('doc-refs', 'verify-doc-refs', { label: 'doc refs' }),
  229. pnpmScript('package-paths', 'verify-package-paths', { label: 'package paths' }),
  230. pnpmScript('mermaid', 'verify-mermaid'),
  231. pnpmScript('rfc-classification', 'verify-rfc-classification', { label: 'rfc classification' }),
  232. pnpmScript('rfc-format', 'verify-rfc-format', { label: 'rfc format' }),
  233. pnpmScript('type-equivalence', 'verify-type-equiv', { label: 'type equivalence' }),
  234. pnpmScript('translation-pairing', 'verify-translation-pairing', { label: 'translation pairing' }),
  235. pnpmScript('doc-budgets', 'verify-doc-budgets', { label: 'doc budgets' }),
  236. ]
  237. }
  238. function demoSmokeGate(options: { needs?: string[] } = {}): Gate {
  239. const dependencyOptions = options.needs === undefined ? {} : { needs: options.needs }
  240. return {
  241. id: 'demo-smoke',
  242. label: 'demo smoke',
  243. command: pnpmBin(),
  244. args: ['run', 'demo:echo'],
  245. input: 'echo ci smoke\n',
  246. ...dependencyOptions,
  247. verify: async (result) => {
  248. const output = result.stdout + result.stderr
  249. if (!output.includes('[tool call] echo({"text":"ci smoke"})')) {
  250. throw new Error('demo smoke did not show the echo tool call.')
  251. }
  252. if (!output.includes('[tool result] ECHO: CI SMOKE')) {
  253. throw new Error('demo smoke did not show the echo tool result.')
  254. }
  255. const sessionDir = join(root, '.sessions', '_no-cwd')
  256. const entries = await readdir(sessionDir)
  257. if (!entries.some(entry => /^main-session-.+\.jsonl$/.test(entry))) {
  258. throw new Error('demo smoke did not create a main-session JSONL log.')
  259. }
  260. await rm(join(root, '.sessions'), { recursive: true, force: true })
  261. },
  262. }
  263. }
  264. function builtBinSmokeGate(): Gate {
  265. return pnpmExec('built-bin-smoke', [
  266. 'vitest',
  267. 'run',
  268. '--config',
  269. 'vitest.e2e.config.ts',
  270. 'packages/ui/stdio-agent/tests/built-bin.e2e.ts',
  271. 'packages/ui/acp-agent/tests/built-bin.e2e.ts',
  272. ], {
  273. label: 'built-bin smoke',
  274. needs: ['build'],
  275. })
  276. }
  277. async function runGates(allGates: Gate[], maxActive: number): Promise<GateResult[]> {
  278. const states = new Map<string, GateStatus>(allGates.map(gate => [gate.id, 'pending']))
  279. const results = new Map<string, GateResult>()
  280. const running: RunningGate[] = []
  281. for (;;) {
  282. let madeProgress = false
  283. while (running.length < maxActive) {
  284. const ready = allGates.find(gate => states.get(gate.id) === 'pending' && dependenciesPassed(gate, states))
  285. if (ready === undefined) break
  286. states.set(ready.id, 'running')
  287. running.push({ gate: ready, promise: runGate(ready) })
  288. console.log(`run-gates: start ${ready.label}`)
  289. madeProgress = true
  290. }
  291. if (running.length === 0) {
  292. const pending = allGates.filter(gate => states.get(gate.id) === 'pending')
  293. for (const gate of pending) {
  294. const failedDeps = (gate.needs ?? []).filter(id => states.get(id) !== 'passed')
  295. const result: GateResult = {
  296. gate,
  297. status: 'skipped',
  298. durationMs: 0,
  299. stdout: '',
  300. stderr: '',
  301. exitCode: null,
  302. error: `dependency failed or skipped: ${failedDeps.join(', ')}`,
  303. }
  304. states.set(gate.id, 'skipped')
  305. results.set(gate.id, result)
  306. printResult(result)
  307. }
  308. break
  309. }
  310. if (!madeProgress) {
  311. const settled = await Promise.race(running.map(async item => ({ item, result: await item.promise })))
  312. running.splice(running.indexOf(settled.item), 1)
  313. states.set(settled.item.gate.id, settled.result.status)
  314. results.set(settled.item.gate.id, settled.result)
  315. printResult(settled.result)
  316. }
  317. }
  318. return allGates.map((gate) => {
  319. const result = results.get(gate.id)
  320. if (result === undefined) throw new Error(`run-gates: missing result for ${gate.id}.`)
  321. return result
  322. })
  323. }
  324. function dependenciesPassed(gate: Gate, states: Map<string, GateStatus>): boolean {
  325. return (gate.needs ?? []).every(id => states.get(id) === 'passed')
  326. }
  327. async function runGate(gate: Gate): Promise<GateResult> {
  328. const started = performance.now()
  329. let stdout = ''
  330. let stderr = ''
  331. const exitCode = await new Promise<number | null>((resolveExit, reject) => {
  332. const child = spawn(gate.command, gate.args, {
  333. cwd: root,
  334. env: { ...process.env, ...gate.env },
  335. stdio: ['pipe', 'pipe', 'pipe'],
  336. })
  337. child.stdout.setEncoding('utf8')
  338. child.stderr.setEncoding('utf8')
  339. child.stdout.on('data', (chunk: string) => { stdout += chunk })
  340. child.stderr.on('data', (chunk: string) => { stderr += chunk })
  341. child.on('error', reject)
  342. child.on('close', resolveExit)
  343. if (gate.input !== undefined) child.stdin.end(gate.input)
  344. else child.stdin.end()
  345. })
  346. let status: GateStatus = exitCode === 0 ? 'passed' : 'failed'
  347. let error: string | undefined
  348. if (status === 'passed' && gate.verify !== undefined) {
  349. try {
  350. await gate.verify({ gate, status, durationMs: performance.now() - started, stdout, stderr, exitCode })
  351. } catch (verifyError: unknown) {
  352. status = 'failed'
  353. error = verifyError instanceof Error ? verifyError.message : String(verifyError)
  354. }
  355. }
  356. const result: GateResult = {
  357. gate,
  358. status,
  359. durationMs: performance.now() - started,
  360. stdout,
  361. stderr,
  362. exitCode,
  363. }
  364. if (error !== undefined) result.error = error
  365. return result
  366. }
  367. function printResult(result: GateResult): void {
  368. const seconds = (result.durationMs / 1000).toFixed(2)
  369. console.log(`\n== ${result.status.toUpperCase()} ${result.gate.label} (${seconds}s) ==`)
  370. process.stdout.write(result.stdout)
  371. process.stderr.write(result.stderr)
  372. if (result.error !== undefined) console.error(result.error)
  373. }
  374. function printSummary(results: GateResult[], durationMs: number): void {
  375. const passed = results.filter(result => result.status === 'passed').length
  376. const failed = results.filter(result => result.status === 'failed').length
  377. const skipped = results.filter(result => result.status === 'skipped').length
  378. const seconds = (durationMs / 1000).toFixed(2)
  379. console.log(`\nrun-gates: ${passed} passed, ${failed} failed, ${skipped} skipped in ${seconds}s.`)
  380. }