run-gates.spec.ts 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925
  1. import { readFileSync } from 'node:fs'
  2. import { describe, expect, it, vi, type MockInstance } from 'vitest'
  3. import {
  4. cliGateOptions,
  5. defaultConcurrency,
  6. formatGateResultReason,
  7. gatesForMode,
  8. parsePidPpidLines,
  9. runGate,
  10. runGates,
  11. taskkillArgs,
  12. type Gate,
  13. type GateResult,
  14. } from './run-gates.ts'
  15. /**
  16. * Capture output a gate streams through runGate's streamOutput path.
  17. * @returns the accumulated chunks and the stdout spy to restore in finally.
  18. */
  19. function captureStreamedOutput(): { writes: string[]; write: MockInstance } {
  20. const writes: string[] = []
  21. const write = vi.spyOn(process.stdout, 'write').mockImplementation((chunk) => {
  22. writes.push(String(chunk))
  23. return true
  24. })
  25. return { writes, write }
  26. }
  27. /**
  28. * A process has stopped executing when its /proc entry is gone, or when it
  29. * lingers as a zombie ('Z') — an un-reaped but dead entry still answers
  30. * kill(pid, 0), so existence is not a liveness check. Non-Linux falls back to
  31. * kill(pid, 0), whose ESRCH means the process is gone.
  32. */
  33. function procStopped(pid: number): boolean {
  34. if (process.platform === 'linux') {
  35. try {
  36. const stat = readFileSync(`/proc/${pid}/stat`, 'utf8')
  37. return /\)\s+Z\s/.test(stat)
  38. } catch {
  39. return true
  40. }
  41. }
  42. try {
  43. process.kill(pid, 0)
  44. return false
  45. } catch {
  46. return true
  47. }
  48. }
  49. /**
  50. * Wait until the captured output contains `marker` and the grandchild pid the
  51. * gate printed, then return that pid.
  52. * @param writes - chunks captured from the gate's streamed stdout.
  53. * @param marker - the output line that proves the gate reached the abort point.
  54. * @param deadline - fail the wait when exceeded.
  55. * @returns the grandchild pid printed by the gate script.
  56. */
  57. async function waitForGrandchildPid(writes: string[], marker: string, deadline: number): Promise<number> {
  58. let pid: number | undefined
  59. while ((pid === undefined || !writes.join('').includes(marker)) && Date.now() < deadline) {
  60. const match = writes.join('').match(/grandchild:(\d+)/)
  61. if (match !== null) pid = Number(match[1])
  62. await new Promise(resolve => setTimeout(resolve, 50))
  63. }
  64. expect(pid ?? 0).toBeGreaterThan(0)
  65. expect(writes.join('')).toContain(marker)
  66. return pid!
  67. }
  68. /**
  69. * Abort the run and assert it settles marked aborted with the grandchild no
  70. * longer executing — the abort path must have signalled it from the captured
  71. * descendant list rather than settling over a live orphan.
  72. * @param promise - the pending `runGate` promise.
  73. * @param controller - the signal source to abort.
  74. * @param pid - the grandchild pid the gate script printed.
  75. */
  76. async function abortAndExpectTreeStopped(promise: Promise<GateResult>, controller: AbortController, pid: number): Promise<void> {
  77. controller.abort()
  78. const result = await promise
  79. expect(result.aborted).toBe(true)
  80. const stopDeadline = Date.now() + 8000
  81. while (!procStopped(pid) && Date.now() < stopDeadline) {
  82. await new Promise(resolve => setTimeout(resolve, 50))
  83. }
  84. expect(procStopped(pid)).toBe(true)
  85. }
  86. function gate(id: string, options: Partial<Gate> = {}): Gate {
  87. return {
  88. id,
  89. label: id,
  90. displayCommand: `run ${id}`,
  91. command: process.execPath,
  92. args: ['-e', ''],
  93. ...options,
  94. }
  95. }
  96. function resultFor(subject: Gate, status: GateResult['status'] = 'passed'): GateResult {
  97. return {
  98. gate: subject,
  99. status,
  100. durationMs: 10,
  101. output: [],
  102. exitCode: status === 'passed' ? 0 : 1,
  103. signalCode: null,
  104. }
  105. }
  106. function withPnpmEntrypoint<T>(action: () => T, entrypoint = '/private/pnpm.cjs'): T {
  107. const previous = process.env.npm_execpath
  108. process.env.npm_execpath = entrypoint
  109. try {
  110. return action()
  111. } finally {
  112. if (previous === undefined) Reflect.deleteProperty(process.env, 'npm_execpath')
  113. else process.env.npm_execpath = previous
  114. }
  115. }
  116. function withEnv<T>(name: string, value: string | undefined, action: () => T): T {
  117. const previous = process.env[name]
  118. if (value === undefined) Reflect.deleteProperty(process.env, name)
  119. else process.env[name] = value
  120. try {
  121. return action()
  122. } finally {
  123. if (previous === undefined) Reflect.deleteProperty(process.env, name)
  124. else process.env[name] = previous
  125. }
  126. }
  127. describe('gate graph validation', () => {
  128. it.each([
  129. 'ci-primary',
  130. 'ci-linux-primary',
  131. 'ci-static',
  132. 'ci-lint-contracts-ready',
  133. 'ci-coverage',
  134. 'ci-bench',
  135. 'ci-snapshot',
  136. 'ci-artifacts',
  137. 'ci-consumers',
  138. 'ci-windows-blocking',
  139. 'ci-windows-complete',
  140. 'ci-windows-observational',
  141. 'node-compat',
  142. 'check-all',
  143. 'hygiene',
  144. 'doc-sync',
  145. 'doc-quick',
  146. ] as const)('constructs and executes preflight for a valid non-empty %s graph', async (mode) => {
  147. const subject = withPnpmEntrypoint(() => gatesForMode(mode))
  148. const execute = vi.fn(async (item: Gate) => resultFor(item))
  149. await expect(runGates(subject, subject.length, execute)).resolves.toHaveLength(subject.length)
  150. })
  151. it('keeps the public repository link policy in the documentation gate', () => {
  152. const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
  153. expect(ids).toContain('public-repository-links')
  154. })
  155. it('keeps package-group subsystem ownership in the documentation gate', () => {
  156. const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
  157. expect(ids).toContain('subsystem-pages')
  158. })
  159. it('keeps the package README Summary limit in the documentation gate', () => {
  160. const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
  161. expect(ids).toContain('package-readme-summaries')
  162. })
  163. it('derives the quick documentation aggregate from marked doc-sync leaves', () => {
  164. const full = withPnpmEntrypoint(() => gatesForMode('doc-sync'))
  165. const quick = withPnpmEntrypoint(() => gatesForMode('doc-quick'))
  166. expect(quick).toEqual(full.filter(gate => gate.quick === true))
  167. })
  168. it('keeps the hygiene aggregate aligned with the package script checks', () => {
  169. const ids = withPnpmEntrypoint(() => gatesForMode('hygiene').map(subject => subject.id))
  170. expect(ids).toEqual([
  171. 'rescope-vendor', 'publint', 'constraints', 'package-dependencies', 'application-entrypoints',
  172. 'dsh-package-licenses', 'package-invariants', 'built-package-invariants', 'node-next-types',
  173. 'optional-dependency-imports', 'client-packages', 'client-ui-i18n', 'no-bare-dispatcher', 'cordis-config',
  174. 'runtime-closure', 'vendored-links',
  175. ])
  176. expect(defaultConcurrency('hygiene', ids.length, 8)).toEqual({
  177. workers: 4,
  178. source: '8 available CPU(s), hygiene cap 4',
  179. })
  180. })
  181. it('schedules the longest documentation leaves before short checks', () => {
  182. const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
  183. expect(ids.slice(0, 10)).toEqual([
  184. 'doc-typecheck', 'docs-site-build', 'doc-graphs', 'markdown-links', 'type-equivalence',
  185. 'cordis-catalog', 'cordis-inspect-catalog', 'mermaid', 'scoped-events', 'translation-pairing',
  186. ])
  187. })
  188. it('launches a native pnpm entrypoint directly', () => {
  189. const entrypoint = String.raw`C:\Program Files\pnpm\pnpm.exe`
  190. const subject = withPnpmEntrypoint(() => gatesForMode('ci-windows-blocking')[0], entrypoint)
  191. expect(subject).toMatchObject({
  192. command: entrypoint,
  193. args: ['run', 'build'],
  194. })
  195. })
  196. it.each(['ci-primary', 'ci-static', 'check-all'] as const)(
  197. 'keeps the DSH package license policy in %s',
  198. (mode) => {
  199. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  200. expect(ids).toContain('dsh-package-licenses')
  201. },
  202. )
  203. it.each(['ci-primary', 'ci-static', 'check-all', 'hygiene'] as const)(
  204. 'keeps package dependency enforcement in %s',
  205. (mode) => {
  206. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  207. expect(ids).toContain('package-dependencies')
  208. },
  209. )
  210. it.each(['ci-primary', 'ci-static', 'check-all'] as const)(
  211. 'keeps the client dependency policy in %s',
  212. (mode) => {
  213. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  214. expect(ids).toContain('client-packages')
  215. },
  216. )
  217. it.each(['ci-primary', 'ci-static', 'check-all'] as const)(
  218. 'keeps review request policy tests in %s',
  219. (mode) => {
  220. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  221. expect(ids).toContain('request-review')
  222. },
  223. )
  224. it.each(['ci-primary', 'ci-static', 'check-all', 'hygiene'] as const)(
  225. 'keeps hard-coded Client UI copy enforcement in %s',
  226. (mode) => {
  227. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  228. expect(ids).toContain('client-ui-i18n')
  229. },
  230. )
  231. it.each(['ci-primary', 'ci-static', 'check-all', 'hygiene'] as const)(
  232. 'keeps application entrypoint enforcement in %s',
  233. (mode) => {
  234. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  235. expect(ids).toContain('application-entrypoints')
  236. },
  237. )
  238. it('keeps native Windows coverage blocking and behind the complete build', () => {
  239. const complete = withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))
  240. const observational = withPnpmEntrypoint(() => gatesForMode('ci-windows-observational'))
  241. .filter(gate => gate.id !== 'build' && gate.id !== 'docs-site-build')
  242. const byId = new Map(complete.map(subject => [subject.id, subject]))
  243. expect(byId.get('coverage')?.allowFailure).not.toBe(true)
  244. expect(byId.get('coverage')?.needs).toContain('build')
  245. expect(byId.get('coverage-exempt-heavy')?.allowFailure).not.toBe(true)
  246. expect(byId.get('coverage')?.needs).toContain('build')
  247. expect(byId.get('coverage-exempt-heavy')?.needs).toContain('build')
  248. expect(byId.get('coverage-exempt-heavy')?.args).toContain(
  249. 'packages/experimental/webworker-packer/tests/image-loadable.spec.ts',
  250. )
  251. expect(observational).not.toHaveLength(0)
  252. for (const gate of observational) {
  253. const completeGate = byId.get(gate.id)
  254. expect(completeGate?.allowFailure).toBe(true)
  255. expect(completeGate?.after).toEqual(expect.arrayContaining([
  256. 'coverage',
  257. 'coverage-exempt-heavy',
  258. ]))
  259. expect(completeGate?.needs).toEqual(gate.needs)
  260. }
  261. })
  262. it('runs the Windows built-bin smoke after other observational gates settle', () => {
  263. const observational = withPnpmEntrypoint(() => gatesForMode('ci-windows-observational'))
  264. const builtBin = observational.find(gate => gate.id === 'built-bin-smoke')
  265. expect(builtBin?.after).toEqual(
  266. observational.filter(gate => gate.id !== 'built-bin-smoke').map(gate => gate.id),
  267. )
  268. const completeBuiltBin = withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))
  269. .find(gate => gate.id === 'built-bin-smoke')
  270. expect(completeBuiltBin?.after).toContain('windows-site')
  271. expect(completeBuiltBin?.after).not.toContain('docs-site-build')
  272. })
  273. it('applies one configured test, polling, and hook timeout to both coverage gates', () => {
  274. const gates = withEnv('DSH_COVERAGE_TEST_TIMEOUT_MS', '15000', () =>
  275. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete')))
  276. for (const id of ['coverage', 'coverage-exempt-heavy']) {
  277. expect(gates.find(subject => subject.id === id)?.args).toEqual(expect.arrayContaining([
  278. '--testTimeout=15000',
  279. '--expect.poll.timeout=15000',
  280. '--hookTimeout=15000',
  281. ]))
  282. }
  283. })
  284. it('keeps Vitest timeout defaults when the coverage override is absent', () => {
  285. const gates = withEnv('DSH_COVERAGE_TEST_TIMEOUT_MS', undefined, () =>
  286. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete')))
  287. for (const id of ['coverage', 'coverage-exempt-heavy']) {
  288. expect(gates.find(subject => subject.id === id)?.args).not.toEqual(expect.arrayContaining([
  289. expect.stringMatching(/^--(?:testTimeout|expect\.poll\.timeout|hookTimeout)=/),
  290. ]))
  291. }
  292. })
  293. it('rejects an invalid coverage timeout before starting a gate', () => {
  294. expect(() => withEnv('DSH_COVERAGE_TEST_TIMEOUT_MS', '0', () =>
  295. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))))
  296. .toThrow('DSH_COVERAGE_TEST_TIMEOUT_MS must be a positive integer')
  297. })
  298. it('selects partitioned coverage only when explicitly configured', () => {
  299. const coverage = withEnv('DSH_COVERAGE_PARTITIONS', '3', () =>
  300. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete').find(subject => subject.id === 'coverage')))
  301. expect(coverage).toMatchObject({
  302. displayCommand: 'DSH_COVERAGE_PARTITIONS=3 pnpm run test:coverage:partitioned',
  303. args: ['/private/pnpm.cjs', 'run', 'test:coverage:partitioned'],
  304. env: { DSH_COVERAGE_EXEMPT_HEAVY: '1' },
  305. streamOutput: true,
  306. })
  307. })
  308. it('rejects an invalid coverage partition count before starting a gate', () => {
  309. expect(() => withEnv('DSH_COVERAGE_PARTITIONS', '1', () =>
  310. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))))
  311. .toThrow('DSH_COVERAGE_PARTITIONS must be an integer greater than 1')
  312. })
  313. it.each([
  314. ['empty', [], /gate graph has no gates/],
  315. ['duplicate ids', [gate('same'), gate('same')], /duplicate gate id "same"/],
  316. ['unknown dependencies', [gate('subject', { needs: ['missing'] })], /depends on unknown gate "missing"/],
  317. ['unknown ordering predecessors', [gate('subject', { after: ['missing'] })], /waits for unknown gate "missing"/],
  318. ['cycles', [gate('first', { needs: ['second'] }), gate('second', { needs: ['first'] })], /dependency cycle: first -> second -> first/],
  319. ['mixed cycles', [gate('first', { after: ['second'] }), gate('second', { needs: ['first'] })], /dependency cycle: first -> second -> first/],
  320. ] as const)('rejects %s before starting a child', async (_label, invalid, message) => {
  321. const execute = vi.fn(async (subject: Gate) => resultFor(subject))
  322. await expect(runGates([...invalid], 1, execute)).rejects.toThrow(message)
  323. expect(execute).not.toHaveBeenCalled()
  324. })
  325. it('rejects an invalid worker count before starting a child', async () => {
  326. const execute = vi.fn(async (subject: Gate) => resultFor(subject))
  327. await expect(runGates([gate('subject')], 0, execute)).rejects.toThrow('max concurrency must be a positive integer')
  328. expect(execute).not.toHaveBeenCalled()
  329. })
  330. it('skips dependents after their prerequisite fails', async () => {
  331. const dependent = gate('dependent', { needs: ['root'] })
  332. const root = gate('root')
  333. const execute = vi.fn(async (subject: Gate) => resultFor(subject, 'failed'))
  334. const results = await runGates([dependent, root], 1, execute)
  335. expect(execute).toHaveBeenCalledOnce()
  336. expect(execute).toHaveBeenCalledWith(root, undefined)
  337. expect(results[0]).toMatchObject({ gate: dependent, status: 'skipped', error: 'dependency failed or skipped: root' })
  338. })
  339. it('runs an ordered follower after its predecessor fails', async () => {
  340. const follower = gate('follower', { after: ['root'] })
  341. const root = gate('root')
  342. const execute = vi.fn(async (subject: Gate) => resultFor(subject, subject === root ? 'failed' : 'passed'))
  343. const results = await runGates([follower, root], 2, execute)
  344. expect(execute.mock.calls.map(([subject]) => subject.id)).toEqual(['root', 'follower'])
  345. expect(results.map(result => result.status)).toEqual(['passed', 'failed'])
  346. })
  347. it('runs an ordered follower after its predecessor is skipped', async () => {
  348. const follower = gate('follower', { after: ['dependent'] })
  349. const dependent = gate('dependent', { needs: ['root'] })
  350. const root = gate('root')
  351. const execute = vi.fn(async (subject: Gate) => resultFor(subject, subject === root ? 'failed' : 'passed'))
  352. const results = await runGates([follower, dependent, root], 2, execute)
  353. expect(execute.mock.calls.map(([subject]) => subject.id)).toEqual(['root', 'follower'])
  354. expect(results.map(result => result.status)).toEqual(['passed', 'skipped', 'failed'])
  355. })
  356. })
  357. describe('Oxlint gate', () => {
  358. it('uses the package script when no worker bound is configured', () => {
  359. const subject = withEnv('DSH_OXLINT_THREADS', undefined, () =>
  360. withPnpmEntrypoint(() => gatesForMode('ci-lint-contracts-ready')[0]))
  361. expect(subject).toMatchObject({
  362. id: 'lint',
  363. displayCommand: 'pnpm run lint:contracts-ready',
  364. command: process.execPath,
  365. args: ['/private/pnpm.cjs', 'run', 'lint:contracts-ready'],
  366. })
  367. })
  368. it('surfaces the configured worker bound on the shared package script', () => {
  369. const subject = withEnv('DSH_OXLINT_THREADS', '4', () =>
  370. withPnpmEntrypoint(() => gatesForMode('ci-lint-contracts-ready')[0]))
  371. expect(subject).toMatchObject({
  372. id: 'lint',
  373. displayCommand: 'DSH_OXLINT_THREADS=4 pnpm run lint:contracts-ready',
  374. command: process.execPath,
  375. args: ['/private/pnpm.cjs', 'run', 'lint:contracts-ready'],
  376. })
  377. })
  378. })
  379. describe('Typert contract preparation', () => {
  380. it('prepares primary source consumers once before they run', () => {
  381. const subject = withEnv('DSH_OXLINT_THREADS', undefined, () =>
  382. withPnpmEntrypoint(() => gatesForMode('ci-primary')))
  383. expect(subject.find(item => item.id === 'typert-contracts')).toMatchObject({
  384. displayCommand: 'pnpm run build:lib:host',
  385. args: ['/private/pnpm.cjs', 'run', 'build:lib:host'],
  386. })
  387. for (const [id, script] of [
  388. ['typecheck', 'typecheck:contracts-ready'],
  389. ['lint', 'lint:contracts-ready'],
  390. ['doc-typecheck', 'doc-typecheck:contracts-ready'],
  391. ] as const) {
  392. expect(subject.find(item => item.id === id)).toMatchObject({
  393. displayCommand: `pnpm run ${script}`,
  394. args: ['/private/pnpm.cjs', 'run', script],
  395. needs: ['typert-contracts'],
  396. })
  397. }
  398. expect(subject.find(item => item.id === 'build')?.needs).toEqual([
  399. 'typecheck',
  400. 'lint',
  401. 'doc-typecheck',
  402. ])
  403. })
  404. it('reuses contracts from the validated consumer build', () => {
  405. const subject = withPnpmEntrypoint(() => gatesForMode('ci-consumers'))
  406. expect(subject.find(item => item.id === 'lint-and-duplication')).toMatchObject({
  407. displayCommand: 'pnpm run check:ci:lint:contracts-ready',
  408. args: ['/private/pnpm.cjs', 'run', 'check:ci:lint:contracts-ready'],
  409. })
  410. expect(subject.find(item => item.id === 'doc-typecheck')).toMatchObject({
  411. displayCommand: 'pnpm run doc-typecheck:contracts-ready',
  412. args: ['/private/pnpm.cjs', 'run', 'doc-typecheck:contracts-ready'],
  413. })
  414. })
  415. it('keeps standalone doc sync responsible for preparation', () => {
  416. const docTypecheck = withPnpmEntrypoint(() =>
  417. gatesForMode('doc-sync').find(item => item.id === 'doc-typecheck'))
  418. expect(docTypecheck?.displayCommand).toBe('pnpm run doc-typecheck')
  419. })
  420. })
  421. describe('Node compatibility graph', () => {
  422. it('runs the jsdom environment smoke on every advertised Node line', () => {
  423. const subject = withPnpmEntrypoint(() => gatesForMode('node-compat'))
  424. expect(subject.find(item => item.id === 'vitest-jsdom-smoke')).toMatchObject({
  425. label: 'Vitest jsdom smoke',
  426. args: [
  427. '/private/pnpm.cjs',
  428. 'exec',
  429. 'vitest',
  430. 'run',
  431. 'scripts/vitest-environment.compat.spec.ts',
  432. ],
  433. })
  434. })
  435. })
  436. describe('Node 24 lane ownership', () => {
  437. it('keeps the static lane source-only', () => {
  438. const subject = withPnpmEntrypoint(() => gatesForMode('ci-static'))
  439. expect(subject.map(item => item.id)).not.toContain('build')
  440. expect(subject.map(item => item.id)).not.toContain('doc-typecheck')
  441. })
  442. it('owns the build and orders its artifact consumers', () => {
  443. const subject = withPnpmEntrypoint(() => gatesForMode('ci-consumers'))
  444. expect(defaultConcurrency('ci-consumers', subject.length, 4)).toEqual({
  445. workers: 11,
  446. source: 'ci-consumers gate count',
  447. })
  448. expect(subject.map(item => item.id)).toEqual([
  449. 'build',
  450. 'node-compat',
  451. 'publint',
  452. 'built-package-invariants',
  453. 'lint-and-duplication',
  454. 'snapshot',
  455. 'expected-output',
  456. 'web-snapshot',
  457. 'doc-typecheck',
  458. 'node-next-types',
  459. 'built-bin-smoke',
  460. ])
  461. expect(subject.find(item => item.id === 'publint')?.needs).toEqual(['build'])
  462. expect(subject.find(item => item.id === 'build')?.env).toEqual({
  463. DSH_BUILD_CLIENT_PROFILE: 'official',
  464. })
  465. expect(subject.find(item => item.id === 'node-compat')?.env).toEqual({
  466. DSH_BUILD_CLIENT_PROFILE: 'official',
  467. })
  468. expect(subject.find(item => item.id === 'built-package-invariants')?.needs).toEqual(['build'])
  469. expect(subject.find(item => item.id === 'lint-and-duplication')?.needs).toEqual(['built-package-invariants'])
  470. for (const id of [
  471. 'snapshot',
  472. 'expected-output',
  473. 'web-snapshot',
  474. 'doc-typecheck',
  475. 'node-next-types',
  476. 'built-bin-smoke',
  477. ]) {
  478. expect(subject.find(item => item.id === id)?.needs).toEqual(['built-package-invariants'])
  479. }
  480. expect(subject.find(item => item.id === 'snapshot')?.env).toEqual({ DSH_EXAMPLE_MODE: 'lib' })
  481. expect(subject.find(item => item.id === 'expected-output')?.env).toEqual({ DSH_EXAMPLE_MODE: 'lib' })
  482. expect(subject.find(item => item.id === 'doc-typecheck')?.env).toEqual({
  483. DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1',
  484. })
  485. expect(subject.find(item => item.id === 'built-bin-smoke')?.args).toEqual(
  486. expect.arrayContaining([
  487. 'packages/subprocess/subprocess-local/tests/spawn-runner-built.e2e.ts',
  488. 'packages/subagent/subagent-codex/tests/loader-composition.e2e.ts',
  489. 'packages/subagent/subagent-claude-code/tests/loader-composition.e2e.ts',
  490. 'packages/experimental/agent-team/tests/built-lib.e2e.ts',
  491. ]),
  492. )
  493. expect(subject.find(item => item.id === 'web-snapshot')).toMatchObject({
  494. displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
  495. env: { DSH_SNAPSHOT: 'replay' },
  496. after: [
  497. 'publint',
  498. 'lint-and-duplication',
  499. 'snapshot',
  500. 'expected-output',
  501. 'doc-typecheck',
  502. 'node-next-types',
  503. 'built-bin-smoke',
  504. ],
  505. })
  506. })
  507. })
  508. describe('Linux primary graph', () => {
  509. it('adds the same compare-only web gate after built client artifacts', () => {
  510. const subject = withPnpmEntrypoint(() => gatesForMode('ci-linux-primary'))
  511. const web = subject.find(item => item.id === 'web-snapshot')
  512. expect(web).toMatchObject({
  513. displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
  514. env: { DSH_SNAPSHOT: 'replay' },
  515. needs: ['built-package-invariants'],
  516. })
  517. })
  518. })
  519. describe('gate process outcomes', () => {
  520. it('streams selected gate output without retaining it', async () => {
  521. const write = vi.spyOn(process.stdout, 'write').mockReturnValue(true)
  522. try {
  523. const result = await runGate(gate('streamed', {
  524. args: ['-e', "process.stdout.write('live output')"],
  525. streamOutput: true,
  526. }))
  527. expect(result.status).toBe('passed')
  528. expect(result.output).toEqual([])
  529. expect(write).toHaveBeenCalledWith('live output')
  530. } finally {
  531. write.mockRestore()
  532. }
  533. })
  534. it.skipIf(process.platform === 'win32')('reports signal termination independently from exit status', async () => {
  535. const result = await runGate(gate('terminated', {
  536. args: ['-e', "process.kill(process.pid, 'SIGTERM')"],
  537. }))
  538. expect(result.status).toBe('failed')
  539. expect(result.exitCode).toBeNull()
  540. expect(result.signalCode).toBe('SIGTERM')
  541. expect(formatGateResultReason(result)).toBe('signal SIGTERM')
  542. })
  543. })
  544. describe('fail-fast scheduling', () => {
  545. it('aborts the aggregate at the first blocking failure', async () => {
  546. const slow = gate('slow')
  547. const fast = gate('fast')
  548. const dependent = gate('dependent', { needs: ['slow'] })
  549. const execute = vi.fn(async (subject: Gate, signal?: AbortSignal) => {
  550. if (subject.id === 'fast') {
  551. return new Promise<GateResult>((resolve) => {
  552. signal?.addEventListener('abort', () => {
  553. // The real runGate marks a gate the abort terminated; the drain
  554. // must then record it skipped rather than keep the failure.
  555. resolve({ ...resultFor(subject, 'failed'), aborted: true })
  556. }, { once: true })
  557. })
  558. }
  559. return resultFor(subject, subject.id === 'slow' ? 'failed' : 'passed')
  560. })
  561. const results = await runGates([slow, fast, dependent], 2, execute, () => {}, { failFast: true })
  562. expect(execute.mock.calls.map(([subject]) => subject.id)).toEqual(['slow', 'fast'])
  563. expect(results.map(result => result.status)).toEqual(['failed', 'skipped', 'skipped'])
  564. expect(results[1]).toMatchObject({
  565. status: 'skipped',
  566. error: 'aborted by fail-fast: slow failed',
  567. })
  568. expect(results[2]).toMatchObject({
  569. status: 'skipped',
  570. error: 'aborted by fail-fast: slow failed',
  571. })
  572. })
  573. it('does not abort on a non-blocking gate failure', async () => {
  574. const observational = gate('observational', { allowFailure: true })
  575. const root = gate('root')
  576. const execute = vi.fn(async (subject: Gate) => (
  577. resultFor(subject, subject.id === 'observational' ? 'failed' : 'passed')
  578. ))
  579. const results = await runGates([observational, root], 2, execute, () => {}, { failFast: true })
  580. expect(execute).toHaveBeenCalledTimes(2)
  581. expect(results.map(result => result.status)).toEqual(['failed', 'passed'])
  582. })
  583. it('runs independent gates to completion when fail-fast is disabled', async () => {
  584. const root = gate('root')
  585. const sibling = gate('sibling')
  586. const execute = vi.fn(async (subject: Gate) => (
  587. resultFor(subject, subject.id === 'root' ? 'failed' : 'passed')
  588. ))
  589. const results = await runGates([root, sibling], 2, execute, () => {}, { failFast: false })
  590. expect(execute).toHaveBeenCalledTimes(2)
  591. expect(results.map(result => result.status)).toEqual(['failed', 'passed'])
  592. })
  593. it('kills the child when the abort signal fires', async () => {
  594. const controller = new AbortController()
  595. const promise = runGate(gate('killable', { args: ['-e', 'setInterval(() => {}, 1000)'] }), controller.signal)
  596. controller.abort()
  597. const result = await promise
  598. expect(result.status).toBe('failed')
  599. expect(result.aborted).toBe(true)
  600. if (process.platform !== 'win32') expect(result.signalCode).toBe('SIGTERM')
  601. })
  602. it.skipIf(process.platform === 'win32')('marks a zero-exit child as aborted when the signal fired', async () => {
  603. const { writes, write } = captureStreamedOutput()
  604. try {
  605. const controller = new AbortController()
  606. const child = gate('traps-signal', {
  607. args: ['-e', "process.stdout.write('ready\\n'); process.on('SIGTERM', () => process.exit(0)); setInterval(() => {}, 1000)"],
  608. streamOutput: true,
  609. })
  610. const promise = runGate(child, controller.signal)
  611. // Wait for the child to register its SIGTERM trap before aborting, so
  612. // the signal is caught and the child really exits zero.
  613. const deadline = Date.now() + 5000
  614. while (!writes.join('').includes('ready') && Date.now() < deadline) {
  615. await new Promise(resolve => setTimeout(resolve, 10))
  616. }
  617. controller.abort()
  618. const result = await promise
  619. // The child trapped the signal and exited zero; the drain must not
  620. // report this gate passed, so the raw outcome carries the abort mark.
  621. expect(result.status).toBe('passed')
  622. expect(result.aborted).toBe(true)
  623. } finally {
  624. write.mockRestore()
  625. }
  626. })
  627. it.skipIf(process.platform === 'win32')('kills the whole gate process tree when the abort signal fires', async () => {
  628. const { writes, write } = captureStreamedOutput()
  629. const controller = new AbortController()
  630. let promise: Promise<GateResult> | undefined
  631. try {
  632. const script = [
  633. "const { spawn } = require('node:child_process')",
  634. // Detached, so the grandchild leads its own process group: the gate
  635. // group signal cannot reach it, and only the descendant enumeration in
  636. // treeKill does — the shape of a nested run-gates' leaf gates.
  637. "const grandchild = spawn(process.execPath, ['-e', 'setInterval(() => {}, 1000)'], { detached: true })",
  638. "process.stdout.write('grandchild:' + grandchild.pid + '\\n')",
  639. 'setInterval(() => {}, 1000)',
  640. ].join(';')
  641. promise = runGate(gate('tree', { args: ['-e', script], streamOutput: true }), controller.signal)
  642. const deadline = Date.now() + 5000
  643. let pid: number | undefined
  644. while (pid === undefined && Date.now() < deadline) {
  645. const match = writes.join('').match(/grandchild:(\d+)/)
  646. if (match !== null) pid = Number(match[1])
  647. else await new Promise(resolve => setTimeout(resolve, 20))
  648. }
  649. expect(pid ?? 0).toBeGreaterThan(0)
  650. controller.abort()
  651. const result = await promise
  652. expect(result.status).toBe('failed')
  653. // The descendant enumeration signals the detached grandchild at the same
  654. // time as the group signal reaches the direct child; the direct child's
  655. // own death closes the gate pipes, so poll for the grandchild to stop
  656. // executing rather than asserting on a fixed instant.
  657. const stopDeadline = Date.now() + 5000
  658. while (!procStopped(pid!) && Date.now() < stopDeadline) {
  659. await new Promise(resolve => setTimeout(resolve, 20))
  660. }
  661. expect(procStopped(pid!)).toBe(true)
  662. } finally {
  663. // A failed wait or assertion must not leave the forever-looping detached
  664. // grandchild behind on the host: abort the gate and wait for the
  665. // process tree to settle before restoring the spy.
  666. controller.abort()
  667. await promise
  668. write.mockRestore()
  669. }
  670. })
  671. it('forwards host interruption signals to the abort path', async () => {
  672. const slow = gate('slow')
  673. const sibling = gate('sibling')
  674. const execute = vi.fn(async (subject: Gate, signal?: AbortSignal) => {
  675. if (subject.id === 'slow') {
  676. return new Promise<GateResult>((resolve) => {
  677. signal?.addEventListener('abort', () => {
  678. // A child can trap the signal and exit zero; the drain must still
  679. // record the gate skipped so the interrupted run fails.
  680. resolve({ ...resultFor(subject, 'passed'), aborted: true })
  681. }, { once: true })
  682. })
  683. }
  684. return resultFor(subject)
  685. })
  686. const promise = runGates([slow, sibling], 1, execute, () => {}, { failFast: true, forwardProcessSignals: true })
  687. // The first loop iteration starts `slow` synchronously, so its abort
  688. // listener is registered before the signal is emitted.
  689. process.emit('SIGTERM')
  690. const results = await promise
  691. expect(execute).toHaveBeenCalledOnce()
  692. expect(results.map(result => result.status)).toEqual(['skipped', 'skipped'])
  693. expect(results[0]).toMatchObject({
  694. status: 'skipped',
  695. error: 'aborted by fail-fast: host interruption',
  696. })
  697. })
  698. it('pairs host signal forwarding with fail-fast at the CLI entrypoint', () => {
  699. expect(cliGateOptions(true)).toEqual({ failFast: true, forwardProcessSignals: true })
  700. expect(cliGateOptions(false)).toEqual({ failFast: false, forwardProcessSignals: false })
  701. })
  702. it('rejects host signal forwarding without fail-fast', async () => {
  703. const execute = vi.fn(async (subject: Gate) => resultFor(subject))
  704. await expect(runGates([gate('subject')], 1, execute, () => {}, { forwardProcessSignals: true }))
  705. .rejects.toThrow('forwardProcessSignals requires failFast')
  706. expect(execute).not.toHaveBeenCalled()
  707. })
  708. it('leaves an un-aborted child running to completion', async () => {
  709. const result = await runGate(gate('settles', { args: ['-e', ''] }), new AbortController().signal)
  710. expect(result.status).toBe('passed')
  711. expect(result.aborted).toBe(false)
  712. })
  713. it.skipIf(process.platform === 'win32')('kills a detached descendant that outlived the child when the abort arrives later', async () => {
  714. const writes: string[] = []
  715. const write = vi.spyOn(process.stdout, 'write').mockImplementation((chunk) => {
  716. writes.push(String(chunk))
  717. return true
  718. })
  719. const controller = new AbortController()
  720. let promise: Promise<GateResult> | undefined
  721. try {
  722. const script = [
  723. "const { spawn } = require('node:child_process')",
  724. // Detached with inherited stdio: the grandchild leads its own process
  725. // group (the gate group signal misses it) and holds the gate's
  726. // stdout write end (so `close` stays pending past the child exit).
  727. "const grandchild = spawn(process.execPath, ['-e', 'setInterval(() => {}, 1000)'], { detached: true, stdio: 'inherit' })",
  728. "process.stdout.write('grandchild:' + grandchild.pid + '\\n')",
  729. // Outlive the first descendant-sampler tick with margin so the cache
  730. // holds the grandchild even on a loaded runner, then exit normally
  731. // before the abort arrives.
  732. "setTimeout(() => { process.stdout.write('child-exit\\n'); process.exit(0) }, 8000)",
  733. ].join(';')
  734. promise = runGate(gate('late-abort', { args: ['-e', script], streamOutput: true }), controller.signal)
  735. const pid = await waitForGrandchildPid(writes, 'child-exit', Date.now() + 10000)
  736. // terminate must not re-enumerate over the sampler cache now that the
  737. // child is gone; the detached grandchild is killed from the cached list.
  738. await abortAndExpectTreeStopped(promise, controller, pid)
  739. } finally {
  740. // A failed wait or assertion must not leave the forever-looping detached
  741. // grandchild behind on the host: abort the gate and wait for the
  742. // process tree to settle before restoring the spy.
  743. controller.abort()
  744. await promise
  745. write.mockRestore()
  746. }
  747. }, 20000)
  748. it.skipIf(process.platform === 'win32')('keeps a reparented detached descendant tracked across a sampler tick', async () => {
  749. const { writes, write } = captureStreamedOutput()
  750. const controller = new AbortController()
  751. let promise: Promise<GateResult> | undefined
  752. try {
  753. const script = [
  754. "const { spawn } = require('node:child_process')",
  755. // Wrapper spawns a detached grandchild with inherited stdio (its own
  756. // process group, holding the gate's stdout write end), prints the pid,
  757. // then exits after 7 seconds — after the first sampler tick, before
  758. // the second. From then on the grandchild is reparented and
  759. // unreachable by parent id.
  760. "const wrapper = spawn(process.execPath, ['-e', \"const { spawn } = require('node:child_process'); const grandchild = spawn(process.execPath, ['-e', 'setInterval(() => {}, 1000)'], { detached: true, stdio: 'inherit' }); process.stdout.write('grandchild:' + grandchild.pid + '\\\\n'); setTimeout(() => process.exit(0), 7000)\"], { stdio: 'inherit' })",
  761. "wrapper.on('exit', () => process.stdout.write('wrapper-exited\\n'))",
  762. // Keep the root child alive past the abort with a heartbeat so the
  763. // test can abort while it is still running.
  764. "setInterval(() => process.stdout.write('hb\\n'), 1000)",
  765. ].join(';')
  766. promise = runGate(gate('sampler-merge', { args: ['-e', script], streamOutput: true }), controller.signal)
  767. const pid = await waitForGrandchildPid(writes, 'wrapper-exited', Date.now() + 15000)
  768. // Wait past the second sampler tick (t=10) with margin: a replacing tick
  769. // would drop the reparented grandchild from the cache, after which the
  770. // abort cannot reach it. The root child keeps running throughout.
  771. const tickDeadline = Date.now() + 10000
  772. const wrapperExitedAt = Date.now()
  773. while (Date.now() - wrapperExitedAt < 5000 && Date.now() < tickDeadline) {
  774. await new Promise(resolve => setTimeout(resolve, 50))
  775. }
  776. expect(Date.now() - wrapperExitedAt).toBeGreaterThanOrEqual(5000)
  777. await abortAndExpectTreeStopped(promise, controller, pid)
  778. } finally {
  779. // A failed wait or assertion must not leave the forever-looping detached
  780. // grandchild behind on the host: abort the gate and wait for the
  781. // process tree to settle before restoring the spy.
  782. controller.abort()
  783. await promise
  784. write.mockRestore()
  785. }
  786. }, 30000)
  787. })
  788. describe('process-table parsing', () => {
  789. it('parses `pid ppid` rows from a POSIX ps dump', () => {
  790. expect(parsePidPpidLines(' 123 1\n456 123\n 789 456\n')).toEqual([[123, 1], [456, 123], [789, 456]])
  791. })
  792. it('parses Windows PowerShell Get-CimInstance output of the same shape', () => {
  793. expect(parsePidPpidLines(' 123 1\r\n456 123\r\n')).toEqual([[123, 1], [456, 123]])
  794. })
  795. it('drops blank and malformed lines', () => {
  796. expect(parsePidPpidLines(' 123 1\n\ncommand not found\n999 abc\n')).toEqual([[123, 1]])
  797. })
  798. })
  799. describe('Windows tree termination', () => {
  800. it('targets the root first and each captured descendant after it', () => {
  801. expect(taskkillArgs(100, [201, 302, 403])).toEqual([
  802. ['/PID', '100', '/T', '/F'],
  803. ['/PID', '201', '/T', '/F'],
  804. ['/PID', '302', '/T', '/F'],
  805. ['/PID', '403', '/T', '/F'],
  806. ])
  807. })
  808. it('terminates the root alone when no descendant was captured', () => {
  809. expect(taskkillArgs(100, [])).toEqual([['/PID', '100', '/T', '/F']])
  810. })
  811. })