run-gates.ts 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817
  1. /**
  2. * Run local and CI quality gates with bounded in-process scheduling.
  3. *
  4. * Package scripts own public aggregate names; this runner owns their validated
  5. * dependency graphs, scheduler environment, and process diagnostics.
  6. * @see ../.agents/notes/implemented/process/2026-07-06-parallel-pre-push-gates.md
  7. */
  8. import { spawn } from 'node:child_process'
  9. import { availableParallelism } from 'node:os'
  10. import { resolve } from 'node:path'
  11. import { performance } from 'node:perf_hooks'
  12. import { COVERAGE_EXEMPT_ENV, coverageExemptHeavySuites } from './coverage-exempt.ts'
  13. /** A named aggregate exposed by the gate runner. */
  14. export type Mode =
  15. | 'ci-primary'
  16. | 'ci-linux-primary'
  17. | 'ci-static'
  18. | 'ci-lint'
  19. | 'ci-coverage'
  20. | 'ci-snapshot'
  21. | 'ci-artifacts'
  22. | 'ci-consumers'
  23. | 'ci-windows-blocking'
  24. | 'ci-windows-complete'
  25. | 'ci-windows-observational'
  26. | 'node-compat'
  27. | 'check-all'
  28. | 'doc-sync'
  29. type GateResultStatus = 'passed' | 'failed' | 'skipped'
  30. type GateState = 'pending' | 'running' | GateResultStatus
  31. /** A command and its dependency metadata inside one aggregate. */
  32. export interface Gate {
  33. id: string
  34. label: string
  35. displayCommand: string
  36. command: string
  37. args: string[]
  38. needs?: string[]
  39. env?: Record<string, string | undefined>
  40. allowFailure?: boolean
  41. }
  42. /** The observed outcome of one gate process. */
  43. export interface GateResult {
  44. gate: Gate
  45. status: GateResultStatus
  46. durationMs: number
  47. output: GateOutputChunk[]
  48. exitCode: number | null
  49. signalCode: NodeJS.Signals | null
  50. error?: string
  51. }
  52. interface GateOutputChunk {
  53. stream: 'stdout' | 'stderr'
  54. text: string
  55. }
  56. interface RunningGate {
  57. gate: Gate
  58. promise: Promise<GateResult>
  59. }
  60. interface ConcurrencyDefault {
  61. workers: number
  62. source: string
  63. }
  64. type GateExecutor = (gate: Gate) => Promise<GateResult>
  65. type ResultObserver = (result: GateResult) => void
  66. const root = resolve(import.meta.dirname, '..')
  67. if (import.meta.main) {
  68. process.exitCode = await main(process.argv.slice(2))
  69. }
  70. async function main(args: string[]): Promise<number> {
  71. const mode = parseMode(args[0])
  72. const gates = gatesForMode(mode)
  73. const concurrencyDefault = defaultConcurrency(mode, gates.length)
  74. const concurrencyOverride = process.env.DSH_GATE_CONCURRENCY
  75. const maxConcurrency = concurrencyFromEnv('DSH_GATE_CONCURRENCY', concurrencyDefault.workers)
  76. const concurrencySource = concurrencyOverride === undefined || concurrencyOverride === ''
  77. ? concurrencyDefault.source
  78. : '$DSH_GATE_CONCURRENCY'
  79. const startedAt = performance.now()
  80. console.log(`run-gates: ${mode} running ${gates.length} gate(s) with ${maxConcurrency} worker(s) from ${concurrencySource}.`)
  81. const results = await runGates(gates, maxConcurrency, runGate, printResult)
  82. printSummary(results, performance.now() - startedAt)
  83. return results.some(result => result.gate.allowFailure !== true && (result.status === 'failed' || result.status === 'skipped'))
  84. ? 1
  85. : 0
  86. }
  87. function parseMode(raw: string | undefined): Mode {
  88. switch (raw) {
  89. case 'ci-primary':
  90. case 'ci-linux-primary':
  91. case 'ci-static':
  92. case 'ci-lint':
  93. case 'ci-coverage':
  94. case 'ci-snapshot':
  95. case 'ci-artifacts':
  96. case 'ci-consumers':
  97. case 'ci-windows-blocking':
  98. case 'ci-windows-complete':
  99. case 'ci-windows-observational':
  100. case 'node-compat':
  101. case 'check-all':
  102. case 'doc-sync':
  103. return raw
  104. default:
  105. throw new Error(
  106. `run-gates: expected mode ci-primary | ci-linux-primary | ci-static | ci-lint | ci-coverage | ci-snapshot | ci-artifacts | ci-consumers | ci-windows-blocking | ci-windows-complete | ci-windows-observational | node-compat | check-all | doc-sync, got ${JSON.stringify(raw)}.`,
  107. )
  108. }
  109. }
  110. /**
  111. * Resolve the default worker count for one aggregate.
  112. * @param selectedMode - aggregate whose resource posture applies.
  113. * @param total - number of gates in the aggregate.
  114. * @param available - host CPU availability for ordinary modes.
  115. * @returns the default worker count and its diagnostic source.
  116. */
  117. export function defaultConcurrency(
  118. selectedMode: Mode,
  119. total: number,
  120. available = availableParallelism(),
  121. ): ConcurrencyDefault {
  122. if (selectedMode === 'ci-consumers') return { workers: total, source: 'ci-consumers gate count' }
  123. // Local modes cap workers: several doc gates each build a full ts.Program,
  124. // so an uncapped default on a large host trades wall clock for memory blowups.
  125. const localCap = selectedMode === 'check-all' || selectedMode === 'doc-sync'
  126. const modeLimit = localCap ? Math.min(4, available) : available
  127. return {
  128. workers: Math.min(total, modeLimit),
  129. source: localCap
  130. ? `${available} available CPU(s), ${selectedMode} cap 4`
  131. : `${available} available CPU(s)`,
  132. }
  133. }
  134. function concurrencyFromEnv(name: string, fallback: number): number {
  135. const raw = process.env[name]
  136. if (raw === undefined || raw === '') return fallback
  137. const parsed = Number.parseInt(raw, 10)
  138. if (!Number.isSafeInteger(parsed) || parsed < 1) {
  139. throw new Error(`run-gates: ${name} must be a positive integer, got ${JSON.stringify(raw)}.`)
  140. }
  141. return parsed
  142. }
  143. function pnpmScript(id: string, script: string, options: Partial<Gate> = {}): Gate {
  144. return {
  145. id,
  146. label: options.label ?? script,
  147. displayCommand: `pnpm run ${script}`,
  148. ...pnpmInvocation(['run', script]),
  149. ...options,
  150. }
  151. }
  152. function pnpmExec(id: string, args: string[], options: Partial<Gate> = {}): Gate {
  153. return {
  154. id,
  155. label: options.label ?? `pnpm exec ${args.join(' ')}`,
  156. displayCommand: `pnpm exec ${args.join(' ')}`,
  157. ...pnpmInvocation(['exec', ...args]),
  158. ...options,
  159. }
  160. }
  161. function pnpmInvocation(args: string[]): Pick<Gate, 'command' | 'args'> {
  162. const entrypoint = process.env.npm_execpath
  163. if (entrypoint === undefined || entrypoint === '') {
  164. throw new Error('run-gates: npm_execpath is unavailable; invoke the runner through a pnpm package script.')
  165. }
  166. // Windows cannot spawn the pnpm.cmd shim directly; the JavaScript entrypoint keeps every host shell-free.
  167. return { command: process.execPath, args: [entrypoint, ...args] }
  168. }
  169. /**
  170. * Construct the complete gate list for a named aggregate.
  171. * @param selected - aggregate mode to construct.
  172. * @returns the aggregate's gate graph.
  173. */
  174. export function gatesForMode(selected: Mode): Gate[] {
  175. switch (selected) {
  176. case 'ci-primary':
  177. return ciPrimaryGates()
  178. case 'ci-linux-primary':
  179. return [...ciPrimaryGates(), webSnapshotGate(['built-package-invariants'])]
  180. case 'ci-static':
  181. return ciStaticGates({ ownsBuild: false })
  182. case 'ci-lint':
  183. return [
  184. lintGate(),
  185. pnpmScript('duplication', 'duplication'),
  186. ]
  187. case 'ci-coverage':
  188. return coverageGates()
  189. case 'ci-snapshot':
  190. return [pnpmScript('build', 'build'), snapshotGate()]
  191. case 'ci-artifacts':
  192. return ciArtifactGates()
  193. case 'ci-consumers':
  194. return ciConsumerGates()
  195. case 'ci-windows-blocking':
  196. return ciWindowsBlockingGates()
  197. case 'ci-windows-complete':
  198. return ciWindowsCompleteGates()
  199. case 'ci-windows-observational':
  200. return ciWindowsObservationalGates()
  201. case 'node-compat':
  202. return nodeCompatGates()
  203. case 'check-all':
  204. return [
  205. pnpmScript('runtime-closure', 'verify-runtime-closure', { label: 'runtime closure' }),
  206. pnpmScript('cordis-config', 'verify-cordis-config', { label: 'Cordis config' }),
  207. pnpmScript('client-domain-graph', 'verify-client-domain-graph', { label: 'client domain graph' }),
  208. pnpmScript('test', 'test'),
  209. pnpmScript('duplication', 'duplication'),
  210. snapshotGate(),
  211. pnpmScript('build', 'build'),
  212. pnpmScript('build:web', 'build:web'),
  213. ...hygieneLeafGates({ artifactNeeds: ['build'] }),
  214. ...docSyncLeafGates({
  215. docTypecheckNeeds: ['build'],
  216. docTypecheckEnv: { DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1' },
  217. }),
  218. pnpmScript('module-graph', 'verify-module-graph', { label: 'module graph' }),
  219. ]
  220. case 'doc-sync':
  221. return docSyncLeafGates()
  222. }
  223. }
  224. function ciPrimaryGates(): Gate[] {
  225. return [
  226. pnpmScript('runtime-closure', 'verify-runtime-closure', { label: 'runtime closure' }),
  227. pnpmScript('constraints', 'constraints'),
  228. pnpmScript('package-invariants', 'verify-package-invariants', { label: 'package invariants' }),
  229. pnpmScript('cordis-config', 'verify-cordis-config', { label: 'Cordis config' }),
  230. pnpmScript('typecheck', 'typecheck'),
  231. lintGate(),
  232. pnpmScript('duplication', 'duplication'),
  233. ...coverageGates(),
  234. ...nodeCompatSmokeGates(),
  235. snapshotGate(),
  236. ...docSyncLeafGates(),
  237. pnpmScript('module-graph', 'verify-module-graph', { label: 'module graph' }),
  238. pnpmScript('knip', 'knip'),
  239. // typecheck and build now drive the same root solution graph; without the
  240. // dependency two concurrent `tsc -b` runs race the same tsbuildinfo files.
  241. // The tsc step is an incremental no-op after typecheck.
  242. pnpmScript('build', 'build', { needs: ['typecheck'] }),
  243. pnpmScript('publint', 'publint', { needs: ['build'] }),
  244. pnpmScript('node-next-types', 'verify-node-next-types', {
  245. label: 'node-next types',
  246. needs: ['build'],
  247. }),
  248. builtPackageInvariantsGate(['build']),
  249. builtBinSmokeGate(),
  250. ]
  251. }
  252. function nodeCompatGates(): Gate[] {
  253. return [
  254. ...flagEnabled('DSH_NODE_COMPAT_SKIP_TYPECHECK') ? [] : [pnpmScript('typecheck', 'typecheck')],
  255. ...nodeCompatSmokeGates(),
  256. ]
  257. }
  258. function nodeCompatSmokeGates(): Gate[] {
  259. return [
  260. pnpmExec('source-worker-smoke', [
  261. 'vitest',
  262. 'run',
  263. 'packages/workflow/workflow-workerthread/tests/source-worker.compat.spec.ts',
  264. ], { label: 'source worker smoke' }),
  265. pnpmExec('jsonl-zstd-smoke', [
  266. 'vitest',
  267. 'run',
  268. 'packages/session-persistence/session-persistence-jsonl/tests/zstd.compat.spec.ts',
  269. ], { label: 'JSONL Zstandard smoke' }),
  270. pnpmExec('dsh-source-launch-smoke', [
  271. 'vitest',
  272. 'run',
  273. 'apps/cli/tests/source-launch.compat.spec.ts',
  274. ], { label: 'dsh source-launch smoke' }),
  275. ]
  276. }
  277. function ciStaticGates(options: { ownsBuild: boolean }): Gate[] {
  278. return [
  279. pnpmScript('runtime-closure', 'verify-runtime-closure', { label: 'runtime closure' }),
  280. pnpmScript('constraints', 'constraints'),
  281. pnpmScript('package-invariants', 'verify-package-invariants', { label: 'package invariants' }),
  282. pnpmScript('cordis-config', 'verify-cordis-config', { label: 'Cordis config' }),
  283. ...options.ownsBuild ? [pnpmScript('build', 'build')] : [],
  284. ...docSyncLeafGates({
  285. includeDocTypecheck: options.ownsBuild,
  286. ...options.ownsBuild
  287. ? {
  288. docTypecheckNeeds: ['build'],
  289. docTypecheckEnv: { DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1' },
  290. }
  291. : {},
  292. docsBuildScript: 'docs:build:mpa',
  293. }),
  294. pnpmScript('module-graph', 'verify-module-graph', { label: 'module graph' }),
  295. pnpmScript('knip', 'knip'),
  296. ]
  297. }
  298. function ciArtifactGates(): Gate[] {
  299. return [
  300. pnpmScript('build', 'build'),
  301. pnpmScript('publint', 'publint', { needs: ['build'] }),
  302. pnpmScript('node-next-types', 'verify-node-next-types', {
  303. label: 'node-next types',
  304. needs: ['build'],
  305. }),
  306. builtPackageInvariantsGate(['build']),
  307. builtBinSmokeGate(),
  308. ]
  309. }
  310. function ciConsumerGates(): Gate[] {
  311. const builtTree = ['build']
  312. const validatedBuild = ['built-package-invariants']
  313. return [
  314. pnpmScript('build', 'build'),
  315. pnpmScript('node-compat', 'check:node-compat', { label: 'Node compatibility' }),
  316. pnpmScript('publint', 'publint', { needs: builtTree }),
  317. builtPackageInvariantsGate(['publint']),
  318. pnpmScript('lint-and-duplication', 'check:ci:lint', {
  319. label: 'lint and duplication',
  320. needs: validatedBuild,
  321. }),
  322. snapshotGate(validatedBuild),
  323. webSnapshotGate(validatedBuild),
  324. pnpmScript('doc-typecheck', 'doc-typecheck', {
  325. needs: validatedBuild,
  326. env: { DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1' },
  327. }),
  328. pnpmScript('node-next-types', 'verify-node-next-types', {
  329. label: 'node-next types',
  330. needs: validatedBuild,
  331. }),
  332. builtBinSmokeGate(validatedBuild),
  333. ]
  334. }
  335. function webSnapshotGate(needs: string[]): Gate {
  336. return pnpmScript('web-snapshot', 'test:web:built', {
  337. label: 'web browser snapshot',
  338. displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
  339. env: { DSH_SNAPSHOT: 'replay' },
  340. needs,
  341. })
  342. }
  343. function ciWindowsBlockingGates(): Gate[] {
  344. return [
  345. pnpmScript('windows-build', 'build', { label: 'build' }),
  346. pnpmScript('windows-site', 'docs:build', { label: 'production site' }),
  347. ]
  348. }
  349. function ciWindowsCompleteGates(): Gate[] {
  350. const observational = ciWindowsObservationalGates()
  351. // The required production site replaces the observational MPA build; both
  352. // VitePress modes write the same output directory and cannot overlap.
  353. .filter(gate => gate.id !== 'build' && gate.id !== 'docs-site-build')
  354. .map(gate => ({ ...gate, allowFailure: true }))
  355. return [
  356. pnpmScript('build', 'build'),
  357. pnpmScript('windows-site', 'docs:build', { label: 'production site' }),
  358. ...observational,
  359. ]
  360. }
  361. function ciWindowsObservationalGates(): Gate[] {
  362. return [
  363. ...ciStaticGates({ ownsBuild: true }),
  364. // Linux owns required lint, coverage, and snapshots; Windows omits those duplicates.
  365. pnpmScript('duplication', 'duplication'),
  366. pnpmScript('publint', 'publint', { needs: ['build'] }),
  367. pnpmScript('node-next-types', 'verify-node-next-types', {
  368. label: 'node-next types',
  369. needs: ['build'],
  370. }),
  371. builtPackageInvariantsGate(['build']),
  372. builtBinSmokeGate(),
  373. ]
  374. }
  375. function lintGate(): Gate {
  376. const raw = process.env.DSH_OXLINT_THREADS
  377. return pnpmScript('lint', 'lint', raw === undefined || raw === ''
  378. ? {}
  379. : { displayCommand: `DSH_OXLINT_THREADS=${raw} pnpm run lint` })
  380. }
  381. // The heavy suites run uninstrumented beside the thresholded gate: their
  382. // compiler- and subprocess-bound fixtures pay a multiple of their runtime
  383. // under v8 instrumentation while contributing nothing the thresholds need
  384. // (membership contract in scripts/coverage-exempt.ts).
  385. //
  386. // DSH_COVERAGE_MAX_WORKERS is the lane's worker budget, so the two parallel
  387. // gates split it instead of each claiming it whole (the failover pool's
  388. // 8 x 6-instance bound assumes one lane never exceeds its value). The exempt
  389. // gate's wall clock is dominated by its longest single file, so it takes the
  390. // small share. A budget of 1 gives each gate 1 worker; lanes that need a
  391. // strict total of one (the serial reference jobs) also set
  392. // DSH_GATE_CONCURRENCY=1, which keeps the gates from overlapping at all.
  393. function coverageWorkerArgs(): { instrumented: string[]; exempt: string[] } {
  394. const [flag] = positiveIntArg('DSH_COVERAGE_MAX_WORKERS', '--maxWorkers')
  395. if (flag === undefined) return { instrumented: [], exempt: [] }
  396. const total = Number.parseInt(flag.split('=')[1] ?? '', 10)
  397. const exempt = Math.max(1, Math.floor(total / 3))
  398. const instrumented = Math.max(1, total - exempt)
  399. return {
  400. instrumented: [`--maxWorkers=${String(instrumented)}`],
  401. exempt: [`--maxWorkers=${String(exempt)}`],
  402. }
  403. }
  404. function coverageGates(): Gate[] {
  405. const workers = coverageWorkerArgs()
  406. return [
  407. pnpmExec('coverage', [
  408. 'vitest',
  409. 'run',
  410. '--coverage',
  411. ...workers.instrumented,
  412. ], {
  413. label: 'test:coverage',
  414. env: { [COVERAGE_EXEMPT_ENV]: '1' },
  415. }),
  416. pnpmExec('coverage-exempt-heavy', [
  417. 'vitest',
  418. 'run',
  419. ...coverageExemptHeavySuites.map(suite => suite.filter),
  420. ...workers.exempt,
  421. ], {
  422. label: 'test:coverage-exempt-heavy',
  423. }),
  424. ]
  425. }
  426. // Example and package snapshots boot their bins in `lib` mode (built artifacts under plain Node,
  427. // plugins via real exports); repository-script snapshots execute their real source entry path.
  428. // Callers wait either on `build` or on a validation gate that transitively owns that build.
  429. function snapshotGate(needs: string[] = ['build']): Gate {
  430. return pnpmScript('snapshot', 'test:snapshot', {
  431. env: { DSH_EXAMPLE_MODE: 'lib' },
  432. needs,
  433. })
  434. }
  435. function builtPackageInvariantsGate(needs?: string[]): Gate {
  436. return pnpmScript('built-package-invariants', 'verify-built-package-invariants', {
  437. label: 'built package invariants',
  438. ...needs === undefined ? {} : { needs },
  439. })
  440. }
  441. function positiveIntArg(envName: string, flag: string): string[] {
  442. const raw = process.env[envName]
  443. if (raw === undefined || raw === '') return []
  444. const parsed = Number.parseInt(raw, 10)
  445. if (!Number.isSafeInteger(parsed) || parsed < 1 || String(parsed) !== raw) {
  446. throw new Error(`run-gates: ${envName} must be a positive integer, got ${JSON.stringify(raw)}.`)
  447. }
  448. return [`${flag}=${raw}`]
  449. }
  450. function flagEnabled(envName: string): boolean {
  451. const raw = process.env[envName]
  452. if (raw === undefined || raw === '') return false
  453. if (raw !== '1') throw new Error(`run-gates: ${envName} must be 1 when set, got ${JSON.stringify(raw)}.`)
  454. return true
  455. }
  456. function hygieneLeafGates(options: { artifactNeeds?: string[] } = {}): Gate[] {
  457. const artifactOptions = options.artifactNeeds === undefined ? {} : { needs: options.artifactNeeds }
  458. return [
  459. pnpmScript('knip', 'knip'),
  460. pnpmScript('publint', 'publint', artifactOptions),
  461. pnpmScript('constraints', 'constraints'),
  462. pnpmScript('package-invariants', 'verify-package-invariants', { label: 'package invariants' }),
  463. builtPackageInvariantsGate(options.artifactNeeds),
  464. pnpmScript('node-next-types', 'verify-node-next-types', {
  465. label: 'node-next types',
  466. ...artifactOptions,
  467. }),
  468. ]
  469. }
  470. function docSyncLeafGates(options: {
  471. includeDocTypecheck?: boolean
  472. docTypecheckNeeds?: string[]
  473. docTypecheckEnv?: Record<string, string | undefined>
  474. docsBuildScript?: 'docs:build' | 'docs:build:mpa'
  475. } = {}): Gate[] {
  476. const docTypecheckOptions: Partial<Gate> = {}
  477. if (options.docTypecheckNeeds !== undefined) docTypecheckOptions.needs = options.docTypecheckNeeds
  478. if (options.docTypecheckEnv !== undefined) docTypecheckOptions.env = options.docTypecheckEnv
  479. return [
  480. ...options.includeDocTypecheck === false
  481. ? []
  482. : [pnpmScript('doc-typecheck', 'doc-typecheck', docTypecheckOptions)],
  483. pnpmScript('cordis-catalog', 'verify-cordis-catalog', { label: 'cordis catalog' }),
  484. pnpmScript('export-jsdoc', 'verify-export-jsdoc', { label: 'export jsdoc' }),
  485. pnpmScript('tool-catalog', 'verify-tool-catalog', { label: 'tool catalog' }),
  486. pnpmScript('config-catalog', 'verify-config-catalog', { label: 'config catalog' }),
  487. pnpmScript('persistence-catalog', 'verify-persistence-catalog', { label: 'persistence catalog' }),
  488. pnpmScript('doc-graphs', 'verify-doc-graphs', { label: 'doc graphs' }),
  489. pnpmScript('scoped-events', 'verify-scoped-events', { label: 'scoped events' }),
  490. pnpmScript('markdown-wrap', 'verify-md-wrap', { label: 'markdown wrap' }),
  491. pnpmScript('markdown-links', 'verify-md-links', { label: 'markdown links' }),
  492. pnpmScript('doc-refs', 'verify-doc-refs', { label: 'doc refs' }),
  493. pnpmScript('package-paths', 'verify-package-paths', { label: 'package paths' }),
  494. pnpmScript('package-readme-model-experience', 'verify-package-readme-model-experience', { label: 'package README model experience' }),
  495. pnpmScript('mermaid', 'verify-mermaid'),
  496. pnpmScript('agent-note-classification', 'verify-agent-note-classification', { label: 'agent note classification' }),
  497. pnpmScript('agent-note-format', 'verify-agent-note-format', { label: 'agent note format' }),
  498. pnpmScript('archived-agent-notes', 'verify-archived-agent-notes', { label: 'archived agent notes' }),
  499. pnpmScript('type-equivalence', 'verify-type-equiv', { label: 'type equivalence' }),
  500. pnpmScript('translation-prompt', 'verify-translation-prompt', { label: 'translation prompt' }),
  501. pnpmScript('translation-pairing', 'verify-translation-pairing', { label: 'translation pairing' }),
  502. pnpmScript('doc-budgets', 'verify-doc-budgets', { label: 'doc budgets' }),
  503. pnpmExec('docs-site-projection', ['vitest', 'run', 'scripts/project-doc-site.spec.ts'], {
  504. label: 'documentation projection',
  505. }),
  506. // Keep the VitePress build itself in one gate because projection rewrites website/.generated.
  507. pnpmScript('docs-site-build', options.docsBuildScript ?? 'docs:build', { label: 'documentation build' }),
  508. pnpmScript('package-readme-limitations', 'verify-package-readme-limitations', { label: 'package README limitations' }),
  509. ]
  510. }
  511. function builtBinSmokeGate(needs: string[] = ['build']): Gate {
  512. return pnpmExec('built-bin-smoke', [
  513. 'vitest',
  514. 'run',
  515. '--config',
  516. 'vitest.e2e.config.ts',
  517. 'examples/headless-agent/tests/keyless-smoke.e2e.ts',
  518. 'apps/cli/tests/tui-keyless-smoke.e2e.ts',
  519. 'packages/examples/cli-demo/tests/built-bin.e2e.ts',
  520. 'packages/examples/acp-demo/tests/built-bin.e2e.ts',
  521. 'packages/ui/jsonrpc/tests/built-scope-carrier.e2e.ts',
  522. // The worker-entry packages' built bundles: the only automated proof
  523. // that lib/index.js resolves its sibling lib/worker.cjs under plain node
  524. // (the e2e lane runs unbuilt, so these files self-skip there).
  525. 'packages/workflow/workflow-workerthread/tests/built-worker.e2e.ts',
  526. 'packages/code-runtime/code-runtime-worker/tests/built-lib.e2e.ts',
  527. ], {
  528. label: 'built-bin smoke',
  529. needs,
  530. env: { DSH_EXAMPLE_MODE: 'lib' },
  531. })
  532. }
  533. /**
  534. * Reject a gate list whose graph cannot be executed unambiguously.
  535. * @param gates - complete aggregate to validate.
  536. */
  537. function validateGateGraph(gates: readonly Gate[]): void {
  538. if (gates.length === 0) throw new Error('run-gates: gate graph has no gates.')
  539. const ids = new Set<string>()
  540. for (const gate of gates) {
  541. if (ids.has(gate.id)) throw new Error(`run-gates: duplicate gate id ${JSON.stringify(gate.id)}.`)
  542. ids.add(gate.id)
  543. }
  544. for (const gate of gates) {
  545. for (const dependency of gate.needs ?? []) {
  546. if (!ids.has(dependency)) {
  547. throw new Error(`run-gates: gate ${JSON.stringify(gate.id)} depends on unknown gate ${JSON.stringify(dependency)}.`)
  548. }
  549. }
  550. }
  551. const cycle = findDependencyCycle(gates)
  552. if (cycle !== undefined) throw new Error(`run-gates: dependency cycle: ${cycle.join(' -> ')}.`)
  553. }
  554. function findDependencyCycle(gates: readonly Gate[]): string[] | undefined {
  555. const byId = new Map(gates.map(gate => [gate.id, gate]))
  556. const complete = new Set<string>()
  557. const active = new Map<string, number>()
  558. const path: string[] = []
  559. const visit = (id: string): string[] | undefined => {
  560. if (complete.has(id)) return undefined
  561. const cycleStart = active.get(id)
  562. if (cycleStart !== undefined) return [...path.slice(cycleStart), id]
  563. const gate = byId.get(id)
  564. if (gate === undefined) return undefined
  565. active.set(id, path.length)
  566. path.push(id)
  567. for (const dependency of gate.needs ?? []) {
  568. const cycle = visit(dependency)
  569. if (cycle !== undefined) return cycle
  570. }
  571. path.pop()
  572. active.delete(id)
  573. complete.add(id)
  574. return undefined
  575. }
  576. for (const gate of gates) {
  577. const cycle = visit(gate.id)
  578. if (cycle !== undefined) return cycle
  579. }
  580. return undefined
  581. }
  582. /**
  583. * Validate and run one aggregate before the injected executor can start a child.
  584. * @param gates - complete aggregate to execute.
  585. * @param maxActive - maximum concurrent child count.
  586. * @param execute - child-process executor.
  587. * @param observe - result observer invoked when each gate settles.
  588. * @returns results in aggregate order.
  589. */
  590. export async function runGates(
  591. gates: Gate[],
  592. maxActive: number,
  593. execute: GateExecutor,
  594. observe: ResultObserver = () => {},
  595. ): Promise<GateResult[]> {
  596. validateGateGraph(gates)
  597. if (!Number.isSafeInteger(maxActive) || maxActive < 1) {
  598. throw new Error(`run-gates: max concurrency must be a positive integer, got ${JSON.stringify(maxActive)}.`)
  599. }
  600. const states = new Map<string, GateState>(gates.map(gate => [gate.id, 'pending']))
  601. const results = new Map<string, GateResult>()
  602. const running: RunningGate[] = []
  603. for (;;) {
  604. let madeProgress = false
  605. while (running.length < maxActive) {
  606. const ready = gates.find(gate => states.get(gate.id) === 'pending' && dependenciesPassed(gate, states))
  607. if (ready === undefined) break
  608. states.set(ready.id, 'running')
  609. running.push({ gate: ready, promise: execute(ready) })
  610. console.log(`run-gates: start ${ready.label}`)
  611. madeProgress = true
  612. }
  613. if (running.length === 0) {
  614. let pending = gates.filter(gate => states.get(gate.id) === 'pending')
  615. while (pending.length > 0) {
  616. const gate = pending.find(item => (item.needs ?? []).some((id) => {
  617. const state = states.get(id)
  618. return state === 'failed' || state === 'skipped'
  619. }))
  620. if (gate === undefined) throw new Error('run-gates: validated graph stalled without a failed dependency.')
  621. const failedDeps = (gate.needs ?? []).filter((id) => {
  622. const state = states.get(id)
  623. return state === 'failed' || state === 'skipped'
  624. })
  625. const result: GateResult = {
  626. gate,
  627. status: 'skipped',
  628. durationMs: 0,
  629. output: [],
  630. exitCode: null,
  631. signalCode: null,
  632. error: `dependency failed or skipped: ${failedDeps.join(', ')}`,
  633. }
  634. states.set(gate.id, 'skipped')
  635. results.set(gate.id, result)
  636. observe(result)
  637. pending = pending.filter(item => item !== gate)
  638. }
  639. break
  640. }
  641. if (!madeProgress) {
  642. const settled = await Promise.race(running.map(async item => ({ item, result: await item.promise })))
  643. running.splice(running.indexOf(settled.item), 1)
  644. states.set(settled.item.gate.id, settled.result.status)
  645. results.set(settled.item.gate.id, settled.result)
  646. observe(settled.result)
  647. }
  648. }
  649. return gates.map((gate) => {
  650. const result = results.get(gate.id)
  651. if (result === undefined) throw new Error(`run-gates: missing result for ${gate.id}.`)
  652. return result
  653. })
  654. }
  655. function dependenciesPassed(gate: Gate, states: Map<string, GateState>): boolean {
  656. return (gate.needs ?? []).every(id => states.get(id) === 'passed')
  657. }
  658. /**
  659. * Execute one gate through the real shell-free child-process boundary.
  660. * @param gate - command and scheduler environment to execute.
  661. * @returns the complete process outcome.
  662. */
  663. export async function runGate(gate: Gate): Promise<GateResult> {
  664. const started = performance.now()
  665. const output: GateOutputChunk[] = []
  666. let spawnError: string | undefined
  667. const outcome = await new Promise<{
  668. exitCode: number | null
  669. signalCode: NodeJS.Signals | null
  670. }>((resolveExit) => {
  671. const child = spawn(gate.command, gate.args, {
  672. cwd: root,
  673. env: { ...process.env, ...gate.env },
  674. stdio: ['pipe', 'pipe', 'pipe'],
  675. })
  676. child.stdout.setEncoding('utf8')
  677. child.stderr.setEncoding('utf8')
  678. child.stdout.on('data', (chunk: string) => {
  679. output.push({ stream: 'stdout', text: chunk })
  680. })
  681. child.stderr.on('data', (chunk: string) => {
  682. output.push({ stream: 'stderr', text: chunk })
  683. })
  684. child.on('error', (error) => {
  685. spawnError = `failed to start command: ${error.message}`
  686. resolveExit({ exitCode: null, signalCode: null })
  687. })
  688. child.on('close', (exitCode, signalCode) => {
  689. resolveExit({ exitCode, signalCode })
  690. })
  691. child.stdin.end()
  692. })
  693. const { exitCode, signalCode } = outcome
  694. const status: GateResultStatus = exitCode === 0 && signalCode === null && spawnError === undefined ? 'passed' : 'failed'
  695. const result: GateResult = {
  696. gate,
  697. status,
  698. durationMs: performance.now() - started,
  699. output,
  700. exitCode,
  701. signalCode,
  702. }
  703. if (spawnError !== undefined) result.error = spawnError
  704. return result
  705. }
  706. /**
  707. * Format every independently observed failure fact for the aggregate summary.
  708. * @param result - unsuccessful gate result.
  709. * @returns error, exit, and signal facts without allowing one to hide another.
  710. */
  711. export function formatGateResultReason(result: GateResult): string {
  712. const facts: string[] = []
  713. if (result.error !== undefined) facts.push(result.error)
  714. if (result.exitCode !== null) facts.push(`exit ${result.exitCode}`)
  715. if (result.signalCode !== null) facts.push(`signal ${result.signalCode}`)
  716. return facts.length === 0 ? 'no exit code or signal' : facts.join(', ')
  717. }
  718. function printResult(result: GateResult): void {
  719. const verbose = process.env.DSH_GATE_VERBOSE === '1'
  720. const seconds = (result.durationMs / 1000).toFixed(2)
  721. if (result.status === 'passed' && !verbose) {
  722. console.log(`run-gates: PASS ${result.gate.label} (${seconds}s)`)
  723. return
  724. }
  725. const heading = `${result.status.toUpperCase()} ${result.gate.label} (${seconds}s)`
  726. const writeHeading = result.status === 'passed' ? console.log : console.error
  727. writeHeading(`\n== ${heading} ==`)
  728. if (result.status !== 'passed') {
  729. console.error(`command: ${result.gate.displayCommand}`)
  730. console.error(`outcome: ${formatGateResultReason(result)}`)
  731. }
  732. printOutput(result.output)
  733. }
  734. function printSummary(results: GateResult[], durationMs: number): void {
  735. const passed = results.filter(result => result.status === 'passed').length
  736. const failed = results.filter(result => result.status === 'failed').length
  737. const skipped = results.filter(result => result.status === 'skipped').length
  738. const seconds = (durationMs / 1000).toFixed(2)
  739. console.log(`\nrun-gates: ${passed} passed, ${failed} failed, ${skipped} skipped in ${seconds}s.`)
  740. const unsuccessful = results.filter(result => result.status === 'failed' || result.status === 'skipped')
  741. if (unsuccessful.length === 0) return
  742. console.error('run-gates: unsuccessful gates:')
  743. for (const result of unsuccessful) {
  744. const duration = (result.durationMs / 1000).toFixed(2)
  745. const reason = formatGateResultReason(result)
  746. const disposition = result.gate.allowFailure === true ? 'NON-BLOCKING ' : ''
  747. console.error(` - ${disposition}${result.status.toUpperCase()} ${result.gate.label} (${duration}s, ${reason})`)
  748. console.error(` ${result.gate.displayCommand}`)
  749. }
  750. }
  751. function printOutput(output: GateOutputChunk[]): void {
  752. for (const chunk of output) {
  753. if (chunk.stream === 'stdout') process.stdout.write(chunk.text)
  754. else process.stderr.write(chunk.text)
  755. }
  756. }