run-gates.spec.ts 39 KB

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