run-gates.ts 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796
  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. function coverageGates(): Gate[] {
  386. return [
  387. pnpmExec('coverage', [
  388. 'vitest',
  389. 'run',
  390. '--coverage',
  391. ...positiveIntArg('DSH_COVERAGE_MAX_WORKERS', '--maxWorkers'),
  392. ], {
  393. label: 'test:coverage',
  394. env: { [COVERAGE_EXEMPT_ENV]: '1' },
  395. }),
  396. pnpmExec('coverage-exempt-heavy', [
  397. 'vitest',
  398. 'run',
  399. ...coverageExemptHeavySuites.map(suite => suite.filter),
  400. ...positiveIntArg('DSH_COVERAGE_MAX_WORKERS', '--maxWorkers'),
  401. ], {
  402. label: 'test:coverage-exempt-heavy',
  403. }),
  404. ]
  405. }
  406. // Example and package snapshots boot their bins in `lib` mode (built artifacts under plain Node,
  407. // plugins via real exports); repository-script snapshots execute their real source entry path.
  408. // Callers wait either on `build` or on a validation gate that transitively owns that build.
  409. function snapshotGate(needs: string[] = ['build']): Gate {
  410. return pnpmScript('snapshot', 'test:snapshot', {
  411. env: { DSH_EXAMPLE_MODE: 'lib' },
  412. needs,
  413. })
  414. }
  415. function builtPackageInvariantsGate(needs?: string[]): Gate {
  416. return pnpmScript('built-package-invariants', 'verify-built-package-invariants', {
  417. label: 'built package invariants',
  418. ...needs === undefined ? {} : { needs },
  419. })
  420. }
  421. function positiveIntArg(envName: string, flag: string): string[] {
  422. const raw = process.env[envName]
  423. if (raw === undefined || raw === '') return []
  424. const parsed = Number.parseInt(raw, 10)
  425. if (!Number.isSafeInteger(parsed) || parsed < 1 || String(parsed) !== raw) {
  426. throw new Error(`run-gates: ${envName} must be a positive integer, got ${JSON.stringify(raw)}.`)
  427. }
  428. return [`${flag}=${raw}`]
  429. }
  430. function flagEnabled(envName: string): boolean {
  431. const raw = process.env[envName]
  432. if (raw === undefined || raw === '') return false
  433. if (raw !== '1') throw new Error(`run-gates: ${envName} must be 1 when set, got ${JSON.stringify(raw)}.`)
  434. return true
  435. }
  436. function hygieneLeafGates(options: { artifactNeeds?: string[] } = {}): Gate[] {
  437. const artifactOptions = options.artifactNeeds === undefined ? {} : { needs: options.artifactNeeds }
  438. return [
  439. pnpmScript('knip', 'knip'),
  440. pnpmScript('publint', 'publint', artifactOptions),
  441. pnpmScript('constraints', 'constraints'),
  442. pnpmScript('package-invariants', 'verify-package-invariants', { label: 'package invariants' }),
  443. builtPackageInvariantsGate(options.artifactNeeds),
  444. pnpmScript('node-next-types', 'verify-node-next-types', {
  445. label: 'node-next types',
  446. ...artifactOptions,
  447. }),
  448. ]
  449. }
  450. function docSyncLeafGates(options: {
  451. includeDocTypecheck?: boolean
  452. docTypecheckNeeds?: string[]
  453. docTypecheckEnv?: Record<string, string | undefined>
  454. docsBuildScript?: 'docs:build' | 'docs:build:mpa'
  455. } = {}): Gate[] {
  456. const docTypecheckOptions: Partial<Gate> = {}
  457. if (options.docTypecheckNeeds !== undefined) docTypecheckOptions.needs = options.docTypecheckNeeds
  458. if (options.docTypecheckEnv !== undefined) docTypecheckOptions.env = options.docTypecheckEnv
  459. return [
  460. ...options.includeDocTypecheck === false
  461. ? []
  462. : [pnpmScript('doc-typecheck', 'doc-typecheck', docTypecheckOptions)],
  463. pnpmScript('cordis-catalog', 'verify-cordis-catalog', { label: 'cordis catalog' }),
  464. pnpmScript('export-jsdoc', 'verify-export-jsdoc', { label: 'export jsdoc' }),
  465. pnpmScript('tool-catalog', 'verify-tool-catalog', { label: 'tool catalog' }),
  466. pnpmScript('config-catalog', 'verify-config-catalog', { label: 'config catalog' }),
  467. pnpmScript('persistence-catalog', 'verify-persistence-catalog', { label: 'persistence catalog' }),
  468. pnpmScript('doc-graphs', 'verify-doc-graphs', { label: 'doc graphs' }),
  469. pnpmScript('scoped-events', 'verify-scoped-events', { label: 'scoped events' }),
  470. pnpmScript('markdown-wrap', 'verify-md-wrap', { label: 'markdown wrap' }),
  471. pnpmScript('markdown-links', 'verify-md-links', { label: 'markdown links' }),
  472. pnpmScript('doc-refs', 'verify-doc-refs', { label: 'doc refs' }),
  473. pnpmScript('package-paths', 'verify-package-paths', { label: 'package paths' }),
  474. pnpmScript('package-readme-model-experience', 'verify-package-readme-model-experience', { label: 'package README model experience' }),
  475. pnpmScript('mermaid', 'verify-mermaid'),
  476. pnpmScript('agent-note-classification', 'verify-agent-note-classification', { label: 'agent note classification' }),
  477. pnpmScript('agent-note-format', 'verify-agent-note-format', { label: 'agent note format' }),
  478. pnpmScript('archived-agent-notes', 'verify-archived-agent-notes', { label: 'archived agent notes' }),
  479. pnpmScript('type-equivalence', 'verify-type-equiv', { label: 'type equivalence' }),
  480. pnpmScript('translation-prompt', 'verify-translation-prompt', { label: 'translation prompt' }),
  481. pnpmScript('translation-pairing', 'verify-translation-pairing', { label: 'translation pairing' }),
  482. pnpmScript('doc-budgets', 'verify-doc-budgets', { label: 'doc budgets' }),
  483. pnpmExec('docs-site-projection', ['vitest', 'run', 'scripts/project-doc-site.spec.ts'], {
  484. label: 'documentation projection',
  485. }),
  486. // Keep the VitePress build itself in one gate because projection rewrites website/.generated.
  487. pnpmScript('docs-site-build', options.docsBuildScript ?? 'docs:build', { label: 'documentation build' }),
  488. pnpmScript('package-readme-limitations', 'verify-package-readme-limitations', { label: 'package README limitations' }),
  489. ]
  490. }
  491. function builtBinSmokeGate(needs: string[] = ['build']): Gate {
  492. return pnpmExec('built-bin-smoke', [
  493. 'vitest',
  494. 'run',
  495. '--config',
  496. 'vitest.e2e.config.ts',
  497. 'examples/headless-agent/tests/keyless-smoke.e2e.ts',
  498. 'apps/cli/tests/tui-keyless-smoke.e2e.ts',
  499. 'packages/examples/cli-demo/tests/built-bin.e2e.ts',
  500. 'packages/examples/acp-demo/tests/built-bin.e2e.ts',
  501. 'packages/ui/jsonrpc/tests/built-scope-carrier.e2e.ts',
  502. // The worker-entry packages' built bundles: the only automated proof
  503. // that lib/index.js resolves its sibling lib/worker.cjs under plain node
  504. // (the e2e lane runs unbuilt, so these files self-skip there).
  505. 'packages/workflow/workflow-workerthread/tests/built-worker.e2e.ts',
  506. 'packages/code-runtime/code-runtime-worker/tests/built-lib.e2e.ts',
  507. ], {
  508. label: 'built-bin smoke',
  509. needs,
  510. env: { DSH_EXAMPLE_MODE: 'lib' },
  511. })
  512. }
  513. /**
  514. * Reject a gate list whose graph cannot be executed unambiguously.
  515. * @param gates - complete aggregate to validate.
  516. */
  517. function validateGateGraph(gates: readonly Gate[]): void {
  518. if (gates.length === 0) throw new Error('run-gates: gate graph has no gates.')
  519. const ids = new Set<string>()
  520. for (const gate of gates) {
  521. if (ids.has(gate.id)) throw new Error(`run-gates: duplicate gate id ${JSON.stringify(gate.id)}.`)
  522. ids.add(gate.id)
  523. }
  524. for (const gate of gates) {
  525. for (const dependency of gate.needs ?? []) {
  526. if (!ids.has(dependency)) {
  527. throw new Error(`run-gates: gate ${JSON.stringify(gate.id)} depends on unknown gate ${JSON.stringify(dependency)}.`)
  528. }
  529. }
  530. }
  531. const cycle = findDependencyCycle(gates)
  532. if (cycle !== undefined) throw new Error(`run-gates: dependency cycle: ${cycle.join(' -> ')}.`)
  533. }
  534. function findDependencyCycle(gates: readonly Gate[]): string[] | undefined {
  535. const byId = new Map(gates.map(gate => [gate.id, gate]))
  536. const complete = new Set<string>()
  537. const active = new Map<string, number>()
  538. const path: string[] = []
  539. const visit = (id: string): string[] | undefined => {
  540. if (complete.has(id)) return undefined
  541. const cycleStart = active.get(id)
  542. if (cycleStart !== undefined) return [...path.slice(cycleStart), id]
  543. const gate = byId.get(id)
  544. if (gate === undefined) return undefined
  545. active.set(id, path.length)
  546. path.push(id)
  547. for (const dependency of gate.needs ?? []) {
  548. const cycle = visit(dependency)
  549. if (cycle !== undefined) return cycle
  550. }
  551. path.pop()
  552. active.delete(id)
  553. complete.add(id)
  554. return undefined
  555. }
  556. for (const gate of gates) {
  557. const cycle = visit(gate.id)
  558. if (cycle !== undefined) return cycle
  559. }
  560. return undefined
  561. }
  562. /**
  563. * Validate and run one aggregate before the injected executor can start a child.
  564. * @param gates - complete aggregate to execute.
  565. * @param maxActive - maximum concurrent child count.
  566. * @param execute - child-process executor.
  567. * @param observe - result observer invoked when each gate settles.
  568. * @returns results in aggregate order.
  569. */
  570. export async function runGates(
  571. gates: Gate[],
  572. maxActive: number,
  573. execute: GateExecutor,
  574. observe: ResultObserver = () => {},
  575. ): Promise<GateResult[]> {
  576. validateGateGraph(gates)
  577. if (!Number.isSafeInteger(maxActive) || maxActive < 1) {
  578. throw new Error(`run-gates: max concurrency must be a positive integer, got ${JSON.stringify(maxActive)}.`)
  579. }
  580. const states = new Map<string, GateState>(gates.map(gate => [gate.id, 'pending']))
  581. const results = new Map<string, GateResult>()
  582. const running: RunningGate[] = []
  583. for (;;) {
  584. let madeProgress = false
  585. while (running.length < maxActive) {
  586. const ready = gates.find(gate => states.get(gate.id) === 'pending' && dependenciesPassed(gate, states))
  587. if (ready === undefined) break
  588. states.set(ready.id, 'running')
  589. running.push({ gate: ready, promise: execute(ready) })
  590. console.log(`run-gates: start ${ready.label}`)
  591. madeProgress = true
  592. }
  593. if (running.length === 0) {
  594. let pending = gates.filter(gate => states.get(gate.id) === 'pending')
  595. while (pending.length > 0) {
  596. const gate = pending.find(item => (item.needs ?? []).some((id) => {
  597. const state = states.get(id)
  598. return state === 'failed' || state === 'skipped'
  599. }))
  600. if (gate === undefined) throw new Error('run-gates: validated graph stalled without a failed dependency.')
  601. const failedDeps = (gate.needs ?? []).filter((id) => {
  602. const state = states.get(id)
  603. return state === 'failed' || state === 'skipped'
  604. })
  605. const result: GateResult = {
  606. gate,
  607. status: 'skipped',
  608. durationMs: 0,
  609. output: [],
  610. exitCode: null,
  611. signalCode: null,
  612. error: `dependency failed or skipped: ${failedDeps.join(', ')}`,
  613. }
  614. states.set(gate.id, 'skipped')
  615. results.set(gate.id, result)
  616. observe(result)
  617. pending = pending.filter(item => item !== gate)
  618. }
  619. break
  620. }
  621. if (!madeProgress) {
  622. const settled = await Promise.race(running.map(async item => ({ item, result: await item.promise })))
  623. running.splice(running.indexOf(settled.item), 1)
  624. states.set(settled.item.gate.id, settled.result.status)
  625. results.set(settled.item.gate.id, settled.result)
  626. observe(settled.result)
  627. }
  628. }
  629. return gates.map((gate) => {
  630. const result = results.get(gate.id)
  631. if (result === undefined) throw new Error(`run-gates: missing result for ${gate.id}.`)
  632. return result
  633. })
  634. }
  635. function dependenciesPassed(gate: Gate, states: Map<string, GateState>): boolean {
  636. return (gate.needs ?? []).every(id => states.get(id) === 'passed')
  637. }
  638. /**
  639. * Execute one gate through the real shell-free child-process boundary.
  640. * @param gate - command and scheduler environment to execute.
  641. * @returns the complete process outcome.
  642. */
  643. export async function runGate(gate: Gate): Promise<GateResult> {
  644. const started = performance.now()
  645. const output: GateOutputChunk[] = []
  646. let spawnError: string | undefined
  647. const outcome = await new Promise<{
  648. exitCode: number | null
  649. signalCode: NodeJS.Signals | null
  650. }>((resolveExit) => {
  651. const child = spawn(gate.command, gate.args, {
  652. cwd: root,
  653. env: { ...process.env, ...gate.env },
  654. stdio: ['pipe', 'pipe', 'pipe'],
  655. })
  656. child.stdout.setEncoding('utf8')
  657. child.stderr.setEncoding('utf8')
  658. child.stdout.on('data', (chunk: string) => {
  659. output.push({ stream: 'stdout', text: chunk })
  660. })
  661. child.stderr.on('data', (chunk: string) => {
  662. output.push({ stream: 'stderr', text: chunk })
  663. })
  664. child.on('error', (error) => {
  665. spawnError = `failed to start command: ${error.message}`
  666. resolveExit({ exitCode: null, signalCode: null })
  667. })
  668. child.on('close', (exitCode, signalCode) => {
  669. resolveExit({ exitCode, signalCode })
  670. })
  671. child.stdin.end()
  672. })
  673. const { exitCode, signalCode } = outcome
  674. const status: GateResultStatus = exitCode === 0 && signalCode === null && spawnError === undefined ? 'passed' : 'failed'
  675. const result: GateResult = {
  676. gate,
  677. status,
  678. durationMs: performance.now() - started,
  679. output,
  680. exitCode,
  681. signalCode,
  682. }
  683. if (spawnError !== undefined) result.error = spawnError
  684. return result
  685. }
  686. /**
  687. * Format every independently observed failure fact for the aggregate summary.
  688. * @param result - unsuccessful gate result.
  689. * @returns error, exit, and signal facts without allowing one to hide another.
  690. */
  691. export function formatGateResultReason(result: GateResult): string {
  692. const facts: string[] = []
  693. if (result.error !== undefined) facts.push(result.error)
  694. if (result.exitCode !== null) facts.push(`exit ${result.exitCode}`)
  695. if (result.signalCode !== null) facts.push(`signal ${result.signalCode}`)
  696. return facts.length === 0 ? 'no exit code or signal' : facts.join(', ')
  697. }
  698. function printResult(result: GateResult): void {
  699. const verbose = process.env.DSH_GATE_VERBOSE === '1'
  700. const seconds = (result.durationMs / 1000).toFixed(2)
  701. if (result.status === 'passed' && !verbose) {
  702. console.log(`run-gates: PASS ${result.gate.label} (${seconds}s)`)
  703. return
  704. }
  705. const heading = `${result.status.toUpperCase()} ${result.gate.label} (${seconds}s)`
  706. const writeHeading = result.status === 'passed' ? console.log : console.error
  707. writeHeading(`\n== ${heading} ==`)
  708. if (result.status !== 'passed') {
  709. console.error(`command: ${result.gate.displayCommand}`)
  710. console.error(`outcome: ${formatGateResultReason(result)}`)
  711. }
  712. printOutput(result.output)
  713. }
  714. function printSummary(results: GateResult[], durationMs: number): void {
  715. const passed = results.filter(result => result.status === 'passed').length
  716. const failed = results.filter(result => result.status === 'failed').length
  717. const skipped = results.filter(result => result.status === 'skipped').length
  718. const seconds = (durationMs / 1000).toFixed(2)
  719. console.log(`\nrun-gates: ${passed} passed, ${failed} failed, ${skipped} skipped in ${seconds}s.`)
  720. const unsuccessful = results.filter(result => result.status === 'failed' || result.status === 'skipped')
  721. if (unsuccessful.length === 0) return
  722. console.error('run-gates: unsuccessful gates:')
  723. for (const result of unsuccessful) {
  724. const duration = (result.durationMs / 1000).toFixed(2)
  725. const reason = formatGateResultReason(result)
  726. const disposition = result.gate.allowFailure === true ? 'NON-BLOCKING ' : ''
  727. console.error(` - ${disposition}${result.status.toUpperCase()} ${result.gate.label} (${duration}s, ${reason})`)
  728. console.error(` ${result.gate.displayCommand}`)
  729. }
  730. }
  731. function printOutput(output: GateOutputChunk[]): void {
  732. for (const chunk of output) {
  733. if (chunk.stream === 'stdout') process.stdout.write(chunk.text)
  734. else process.stderr.write(chunk.text)
  735. }
  736. }