run-gates.spec.ts 36 KB

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