workflow-workerthread.spec.ts 63 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344
  1. import { describe, expect, it, vi } from 'vitest'
  2. import { fileURLToPath } from 'node:url'
  3. import type { Worker } from 'node:worker_threads'
  4. import { Context } from 'cordis'
  5. import Loader from '@cordisjs/plugin-loader'
  6. import { AgentId } from '@deepseek-ai/dsh-agent'
  7. import type { Agent } from '@deepseek-ai/dsh-agent'
  8. import SubagentService from '@deepseek-ai/dsh-subagent'
  9. import type { SubagentCapabilities, SubagentProvider, SubagentResult, SubagentRun, SubagentStartRequest } from '@deepseek-ai/dsh-subagent'
  10. import type { WorkflowMeta, WorkflowResult, WorkflowResultInfo, WorkflowRunInfo } from '@deepseek-ai/dsh-workflow'
  11. import * as workerEngineModule from '../src/index.ts'
  12. import WorkerWorkflowEngine, { type Config } from '../src/index.ts'
  13. import { HostToWorkerType, WorkerToHostType } from '../src/protocol.ts'
  14. /** A minimal parent stand-in: the engine only threads it through to the provider. */
  15. function fakeParent(): Agent {
  16. return { id: AgentId('workflow-parent'), options: {} } as unknown as Agent
  17. }
  18. // Allow cold worker startup on contended CI runners.
  19. vi.setConfig({ testTimeout: 30_000 })
  20. /**
  21. * Wait up to 10 seconds for CPU-bound worker startup or cross-thread delivery on contended CI.
  22. * Host reactions after an observed event use explicit tight overrides, so this generous startup
  23. * allowance cannot hide multi-second reap regressions.
  24. */
  25. function waitFor(assertion: () => void, timeout = 10_000): Promise<void> {
  26. return vi.waitFor(assertion, { timeout, interval: 50 })
  27. }
  28. /** The vm-context escape hatch, spelled once: real Worker tests use it to make the WORKER misbehave. */
  29. const ESCAPE = "globalThis.constructor.constructor('return process')()"
  30. /** One controllable child run: the test (or auto mode) settles it. */
  31. interface ControlledRun {
  32. request: SubagentStartRequest
  33. /** Fulfill the provider's async start with a ready child. */
  34. publish(): void
  35. /** Reject the provider's async start before ownership transfer. */
  36. rejectStart(error: unknown): void
  37. settle(result: SubagentResult): void
  38. rejectResult(error: unknown): void
  39. cancelled: string | undefined
  40. disposed: boolean
  41. disposeCalls: number
  42. }
  43. /**
  44. * A scripted in-test provider over the REAL SubagentService registry: `auto`
  45. * settles each run via the reply function on a microtask; `manual` piles runs
  46. * up in `runs` for the test to settle. A run aborts (settles `aborted`) when
  47. * the request signal fires, like the real in-process backends.
  48. */
  49. class StubProvider implements SubagentProvider {
  50. readonly capabilities: SubagentCapabilities = { outputSchema: true, depthLimit: true, toolFilter: true, persona: false }
  51. readonly inheritsParentContext = false
  52. readonly runs: ControlledRun[] = []
  53. constructor(
  54. readonly name: string,
  55. private readonly reply?: (request: SubagentStartRequest, index: number) => SubagentResult,
  56. private readonly disposeDelayMs = 0,
  57. private readonly deferStart = false,
  58. private readonly onAbortString?: (reason: string | undefined, index: number) => void,
  59. private readonly onSignalAbort?: (reason: unknown, index: number) => void,
  60. ) {}
  61. async start(request: SubagentStartRequest): Promise<SubagentRun> {
  62. const startGate = Promise.withResolvers<undefined>()
  63. const terminal = Promise.withResolvers<SubagentResult>()
  64. terminal.promise.catch(() => { /* provider owns early settlement until publication */ })
  65. let published = false
  66. const controlled: ControlledRun = {
  67. request,
  68. publish: () => { published = true; startGate.resolve(undefined) },
  69. rejectStart: (error) => { startGate.reject(error) },
  70. settle: (result) => { terminal.resolve(result) },
  71. rejectResult: (error) => { terminal.reject(error) },
  72. cancelled: undefined,
  73. disposed: false,
  74. disposeCalls: 0,
  75. }
  76. this.runs.push(controlled)
  77. const index = this.runs.length - 1
  78. request.signal.addEventListener('abort', () => {
  79. controlled.cancelled = String(request.signal.reason ?? 'cancelled')
  80. this.onAbortString?.(String(request.signal.reason ?? 'cancelled'), index)
  81. this.onSignalAbort?.(request.signal.reason, index)
  82. if (published) terminal.resolve({ output: [], stopReason: 'aborted' })
  83. else startGate.reject(new Error('child start aborted before publication'))
  84. }, { once: true })
  85. if (!this.deferStart) controlled.publish()
  86. if (this.reply) {
  87. const reply = this.reply
  88. queueMicrotask(() => { terminal.resolve(reply(request, index)) })
  89. }
  90. try {
  91. await startGate.promise
  92. } catch (error: unknown) {
  93. controlled.disposeCalls += 1
  94. controlled.disposed = true
  95. throw error
  96. }
  97. if (request.signal.aborted) throw new Error('child start aborted before publication')
  98. return {
  99. id: AgentId(`stub-child-${index}`),
  100. result: terminal.promise,
  101. dispose: () => {
  102. controlled.disposeCalls += 1
  103. if (this.disposeDelayMs === 0) {
  104. controlled.disposed = true
  105. return Promise.resolve()
  106. }
  107. return new Promise<void>((resolve) => {
  108. setTimeout(() => {
  109. controlled.disposed = true
  110. resolve()
  111. }, this.disposeDelayMs)
  112. })
  113. },
  114. }
  115. }
  116. }
  117. /** Text-reply helper for auto providers. */
  118. function text(reply: string): SubagentResult {
  119. return { output: [{ type: 'text', text: reply }], stopReason: 'completed' }
  120. }
  121. interface SetupOptions {
  122. config?: Config
  123. reply?: (request: SubagentStartRequest, index: number) => SubagentResult
  124. manual?: boolean
  125. disposeDelayMs?: number
  126. deferStart?: boolean
  127. onChildAbortString?: (reason: string | undefined, index: number) => void
  128. onChildSignalAbort?: (reason: unknown, index: number) => void
  129. }
  130. async function setup(options?: SetupOptions) {
  131. const ctx = new Context()
  132. await ctx.plugin(SubagentService)
  133. const provider = new StubProvider(
  134. 'stub',
  135. options?.manual ? undefined : options?.reply ?? (() => text('stub reply')),
  136. options?.disposeDelayMs ?? 0,
  137. options?.deferStart ?? false,
  138. options?.onChildAbortString,
  139. options?.onChildSignalAbort,
  140. )
  141. ctx.subagents.registerProvider(provider)
  142. // A fixed concurrency ceiling: the auto-resolved default is machine-derived
  143. // (cores - 2, floored at 1), so tests that expect N children in flight
  144. // would wedge on small CI runners.
  145. const engineFiber = await ctx.plugin(WorkerWorkflowEngine, { provider: 'stub', maxConcurrentAgents: 8, ...options?.config })
  146. return { ctx, provider, parent: fakeParent(), engineFiber }
  147. }
  148. /** The standard test meta plus a body, spread into a start request. */
  149. function scripted(body: string, metaExtra?: Partial<WorkflowMeta>): { script: string; meta: WorkflowMeta } {
  150. return { script: body, meta: { name: 'test-flow', description: 'a test workflow', ...metaExtra } }
  151. }
  152. /** Start + await one run, disposing on the way out. */
  153. async function run(ctx: Context, parent: Agent, source: { script: string; meta: WorkflowMeta }, args?: unknown): Promise<WorkflowResult> {
  154. const handle = ctx.workflows.start({ ...source, parent, ...args !== undefined ? { args } : {} })
  155. try {
  156. return await handle.result
  157. } finally {
  158. await handle.dispose()
  159. }
  160. }
  161. describe('dsh-workflow-workerthread', () => {
  162. describe('script execution over a real worker thread', () => {
  163. it('runs a script end-to-end: agent() text results, phases, log, args, return value, events', async () => {
  164. const { ctx, parent, provider } = await setup({ reply: (_request, index) => text(`answer-${index}`) })
  165. const events: [string, unknown[]][] = []
  166. for (const name of ['workflow/start', 'workflow/phase', 'workflow/log', 'workflow/agent-start', 'workflow/agent-end', 'workflow/end'] as const) {
  167. ctx.on(name, (...payload: unknown[]) => { events.push([name, payload]) })
  168. }
  169. const result = await run(ctx, parent, scripted(`
  170. phase('Scan')
  171. log('starting with ' + args.files.length + ' files')
  172. const answers = await pipeline(args.files, (prev, item) => agent('read ' + item))
  173. phase('Report')
  174. return { answers, count: args.files.length }
  175. `, { phases: [{ title: 'Scan' }, { title: 'Report' }] }), { files: ['a.ts', 'b.ts'] })
  176. expect(result.stopReason).toBe('completed')
  177. expect(result.agentsStarted).toBe(2)
  178. expect(result.value).toEqual({ answers: ['answer-0', 'answer-1'], count: 2 })
  179. expect(provider.runs.every(r => r.disposed)).toBe(true)
  180. const names = events.map(([name]) => name)
  181. expect(names[0]).toBe('workflow/start')
  182. expect(names).toContain('workflow/phase')
  183. expect(names).toContain('workflow/log')
  184. expect(names.at(-1)).toBe('workflow/end')
  185. const info = events[0]![1][0] as WorkflowRunInfo
  186. expect(info.meta.name).toBe('test-flow')
  187. const end = events.at(-1)![1][1] as Record<string, unknown>
  188. expect(end).toEqual({ stopReason: 'completed', agentsStarted: 2 })
  189. expect('value' in end).toBe(false)
  190. })
  191. it('agent({schema, model}) forwards outputSchema and agentOptions to the provider across the thread', async () => {
  192. const { ctx, parent, provider } = await setup({
  193. reply: () => ({ output: [], structured: { files: ['x.ts', 'y.ts'] }, stopReason: 'completed' }),
  194. })
  195. const result = await run(ctx, parent, scripted(`
  196. const found = await agent('list files', { model: 'deepseek-v4-pro', schema: { type: 'object', properties: { files: { type: 'array', items: { type: 'string' } } }, required: ['files'] } })
  197. return { first: found.files[0], count: found.files.length }
  198. `))
  199. expect(result.value).toEqual({ first: 'x.ts', count: 2 })
  200. expect(provider.runs[0]!.request.outputSchema).toEqual({
  201. type: 'object',
  202. properties: { files: { type: 'array', items: { type: 'string' } } },
  203. required: ['files'],
  204. })
  205. expect(provider.runs[0]!.request.agentOptions).toEqual({ model: 'deepseek-v4-pro' })
  206. expect(provider.runs[0]!.request.parent).toBeDefined()
  207. })
  208. it('agent({provider}) forwards provider-only agentOptions across the thread', async () => {
  209. const { ctx, parent, provider } = await setup()
  210. const result = await run(ctx, parent, scripted("return await agent('route me', { provider: 'openai' })"))
  211. expect(result.value).toBe('stub reply')
  212. expect(provider.runs[0]!.request.agentOptions).toEqual({ provider: 'openai' })
  213. })
  214. it('a fatal hook error inside the worker kills the script and reports the error', async () => {
  215. const { ctx, parent } = await setup()
  216. const result = await run(ctx, parent, scripted("return await parallel([() => agent('x', { isolation: 'worktree' })])"))
  217. expect(result.stopReason).toBe('error')
  218. expect(result.error).toContain('"isolation" is deferred')
  219. })
  220. it('a provider start failure crosses back as a fatal AGENT_START error', async () => {
  221. const { ctx, parent } = await setup({ config: { provider: 'nonexistent' } })
  222. const result = await run(ctx, parent, scripted("return await pipeline([1], () => agent('p'))"))
  223. expect(result.stopReason).toBe('error')
  224. expect(result.error).toContain('agent() could not start a child')
  225. })
  226. it('waits for async provider start before announcing a result that settled early', async () => {
  227. const { ctx, parent, provider } = await setup({ manual: true, deferStart: true })
  228. const order: string[] = []
  229. ctx.on('workflow/agent-start', (_info, agent) => { order.push(`start:${agent.seq}`) })
  230. ctx.on('workflow/agent-end', (_info, agent) => { order.push(`end:${agent.outcome}`) })
  231. ctx.on('workflow/end', () => { order.push('run-end') })
  232. const handle = ctx.workflows.start({ ...scripted("return await agent('p')"), parent })
  233. await waitFor(() => { expect(provider.runs.length).toBe(1) })
  234. const early = text('accepted value')
  235. provider.runs[0]!.settle(early)
  236. // The provider still owns this early result while start is pending.
  237. await new Promise(resolve => setTimeout(resolve, 0))
  238. expect(order).toEqual([])
  239. provider.runs[0]!.publish()
  240. const result = await handle.result
  241. expect(result.value).toBe('accepted value')
  242. expect(order).toEqual(['start:1', 'end:completed', 'run-end'])
  243. await handle.dispose()
  244. expect(provider.runs[0]!.disposeCalls).toBe(1)
  245. })
  246. it('observes an early result rejection but sends ChildStarted before ChildFailed after start fulfills', async () => {
  247. const { ctx, parent, provider } = await setup({ manual: true, deferStart: true })
  248. const lifecycle: string[] = []
  249. ctx.on('workflow/agent-start', () => { lifecycle.push('start') })
  250. ctx.on('workflow/agent-end', (_info, agent) => { lifecycle.push(`end:${agent.outcome}`) })
  251. const handle = ctx.workflows.start({
  252. ...scripted("try { await agent('p'); return 'unreachable' } catch (e) { return { code: e.code, message: e.message } }"),
  253. parent,
  254. })
  255. const worker = (handle as unknown as { worker: { postMessage(message: unknown): void } }).worker
  256. const post = vi.spyOn(worker, 'postMessage')
  257. const childMessageTypes = (): HostToWorkerType[] => post.mock.calls
  258. .map(([message]) => (message as { type: HostToWorkerType }).type)
  259. .filter(type => type === HostToWorkerType.ChildStarted || type === HostToWorkerType.ChildFailed)
  260. await waitFor(() => { expect(provider.runs.length).toBe(1) })
  261. provider.runs[0]!.rejectResult(new Error('backend failed before publication'))
  262. await new Promise(resolve => setTimeout(resolve, 0))
  263. expect(childMessageTypes()).toEqual([])
  264. expect(lifecycle).toEqual([])
  265. provider.runs[0]!.publish()
  266. const result = await handle.result
  267. expect(result.value).toMatchObject({ code: 'AGENT_RESULT' })
  268. expect((result.value as { message: string }).message).toContain('backend failed before publication')
  269. expect(childMessageTypes()).toEqual([HostToWorkerType.ChildStarted, HostToWorkerType.ChildFailed])
  270. expect(lifecycle).toEqual(['start', 'end:failed'])
  271. post.mockRestore()
  272. await handle.dispose()
  273. })
  274. it('classifies provider start rejection as AGENT_START, drops an early result, and emits no false lifecycle pair', async () => {
  275. const { ctx, parent, provider } = await setup({ manual: true, deferStart: true })
  276. const lifecycle: string[] = []
  277. ctx.on('workflow/agent-start', () => { lifecycle.push('start') })
  278. ctx.on('workflow/agent-end', () => { lifecycle.push('end') })
  279. const handle = ctx.workflows.start({
  280. ...scripted("try { await agent('p'); return 'unreachable' } catch (e) { return { code: e.code, message: e.message } }"),
  281. parent,
  282. })
  283. await waitFor(() => { expect(provider.runs.length).toBe(1) })
  284. // ACP-style failure can settle result(error) before its session/publication
  285. // boundary rejects. Start rejection must dominate that buffered child outcome.
  286. provider.runs[0]!.settle({ output: [], stopReason: 'error' })
  287. await new Promise(resolve => setTimeout(resolve, 0))
  288. provider.runs[0]!.rejectStart(new Error('publication rolled back'))
  289. const result = await handle.result
  290. expect(result.value).toMatchObject({ code: 'AGENT_START' })
  291. expect((result.value as { message: string }).message).toContain('publication rolled back')
  292. expect(lifecycle).toEqual([])
  293. await waitFor(() => {
  294. expect(provider.runs[0]!.disposed).toBe(true)
  295. expect(provider.runs[0]!.disposeCalls).toBe(1)
  296. })
  297. await handle.dispose()
  298. expect(provider.runs[0]!.disposeCalls).toBe(1)
  299. })
  300. it('aborts a pending provider start once without publishing workflow lifecycle', async () => {
  301. const { ctx, parent, provider } = await setup({ manual: true, deferStart: true, config: { disposeGraceMs: 500 } })
  302. const lifecycle: string[] = []
  303. ctx.on('workflow/agent-start', () => { lifecycle.push('start') })
  304. ctx.on('workflow/agent-end', () => { lifecycle.push('end') })
  305. const handle = ctx.workflows.start({ ...scripted("return await agent('pending')"), parent })
  306. await waitFor(() => { expect(provider.runs.length).toBe(1) })
  307. const disposal = handle.dispose()
  308. await waitFor(() => {
  309. expect(provider.runs[0]!.cancelled).toBe('workflow disposed')
  310. expect(provider.runs[0]!.disposed).toBe(true)
  311. })
  312. // Ensure the host-driven disposal removed the registry entry before the
  313. // late start rejection; its callback must not invoke dispose again.
  314. await new Promise(resolve => setTimeout(resolve, 0))
  315. provider.runs[0]!.rejectStart(new Error('cancelled before publication'))
  316. const result = await handle.result
  317. await disposal
  318. expect(result.stopReason).toBe('cancelled')
  319. expect(lifecycle).toEqual([])
  320. expect(provider.runs[0]!.disposeCalls).toBe(1)
  321. })
  322. it('a child result REJECTION crosses back as a fatal AGENT_RESULT error (a broken provider is not a failed child)', async () => {
  323. const ctx = new Context()
  324. await ctx.plugin(SubagentService)
  325. const provider: SubagentProvider = {
  326. name: 'rejecting',
  327. capabilities: { outputSchema: true, depthLimit: true, toolFilter: true, persona: false },
  328. inheritsParentContext: false,
  329. start: async () => ({
  330. id: AgentId('reject-child'),
  331. result: Promise.reject(new Error('backend exploded')),
  332. dispose: () => Promise.resolve(),
  333. }),
  334. }
  335. ctx.subagents.registerProvider(provider)
  336. await ctx.plugin(WorkerWorkflowEngine, { provider: 'rejecting', maxConcurrentAgents: 2 })
  337. const result = await run(ctx, fakeParent(), scripted(`
  338. try { await agent('p'); return 'unreachable' } catch (e) { return { name: e.name, code: e.code, fatal: e.fatal, message: e.message } }
  339. `))
  340. expect(result.value).toMatchObject({ name: 'WorkflowError', code: 'AGENT_RESULT', fatal: true })
  341. expect((result.value as { message: string }).message).toContain('backend exploded')
  342. })
  343. it('maps a non-JSON ready-child result to fatal AGENT_RESULT instead of wedging the bridge', async () => {
  344. const { ctx, parent } = await setup({
  345. reply: () => ({ output: [], structured: () => { /* deliberately outside lossless JSON */ }, stopReason: 'completed' }),
  346. })
  347. const result = await run(ctx, parent, scripted(`
  348. try { await agent('p'); return 'unreachable' } catch (e) { return { code: e.code, message: e.message } }
  349. `))
  350. expect(result.value).toMatchObject({ code: 'AGENT_RESULT' })
  351. expect((result.value as { message: string }).message).toContain('workflow child result could not cross the worker boundary')
  352. })
  353. it('contains a non-JSON result even if the injected subagent service violates its normalization contract', async () => {
  354. // The real worker boundary must reject a non-JSON same-process result.
  355. const { ctx, parent } = await setup()
  356. const invalid = {
  357. output: [],
  358. structured: () => { /* deliberately outside lossless JSON */ },
  359. stopReason: 'completed',
  360. } as unknown as SubagentResult
  361. const start = vi.spyOn(ctx.subagents, 'start').mockResolvedValue({
  362. id: AgentId('raw-invalid-child'),
  363. result: Promise.resolve(invalid),
  364. dispose: () => Promise.resolve(),
  365. })
  366. const result = await run(ctx, parent, scripted(`
  367. try { await agent('p'); return 'unreachable' } catch (e) { return { code: e.code, message: e.message } }
  368. `))
  369. expect(start).toHaveBeenCalledOnce()
  370. expect(result.value).toMatchObject({ code: 'AGENT_RESULT' })
  371. expect((result.value as { message: string }).message)
  372. .toContain('workflow child result could not cross the worker boundary')
  373. })
  374. it('a child whose dispose() throws synchronously cannot wedge the script (the host acks anyway)', async () => {
  375. const ctx = new Context()
  376. await ctx.plugin(SubagentService)
  377. const provider: SubagentProvider = {
  378. name: 'bad-dispose',
  379. capabilities: { outputSchema: true, depthLimit: true, toolFilter: true, persona: false },
  380. inheritsParentContext: false,
  381. start: async () => ({
  382. id: AgentId('bad-dispose-child'),
  383. result: Promise.resolve({ output: [{ type: 'text', text: 'fine' }], stopReason: 'completed' }),
  384. cancel: () => { /* settled already */ },
  385. dispose: () => { throw new Error('dispose exploded') },
  386. }),
  387. }
  388. ctx.subagents.registerProvider(provider)
  389. await ctx.plugin(WorkerWorkflowEngine, { provider: 'bad-dispose', maxConcurrentAgents: 2 })
  390. const result = await run(ctx, fakeParent(), scripted("return await agent('p')"))
  391. expect(result.stopReason).toBe('completed')
  392. expect(result.value).toBe('fine')
  393. })
  394. it('a child dispose() rejecting an UNRENDERABLE value still acks — the containment warn is total', async () => {
  395. const ctx = new Context()
  396. await ctx.plugin(SubagentService)
  397. const provider: SubagentProvider = {
  398. name: 'coercion-trap-dispose',
  399. capabilities: { outputSchema: true, depthLimit: true, toolFilter: true, persona: false },
  400. inheritsParentContext: false,
  401. start: async () => ({
  402. id: AgentId('trap-child'),
  403. result: Promise.resolve({ output: [{ type: 'text', text: 'fine' }], stopReason: 'completed' }),
  404. cancel: () => { /* settled already */ },
  405. // The rejection VALUE's own coercion throws: a warn built with bare
  406. // String(error) would itself throw, skipping the ChildDisposed ack
  407. // and wedging the script's finally until the grace/terminate path.
  408. // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors -- the non-Error rejection IS the scenario under test
  409. dispose: () => Promise.reject({ toString: () => { throw new Error('coercion trap') } }),
  410. }),
  411. }
  412. ctx.subagents.registerProvider(provider)
  413. await ctx.plugin(WorkerWorkflowEngine, { provider: 'coercion-trap-dispose', maxConcurrentAgents: 2 })
  414. const result = await run(ctx, fakeParent(), scripted("return await agent('p')"))
  415. expect(result.stopReason).toBe('completed')
  416. expect(result.value).toBe('fine')
  417. })
  418. it('the worker spawns with an EMPTY environment: an escaped script finds no ambient credentials', async () => {
  419. const { ctx, parent } = await setup()
  420. // A canary in the HARNESS process's env: with an inherited environment
  421. // the escape below would read it back (exactly how DEEPSEEK_API_KEY
  422. // would leak); env: {} in the spawn options is what keeps it out.
  423. process.env.WORKFLOW_ENV_CANARY = 'leak me'
  424. try {
  425. const result = await run(ctx, parent, scripted(`
  426. const proc = ${ESCAPE}
  427. return { canary: proc.env.WORKFLOW_ENV_CANARY ?? null, keys: Object.keys(proc.env).length }
  428. `))
  429. expect(result.stopReason).toBe('completed')
  430. expect(result.value).toEqual({ canary: null, keys: 0 })
  431. } finally {
  432. delete process.env.WORKFLOW_ENV_CANARY
  433. }
  434. })
  435. it('the unbuilt worker forwards exactly TSX_TSCONFIG_PATH through the scrub: the paths-map pin survives, secrets do not', async () => {
  436. const { ctx, parent } = await setup()
  437. // The ACP snapshot harness runs the parent with its cwd OUTSIDE the
  438. // repo and pins the repo tsconfig through this variable; the worker
  439. // must inherit the pin (or its dsh-* imports silently resolve to
  440. // unbuilt lib/ bundles) while every other variable stays scrubbed.
  441. const tsconfig = fileURLToPath(new URL('../../../../tsconfig.json', import.meta.url))
  442. process.env.TSX_TSCONFIG_PATH = tsconfig
  443. process.env.WORKFLOW_ENV_CANARY = 'leak me'
  444. try {
  445. const result = await run(ctx, parent, scripted(`
  446. const proc = ${ESCAPE}
  447. return { keys: Object.keys(proc.env), tsconfig: proc.env.TSX_TSCONFIG_PATH }
  448. `))
  449. expect(result.stopReason).toBe('completed')
  450. expect(result.value).toEqual({ keys: ['TSX_TSCONFIG_PATH'], tsconfig })
  451. } finally {
  452. delete process.env.TSX_TSCONFIG_PATH
  453. delete process.env.WORKFLOW_ENV_CANARY
  454. }
  455. })
  456. })
  457. describe('lifecycle: parse errors, cancellation, termination, disposal', () => {
  458. it('start() throws synchronously for invalid meta data or an unparseable body (host-side pre-checks)', async () => {
  459. const { ctx, parent } = await setup()
  460. // Meta is DATA — shape violations reject loud, every one named.
  461. expect(() => ctx.workflows.start({ script: 'return 1', meta: { name: '', description: 'd' }, parent })).toThrow(/meta\.name must be a non-empty string/)
  462. expect(() => ctx.workflows.start({ script: 'return 1', meta: { name: 'x', description: 'd', extra: 1 } as unknown as WorkflowMeta, parent })).toThrow(/META_INVALID|not a recognized field/)
  463. expect(() => ctx.workflows.start({ ...scripted('return ((('), parent })).toThrow(/does not parse/)
  464. // The likeliest authoring slip — a Claude Code-style meta header in the
  465. // body — gets a pointed message, not a bare SyntaxError.
  466. expect(() => ctx.workflows.start({ ...scripted("export const meta = { name: 'x', description: 'd' }\nreturn 1"), parent })).toThrow(/meta rides the `meta` request field/)
  467. })
  468. it('cancel() aborts in-flight children (signal AND cancel RPC) and settles the run cancelled', async () => {
  469. const { ctx, parent, provider } = await setup({ manual: true })
  470. const ends: unknown[] = []
  471. ctx.on('workflow/agent-end', (_info, agent) => { ends.push(agent) })
  472. const runEnds: WorkflowResultInfo[] = []
  473. ctx.on('workflow/end', (_info, result) => { runEnds.push(result) })
  474. const handle = ctx.workflows.start({ ...scripted("return await agent('long job')"), parent })
  475. await waitFor(() => { expect(provider.runs.length).toBe(1) })
  476. handle.cancel('user stopped it')
  477. const result = await handle.result
  478. expect(result.stopReason).toBe('cancelled')
  479. expect(result.error).toContain('user stopped it')
  480. await handle.dispose()
  481. expect(provider.runs[0]!.disposed).toBe(true)
  482. expect(ends).toEqual([expect.objectContaining({ seq: 1, outcome: 'cancelled' })])
  483. // workflow/end is an observer's only death signal: it fires for a
  484. // cancelled run too, mirroring the settled outcome data.
  485. expect(runEnds).toEqual([{ stopReason: 'cancelled', error: result.error, agentsStarted: result.agentsStarted }])
  486. })
  487. it('an already-aborted request signal cancels before the body ever runs (the go handshake holds it)', async () => {
  488. const { ctx, parent, provider } = await setup()
  489. const controller = new AbortController()
  490. controller.abort()
  491. const logs: string[] = []
  492. ctx.on('workflow/log', (_info, message) => { logs.push(message) })
  493. const handle = ctx.workflows.start({ ...scripted("log('ran')\nreturn 123"), parent, signal: controller.signal })
  494. const result = await handle.result
  495. expect(result.stopReason).toBe('cancelled')
  496. expect(result.value).toBeNull()
  497. expect(logs).toEqual([])
  498. expect(provider.runs.length).toBe(0)
  499. await handle.dispose()
  500. })
  501. it('cancel() right after start() cancels before the body runs; the signal aborting mid-run cancels like cancel()', async () => {
  502. const { ctx, parent, provider } = await setup({ manual: true })
  503. const first = ctx.workflows.start({ ...scripted("return await agent('never')"), parent })
  504. // No-reason cancel: the canonical default reason must ride the result.
  505. first.cancel()
  506. const firstResult = await first.result
  507. expect(firstResult.stopReason).toBe('cancelled')
  508. expect(firstResult.error).toContain('workflow cancelled')
  509. expect(provider.runs.length).toBe(0)
  510. await first.dispose()
  511. const controller = new AbortController()
  512. const second = ctx.workflows.start({ ...scripted("return await agent('job')"), parent, signal: controller.signal })
  513. await waitFor(() => { expect(provider.runs.length).toBe(1) })
  514. controller.abort()
  515. expect((await second.result).stopReason).toBe('cancelled')
  516. await second.dispose()
  517. })
  518. it('removes the exact external abort callback on first settlement or teardown', async () => {
  519. const { ctx, parent } = await setup()
  520. const settledController = new AbortController()
  521. const settledAdd = vi.spyOn(settledController.signal, 'addEventListener')
  522. const settledRemove = vi.spyOn(settledController.signal, 'removeEventListener')
  523. const completed = ctx.workflows.start({ ...scripted('return 123'), parent, signal: settledController.signal })
  524. const settledAbort = settledAdd.mock.calls.find(([type]) => type === 'abort')?.[1]
  525. expect(typeof settledAbort).toBe('function')
  526. await expect(completed.result).resolves.toMatchObject({ value: 123, stopReason: 'completed' })
  527. expect(settledRemove).toHaveBeenCalledWith('abort', settledAbort)
  528. const cancelAfterSettle = vi.spyOn(completed, 'cancel')
  529. settledController.abort()
  530. expect(cancelAfterSettle).not.toHaveBeenCalled()
  531. cancelAfterSettle.mockRestore()
  532. await completed.dispose()
  533. const manual = await setup({ manual: true })
  534. const teardownController = new AbortController()
  535. const teardownAdd = vi.spyOn(teardownController.signal, 'addEventListener')
  536. const teardownRemove = vi.spyOn(teardownController.signal, 'removeEventListener')
  537. const tornDown = manual.ctx.workflows.start({
  538. ...scripted("return await agent('job')"),
  539. parent: manual.parent,
  540. signal: teardownController.signal,
  541. })
  542. await waitFor(() => { expect(manual.provider.runs).toHaveLength(1) })
  543. const teardownAbort = teardownAdd.mock.calls.find(([type]) => type === 'abort')?.[1]
  544. expect(typeof teardownAbort).toBe('function')
  545. const disposing = tornDown.dispose()
  546. expect(teardownRemove).toHaveBeenCalledWith('abort', teardownAbort)
  547. await disposing
  548. })
  549. it('a child-start racing the host cancel is refused: no child starts after cancellation', async () => {
  550. const { ctx, parent, provider } = await setup({ manual: true })
  551. // Cancel from INSIDE the log listener: the worker has already posted
  552. // its child-start (queued right behind the log message), so the host
  553. // processes it with cancelReason set — the refusal arm no real-world
  554. // timing can hit reliably. (The closure runs only after `handle` below
  555. // is initialized — the listener fires on the worker's first message.)
  556. ctx.on('workflow/log', () => { handle.cancel('cancelled from the log listener') })
  557. const handle = ctx.workflows.start({ ...scripted("log('mark')\nreturn await agent('late')"), parent })
  558. const result = await handle.result
  559. expect(result.stopReason).toBe('cancelled')
  560. expect(provider.runs.length).toBe(0)
  561. await handle.dispose()
  562. })
  563. it('post-cancel narration is suppressed host-side, and completion racing a cancel reports cancelled', async () => {
  564. const { ctx, parent } = await setup()
  565. const narration: string[] = []
  566. ctx.on('workflow/log', (_info, message) => { narration.push(message) })
  567. ctx.on('workflow/phase', (_info, title) => { narration.push(`phase:${title}`) })
  568. const handle = ctx.workflows.start({
  569. // The sync spin keeps the worker's loop busy so the cancel message
  570. // cannot be processed before the script settles `completed` — the
  571. // worker posts a completed result that must LOSE to the in-flight
  572. // host cancellation. The trailing narration exercises host-side
  573. // suppression: posted pre-cancel-processing worker-side, arriving
  574. // post-cancel host-side.
  575. ...scripted(`
  576. log('started')
  577. const end = Date.now() + 1000
  578. while (Date.now() < end) {}
  579. phase('late phase')
  580. log('late log')
  581. return 'done'
  582. `),
  583. parent,
  584. })
  585. await waitFor(() => { expect(narration).toContain('started') })
  586. handle.cancel('raced the completion')
  587. const result = await handle.result
  588. expect(result.stopReason).toBe('cancelled')
  589. expect(result.error).toContain('raced the completion')
  590. expect(narration).toEqual(['started'])
  591. await handle.dispose()
  592. }, 15_000)
  593. it('cancel() force-settles a script parked on a promise no hook owns, and TERMINATES its worker', async () => {
  594. const { ctx, parent } = await setup({ config: { provider: 'stub', disposeGraceMs: 50 } })
  595. const runEnds: WorkflowResultInfo[] = []
  596. ctx.on('workflow/end', (_info, result) => { runEnds.push(result) })
  597. const handle = ctx.workflows.start({
  598. ...scripted("await new Promise(() => {})\nreturn 'unreachable'"),
  599. parent,
  600. })
  601. handle.cancel('user aborted')
  602. const result = await handle.result
  603. expect(result.stopReason).toBe('cancelled')
  604. expect(result.error).toContain('user aborted')
  605. // The grace force-settle fires workflow/end exactly like an ordinary
  606. // settlement — a terminated script's death still reaches observers.
  607. expect(runEnds).toEqual([{ stopReason: 'cancelled', error: result.error, agentsStarted: 0 }])
  608. await handle.dispose()
  609. })
  610. it('dispose() on a stuck script returns within the grace instead of hanging (result settles cancelled)', async () => {
  611. const { ctx, parent } = await setup({ config: { provider: 'stub', disposeGraceMs: 50 } })
  612. const handle = ctx.workflows.start({
  613. ...scripted("await new Promise(() => {})\nreturn 'unreachable'"),
  614. parent,
  615. })
  616. const before = Date.now()
  617. await handle.dispose()
  618. expect(Date.now() - before).toBeLessThan(2000)
  619. const result = await handle.result
  620. expect(result.stopReason).toBe('cancelled')
  621. })
  622. it('dispose() is idempotent and settles cleanly after a completed run', async () => {
  623. const { ctx, parent } = await setup()
  624. const handle = ctx.workflows.start({ ...scripted('return 1'), parent })
  625. await handle.result
  626. await handle.dispose()
  627. await handle.dispose()
  628. })
  629. it('a settled run arms NO grace timer: disposing a completed run must not pin it for disposeGraceMs', async () => {
  630. // A distinctive grace so the spy can tell the cancel-path grace timer
  631. // apart from every other timeout in flight.
  632. const GRACE = 44_444
  633. const { ctx, parent } = await setup({ config: { provider: 'stub', disposeGraceMs: GRACE } })
  634. const handle = ctx.workflows.start({ ...scripted('return 1'), parent })
  635. await handle.result
  636. const spy = vi.spyOn(globalThis, 'setTimeout')
  637. try {
  638. await handle.dispose()
  639. // dispose()'s own bounded-wait sleep is the ONLY grace-sized timer
  640. // allowed here; before the settled guard, cancel() armed a second one
  641. // that nothing would ever clear (the run was already settled), keeping
  642. // the WorkerRun/Worker closure alive until the grace expired.
  643. const graceTimers = spy.mock.calls.filter(call => call[1] === GRACE)
  644. expect(graceTimers.length).toBe(1)
  645. } finally {
  646. spy.mockRestore()
  647. }
  648. })
  649. it('strays: children fired without await are aborted once the script settles, and dispose() waits for their disposal', async () => {
  650. const { ctx, parent, provider } = await setup({ manual: true, disposeDelayMs: 40 })
  651. const handle = ctx.workflows.start({
  652. ...scripted(`
  653. agent('stray')
  654. return 'done without awaiting'
  655. `),
  656. parent,
  657. })
  658. const result = await handle.result
  659. expect(result.stopReason).toBe('completed')
  660. await waitFor(() => { expect(provider.runs.length).toBe(1) })
  661. await handle.dispose()
  662. // Not a waitFor: by the time dispose() returns, the slow child disposal
  663. // must already be complete (host-side registry quiescence).
  664. expect(provider.runs[0]!.disposed).toBe(true)
  665. })
  666. it('result settlement reaps a registered stray even when the worker cannot relay disposal', async () => {
  667. const { ctx, parent, provider } = await setup({
  668. manual: true,
  669. config: { provider: 'stub', disposeGraceMs: 30_000 },
  670. })
  671. const handle = ctx.workflows.start({
  672. ...scripted("agent('stray')\nawait new Promise(() => {})"),
  673. parent,
  674. })
  675. await waitFor(() => { expect(provider.runs).toHaveLength(1) })
  676. // Claim the host result while the real worker remains wedged, so it can
  677. // send neither ChildDispose nor an exit. This leaves the accepted child
  678. // in the host registry when public disposal begins.
  679. const worker = (handle as unknown as { worker: Worker }).worker
  680. worker.emit('message', {
  681. type: WorkerToHostType.Result,
  682. result: { value: 'synthetic completion', stopReason: 'completed', agentsStarted: 1 },
  683. })
  684. await expect(handle.result).resolves.toMatchObject({ stopReason: 'completed' })
  685. await waitFor(() => { expect(provider.runs[0]!.disposed).toBe(true) }, 1000)
  686. const disposal = handle.dispose()
  687. await disposal
  688. expect(provider.runs[0]!.disposeCalls).toBe(1)
  689. await ctx.fiber.dispose()
  690. })
  691. it('the settle-reap fires the request signal too: a provider honoring ONLY the signal winds its stray down promptly', async () => {
  692. const ctx = new Context()
  693. await ctx.plugin(SubagentService)
  694. const aborted: string[] = []
  695. const provider: SubagentProvider = {
  696. name: 'signal-only',
  697. capabilities: { outputSchema: true, depthLimit: true, toolFilter: true, persona: false },
  698. inheritsParentContext: false,
  699. start: async (request) => {
  700. let settle!: (result: SubagentResult) => void
  701. const result = new Promise<SubagentResult>((resolve) => { settle = resolve })
  702. request.signal.addEventListener('abort', () => {
  703. aborted.push(String(request.signal.reason))
  704. settle({ output: [], stopReason: 'aborted' })
  705. }, { once: true })
  706. return {
  707. id: AgentId('signal-only-child'),
  708. result,
  709. dispose: () => Promise.resolve(),
  710. }
  711. },
  712. }
  713. ctx.subagents.registerProvider(provider)
  714. await ctx.plugin(WorkerWorkflowEngine, { provider: 'signal-only', maxConcurrentAgents: 2 })
  715. const handle = ctx.workflows.start({
  716. ...scripted(`
  717. agent('stray, never awaited')
  718. return 'done'
  719. `),
  720. parent: fakeParent(),
  721. })
  722. const result = await handle.result
  723. expect(result.stopReason).toBe('completed')
  724. // BEFORE dispose(): the settlement itself must have aborted the signal —
  725. // without it this child would stay live until dispose's terminate. This
  726. // is a HOST-PROMPTNESS claim, not a cold-start race — a tight explicit
  727. // bound (unlike the file default) so a multi-second reap regression
  728. // cannot pass by outlasting the wait.
  729. await waitFor(() => { expect(aborted).toEqual(['workflow settled']) }, 1000)
  730. await handle.dispose()
  731. })
  732. it('the settle-reap aborts a pending provider start before workflow/end', async () => {
  733. const { ctx, parent, provider } = await setup({ manual: true, deferStart: true })
  734. const childLifecycle: string[] = []
  735. let cancellationAtWorkflowEnd: string | undefined
  736. ctx.on('workflow/agent-start', () => { childLifecycle.push('start') })
  737. ctx.on('workflow/agent-end', () => { childLifecycle.push('end') })
  738. ctx.on('workflow/end', () => {
  739. cancellationAtWorkflowEnd = provider.runs[0]?.cancelled
  740. })
  741. const handle = ctx.workflows.start({
  742. ...scripted(`
  743. agent('start-pending stray')
  744. return 'done'
  745. `),
  746. parent,
  747. })
  748. const result = await handle.result
  749. expect(result.stopReason).toBe('completed')
  750. expect(provider.runs).toHaveLength(1)
  751. expect(provider.runs[0]!.request.signal?.aborted).toBe(true)
  752. expect(provider.runs[0]!.request.signal?.reason).toBe('workflow settled')
  753. expect(provider.runs[0]!.cancelled).toBe('workflow settled')
  754. expect(cancellationAtWorkflowEnd).toBe('workflow settled')
  755. expect(childLifecycle).toEqual([])
  756. await handle.dispose()
  757. expect(provider.runs[0]!.disposeCalls).toBe(1)
  758. })
  759. it('a duplicate Result after the terminal claim cannot repeat cleanup or rewrite the outcome', async () => {
  760. let signalAborts = 0
  761. const { ctx, parent, provider } = await setup({
  762. manual: true,
  763. onChildAbortString: (_reason, index) => { if (index === 0) signalAborts += 1 },
  764. })
  765. const handle = ctx.workflows.start({
  766. ...scripted("agent('stray')\nawait new Promise(() => {})"),
  767. parent,
  768. })
  769. await waitFor(() => { expect(provider.runs).toHaveLength(1) })
  770. const worker = (handle as unknown as { worker: Worker }).worker
  771. worker.emit('message', {
  772. type: WorkerToHostType.Result,
  773. result: { value: 'first', stopReason: 'completed', agentsStarted: 1 },
  774. })
  775. worker.emit('message', {
  776. type: WorkerToHostType.Result,
  777. result: { value: 'late', stopReason: 'completed', agentsStarted: 1 },
  778. })
  779. await expect(handle.result).resolves.toMatchObject({ value: 'first', stopReason: 'completed' })
  780. expect(signalAborts).toBe(1)
  781. await handle.dispose()
  782. expect(signalAborts).toBe(1)
  783. await ctx.fiber.dispose()
  784. })
  785. it('a grace-terminated worker reaps its child on exit without waiting for consumer dispose()', async () => {
  786. const { ctx, parent, provider } = await setup({
  787. manual: true,
  788. config: { provider: 'stub', maxConcurrentAgents: 2, disposeGraceMs: 100 },
  789. })
  790. const handle = ctx.workflows.start({
  791. // Let child-start cross, then make the worker unable to process its
  792. // Cancel message. Grace settles the result and terminates the thread;
  793. // that exit must independently own the host registry's disposal pass.
  794. ...scripted(`
  795. agent('survives until exit reap')
  796. for (let i = 0; i < 20; i++) await null
  797. const end = Date.now() + 1500
  798. while (Date.now() < end) {}
  799. return 'unreachable'
  800. `),
  801. parent,
  802. })
  803. await waitFor(() => { expect(provider.runs).toHaveLength(1) })
  804. handle.cancel('force termination')
  805. const result = await handle.result
  806. expect(result.stopReason).toBe('cancelled')
  807. // Deliberately assert before handle.dispose(): host-owned worker exit,
  808. // not consumer courtesy, is responsible for this resource guarantee.
  809. await waitFor(() => { expect(provider.runs[0]!.disposed).toBe(true) }, 1000)
  810. expect(provider.runs[0]!.disposeCalls).toBe(1)
  811. await handle.dispose()
  812. await ctx.fiber.dispose()
  813. }, 15_000)
  814. it('dispose() on a wedged worker host-drives child disposal inside the grace: it returns with the children DISPOSED, not with their teardown still in flight', async () => {
  815. const { ctx, parent, provider } = await setup({
  816. manual: true,
  817. disposeDelayMs: 40,
  818. config: { provider: 'stub', maxConcurrentAgents: 8, disposeGraceMs: 400 },
  819. })
  820. const handle = ctx.workflows.start({
  821. // Same shape as the wedged-cancel test above: the child's start RPC
  822. // reaches the host, then the script seizes its worker's loop, so the
  823. // worker can relay NO dispose RPC — the host's own dispose() drive is
  824. // the only thing that can start (and finish) this child's disposal
  825. // before the grace runs out.
  826. ...scripted(`
  827. agent('wedged child')
  828. for (let i = 0; i < 20; i++) await null
  829. const end = Date.now() + 1500
  830. while (Date.now() < end) {}
  831. return 'raced'
  832. `),
  833. parent,
  834. })
  835. await waitFor(() => { expect(provider.runs.length).toBe(1) })
  836. const before = Date.now()
  837. await handle.dispose()
  838. // Bounded by the grace (plus the terminate), never by the 1.5s spin.
  839. expect(Date.now() - before).toBeLessThan(1200)
  840. // Not a waitFor: dispose() resolving IS the quiescence claim — the slow
  841. // child disposal must be complete, not merely started (before the
  842. // host-driven drive, disposal only STARTED at the post-terminate reap,
  843. // so dispose() returned with it still in flight).
  844. expect(provider.runs[0]!.disposed).toBe(true)
  845. const result = await handle.result
  846. expect(result.stopReason).toBe('cancelled')
  847. }, 15_000)
  848. it('a live child disposed by the dispose() drive is disposed ONCE, and the worker\'s late dispose RPC still gets its ack (the script settles, not the grace)', async () => {
  849. const { ctx, parent, provider } = await setup({ manual: true })
  850. const handle = ctx.workflows.start({
  851. ...scripted(`
  852. await agent('long child')
  853. return 'unreachable'
  854. `),
  855. parent,
  856. })
  857. await waitFor(() => { expect(provider.runs.length).toBe(1) })
  858. const handleDispose = handle.dispose()
  859. const result = await handle.result
  860. // The script itself settled (the wrapper's own dispose RPC found the
  861. // child already reaped host-side and was acked) — a missing ack would
  862. // wedge the wrapper's finally until the 5s default grace force-settle.
  863. expect(result.stopReason).toBe('cancelled')
  864. expect(result.error).toContain('workflow disposed')
  865. await handleDispose
  866. expect(provider.runs[0]!.disposed).toBe(true)
  867. // The memo: the host drive and the worker's RPC share one disposal.
  868. expect(provider.runs[0]!.disposeCalls).toBe(1)
  869. })
  870. it('the grace force-settle pairs every stranded start: a host-synthesized cancelled agent-end lands before workflow/end', async () => {
  871. const { ctx, parent, provider } = await setup({ manual: true, config: { provider: 'stub', maxConcurrentAgents: 8, disposeGraceMs: 300 } })
  872. const ends: { seq: number; outcome: string }[] = []
  873. const order: string[] = []
  874. ctx.on('workflow/agent-start', (_info, agent) => { order.push(`start:${agent.seq}`) })
  875. ctx.on('workflow/agent-end', (_info, agent) => {
  876. ends.push({ seq: agent.seq, outcome: agent.outcome })
  877. order.push(`end:${agent.seq}`)
  878. })
  879. ctx.on('workflow/end', () => { order.push('run-end') })
  880. const handle = ctx.workflows.start({
  881. // 'slow' starts and its agent-start crosses to observers (the awaited
  882. // 'fast' call keeps the worker loop turning), then the script seizes
  883. // the loop: the wedged worker can never author slow's agent-end —
  884. // only the host's ledger can close the pair.
  885. ...scripted(`
  886. const p = agent('slow')
  887. await agent('fast')
  888. const end = Date.now() + 1500
  889. while (Date.now() < end) {}
  890. return 'raced'
  891. `),
  892. parent,
  893. })
  894. await waitFor(() => { expect(order.filter(entry => entry.startsWith('start:')).length).toBe(2) })
  895. const fast = provider.runs.find(run => (run.request.prompt[0] as { text?: string }).text === 'fast')!
  896. fast.settle(text('fast done'))
  897. handle.cancel('stop now')
  898. const result = await handle.result
  899. expect(result.stopReason).toBe('cancelled')
  900. // fast's end is the worker's own report; slow's is host-synthesized at
  901. // the force-settle — exactly one end per started seq, no third event.
  902. expect(ends).toEqual([
  903. { seq: 2, outcome: 'completed' },
  904. { seq: 1, outcome: 'cancelled' },
  905. ])
  906. // Both ends reached observers BEFORE workflow/end: a progress consumer
  907. // can finalize its state at run-end without dangling agents.
  908. expect(order.indexOf('run-end')).toBe(order.length - 1)
  909. await handle.dispose()
  910. }, 15_000)
  911. it('graceful cancellation keeps pairing worker-authored: exactly one agent-end per start, nothing synthesized on top', async () => {
  912. const { ctx, parent, provider } = await setup({ manual: true })
  913. const ends: { seq: number; outcome: string }[] = []
  914. const order: string[] = []
  915. ctx.on('workflow/agent-end', (_info, agent) => {
  916. ends.push({ seq: agent.seq, outcome: agent.outcome })
  917. order.push(`end:${agent.seq}`)
  918. })
  919. ctx.on('workflow/end', () => { order.push('run-end') })
  920. const handle = ctx.workflows.start({
  921. ...scripted("await parallel([() => agent('a'), () => agent('b')])\nreturn 'unreachable'"),
  922. parent,
  923. })
  924. await waitFor(() => { expect(provider.runs.length).toBe(2) })
  925. handle.cancel('user stop')
  926. const result = await handle.result
  927. expect(result.stopReason).toBe('cancelled')
  928. // The live worker reported both pairs itself; the ledger must not add
  929. // a synthesized duplicate on any path that settles inside the grace.
  930. expect(ends.map(end => end.outcome)).toEqual(['cancelled', 'cancelled'])
  931. expect(new Set(ends.map(end => end.seq)).size).toBe(2)
  932. expect(order.indexOf('run-end')).toBe(order.length - 1)
  933. await handle.dispose()
  934. })
  935. })
  936. describe('worker death', () => {
  937. it('the first death signal closes admission to messages Node delivers before exit', async () => {
  938. const { ctx, parent, provider } = await setup({ manual: true })
  939. const phases: string[] = []
  940. ctx.on('workflow/phase', (_info, title) => { phases.push(title) })
  941. const handle = ctx.workflows.start({
  942. ...scripted('await new Promise(() => {})'),
  943. parent,
  944. })
  945. const worker = (handle as unknown as { worker: Worker }).worker
  946. // Node may physically emit error -> queued message -> exit. Reproduce
  947. // that ordering deterministically at the Worker event boundary: the
  948. // late protocol data must not create work, narrate, or rewrite error.
  949. worker.emit('error', new Error('synthetic error-before-message'))
  950. worker.emit('message', { type: WorkerToHostType.Phase, title: 'late phase' })
  951. worker.emit('message', {
  952. type: WorkerToHostType.ChildStart,
  953. callId: 999,
  954. request: { prompt: 'late child' },
  955. })
  956. worker.emit('message', {
  957. type: WorkerToHostType.Result,
  958. result: { value: 'late', stopReason: 'completed', agentsStarted: 1 },
  959. })
  960. const result = await handle.result
  961. expect(result.stopReason).toBe('error')
  962. expect(result.error).toContain('synthetic error-before-message')
  963. expect(provider.runs).toHaveLength(0)
  964. expect(phases).toEqual([])
  965. await handle.dispose()
  966. await ctx.fiber.dispose()
  967. })
  968. it('refuses and disposes a provider run that becomes ready after its real worker dies', async () => {
  969. const ctx = new Context()
  970. await ctx.plugin(SubagentService)
  971. const requested = Promise.withResolvers<SubagentStartRequest>()
  972. const ready = Promise.withResolvers<SubagentRun>()
  973. let disposeCalls = 0
  974. const warn = vi.spyOn(ctx.logger, 'warn').mockImplementation(() => ctx.logger)
  975. const provider: SubagentProvider = {
  976. name: 'late-ready',
  977. capabilities: { outputSchema: true, depthLimit: true, toolFilter: true, persona: false },
  978. inheritsParentContext: false,
  979. start: (request) => {
  980. requested.resolve(request)
  981. // Model a backend whose independent startup boundary cannot be
  982. // interrupted promptly. The host must still reject ownership if the
  983. // worker dies before this promise transfers the ready run.
  984. return ready.promise
  985. },
  986. }
  987. ctx.subagents.registerProvider(provider)
  988. await ctx.plugin(WorkerWorkflowEngine, { provider: 'late-ready', maxConcurrentAgents: 1 })
  989. const lifecycle: string[] = []
  990. ctx.on('workflow/agent-start', () => { lifecycle.push('start') })
  991. ctx.on('workflow/agent-end', () => { lifecycle.push('end') })
  992. const handle = ctx.workflows.start({
  993. ...scripted("return await agent('pending startup')"),
  994. parent: fakeParent(),
  995. })
  996. const request = await requested.promise
  997. const worker = (handle as unknown as { worker: Worker }).worker
  998. // Kill the actual Worker while provider startup is independently
  999. // pending. Death closes admission and aborts the shared signal, but this
  1000. // deliberately uncooperative provider still fulfills afterward.
  1001. await worker.terminate()
  1002. const result = await handle.result
  1003. expect(result.stopReason).toBe('error')
  1004. expect(result.error).toContain('exit code')
  1005. expect(request.signal.aborted).toBe(true)
  1006. expect(request.signal.reason).toBe('workflow worker gone')
  1007. ready.resolve({
  1008. id: AgentId('late-ready-child'),
  1009. result: Promise.resolve({ output: [], stopReason: 'aborted' }),
  1010. dispose: () => {
  1011. disposeCalls += 1
  1012. return Promise.reject(new Error('late ready dispose failed'))
  1013. },
  1014. })
  1015. await waitFor(() => {
  1016. expect(disposeCalls).toBe(1)
  1017. expect(warn).toHaveBeenCalledWith(expect.stringContaining('refused child dispose failed: Error: late ready dispose failed'))
  1018. }, 1000)
  1019. expect(lifecycle).toEqual([])
  1020. await handle.dispose()
  1021. expect(disposeCalls).toBe(1)
  1022. await ctx.fiber.dispose()
  1023. })
  1024. it('a worker that exits before settling reports an error result and reaps its children', async () => {
  1025. const ctx = new Context()
  1026. await ctx.plugin(SubagentService)
  1027. // The child's dispose() REJECTS on top of the worker death: the reap
  1028. // must contain it (warn, not crash) while still emptying the registry.
  1029. const signalAborts: unknown[] = []
  1030. const provider: SubagentProvider = {
  1031. name: 'doomed',
  1032. capabilities: { outputSchema: true, depthLimit: true, toolFilter: true, persona: false },
  1033. inheritsParentContext: false,
  1034. start: async (request) => {
  1035. request.signal.addEventListener('abort', () => {
  1036. signalAborts.push(request.signal.reason)
  1037. // The death claim precedes the shared-signal fanout. This
  1038. // synchronous callback cannot turn death into cancellation.
  1039. handle.cancel('reentered from worker-death signal cleanup')
  1040. }, { once: true })
  1041. return {
  1042. id: AgentId('doomed-child'),
  1043. result: new Promise(() => { /* never settles; the reap is the teardown */ }),
  1044. dispose: () => Promise.reject(new Error('dispose exploded during reap')),
  1045. }
  1046. },
  1047. }
  1048. ctx.subagents.registerProvider(provider)
  1049. await ctx.plugin(WorkerWorkflowEngine, { provider: 'doomed', maxConcurrentAgents: 2 })
  1050. const runEnds: WorkflowResultInfo[] = []
  1051. ctx.on('workflow/end', (_info, result) => { runEnds.push(result) })
  1052. const handle = ctx.workflows.start({
  1053. // The stray child's start RPC reaches the host, then the script kills
  1054. // its own worker through the documented vm escape — the host must
  1055. // settle `error` with the exit diagnostics and wind the child down.
  1056. ...scripted(`
  1057. agent('doomed')
  1058. const proc = ${ESCAPE}
  1059. const st = globalThis.constructor.constructor('return setTimeout')()
  1060. await new Promise(resolve => st(resolve, 200))
  1061. proc.exit(7)
  1062. `),
  1063. parent: fakeParent(),
  1064. })
  1065. const result = await handle.result
  1066. expect(result.stopReason).toBe('error')
  1067. expect(result.error).toContain('exit code 7')
  1068. expect(result.agentsStarted).toBe(1)
  1069. // A worker death is a stop reason like any other: workflow/end fires
  1070. // with the error outcome — for a bus observer it is the only obituary.
  1071. expect(runEnds).toEqual([{ stopReason: 'error', error: result.error, agentsStarted: 1 }])
  1072. // Result already settled — this is the reap's promptness, not a
  1073. // cold-start race; tight explicit bound (see the helper's doc comment).
  1074. await waitFor(() => {
  1075. expect(signalAborts).toEqual(['workflow worker gone'])
  1076. }, 1000)
  1077. await Promise.resolve()
  1078. expect(result.stopReason).toBe('error')
  1079. await handle.dispose()
  1080. }, 15_000)
  1081. it('an uncaught exception inside the worker surfaces as an error result and reaps the in-flight child', async () => {
  1082. const { ctx, parent, provider } = await setup({ manual: true })
  1083. const handle = ctx.workflows.start({
  1084. ...scripted(`
  1085. agent('in flight when the worker dies')
  1086. const proc = ${ESCAPE}
  1087. const st = globalThis.constructor.constructor('return setTimeout')()
  1088. await new Promise(resolve => st(resolve, 200))
  1089. proc.nextTick(() => { throw new Error('worker blew up') })
  1090. await new Promise(() => {})
  1091. `),
  1092. parent,
  1093. })
  1094. const result = await handle.result
  1095. expect(result.stopReason).toBe('error')
  1096. expect(result.error).toContain('worker blew up')
  1097. // The reap wound the stray child down (cancel + a CLEAN dispose).
  1098. // Result already settled — this is the reap's promptness, not a
  1099. // cold-start race; tight explicit bound (see the helper's doc comment).
  1100. await waitFor(() => {
  1101. expect(provider.runs.length).toBe(1)
  1102. expect(provider.runs[0]!.disposed).toBe(true)
  1103. }, 1000)
  1104. await handle.dispose()
  1105. }, 15_000)
  1106. it('a worker death pairs every stranded start: the synthesized cancelled agent-end precedes the error workflow/end', async () => {
  1107. const { ctx, parent, provider } = await setup({ manual: true })
  1108. const ends: { seq: number; outcome: string }[] = []
  1109. const order: string[] = []
  1110. ctx.on('workflow/agent-start', (_info, agent) => { order.push(`start:${agent.seq}`) })
  1111. ctx.on('workflow/agent-end', (_info, agent) => {
  1112. ends.push({ seq: agent.seq, outcome: agent.outcome })
  1113. order.push(`end:${agent.seq}`)
  1114. })
  1115. ctx.on('workflow/end', () => { order.push('run-end') })
  1116. const handle = ctx.workflows.start({
  1117. // Same choreography as the force-settle pairing test, but the worker
  1118. // DIES (the documented vm escape) instead of being terminated: the
  1119. // exit path must close slow's pair from the ledger too. The escaped
  1120. // setTimeout lets the already-posted messages flush before the kill.
  1121. ...scripted(`
  1122. const p = agent('slow')
  1123. await agent('fast')
  1124. const proc = ${ESCAPE}
  1125. const st = globalThis.constructor.constructor('return setTimeout')()
  1126. await new Promise(resolve => st(resolve, 150))
  1127. proc.exit(7)
  1128. `),
  1129. parent,
  1130. })
  1131. await waitFor(() => { expect(order.filter(entry => entry.startsWith('start:')).length).toBe(2) })
  1132. const fast = provider.runs.find(run => (run.request.prompt[0] as { text?: string }).text === 'fast')!
  1133. fast.settle(text('fast done'))
  1134. const result = await handle.result
  1135. expect(result.stopReason).toBe('error')
  1136. expect(result.error).toContain('exit code 7')
  1137. expect(ends).toEqual([
  1138. { seq: 2, outcome: 'completed' },
  1139. { seq: 1, outcome: 'cancelled' },
  1140. ])
  1141. expect(order.indexOf('run-end')).toBe(order.length - 1)
  1142. await handle.dispose()
  1143. }, 15_000)
  1144. it('a dispose ack racing the worker death is dropped, not crashed (post after exit)', async () => {
  1145. // Slow child disposal: the ack resolves only AFTER the worker died, so
  1146. // it has nowhere to go and must be dropped silently (the workerGone
  1147. // guard in post()).
  1148. const { ctx, parent, provider } = await setup({ disposeDelayMs: 300 })
  1149. const handle = ctx.workflows.start({
  1150. // The STRAY child settles instantly, so its wrapper starts the slow
  1151. // host-side disposal concurrently while the script goes on to kill
  1152. // its own worker — the ack then resolves into a dead thread.
  1153. ...scripted(`
  1154. agent('stray, never awaited')
  1155. const proc = ${ESCAPE}
  1156. const st = globalThis.constructor.constructor('return setTimeout')()
  1157. await new Promise(resolve => st(resolve, 150))
  1158. proc.exit(5)
  1159. `),
  1160. parent,
  1161. })
  1162. const result = await handle.result
  1163. expect(result.stopReason).toBe('error')
  1164. expect(result.error).toContain('exit code 5')
  1165. // Result already settled — this is the reap's promptness (bounded
  1166. // above the mock's fixed 300ms dispose delay, not a cold-start race);
  1167. // tight explicit bound (see the helper's doc comment).
  1168. await waitFor(() => { expect(provider.runs[0]!.disposed).toBe(true) }, 1000)
  1169. await handle.dispose()
  1170. }, 15_000)
  1171. it('a worker death AFTER a cancel reports cancelled, not error', async () => {
  1172. const { ctx, parent } = await setup({ config: { provider: 'stub', disposeGraceMs: 60_000 } })
  1173. const handle = ctx.workflows.start({
  1174. ...scripted(`
  1175. const proc = ${ESCAPE}
  1176. const st = globalThis.constructor.constructor('return setTimeout')()
  1177. log('armed')
  1178. await new Promise(resolve => st(resolve, 400))
  1179. proc.exit(3)
  1180. `),
  1181. parent,
  1182. })
  1183. const logs: string[] = []
  1184. ctx.on('workflow/log', (_info, message) => { logs.push(message) })
  1185. await waitFor(() => { expect(logs).toContain('armed') })
  1186. handle.cancel('stop it')
  1187. // The grace is deliberately huge: only the worker's own death (exit 3,
  1188. // unreachable by the cancel — the script ignores hooks) settles this.
  1189. const result = await handle.result
  1190. expect(result.stopReason).toBe('cancelled')
  1191. expect(result.error).toContain('stop it')
  1192. await handle.dispose()
  1193. }, 15_000)
  1194. })
  1195. describe('service surface', () => {
  1196. it('run ids are unique and lifecycle meta is the run\'s borrowed immutable value', async () => {
  1197. const { ctx, parent } = await setup()
  1198. let eventMeta: WorkflowRunInfo | undefined
  1199. ctx.on('workflow/start', (info) => { eventMeta = info })
  1200. const first = ctx.workflows.start({ ...scripted('return 1'), parent })
  1201. const second = ctx.workflows.start({ ...scripted('return 2'), parent })
  1202. expect(first.id).not.toBe(second.id)
  1203. expect(eventMeta!.meta).toBe(second.meta)
  1204. expect(second.meta.name).toBe('test-flow')
  1205. await Promise.all([first.result, second.result])
  1206. await first.dispose()
  1207. await second.dispose()
  1208. })
  1209. it('unregisters ctx.workflows when the engine fiber is disposed (HMR safety)', async () => {
  1210. const ctx = new Context()
  1211. await ctx.plugin(SubagentService)
  1212. const fiber = await ctx.plugin(WorkerWorkflowEngine, {})
  1213. expect(ctx.get('workflows')).toBeDefined()
  1214. await fiber.dispose()
  1215. expect(ctx.get('workflows')).toBeUndefined()
  1216. })
  1217. it('keeps a holder-owned run usable when the engine unloads before its child starts', async () => {
  1218. const { ctx, parent, provider, engineFiber } = await setup({ reply: () => text('survived reload') })
  1219. let handle!: ReturnType<typeof ctx.workflows.start>
  1220. const holder = await ctx.plugin(Object.assign((inner: Context) => {
  1221. handle = inner.workflows.start({ ...scripted("return await agent('after reload')"), parent })
  1222. }, { inject: ['workflows'] }))
  1223. try {
  1224. // A real worker cannot deliver child-start in the synchronous start()
  1225. // slice. Unload the provider before that message arrives: the returned
  1226. // run belongs to `holder`, not to the engine fiber being reloaded.
  1227. expect(provider.runs).toHaveLength(0)
  1228. await engineFiber.dispose()
  1229. expect(ctx.get('workflows')).toBeUndefined()
  1230. await expect(handle.result).resolves.toEqual({
  1231. value: 'survived reload',
  1232. stopReason: 'completed',
  1233. agentsStarted: 1,
  1234. })
  1235. expect(provider.runs).toHaveLength(1)
  1236. } finally {
  1237. await handle.dispose()
  1238. await holder.dispose()
  1239. await ctx.fiber.dispose()
  1240. }
  1241. })
  1242. it('has the class-plugin export shape (default = the engine service class)', () => {
  1243. expect(workerEngineModule.default).toBe(WorkerWorkflowEngine)
  1244. expect('WorkerWorkflowEngine' in workerEngineModule).toBe(false)
  1245. const loader = Object.create(Loader.prototype) as Loader
  1246. const unwrapped: unknown = loader.unwrapExports(workerEngineModule)
  1247. expect(unwrapped).toBe(WorkerWorkflowEngine)
  1248. })
  1249. })
  1250. })