run-gates.ts 66 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597
  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, spawnSync } from 'node:child_process'
  9. import { readdirSync, readFileSync } from 'node:fs'
  10. import { availableParallelism } from 'node:os'
  11. import { resolve } from 'node:path'
  12. import { performance } from 'node:perf_hooks'
  13. import { CLIENT_BUILD_PROFILE_SELECTOR } from './client-build-environment.ts'
  14. import { COVERAGE_EXEMPT_ENV, coverageExemptHeavySuites } from './coverage-exempt.ts'
  15. import {
  16. COVERAGE_PARTITIONS_ENV,
  17. COVERAGE_TEST_TIMEOUT_ENV,
  18. coverageTestTimeoutArgs,
  19. parseCoveragePartitionCount,
  20. } from './coverage-partitions.ts'
  21. import { pnpmInvocation } from './pnpm-invocation.ts'
  22. /** A named aggregate exposed by the gate runner. */
  23. export type Mode =
  24. | 'ci-primary'
  25. | 'ci-linux-primary'
  26. | 'ci-static'
  27. | 'ci-lint-contracts-ready'
  28. | 'ci-coverage'
  29. | 'ci-bench'
  30. | 'ci-snapshot'
  31. | 'ci-artifacts'
  32. | 'ci-consumers'
  33. | 'ci-windows-blocking'
  34. | 'ci-windows-complete'
  35. | 'ci-windows-observational'
  36. | 'node-compat'
  37. | 'check-all'
  38. | 'hygiene'
  39. | 'doc-sync'
  40. | 'doc-quick'
  41. type GateResultStatus = 'passed' | 'failed' | 'skipped'
  42. type GateState = 'pending' | 'running' | GateResultStatus
  43. /** A command and its dependency metadata inside one aggregate. */
  44. export interface Gate {
  45. id: string
  46. label: string
  47. displayCommand: string
  48. command: string
  49. args: string[]
  50. needs?: string[]
  51. /** Gate ids that must settle, regardless of outcome, before this gate starts. */
  52. after?: string[]
  53. env?: Record<string, string | undefined>
  54. /** Include this leaf in the build-free documentation aggregate. */
  55. quick?: boolean
  56. /** Keep a failure visible without failing the aggregate. */
  57. allowFailure?: boolean
  58. /** Write child output as it arrives instead of buffering it until completion. */
  59. streamOutput?: boolean
  60. }
  61. /** The observed outcome of one gate process. */
  62. export interface GateResult {
  63. gate: Gate
  64. status: GateResultStatus
  65. durationMs: number
  66. output: GateOutputChunk[]
  67. exitCode: number | null
  68. signalCode: NodeJS.Signals | null
  69. error?: string
  70. /** True when the shared abort signal terminated this gate before its outcome
  71. * was observed; such a result must not be reported as passed, even if the
  72. * child trapped the signal and exited zero. */
  73. aborted?: boolean
  74. }
  75. interface GateOutputChunk {
  76. stream: 'stdout' | 'stderr'
  77. text: string
  78. }
  79. interface RunningGate {
  80. gate: Gate
  81. promise: Promise<GateResult>
  82. }
  83. interface ConcurrencyDefault {
  84. workers: number
  85. source: string
  86. }
  87. type GateExecutor = (gate: Gate, signal?: AbortSignal) => Promise<GateResult>
  88. type ResultObserver = (result: GateResult) => void
  89. const root = resolve(import.meta.dirname, '..')
  90. if (import.meta.main) {
  91. process.exitCode = await main(process.argv.slice(2))
  92. }
  93. async function main(args: string[]): Promise<number> {
  94. const mode = parseMode(args[0])
  95. const gates = gatesForMode(mode)
  96. const concurrencyDefault = defaultConcurrency(mode, gates.length)
  97. const concurrencyOverride = process.env.DSH_GATE_CONCURRENCY
  98. const maxConcurrency = concurrencyFromEnv('DSH_GATE_CONCURRENCY', concurrencyDefault.workers)
  99. const concurrencySource = concurrencyOverride === undefined || concurrencyOverride === ''
  100. ? concurrencyDefault.source
  101. : '$DSH_GATE_CONCURRENCY'
  102. const failFast = flagEnabled('DSH_GATE_FAIL_FAST')
  103. const startedAt = performance.now()
  104. console.log(`run-gates: ${mode} running ${gates.length} gate(s) with ${maxConcurrency} worker(s) from ${concurrencySource}${failFast ? ', fail-fast after first blocking failure' : ''}.`)
  105. const results = await runGates(gates, maxConcurrency, runGate, printResult, cliGateOptions(failFast))
  106. printSummary(results, performance.now() - startedAt)
  107. return results.some(result => result.gate.allowFailure !== true && (result.status === 'failed' || result.status === 'skipped'))
  108. ? 1
  109. : 0
  110. }
  111. /**
  112. * The options the CLI entrypoint hands to the scheduler. Host signal
  113. * forwarding always follows fail-fast: children are detached only then, so
  114. * without it the forwarding would have no tree to drain.
  115. * @param failFast - whether `DSH_GATE_FAIL_FAST` is enabled.
  116. * @returns the scheduler options for the entrypoint.
  117. */
  118. export function cliGateOptions(failFast: boolean): RunGatesOptions {
  119. return { failFast, forwardProcessSignals: failFast }
  120. }
  121. function parseMode(raw: string | undefined): Mode {
  122. switch (raw) {
  123. case 'ci-primary':
  124. case 'ci-linux-primary':
  125. case 'ci-static':
  126. case 'ci-lint-contracts-ready':
  127. case 'ci-coverage':
  128. case 'ci-bench':
  129. case 'ci-snapshot':
  130. case 'ci-artifacts':
  131. case 'ci-consumers':
  132. case 'ci-windows-blocking':
  133. case 'ci-windows-complete':
  134. case 'ci-windows-observational':
  135. case 'node-compat':
  136. case 'check-all':
  137. case 'hygiene':
  138. case 'doc-sync':
  139. case 'doc-quick':
  140. return raw
  141. default:
  142. throw new Error(
  143. `run-gates: expected mode ci-primary | ci-linux-primary | ci-static | ci-lint-contracts-ready | ci-coverage | ci-bench | ci-snapshot | ci-artifacts | ci-consumers | ci-windows-blocking | ci-windows-complete | ci-windows-observational | node-compat | check-all | hygiene | doc-sync | doc-quick, got ${JSON.stringify(raw)}.`,
  144. )
  145. }
  146. }
  147. /**
  148. * Resolve the default worker count for one aggregate.
  149. * @param selectedMode - aggregate whose resource posture applies.
  150. * @param total - number of gates in the aggregate.
  151. * @param available - host CPU availability for ordinary modes.
  152. * @returns the default worker count and its diagnostic source.
  153. */
  154. export function defaultConcurrency(
  155. selectedMode: Mode,
  156. total: number,
  157. available = availableParallelism(),
  158. ): ConcurrencyDefault {
  159. if (selectedMode === 'ci-consumers') return { workers: total, source: 'ci-consumers gate count' }
  160. // Local modes cap workers: several doc gates each build a full ts.Program,
  161. // so an uncapped default on a large host trades wall clock for memory blowups.
  162. const localCap = selectedMode === 'check-all'
  163. || selectedMode === 'hygiene'
  164. || selectedMode === 'doc-sync'
  165. || selectedMode === 'doc-quick'
  166. const modeLimit = localCap ? Math.min(4, available) : available
  167. return {
  168. workers: Math.min(total, modeLimit),
  169. source: localCap
  170. ? `${available} available CPU(s), ${selectedMode} cap 4`
  171. : `${available} available CPU(s)`,
  172. }
  173. }
  174. function concurrencyFromEnv(name: string, fallback: number): number {
  175. const raw = process.env[name]
  176. if (raw === undefined || raw === '') return fallback
  177. const parsed = Number.parseInt(raw, 10)
  178. if (!Number.isSafeInteger(parsed) || parsed < 1) {
  179. throw new Error(`run-gates: ${name} must be a positive integer, got ${JSON.stringify(raw)}.`)
  180. }
  181. return parsed
  182. }
  183. function pnpmScript(id: string, script: string, options: Partial<Gate> = {}): Gate {
  184. return {
  185. id,
  186. label: options.label ?? script,
  187. displayCommand: `pnpm run ${script}`,
  188. ...pnpmInvocation(['run', script]),
  189. ...options,
  190. }
  191. }
  192. /** Build official client artifacts inside a CI aggregate without changing sibling gate environments. */
  193. function ciBuildGate(id = 'build', options: Partial<Gate> = {}): Gate {
  194. return pnpmScript(id, 'build', {
  195. ...options,
  196. env: { ...options.env, [CLIENT_BUILD_PROFILE_SELECTOR]: 'official' },
  197. })
  198. }
  199. function pnpmExec(id: string, args: string[], options: Partial<Gate> = {}): Gate {
  200. return {
  201. id,
  202. label: options.label ?? `pnpm exec ${args.join(' ')}`,
  203. displayCommand: `pnpm exec ${args.join(' ')}`,
  204. ...pnpmInvocation(['exec', ...args]),
  205. ...options,
  206. }
  207. }
  208. /**
  209. * Construct the complete gate list for a named aggregate.
  210. * @param selected - aggregate mode to construct.
  211. * @returns the aggregate's gate graph.
  212. */
  213. export function gatesForMode(selected: Mode): Gate[] {
  214. switch (selected) {
  215. case 'ci-primary':
  216. return ciPrimaryGates()
  217. case 'ci-linux-primary':
  218. return [...ciPrimaryGates(), webSnapshotGate(['built-package-invariants'])]
  219. case 'ci-static':
  220. return ciStaticGates({ ownsBuild: false })
  221. case 'ci-lint-contracts-ready':
  222. return [
  223. lintGate(),
  224. pnpmScript('duplication', 'duplication'),
  225. ]
  226. case 'ci-coverage':
  227. return coverageGates()
  228. case 'ci-bench':
  229. return [pnpmScript('bench', 'test:bench', { label: 'performance benchmarks' })]
  230. case 'ci-snapshot':
  231. return [ciBuildGate(), snapshotGate()]
  232. case 'ci-artifacts':
  233. return ciArtifactGates()
  234. case 'ci-consumers':
  235. return ciConsumerGates()
  236. case 'ci-windows-blocking':
  237. return ciWindowsBlockingGates()
  238. case 'ci-windows-complete':
  239. return ciWindowsCompleteGates()
  240. case 'ci-windows-observational':
  241. return ciWindowsObservationalGates()
  242. case 'node-compat':
  243. return nodeCompatGates()
  244. case 'check-all':
  245. return [
  246. pnpmScript('runtime-closure', 'verify-runtime-closure', { label: 'runtime closure' }),
  247. pnpmScript('cordis-config', 'verify-cordis-config', { label: 'Cordis config' }),
  248. pnpmScript('client-domain-graph', 'verify-client-domain-graph', { label: 'client domain graph' }),
  249. pnpmScript('test', 'test'),
  250. pnpmScript('approval-policy', 'test:approval-policy', { label: 'Weighted approval policy' }),
  251. pnpmScript('issue-management', 'test:issue-management', { label: 'Issue management policy' }),
  252. pnpmScript('duplication', 'duplication'),
  253. snapshotGate(),
  254. expectedOutputGate(),
  255. pnpmScript('build', 'build'),
  256. pnpmScript('build:web', 'build:web'),
  257. ...hygieneLeafGates({ artifactNeeds: ['build'] }),
  258. ...docSyncLeafGates({
  259. docTypecheckNeeds: ['build'],
  260. docTypecheckEnv: { DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1' },
  261. docTypecheckScript: 'doc-typecheck:contracts-ready',
  262. }),
  263. pnpmScript('module-graph', 'verify-module-graph', { label: 'module graph' }),
  264. ]
  265. case 'hygiene':
  266. return [
  267. ...hygieneLeafGates(),
  268. pnpmScript('cordis-config', 'verify-cordis-config', { label: 'Cordis config' }),
  269. pnpmScript('runtime-closure', 'verify-runtime-closure', { label: 'runtime closure' }),
  270. ]
  271. case 'doc-sync':
  272. return docSyncLeafGates()
  273. case 'doc-quick':
  274. return docQuickLeafGates()
  275. }
  276. }
  277. function ciSharedStaticGates(): Gate[] {
  278. return [
  279. pnpmScript('runtime-closure', 'verify-runtime-closure', { label: 'runtime closure' }),
  280. pnpmScript('default-product-isolation', 'verify-default-product-isolation', { label: 'default product isolation' }),
  281. pnpmScript('application-entrypoints', 'verify-application-entrypoints', { label: 'application entrypoints' }),
  282. pnpmScript('constraints', 'constraints'),
  283. pnpmScript('package-dependencies', 'verify-package-dependencies', { label: 'package dependencies' }),
  284. pnpmScript('dsh-package-licenses', 'verify-dsh-package-licenses', { label: 'DSH package licenses' }),
  285. pnpmScript('package-invariants', 'verify-package-invariants', { label: 'package invariants' }),
  286. pnpmScript('cordis-config', 'verify-cordis-config', { label: 'Cordis config' }),
  287. pnpmScript('optional-dependency-imports', 'verify-optional-dependency-imports', {
  288. label: 'optional dependency imports',
  289. }),
  290. pnpmScript('client-packages', 'verify-client-packages', { label: 'client packages' }),
  291. pnpmScript('client-ui-i18n', 'verify-client-ui-i18n', { label: 'client UI i18n' }),
  292. pnpmScript('no-bare-dispatcher', 'verify-no-bare-dispatcher', { label: 'proxy-aware dispatchers' }),
  293. pnpmScript('approval-policy', 'test:approval-policy', { label: 'Weighted approval policy' }),
  294. pnpmScript('issue-management', 'test:issue-management', { label: 'Issue management policy' }),
  295. ]
  296. }
  297. function ciPrimaryGates(): Gate[] {
  298. return [
  299. ...ciSharedStaticGates(),
  300. typertContractsGate(),
  301. pnpmScript('typecheck', 'typecheck:contracts-ready', { needs: ['typert-contracts'] }),
  302. lintGate({ needs: ['typert-contracts'] }),
  303. pnpmScript('duplication', 'duplication'),
  304. ...coverageGates(),
  305. ...nodeCompatSmokeGates(),
  306. snapshotGate(),
  307. ...docSyncLeafGates({
  308. docTypecheckNeeds: ['typert-contracts'],
  309. docTypecheckScript: 'doc-typecheck:contracts-ready',
  310. }),
  311. pnpmScript('module-graph', 'verify-module-graph', { label: 'module graph' }),
  312. // The prepared typecheck and build both drive Client tsc, while build also
  313. // repeats the Host contract pass. Wait for all three consumers so build
  314. // neither races tsbuildinfo nor replaces declarations while they are read.
  315. ciBuildGate('build', { needs: ['typecheck', 'lint', 'doc-typecheck'] }),
  316. pnpmScript('publint', 'publint', { needs: ['build'] }),
  317. pnpmScript('node-next-types', 'verify-node-next-types', {
  318. label: 'node-next types',
  319. needs: ['build'],
  320. }),
  321. builtPackageInvariantsGate(['build']),
  322. builtBinSmokeGate(),
  323. ]
  324. }
  325. function nodeCompatGates(): Gate[] {
  326. const typecheck = flagEnabled('DSH_NODE_COMPAT_SKIP_TYPECHECK')
  327. ? []
  328. : [pnpmScript('typecheck', 'typecheck')]
  329. if (runningNodeMajor() !== 22) {
  330. return [...typecheck, ...nodeCompatSmokeGates()]
  331. }
  332. return [
  333. ...typecheck,
  334. pnpmScript('build', 'build', {
  335. ...typecheck.length === 0 ? {} : { needs: ['typecheck'] },
  336. }),
  337. pnpmScript('build:web', 'build:web', {
  338. label: 'Web frontend build',
  339. needs: ['build'],
  340. }),
  341. ...nodeCompatSmokeGates({ cliSmoke: true }),
  342. ]
  343. }
  344. function nodeCompatSmokeGates(options: { cliSmoke?: boolean } = {}): Gate[] {
  345. const gates: Gate[] = [
  346. pnpmExec('source-worker-smoke', [
  347. 'vitest',
  348. 'run',
  349. 'packages/workflow/workflow-worker-thread/tests/source-worker.compat.spec.ts',
  350. ], { label: 'source worker smoke' }),
  351. pnpmExec('jsonl-zstd-smoke', [
  352. 'vitest',
  353. 'run',
  354. 'packages/session/session-persistence-jsonl/tests/zstd.compat.spec.ts',
  355. ], { label: 'JSONL Zstandard smoke' }),
  356. pnpmExec('dsh-source-launch-smoke', [
  357. 'vitest',
  358. 'run',
  359. 'apps/cli/tests/source-launch.compat.spec.ts',
  360. ], { label: 'dsh source-launch smoke' }),
  361. pnpmExec('vitest-jsdom-smoke', [
  362. 'vitest',
  363. 'run',
  364. 'scripts/vitest-environment.compat.spec.ts',
  365. ], { label: 'Vitest jsdom smoke' }),
  366. ]
  367. if (options.cliSmoke) {
  368. gates.push(
  369. pnpmExec('cli-lazy-search-startup-smoke', [
  370. 'vitest',
  371. 'run',
  372. 'apps/cli/tests/lazy-search-startup.compat.spec.ts',
  373. ], {
  374. label: 'CLI lazy-search startup smoke',
  375. env: { DSH_REQUIRE_BUILT_CLI_SMOKE: '1' },
  376. needs: ['build:web'],
  377. }),
  378. )
  379. }
  380. return gates
  381. }
  382. /** Active Node major used to select version-specific compatibility checks. */
  383. function runningNodeMajor(): number {
  384. const major = Number.parseInt(process.versions.node.split('.')[0] ?? '', 10)
  385. if (!Number.isSafeInteger(major)) {
  386. throw new Error(`run-gates: cannot parse Node version ${JSON.stringify(process.versions.node)}.`)
  387. }
  388. return major
  389. }
  390. function ciStaticGates(options: { ownsBuild: boolean }): Gate[] {
  391. return [
  392. ...ciSharedStaticGates(),
  393. ...options.ownsBuild ? [ciBuildGate()] : [],
  394. ...docSyncLeafGates({
  395. includeDocTypecheck: options.ownsBuild,
  396. ...options.ownsBuild
  397. ? {
  398. docTypecheckNeeds: ['build'],
  399. docTypecheckEnv: { DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1' },
  400. docTypecheckScript: 'doc-typecheck:contracts-ready',
  401. }
  402. : {},
  403. docsBuildScript: 'docs:build:mpa',
  404. }),
  405. pnpmScript('module-graph', 'verify-module-graph', { label: 'module graph' }),
  406. ]
  407. }
  408. function ciArtifactGates(): Gate[] {
  409. return [
  410. ciBuildGate(),
  411. pnpmScript('publint', 'publint', { needs: ['build'] }),
  412. pnpmScript('node-next-types', 'verify-node-next-types', {
  413. label: 'node-next types',
  414. needs: ['build'],
  415. }),
  416. builtPackageInvariantsGate(['build']),
  417. builtBinSmokeGate(),
  418. ]
  419. }
  420. function ciConsumerGates(): Gate[] {
  421. const builtTree = ['build']
  422. const validatedBuild = ['built-package-invariants']
  423. // The HMR web test starts `dev:web`, which rewrites the shared `lib/` and
  424. // `apps/web/dist/` trees. Let every build-artifact reader settle before that
  425. // writer starts; `after` preserves the web diagnostic even if a reader fails.
  426. const buildArtifactReaders = [
  427. 'publint',
  428. 'lint-and-duplication',
  429. 'snapshot',
  430. 'expected-output',
  431. 'doc-typecheck',
  432. 'node-next-types',
  433. 'built-bin-smoke',
  434. ]
  435. return [
  436. ciBuildGate(),
  437. pnpmScript('node-compat', 'check:node-compat', {
  438. label: 'Node compatibility',
  439. env: { [CLIENT_BUILD_PROFILE_SELECTOR]: 'official' },
  440. }),
  441. pnpmScript('publint', 'publint', { needs: builtTree }),
  442. builtPackageInvariantsGate(builtTree),
  443. pnpmScript('lint-and-duplication', 'check:ci:lint:contracts-ready', {
  444. label: 'lint and duplication',
  445. needs: validatedBuild,
  446. }),
  447. snapshotGate(validatedBuild),
  448. expectedOutputGate(validatedBuild),
  449. webSnapshotGate(validatedBuild, buildArtifactReaders),
  450. pnpmScript('doc-typecheck', 'doc-typecheck:contracts-ready', {
  451. needs: validatedBuild,
  452. env: { DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1' },
  453. }),
  454. pnpmScript('node-next-types', 'verify-node-next-types', {
  455. label: 'node-next types',
  456. needs: validatedBuild,
  457. }),
  458. builtBinSmokeGate(validatedBuild),
  459. ]
  460. }
  461. function webSnapshotGate(needs: string[], after?: string[]): Gate {
  462. const order = after === undefined ? { needs } : { needs, after }
  463. const workerRaw = process.env.DSH_WEB_SNAPSHOT_WORKERS
  464. if (workerRaw !== undefined && workerRaw !== '') {
  465. const workers = Number.parseInt(workerRaw, 10)
  466. if (!Number.isSafeInteger(workers) || workers < 2 || String(workers) !== workerRaw) {
  467. throw new Error(`run-gates: DSH_WEB_SNAPSHOT_WORKERS must be an integer greater than 1, got ${JSON.stringify(workerRaw)}.`)
  468. }
  469. return pnpmScript('web-snapshot', 'test:web:ci', {
  470. label: 'web browser snapshot',
  471. displayCommand: `DSH_SNAPSHOT=replay DSH_WEB_SNAPSHOT_WORKERS=${workers} pnpm run test:web:ci`,
  472. env: { DSH_SNAPSHOT: 'replay' },
  473. ...order,
  474. streamOutput: true,
  475. })
  476. }
  477. return pnpmScript('web-snapshot', 'test:web:built', {
  478. label: 'web browser snapshot',
  479. displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
  480. env: { DSH_SNAPSHOT: 'replay' },
  481. ...order,
  482. })
  483. }
  484. function ciWindowsBlockingGates(): Gate[] {
  485. return [
  486. ciBuildGate('windows-build', { label: 'build' }),
  487. pnpmScript('windows-site', 'docs:build', { label: 'production site' }),
  488. ]
  489. }
  490. function ciWindowsCompleteGates(): Gate[] {
  491. const coverage = coverageGates().map(gate => ({
  492. ...gate,
  493. needs: [...new Set(['build', ...(gate.needs ?? [])])],
  494. }))
  495. const coverageAfter = coverage.map(gate => gate.id)
  496. const observational = ciWindowsObservationalGates()
  497. // The required production site replaces the observational MPA build; both
  498. // VitePress modes write the same output directory and cannot overlap.
  499. .filter(gate => gate.id !== 'build' && gate.id !== 'docs-site-build')
  500. .map(gate => ({
  501. ...gate,
  502. allowFailure: true,
  503. after: [...new Set([
  504. ...coverageAfter,
  505. ...(gate.after ?? []).map(id => id === 'docs-site-build' ? 'windows-site' : id),
  506. ])],
  507. }))
  508. return [
  509. ciBuildGate(),
  510. pnpmScript('windows-site', 'docs:build', { label: 'production site' }),
  511. ...coverage,
  512. ...observational,
  513. ]
  514. }
  515. function ciWindowsObservationalGates(): Gate[] {
  516. const predecessors = [
  517. ...ciStaticGates({ ownsBuild: true }),
  518. // Linux owns required lint and snapshots; Windows omits those duplicates.
  519. pnpmScript('duplication', 'duplication'),
  520. pnpmScript('publint', 'publint', { needs: ['build'] }),
  521. pnpmScript('node-next-types', 'verify-node-next-types', {
  522. label: 'node-next types',
  523. needs: ['build'],
  524. }),
  525. builtPackageInvariantsGate(['build']),
  526. ]
  527. return [
  528. ...predecessors,
  529. {
  530. ...builtBinSmokeGate(),
  531. // This smoke starts real application children with bounded startup
  532. // deadlines. Let other Windows processes settle before measuring startup.
  533. after: predecessors.map(gate => gate.id),
  534. },
  535. ]
  536. }
  537. function typertContractsGate(): Gate {
  538. return pnpmScript('typert-contracts', 'build:lib:host', { label: 'Typert contracts' })
  539. }
  540. function lintGate(options: { needs?: string[] } = {}): Gate {
  541. const raw = process.env.DSH_OXLINT_THREADS
  542. const script = 'lint:contracts-ready'
  543. return pnpmScript('lint', script, {
  544. ...raw === undefined || raw === ''
  545. ? {}
  546. : { displayCommand: `DSH_OXLINT_THREADS=${raw} pnpm run ${script}` },
  547. ...options.needs === undefined ? {} : { needs: options.needs },
  548. })
  549. }
  550. // The heavy suites run uninstrumented beside the thresholded gate: their
  551. // compiler- and subprocess-bound fixtures pay a multiple of their runtime
  552. // under v8 instrumentation while contributing nothing the thresholds need
  553. // (membership rules in scripts/coverage-exempt.ts).
  554. //
  555. // DSH_COVERAGE_MAX_WORKERS is the ordinary lane's worker budget, so the two
  556. // parallel gates split it instead of each claiming it whole. When
  557. // DSH_COVERAGE_PARTITIONS is set, its single-worker processes replace the
  558. // instrumented share while this budget still sizes the exempt gate. The exempt
  559. // gate's wall clock is dominated by its longest single file, so it takes the
  560. // small share. A budget of 1 gives each gate 1 worker; lanes that need a strict
  561. // total of one (the serial reference jobs) also set DSH_GATE_CONCURRENCY=1,
  562. // which keeps the gates from overlapping at all.
  563. // DSH_COVERAGE_TEST_TIMEOUT_MS raises Vitest's per-test, expect.poll, and hook
  564. // defaults together for instrumented lanes whose scheduling overhead exceeds
  565. // those defaults. Explicit fixture timeouts remain authoritative.
  566. function coverageWorkerArgs(): { instrumented: string[]; exempt: string[] } {
  567. const [flag] = positiveIntArg('DSH_COVERAGE_MAX_WORKERS', '--maxWorkers')
  568. if (flag === undefined) return { instrumented: [], exempt: [] }
  569. const total = Number.parseInt(flag.split('=')[1] ?? '', 10)
  570. const exempt = Math.max(1, Math.floor(total / 3))
  571. const instrumented = Math.max(1, total - exempt)
  572. return {
  573. instrumented: [`--maxWorkers=${String(instrumented)}`],
  574. exempt: [`--maxWorkers=${String(exempt)}`],
  575. }
  576. }
  577. function coverageGates(): Gate[] {
  578. const workers = coverageWorkerArgs()
  579. const timeouts = coverageTestTimeoutArgs(process.env[COVERAGE_TEST_TIMEOUT_ENV])
  580. const partitions = parseCoveragePartitionCount(process.env[COVERAGE_PARTITIONS_ENV])
  581. const instrumented = partitions === undefined
  582. ? pnpmExec('coverage', [
  583. 'vitest',
  584. 'run',
  585. '--coverage',
  586. ...workers.instrumented,
  587. ...timeouts,
  588. ], {
  589. label: 'test:coverage',
  590. env: { [COVERAGE_EXEMPT_ENV]: '1' },
  591. })
  592. : pnpmScript('coverage', 'test:coverage:partitioned', {
  593. label: 'test:coverage',
  594. displayCommand: `${COVERAGE_PARTITIONS_ENV}=${partitions} pnpm run test:coverage:partitioned`,
  595. env: { [COVERAGE_EXEMPT_ENV]: '1' },
  596. streamOutput: true,
  597. })
  598. return [
  599. pnpmScript('native-system', 'build:native-system'),
  600. { ...instrumented, needs: ['native-system'] },
  601. pnpmExec('coverage-exempt-heavy', [
  602. 'vitest',
  603. 'run',
  604. ...coverageExemptHeavySuites.map(suite => suite.filter),
  605. ...workers.exempt,
  606. ...timeouts,
  607. ], {
  608. label: 'test:coverage-exempt-heavy',
  609. needs: ['native-system'],
  610. }),
  611. ]
  612. }
  613. // Recorded-session adapters boot process scenarios in `lib` mode. Callers wait
  614. // either on `build` or on a validation gate that transitively owns that build.
  615. function snapshotGate(needs: string[] = ['build']): Gate {
  616. return pnpmScript('snapshot', 'test:snapshot', {
  617. env: { DSH_EXAMPLE_MODE: 'lib' },
  618. needs,
  619. })
  620. }
  621. // Owner-local process expectations consume built package exports without entering
  622. // the recorded-session corpus or the credentialed provider lane.
  623. function expectedOutputGate(needs: string[] = ['build']): Gate {
  624. return pnpmScript('expected-output', 'test:expected', {
  625. env: { DSH_EXAMPLE_MODE: 'lib' },
  626. needs,
  627. })
  628. }
  629. function builtPackageInvariantsGate(needs?: string[]): Gate {
  630. return pnpmScript('built-package-invariants', 'verify-built-package-invariants', {
  631. label: 'built package invariants',
  632. ...needs === undefined ? {} : { needs },
  633. })
  634. }
  635. function positiveIntArg(envName: string, flag: string): string[] {
  636. const raw = process.env[envName]
  637. if (raw === undefined || raw === '') return []
  638. const parsed = Number.parseInt(raw, 10)
  639. if (!Number.isSafeInteger(parsed) || parsed < 1 || String(parsed) !== raw) {
  640. throw new Error(`run-gates: ${envName} must be a positive integer, got ${JSON.stringify(raw)}.`)
  641. }
  642. return [`${flag}=${raw}`]
  643. }
  644. function flagEnabled(envName: string): boolean {
  645. const raw = process.env[envName]
  646. if (raw === undefined || raw === '') return false
  647. if (raw !== '1') throw new Error(`run-gates: ${envName} must be 1 when set, got ${JSON.stringify(raw)}.`)
  648. return true
  649. }
  650. function hygieneLeafGates(options: { artifactNeeds?: string[] } = {}): Gate[] {
  651. const artifactOptions = options.artifactNeeds === undefined ? {} : { needs: options.artifactNeeds }
  652. return [
  653. pnpmScript('rescope-vendor', 'rescope-vendor:check', { label: 'vendor rescope' }),
  654. pnpmScript('publint', 'publint', artifactOptions),
  655. pnpmScript('constraints', 'constraints'),
  656. pnpmScript('default-product-isolation', 'verify-default-product-isolation', { label: 'default product isolation' }),
  657. pnpmScript('package-dependencies', 'verify-package-dependencies', { label: 'package dependencies' }),
  658. pnpmScript('application-entrypoints', 'verify-application-entrypoints', { label: 'application entrypoints' }),
  659. pnpmScript('dsh-package-licenses', 'verify-dsh-package-licenses', { label: 'DSH package licenses' }),
  660. pnpmScript('package-invariants', 'verify-package-invariants', { label: 'package invariants' }),
  661. builtPackageInvariantsGate(options.artifactNeeds),
  662. pnpmScript('node-next-types', 'verify-node-next-types', {
  663. label: 'node-next types',
  664. ...artifactOptions,
  665. }),
  666. pnpmScript('optional-dependency-imports', 'verify-optional-dependency-imports', {
  667. label: 'optional dependency imports',
  668. }),
  669. pnpmScript('client-packages', 'verify-client-packages', { label: 'client packages' }),
  670. pnpmScript('client-ui-i18n', 'verify-client-ui-i18n', { label: 'client UI i18n' }),
  671. pnpmScript('no-bare-dispatcher', 'verify-no-bare-dispatcher', { label: 'proxy-aware dispatchers' }),
  672. ]
  673. }
  674. function docSyncLeafGates(options: {
  675. includeDocTypecheck?: boolean
  676. docTypecheckNeeds?: string[]
  677. docTypecheckEnv?: Record<string, string | undefined>
  678. docTypecheckScript?: 'doc-typecheck' | 'doc-typecheck:contracts-ready'
  679. docsBuildScript?: 'docs:build' | 'docs:build:mpa'
  680. } = {}): Gate[] {
  681. const docTypecheckOptions: Partial<Gate> = {}
  682. if (options.docTypecheckNeeds !== undefined) docTypecheckOptions.needs = options.docTypecheckNeeds
  683. if (options.docTypecheckEnv !== undefined) docTypecheckOptions.env = options.docTypecheckEnv
  684. return [
  685. // Stable FIFO starts the longest leaves first; only docs-site-build writes website/.generated.
  686. ...options.includeDocTypecheck === false
  687. ? []
  688. : [pnpmScript('doc-typecheck', options.docTypecheckScript ?? 'doc-typecheck', docTypecheckOptions)],
  689. pnpmScript('docs-site-build', options.docsBuildScript ?? 'docs:build', { label: 'documentation build' }),
  690. pnpmScript('doc-graphs', 'verify-doc-graphs', { label: 'doc graphs' }),
  691. pnpmScript('markdown-links', 'verify-md-links', { label: 'markdown links', quick: true }),
  692. pnpmScript('type-equivalence', 'verify-type-equiv', { label: 'type equivalence', quick: true }),
  693. pnpmScript('cordis-catalog', 'verify-cordis-catalog', { label: 'cordis catalog' }),
  694. pnpmScript('cordis-inspect-catalog', 'verify-cordis-inspect-catalog', { label: 'Cordis inspect catalog' }),
  695. pnpmScript('mermaid', 'verify-mermaid'),
  696. pnpmScript('scoped-events', 'verify-scoped-events', { label: 'scoped events' }),
  697. pnpmScript('translation-pairing', 'verify-translation-pairing', { label: 'translation pairing', quick: true }),
  698. pnpmScript('markdown-wrap', 'verify-md-wrap', { label: 'markdown wrap', quick: true }),
  699. pnpmScript('client-catalog', 'verify-client-catalog', { label: 'client catalog' }),
  700. pnpmScript('export-jsdoc', 'verify-export-jsdoc', { label: 'export jsdoc' }),
  701. pnpmScript('tool-catalog', 'verify-tool-catalog', { label: 'tool catalog' }),
  702. pnpmScript('config-catalog', 'verify-config-catalog', { label: 'config catalog' }),
  703. pnpmScript('dependency-catalog', 'verify-dependency-catalog', { label: 'npm dependency catalog', quick: true }),
  704. pnpmScript('persistence-catalog', 'verify-persistence-catalog', { label: 'persistence catalog' }),
  705. pnpmScript('persistence-changes', 'verify-persistence-changes', { label: 'persistence type history' }),
  706. pnpmScript('persistence-releases', 'verify-persistence-releases', { label: 'released persistence history' }),
  707. pnpmScript('persistence-formats', 'verify-persistence-formats', { label: 'Session format references', quick: true }),
  708. pnpmScript('session-format-catalog', 'verify-session-format-catalog', { label: 'Session format catalog' }),
  709. pnpmScript('public-repository-links', 'verify-public-repository-links', { label: 'public repository links', quick: true }),
  710. pnpmScript('repository-references', 'verify-repository-references', { label: 'repository references', quick: true }),
  711. pnpmScript('concrete-terms', 'verify-concrete-terms', { label: 'concrete terms', quick: true }),
  712. pnpmScript('doc-refs', 'verify-doc-refs', { label: 'doc refs', quick: true }),
  713. pnpmScript('subsystem-pages', 'verify-subsystem-pages', { label: 'subsystem pages' }),
  714. pnpmScript('package-paths', 'verify-package-paths', { label: 'package paths' }),
  715. pnpmScript('tsconfig-paths', 'verify-tsconfig-paths', { label: 'tsconfig paths' }),
  716. pnpmScript('config-source-ownership', 'verify-config-source-ownership', { label: 'config source ownership' }),
  717. pnpmScript('package-readme-summaries', 'verify-package-readme-summaries', { label: 'package README Summaries', quick: true }),
  718. pnpmScript('package-readme-model-experience', 'verify-package-readme-model-experience', { label: 'package README model experience', quick: true }),
  719. pnpmScript('agent-note-classification', 'verify-agent-note-classification', { label: 'agent note classification', quick: true }),
  720. pnpmScript('agent-note-format', 'verify-agent-note-format', { label: 'agent note format', quick: true }),
  721. pnpmScript('archived-agent-notes', 'verify-archived-agent-notes', { label: 'archived agent notes', quick: true }),
  722. pnpmScript('skill-invocation-metadata', 'verify-skill-invocation-metadata', { label: 'skill invocation metadata', quick: true }),
  723. pnpmScript('translation-prompt', 'verify-translation-prompt', { label: 'translation prompt', quick: true }),
  724. pnpmScript('doc-budgets', 'verify-doc-budgets', { label: 'doc budgets', quick: true }),
  725. pnpmExec('doc-standard-tests', ['vitest', 'run', 'scripts/doc-standard.spec.ts'], {
  726. label: 'documentation standard tests',
  727. quick: true,
  728. }),
  729. pnpmExec('docs-site-projection', ['vitest', 'run', 'scripts/project-doc-site.spec.ts', 'scripts/verify-doc-site-fragments.spec.ts'], {
  730. label: 'documentation site checks',
  731. }),
  732. pnpmScript('package-readme-limitations', 'verify-package-readme-limitations', { label: 'package README limitations', quick: true }),
  733. ]
  734. }
  735. /**
  736. * The quick comprehensive documentation-standard aggregate for `test:docs`.
  737. * It covers the prose, pairing, README, budget, and Agent Note gates
  738. * without builds, generator regeneration, or the VitePress site build.
  739. */
  740. function docQuickLeafGates(): Gate[] {
  741. return docSyncLeafGates({ includeDocTypecheck: false }).filter(gate => gate.quick === true)
  742. }
  743. function builtBinSmokeGate(needs: string[] = ['build']): Gate {
  744. return pnpmExec('built-bin-smoke', [
  745. 'vitest',
  746. 'run',
  747. '--config',
  748. 'vitest.e2e.config.ts',
  749. 'apps/cli/tests/profiles/headless/tests/keyless-smoke.e2e.ts',
  750. 'apps/cli/tests/built-bin.e2e.ts',
  751. 'packages/host/directory-picker-native/tests/built-worker.e2e.ts',
  752. 'packages/sdk/server/tests/built-scope-carrier.e2e.ts',
  753. 'packages/fs/tool-present/tests/built-errors.e2e.ts',
  754. 'packages/subprocess/subprocess-local/tests/spawn-runner-built.e2e.ts',
  755. 'packages/subagent/subagent-codex/tests/loader-composition.e2e.ts',
  756. 'packages/subagent/subagent-claude-code/tests/loader-composition.e2e.ts',
  757. 'packages/api/remotes/tests/built-lib.e2e.ts',
  758. 'packages/experimental/agent-team/tests/built-lib.e2e.ts',
  759. // Built execution consumers: the only automated proof that package-name
  760. // imports reach their lib/ entrypoints under plain Node. The e2e lane runs
  761. // unbuilt, so these files self-skip there.
  762. 'packages/workflow/workflow-worker-thread/tests/built-worker.e2e.ts',
  763. 'packages/ptc-runtime/ptc-runtime-node/tests/built-lib.e2e.ts',
  764. 'packages/session/session-persistence-jsonl/tests/built-migration-worker.e2e.ts',
  765. 'packages/lsp/lsp-stdio/tests/built-lib.e2e.ts',
  766. ], {
  767. label: 'built-bin smoke',
  768. needs,
  769. env: { DSH_EXAMPLE_MODE: 'lib' },
  770. })
  771. }
  772. /**
  773. * Reject a gate list whose graph cannot be executed unambiguously.
  774. * @param gates - complete aggregate to validate.
  775. */
  776. function validateGateGraph(gates: readonly Gate[]): void {
  777. if (gates.length === 0) throw new Error('run-gates: gate graph has no gates.')
  778. const ids = new Set<string>()
  779. for (const gate of gates) {
  780. if (ids.has(gate.id)) throw new Error(`run-gates: duplicate gate id ${JSON.stringify(gate.id)}.`)
  781. ids.add(gate.id)
  782. }
  783. for (const gate of gates) {
  784. for (const dependency of gate.needs ?? []) {
  785. if (!ids.has(dependency)) {
  786. throw new Error(`run-gates: gate ${JSON.stringify(gate.id)} depends on unknown gate ${JSON.stringify(dependency)}.`)
  787. }
  788. }
  789. for (const predecessor of gate.after ?? []) {
  790. if (!ids.has(predecessor)) {
  791. throw new Error(`run-gates: gate ${JSON.stringify(gate.id)} waits for unknown gate ${JSON.stringify(predecessor)}.`)
  792. }
  793. }
  794. }
  795. const cycle = findDependencyCycle(gates)
  796. if (cycle !== undefined) throw new Error(`run-gates: dependency cycle: ${cycle.join(' -> ')}.`)
  797. }
  798. function findDependencyCycle(gates: readonly Gate[]): string[] | undefined {
  799. const byId = new Map(gates.map(gate => [gate.id, gate]))
  800. const complete = new Set<string>()
  801. const active = new Map<string, number>()
  802. const path: string[] = []
  803. const visit = (id: string): string[] | undefined => {
  804. if (complete.has(id)) return undefined
  805. const cycleStart = active.get(id)
  806. if (cycleStart !== undefined) return [...path.slice(cycleStart), id]
  807. const gate = byId.get(id)
  808. if (gate === undefined) return undefined
  809. active.set(id, path.length)
  810. path.push(id)
  811. for (const predecessor of [...(gate.needs ?? []), ...(gate.after ?? [])]) {
  812. const cycle = visit(predecessor)
  813. if (cycle !== undefined) return cycle
  814. }
  815. path.pop()
  816. active.delete(id)
  817. complete.add(id)
  818. return undefined
  819. }
  820. for (const gate of gates) {
  821. const cycle = visit(gate.id)
  822. if (cycle !== undefined) return cycle
  823. }
  824. return undefined
  825. }
  826. /**
  827. * Scheduling options for one aggregate.
  828. */
  829. export interface RunGatesOptions {
  830. /** Stop the aggregate at the first blocking gate failure. */
  831. failFast?: boolean
  832. /** Forward host SIGINT/SIGTERM to the abort path so detached gate trees are
  833. * terminated when the run itself is interrupted or the runner cancels it.
  834. * Tree termination additionally requires failFast, because only then is the
  835. * abort signal passed to the executor and children detached. */
  836. forwardProcessSignals?: boolean
  837. }
  838. /**
  839. * Validate and run one aggregate before the injected executor can start a child.
  840. * @param gates - complete aggregate to execute.
  841. * @param maxActive - maximum concurrent child count.
  842. * @param execute - child-process executor; receives the abort signal only when
  843. * fail-fast is enabled, so ordinary runs keep their children in the host
  844. * process group.
  845. * @param observe - result observer invoked when each gate settles.
  846. * @param options - scheduling options; fail-fast aborts the aggregate at the
  847. * first blocking gate failure by killing running children and skipping every
  848. * not-yet-run gate.
  849. * @returns results in aggregate order.
  850. */
  851. export async function runGates(
  852. gates: Gate[],
  853. maxActive: number,
  854. execute: GateExecutor,
  855. observe: ResultObserver = () => {},
  856. options: RunGatesOptions = {},
  857. ): Promise<GateResult[]> {
  858. validateGateGraph(gates)
  859. if (!Number.isSafeInteger(maxActive) || maxActive < 1) {
  860. throw new Error(`run-gates: max concurrency must be a positive integer, got ${JSON.stringify(maxActive)}.`)
  861. }
  862. if (options.forwardProcessSignals === true && options.failFast !== true) {
  863. throw new Error('run-gates: forwardProcessSignals requires failFast, otherwise no child is detached or killed.')
  864. }
  865. const states = new Map<string, GateState>(gates.map(gate => [gate.id, 'pending']))
  866. const results = new Map<string, GateResult>()
  867. const running: RunningGate[] = []
  868. const abort = new AbortController()
  869. let abortCause: string | undefined
  870. // Host interruption (terminal Ctrl+C, runner cancellation) drains through
  871. // the same abort path as a gate failure, so detached trees are killed and
  872. // never orphaned. Handlers are removed before returning.
  873. const hostSignals = options.forwardProcessSignals === true ? ['SIGINT', 'SIGTERM'] as const : []
  874. const hostHandlers = hostSignals.map((name) => {
  875. const handler = () => {
  876. abortCause = abortCause ?? 'host interruption'
  877. abort.abort()
  878. }
  879. process.on(name, handler)
  880. return { name, handler }
  881. })
  882. const failFastSignal = options.failFast === true ? abort.signal : undefined
  883. try {
  884. for (;;) {
  885. let madeProgress = false
  886. if (abortCause === undefined) {
  887. while (running.length < maxActive) {
  888. const ready = gates.find(gate => states.get(gate.id) === 'pending' && predecessorsReady(gate, states))
  889. if (ready === undefined) break
  890. states.set(ready.id, 'running')
  891. running.push({ gate: ready, promise: execute(ready, failFastSignal) })
  892. console.log(`run-gates: start ${ready.label}`)
  893. madeProgress = true
  894. }
  895. }
  896. if (running.length === 0) {
  897. if (abortCause !== undefined) {
  898. for (const gate of gates) {
  899. if (states.get(gate.id) !== 'pending') continue
  900. const skipped = skippedByFailFast(gate, abortCause)
  901. states.set(gate.id, 'skipped')
  902. results.set(gate.id, skipped)
  903. observe(skipped)
  904. }
  905. break
  906. }
  907. const pending = gates.filter(gate => states.get(gate.id) === 'pending')
  908. if (pending.length === 0) break
  909. const gate = pending.find(item => (item.needs ?? []).some(id => gateFailed(states.get(id))))
  910. if (gate === undefined) throw new Error('run-gates: validated graph stalled without a failed dependency.')
  911. const failedDeps = (gate.needs ?? []).filter(id => gateFailed(states.get(id)))
  912. const result: GateResult = {
  913. gate,
  914. status: 'skipped',
  915. durationMs: 0,
  916. output: [],
  917. exitCode: null,
  918. signalCode: null,
  919. error: `dependency failed or skipped: ${failedDeps.join(', ')}`,
  920. }
  921. states.set(gate.id, 'skipped')
  922. results.set(gate.id, result)
  923. observe(result)
  924. continue
  925. }
  926. if (!madeProgress) {
  927. const settled = await Promise.race(running.map(async item => ({ item, result: await item.promise })))
  928. running.splice(running.indexOf(settled.item), 1)
  929. const observed = abortCause === undefined || settled.result.aborted !== true
  930. ? settled.result
  931. : skippedByFailFast(settled.item.gate, abortCause)
  932. states.set(settled.item.gate.id, observed.status)
  933. results.set(settled.item.gate.id, observed)
  934. observe(observed)
  935. if (abortCause === undefined && options.failFast === true
  936. && observed.status === 'failed' && settled.item.gate.allowFailure !== true) {
  937. abortCause = `${observed.gate.label} failed`
  938. abort.abort()
  939. console.error(`run-gates: fail-fast aborting: ${abortCause}.`)
  940. for (const gate of gates) {
  941. if (states.get(gate.id) !== 'pending') continue
  942. const skipped = skippedByFailFast(gate, abortCause)
  943. states.set(gate.id, 'skipped')
  944. results.set(gate.id, skipped)
  945. observe(skipped)
  946. }
  947. }
  948. }
  949. }
  950. } finally {
  951. for (const { name, handler } of hostHandlers) process.removeListener(name, handler)
  952. }
  953. return gates.map((gate) => {
  954. const result = results.get(gate.id)
  955. if (result === undefined) throw new Error(`run-gates: missing result for ${gate.id}.`)
  956. return result
  957. })
  958. }
  959. /**
  960. * The result of a gate that produced no evidence because fail-fast aborted.
  961. * A gate whose process settled before the abort took effect keeps its real
  962. * result instead: it did produce evidence, and the summary must say so. Any
  963. * result settling after the abort — including a genuine independent failure
  964. * in the race window, and a child that trapped the signal and exited zero —
  965. * is recorded skipped with its partial output discarded, because on Windows a
  966. * killed process is indistinguishable from a failed one by exit code alone.
  967. * @param gate - the gate that produced no evidence.
  968. * @param cause - the full clause naming what aborted the aggregate, e.g.
  969. * `typecheck failed` or `host interruption`.
  970. * @returns the skipped record with the fail-fast error.
  971. */
  972. function skippedByFailFast(gate: Gate, cause: string): GateResult {
  973. return {
  974. gate,
  975. status: 'skipped',
  976. durationMs: 0,
  977. output: [],
  978. exitCode: null,
  979. signalCode: null,
  980. error: `aborted by fail-fast: ${cause}`,
  981. }
  982. }
  983. function predecessorsReady(gate: Gate, states: Map<string, GateState>): boolean {
  984. return (gate.needs ?? []).every(id => states.get(id) === 'passed')
  985. && (gate.after ?? []).every(id => gateSettled(states.get(id)))
  986. }
  987. function gateSettled(state: GateState | undefined): boolean {
  988. return state === 'passed' || state === 'failed' || state === 'skipped'
  989. }
  990. function gateFailed(state: GateState | undefined): boolean {
  991. return state === 'failed' || state === 'skipped'
  992. }
  993. /**
  994. * Execute one gate through the real shell-free child-process boundary.
  995. * @param gate - command and scheduler environment to execute.
  996. * @param signal - abort signal that terminates the whole gate process tree when
  997. * the aggregate fails fast; an already-aborted signal terminates it
  998. * immediately. A provided signal spawns the child detached so POSIX can signal
  999. * its process group and Windows can reach its tree through taskkill.
  1000. * @returns the complete process outcome.
  1001. */
  1002. export async function runGate(gate: Gate, signal?: AbortSignal): Promise<GateResult> {
  1003. const started = performance.now()
  1004. const output: GateOutputChunk[] = []
  1005. let spawnError: string | undefined
  1006. let aborted = false
  1007. const outcome = await new Promise<{
  1008. exitCode: number | null
  1009. signalCode: NodeJS.Signals | null
  1010. }>((resolveExit) => {
  1011. const child = spawn(gate.command, gate.args, {
  1012. cwd: root,
  1013. env: { ...process.env, ...gate.env },
  1014. stdio: ['pipe', 'pipe', 'pipe'],
  1015. detached: signal !== undefined && process.platform !== 'win32',
  1016. })
  1017. child.stdout.setEncoding('utf8')
  1018. child.stderr.setEncoding('utf8')
  1019. child.stdout.on('data', (chunk: string) => {
  1020. if (gate.streamOutput === true) process.stdout.write(chunk)
  1021. else output.push({ stream: 'stdout', text: chunk })
  1022. })
  1023. child.stderr.on('data', (chunk: string) => {
  1024. if (gate.streamOutput === true) process.stderr.write(chunk)
  1025. else output.push({ stream: 'stderr', text: chunk })
  1026. })
  1027. // Deliver one signal to the entire gate tree: the negative pid targets the
  1028. // POSIX process group the detached child leads; Windows has no groups, so
  1029. // taskkill walks the tree rooted at the child and force-terminates (a
  1030. // taskkill without `/F` does not terminate console processes, which is
  1031. // what gate commands are). Outcomes are deliberately unchecked because
  1032. // delivery races tree exit, and a missing taskkill binary is as tolerable
  1033. // as ESRCH. Mirrors the subprocess package's teardown contract
  1034. // (packages/subprocess/subprocess-local/src/spawn.ts).
  1035. const treeKill = (signalToSend: 'SIGTERM' | 'SIGKILL') => {
  1036. const pid = child.pid
  1037. if (pid === undefined) return
  1038. if (process.platform === 'win32') {
  1039. for (const args of taskkillArgs(pid, descendants)) {
  1040. spawnSync('taskkill', args, { stdio: 'ignore' })
  1041. }
  1042. return
  1043. }
  1044. try {
  1045. process.kill(-pid, signalToSend)
  1046. } catch {
  1047. // The group is gone; the direct child may still be alive alone.
  1048. child.kill(signalToSend)
  1049. }
  1050. // The captured list stays valid after the group kill reparents the
  1051. // detached descendants of a nested run-gates (the `check:node-compat`
  1052. // and `check:ci:lint:contracts-ready` gates in ci-consumers): pids do
  1053. // not change on reparenting, so the escalation reaches leaves that
  1054. // ignored SIGTERM without re-enumerating.
  1055. for (const descendantPid of descendants) {
  1056. try {
  1057. process.kill(descendantPid, signalToSend)
  1058. } catch {
  1059. // The descendant exited between the enumeration and the signal.
  1060. }
  1061. }
  1062. }
  1063. let escalation: ReturnType<typeof setTimeout> | undefined
  1064. let terminatedAt = 0
  1065. // Captured once at terminate and re-signalled on escalation: the group
  1066. // kill reaps the direct child, after which its detached descendants are
  1067. // reparented and unreachable by parent id, so the escalation cannot
  1068. // re-enumerate them.
  1069. let descendants: number[] = []
  1070. let pipeDrain: ReturnType<typeof setTimeout> | undefined
  1071. const terminate = () => {
  1072. aborted = true
  1073. const pid = child.pid
  1074. // Merge while the child is still alive: re-enumerating alone would drop
  1075. // a descendant that an exited intermediate reparented out of the parent
  1076. // chain, and replacing the list entirely would lose the sampler's
  1077. // last-known entries when the child already exited. Union preserves both.
  1078. // The sampler runs on every platform (including Windows, where an
  1079. // exited intermediate's table record vanishes and a fresh enumeration
  1080. // cannot cross the gap), so the cache is the source of truth once the
  1081. // child is gone.
  1082. if (pid !== undefined && child.exitCode === null && child.signalCode === null) {
  1083. descendants = [...new Set([...descendants, ...descendantPids(pid)])]
  1084. }
  1085. treeKill('SIGTERM')
  1086. if (escalation === undefined) {
  1087. terminatedAt = Date.now()
  1088. // Force-kill at the deadline regardless of the direct child's exit
  1089. // state: when the wrapper dies but a grandchild ignores SIGTERM and
  1090. // still holds the stdio pipes, `close` has not fired and the tree must
  1091. // still be killed. treeKill swallows an already-absent group.
  1092. escalation = setTimeout(() => { treeKill('SIGKILL') }, 5000)
  1093. }
  1094. if (pipeDrain === undefined) {
  1095. // `close` can stay pending past the direct child's exit when a
  1096. // descendant holds the stdio write ends (escaped process group, or
  1097. // uninterruptible I/O that keeps the SIGKILL pending). Bound the wait
  1098. // past the 5-second SIGKILL grace and force the streams closed so
  1099. // fail-fast settles instead of hanging to the job timeout. Only the
  1100. // abort path arms it: on an ordinary run a gate that outlives its
  1101. // descendants must keep waiting rather than report passed over a live
  1102. // leak. Armed in terminate (not only at `exit`) so the window where
  1103. // the child already exited before the abort is covered too.
  1104. pipeDrain = setTimeout(() => {
  1105. child.stdout.destroy()
  1106. child.stderr.destroy()
  1107. child.stdin.destroy()
  1108. }, 10000)
  1109. }
  1110. }
  1111. if (signal !== undefined) {
  1112. if (signal.aborted) terminate()
  1113. else signal.addEventListener('abort', terminate, { once: true })
  1114. }
  1115. // Refresh the descendant cache while the child runs, so an abort that
  1116. // arrives after the child already exited can still reach a detached
  1117. // descendant the child left behind: once the child is gone, its
  1118. // descendants are reparented (POSIX) or their intermediate's table record
  1119. // is gone (Windows), so a fresh enumeration cannot cross the gap. The
  1120. // cache is primed at spawn and refreshed every 5 seconds, so a descendant
  1121. // is captured once it appears in any enumeration whose parent chain is
  1122. // still fully present in the table; the residual window is a descendant
  1123. // that never appears in such a snapshot — created after one enumeration
  1124. // and orphaned before the next. Enumeration is asynchronous (a slow
  1125. // WMI/CIM call is bounded by its own 10-second timeout), so a gate's
  1126. // output draining and exit handling are never blocked while the sampler
  1127. // reads the process table. Fail-fast runs only; ordinary runs never
  1128. // abort.
  1129. let descendantSampler: ReturnType<typeof setInterval> | undefined
  1130. if (signal !== undefined) {
  1131. let enumerationInFlight: { cancel: () => void } | undefined
  1132. const refreshDescendants = () => {
  1133. const pid = child.pid
  1134. if (pid === undefined || child.exitCode !== null || child.signalCode !== null) return
  1135. if (enumerationInFlight !== undefined) return
  1136. const handle = descendantPidsAsync(pid, process.platform)
  1137. enumerationInFlight = handle
  1138. void handle.promise.then((fresh) => {
  1139. if (enumerationInFlight === handle) enumerationInFlight = undefined
  1140. // Merge regardless of the child's exit state: the enumeration
  1141. // started while the child was alive, so its snapshot is the last
  1142. // reliable view of the tree. The child may exit (its intermediate
  1143. // gone, its table record vanished) before the promise settles while
  1144. // a grandchild still holds the stdio write ends and keeps `close`
  1145. // pending — exactly when terminate needs this list.
  1146. // Merge instead of replacing, like terminate: an intermediate that
  1147. // exited since the last tick reparented its detached descendants
  1148. // out of the parent chain, so a fresh enumeration alone would drop
  1149. // them. Filter the cache to the still-executing so a long gate
  1150. // does not accumulate stale pids; while sampler ticks still run the
  1151. // live filter also keeps the escalation from signalling a reused
  1152. // pid, but once ticks stop (child exited) the cache can go stale,
  1153. // and a pid reused after that is the accepted sampling window.
  1154. descendants = [...new Set([...descendants.filter(processAlive), ...fresh])]
  1155. })
  1156. }
  1157. const cancelInFlightEnumeration = () => {
  1158. if (enumerationInFlight !== undefined) enumerationInFlight.cancel()
  1159. enumerationInFlight = undefined
  1160. }
  1161. refreshDescendants()
  1162. descendantSampler = setInterval(refreshDescendants, 5000)
  1163. // A gate that settles while an enumeration is still running must not
  1164. // leave the PowerShell subprocess holding stdio handles until its own
  1165. // timeout: stop it as soon as the child's outcome is known.
  1166. child.once('close', cancelInFlightEnumeration)
  1167. child.once('error', cancelInFlightEnumeration)
  1168. }
  1169. child.on('error', (error) => {
  1170. if (escalation !== undefined) clearTimeout(escalation)
  1171. if (pipeDrain !== undefined) clearTimeout(pipeDrain)
  1172. if (descendantSampler !== undefined) clearInterval(descendantSampler)
  1173. if (signal !== undefined) signal.removeEventListener('abort', terminate)
  1174. spawnError = `failed to start command: ${error.message}`
  1175. resolveExit({ exitCode: null, signalCode: null })
  1176. })
  1177. child.on('close', (exitCode, signalCode) => {
  1178. if (pipeDrain !== undefined) clearTimeout(pipeDrain)
  1179. if (descendantSampler !== undefined) clearInterval(descendantSampler)
  1180. if (signal !== undefined) signal.removeEventListener('abort', terminate)
  1181. if (escalation !== undefined && process.platform !== 'win32') {
  1182. // `close` only means the direct child's stdio closed; a grandchild
  1183. // that ignored SIGTERM and redirected its stdio can outlive it. Do
  1184. // not settle until the process group and the captured descendants are
  1185. // confirmed gone — the deadline SIGKILL covers members still alive at
  1186. // the grace end — so runGate returns only once the tree is quiescent.
  1187. const confirmGroupGone = () => {
  1188. if (!groupAlive(child.pid) && descendants.every(descendantPid => !processAlive(descendantPid))) {
  1189. clearTimeout(escalation)
  1190. resolveExit({ exitCode, signalCode })
  1191. return
  1192. }
  1193. if (Date.now() - terminatedAt < 8000) {
  1194. setTimeout(confirmGroupGone, 50)
  1195. return
  1196. }
  1197. // The grace ended with members still alive (e.g. uninterruptible
  1198. // I/O that even SIGKILL cannot cut). Fail loud instead of reporting
  1199. // a quiescent tree: the gate is recorded failed either way.
  1200. console.error(`run-gates: gate tree not quiescent after 8s (${gate.label}).`)
  1201. clearTimeout(escalation)
  1202. resolveExit({ exitCode, signalCode })
  1203. }
  1204. confirmGroupGone()
  1205. return
  1206. }
  1207. if (escalation !== undefined) clearTimeout(escalation)
  1208. resolveExit({ exitCode, signalCode })
  1209. })
  1210. child.stdin.end()
  1211. })
  1212. const { exitCode, signalCode } = outcome
  1213. const status: GateResultStatus = exitCode === 0 && signalCode === null && spawnError === undefined ? 'passed' : 'failed'
  1214. const result: GateResult = {
  1215. gate,
  1216. status,
  1217. durationMs: performance.now() - started,
  1218. output,
  1219. exitCode,
  1220. signalCode,
  1221. }
  1222. result.aborted = aborted
  1223. if (spawnError !== undefined) result.error = spawnError
  1224. return result
  1225. }
  1226. /**
  1227. * Parse the state, parent, and process-group fields from a `/proc/<pid>/stat`
  1228. * line. The comm field may contain spaces and parentheses, so the state starts
  1229. * after the last closing parenthesis.
  1230. * @param stat - one `/proc/<pid>/stat` line.
  1231. * @returns state, parent pid, and process-group pid; undefined when truncated.
  1232. */
  1233. function procStatFields(stat: string): { state: string; ppid: number; pgrp: number } | undefined {
  1234. const fields = stat.slice(stat.lastIndexOf(')') + 2).split(' ')
  1235. const state = fields[0]
  1236. const ppid = fields[1]
  1237. const pgrp = fields[2]
  1238. if (state === undefined || ppid === undefined || pgrp === undefined) return undefined
  1239. return { state, ppid: Number(ppid), pgrp: Number(pgrp) }
  1240. }
  1241. /**
  1242. * Whether one process is still executing. Zombies (state `Z`) do not count:
  1243. * they are dead records awaiting reaping, and kill(pid, 0) would report them
  1244. * as alive. Linux reads /proc/<pid>/stat to distinguish; other platforms fall
  1245. * back to the signal probe.
  1246. * @param pid - the process to probe.
  1247. */
  1248. function processAlive(pid: number): boolean {
  1249. if (process.platform === 'linux') {
  1250. try {
  1251. const parsed = procStatFields(readFileSync(`/proc/${pid}/stat`, 'utf8'))
  1252. return parsed !== undefined && parsed.state !== 'Z'
  1253. } catch {
  1254. return false
  1255. }
  1256. }
  1257. try {
  1258. process.kill(pid, 0)
  1259. return true
  1260. } catch {
  1261. return false
  1262. }
  1263. }
  1264. /**
  1265. * Whether any member of the child's POSIX process group is still executing.
  1266. * Zombie entries (state `Z`) do not count: they are dead records awaiting
  1267. * reaping, and the kill(-pid, 0) group probe would report them as alive.
  1268. * Linux enumerates /proc to distinguish after a fast-path group probe; other
  1269. * POSIX platforms fall back to the probe alone.
  1270. * @param pid - the group leader's pid; undefined or non-positive means the
  1271. * spawn failed and nothing is alive.
  1272. */
  1273. function groupAlive(pid: number | undefined): boolean {
  1274. if (pid === undefined || pid <= 0) return false
  1275. if (process.platform === 'linux') {
  1276. try {
  1277. process.kill(-pid, 0)
  1278. } catch {
  1279. // ESRCH: the group has no entries at all.
  1280. return false
  1281. }
  1282. try {
  1283. for (const entry of readdirSync('/proc')) {
  1284. if (!/^\d+$/.test(entry)) continue
  1285. try {
  1286. const parsed = procStatFields(readFileSync(`/proc/${entry}/stat`, 'utf8'))
  1287. if (parsed !== undefined && parsed.pgrp === pid && parsed.state !== 'Z') return true
  1288. } catch {
  1289. // The process exited mid-scan; it is not a live member.
  1290. }
  1291. }
  1292. return false
  1293. } catch {
  1294. return false
  1295. }
  1296. }
  1297. try {
  1298. process.kill(-pid, 0)
  1299. return true
  1300. } catch {
  1301. return false
  1302. }
  1303. }
  1304. /**
  1305. * The pids of every transitive descendant of `root`, read from the live
  1306. * process table. Linux walks /proc/<pid>/stat parent fields; other platforms
  1307. * parse `ps` (POSIX) or the CIM process table (Windows) output. This is one
  1308. * snapshot, not the full tree-ownership mechanism: terminate and the sampler
  1309. * rely on the 5-second cache to cross an intermediate that exited between
  1310. * ticks (reparented on POSIX, table record gone on Windows), so a single
  1311. * enumeration reaches only the descendants whose parent chain is still fully
  1312. * present in the table.
  1313. * @param root - the pid whose descendants are wanted.
  1314. * @returns descendant pids in breadth-first order; empty on enumeration failure.
  1315. */
  1316. function descendantPids(root: number): number[] {
  1317. if (root <= 0) return []
  1318. if (process.platform === 'linux') {
  1319. const rows: Array<[number, number]> = []
  1320. try {
  1321. for (const entry of readdirSync('/proc')) {
  1322. if (!/^\d+$/.test(entry)) continue
  1323. try {
  1324. const parsed = procStatFields(readFileSync(`/proc/${entry}/stat`, 'utf8'))
  1325. if (parsed !== undefined) rows.push([Number(entry), parsed.ppid])
  1326. } catch {
  1327. // The process exited mid-scan; skip it.
  1328. }
  1329. }
  1330. } catch {
  1331. return []
  1332. }
  1333. return collectDescendants(root, rows)
  1334. }
  1335. let ps: { error?: Error; stdout: string }
  1336. if (process.platform === 'win32') {
  1337. // taskkill /T covers the tree only while the root is alive; once the
  1338. // direct child exits (a descendant still holding the stdio write ends
  1339. // keeps `close` pending), abort must reach the survivors from a fresh
  1340. // enumeration. Windows keeps the exited parent's pid in its descendants'
  1341. // parent column, so this walk still finds the whole tree. A hung
  1342. // PowerShell (WMI/CIM service trouble) must not stall the abort path
  1343. // indefinitely, so the enumeration is bounded.
  1344. ps = spawnSync('powershell', processTableArgs('win32'), { encoding: 'utf8', timeout: 10000 })
  1345. } else {
  1346. ps = spawnSync('ps', processTableArgs('posix'), { encoding: 'utf8' })
  1347. }
  1348. if (ps.error !== undefined) return []
  1349. return collectDescendants(root, parsePidPpidLines(ps.stdout))
  1350. }
  1351. /**
  1352. * The process-table enumeration command for one platform. Windows queries the
  1353. * CIM provider through PowerShell (each line `pid ppid`); other platforms use
  1354. * `ps -axo pid=,ppid=`.
  1355. * @param platform - the target platform.
  1356. * @returns the command arguments to enumerate every live process's pid/ppid.
  1357. */
  1358. function processTableArgs(platform: 'win32' | 'posix'): string[] {
  1359. if (platform === 'win32') {
  1360. return ['-NoProfile', '-NonInteractive', '-Command', 'Get-CimInstance Win32_Process | ForEach-Object { "$($_.ProcessId) $($_.ParentProcessId)" }']
  1361. }
  1362. return ['-axo', 'pid=,ppid=']
  1363. }
  1364. /**
  1365. * Asynchronous descendant enumeration, so a slow WMI/CIM call (bounded by a
  1366. * 10-second timeout) cannot block the event loop: the sampler runs it while
  1367. * the gate's output streams and exit handling must keep flowing. Returns the
  1368. * same descendant list as {@link descendantPids}; used by the fail-fast
  1369. * sampler only, never on the abort path (which needs the synchronous walk to
  1370. * capture the tree before any member exits).
  1371. * @param root - the pid whose descendants are wanted.
  1372. * @param platform - the platform whose table the enumeration reads.
  1373. * @returns a promise of descendant pids in breadth-first order; empty on
  1374. * enumeration failure.
  1375. */
  1376. function descendantPidsAsync(root: number, platform: NodeJS.Platform): { promise: Promise<number[]>; cancel: () => void } {
  1377. if (root <= 0 || platform === 'linux') {
  1378. // The /proc walk is synchronous inside the async wrapper so the sampler
  1379. // keeps the same contract on every platform; /proc reads are fast and
  1380. // need no subprocess, and a completed enumeration needs no cancellation.
  1381. return { promise: Promise.resolve(descendantPids(root)), cancel: () => {} }
  1382. }
  1383. const [command, args] = platform === 'win32'
  1384. ? ['powershell', processTableArgs('win32')]
  1385. : ['ps', processTableArgs('posix')]
  1386. const child = spawn(command, args, {
  1387. stdio: ['ignore', 'pipe', 'ignore'],
  1388. timeout: platform === 'win32' ? 10000 : undefined,
  1389. })
  1390. child.stdout.setEncoding('utf8')
  1391. let stdout = ''
  1392. let settled = false
  1393. let settle!: (value: number[]) => void
  1394. const promise = new Promise<number[]>((resolve) => { settle = resolve })
  1395. const finish = (value: number[]) => {
  1396. if (settled) return
  1397. settled = true
  1398. // The enumeration completed (or was cancelled): stop the subprocess so
  1399. // the gate does not wait on its stdio handles.
  1400. child.kill('SIGTERM')
  1401. settle(value)
  1402. }
  1403. child.stdout.on('data', (chunk: string) => { stdout += chunk })
  1404. child.on('error', () => { finish([]) })
  1405. child.on('close', () => { finish(collectDescendants(root, parsePidPpidLines(stdout))) })
  1406. return {
  1407. promise,
  1408. cancel: () => { finish([]) },
  1409. }
  1410. }
  1411. /** Parse `pid ppid` rows from a process-table dump. Both the POSIX `ps -axo
  1412. * pid=,ppid=` output and the Windows PowerShell `Get-CimInstance Win32_Process`
  1413. * projection emit one `pid ppid` pair per line.
  1414. * @param output - the raw dump text.
  1415. * @returns the parsed pid/ppid rows in line order; blank and malformed lines
  1416. * are dropped.
  1417. */
  1418. export function parsePidPpidLines(output: string): Array<[number, number]> {
  1419. const rows: Array<[number, number]> = []
  1420. for (const line of output.split('\n')) {
  1421. const match = line.trim().match(/^(\d+)\s+(\d+)$/)
  1422. if (match !== null) rows.push([Number(match[1]), Number(match[2])])
  1423. }
  1424. return rows
  1425. }
  1426. /**
  1427. * The taskkill invocations that terminate one Windows gate tree. The direct
  1428. * child leads, because a live `taskkill /T` walks its whole subtree in one
  1429. * call; each captured descendant follows individually, because when the root
  1430. * already exited (a descendant holding the stdio write ends keeps `close`
  1431. * pending) `taskkill /T` rooted at the dead pid finds nothing — Windows never
  1432. * reparents, so the ppid chain captured at terminate still reaches the whole
  1433. * tree, and `/T` lets a surviving intermediate carry its own subtree. A pid
  1434. * that exited between capture and termination is as tolerable as ESRCH on
  1435. * POSIX: taskkill reports a nonzero status that is deliberately unchecked.
  1436. * @param rootPid - the direct child's pid.
  1437. * @param descendants - the captured descendant pids.
  1438. * @returns one `taskkill` argument list per pid, in termination order.
  1439. */
  1440. export function taskkillArgs(rootPid: number, descendants: number[]): string[][] {
  1441. return [rootPid, ...descendants].map(pid => ['/PID', String(pid), '/T', '/F'])
  1442. }
  1443. /**
  1444. * Walk a process-table snapshot without revisiting duplicate or cyclic PID links.
  1445. * @param root - process whose descendants are collected; excluded from the result.
  1446. * @param rows - observed PID and parent PID pairs.
  1447. * @returns distinct reachable descendants in breadth-first order.
  1448. */
  1449. export function collectDescendants(root: number, rows: Array<[number, number]>): number[] {
  1450. const byParent = new Map<number, number[]>()
  1451. for (const [pid, ppid] of rows) {
  1452. const children = byParent.get(ppid) ?? []
  1453. children.push(pid)
  1454. byParent.set(ppid, children)
  1455. }
  1456. const seen = new Set([root])
  1457. const queue = [root]
  1458. for (const parent of queue) {
  1459. for (const pid of byParent.get(parent) ?? []) {
  1460. if (seen.has(pid)) continue
  1461. seen.add(pid)
  1462. queue.push(pid)
  1463. }
  1464. }
  1465. return queue.slice(1)
  1466. }
  1467. /**
  1468. * Format every independently observed failure fact for the aggregate summary.
  1469. * @param result - unsuccessful gate result.
  1470. * @returns error, exit, and signal facts without allowing one to hide another.
  1471. */
  1472. export function formatGateResultReason(result: GateResult): string {
  1473. const facts: string[] = []
  1474. if (result.error !== undefined) facts.push(result.error)
  1475. if (result.exitCode !== null) facts.push(`exit ${result.exitCode}`)
  1476. if (result.signalCode !== null) facts.push(`signal ${result.signalCode}`)
  1477. return facts.length === 0 ? 'no exit code or signal' : facts.join(', ')
  1478. }
  1479. function printResult(result: GateResult): void {
  1480. const verbose = process.env.DSH_GATE_VERBOSE === '1'
  1481. const seconds = (result.durationMs / 1000).toFixed(2)
  1482. if (result.status === 'passed' && !verbose) {
  1483. console.log(`run-gates: PASS ${result.gate.label} (${seconds}s)`)
  1484. return
  1485. }
  1486. const heading = `${result.status.toUpperCase()} ${result.gate.label} (${seconds}s)`
  1487. const writeHeading = result.status === 'passed' ? console.log : console.error
  1488. writeHeading(`\n== ${heading} ==`)
  1489. if (result.status !== 'passed') {
  1490. console.error(`command: ${result.gate.displayCommand}`)
  1491. console.error(`outcome: ${formatGateResultReason(result)}`)
  1492. }
  1493. if (result.gate.streamOutput !== true) printOutput(result.output)
  1494. }
  1495. function printSummary(results: GateResult[], durationMs: number): void {
  1496. const passed = results.filter(result => result.status === 'passed').length
  1497. const failed = results.filter(result => result.status === 'failed').length
  1498. const skipped = results.filter(result => result.status === 'skipped').length
  1499. const seconds = (durationMs / 1000).toFixed(2)
  1500. console.log(`\nrun-gates: ${passed} passed, ${failed} failed, ${skipped} skipped in ${seconds}s.`)
  1501. const unsuccessful = results.filter(result => result.status === 'failed' || result.status === 'skipped')
  1502. if (unsuccessful.length === 0) return
  1503. console.error('run-gates: unsuccessful gates:')
  1504. for (const result of unsuccessful) {
  1505. const duration = (result.durationMs / 1000).toFixed(2)
  1506. const reason = formatGateResultReason(result)
  1507. const disposition = result.gate.allowFailure === true ? 'NON-BLOCKING ' : ''
  1508. console.error(` - ${disposition}${result.status.toUpperCase()} ${result.gate.label} (${duration}s, ${reason})`)
  1509. console.error(` ${result.gate.displayCommand}`)
  1510. }
  1511. }
  1512. function printOutput(output: GateOutputChunk[]): void {
  1513. for (const chunk of output) {
  1514. if (chunk.stream === 'stdout') process.stdout.write(chunk.text)
  1515. else process.stderr.write(chunk.text)
  1516. }
  1517. }