code-mode.spec.ts 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326
  1. import { describe, expect, it } from 'vitest'
  2. import { Context } from 'cordis'
  3. import { CallId } from '@deepseek-ai/dsh-llm'
  4. import { createScope } from '@deepseek-ai/dsh-scope'
  5. import type { Scope } from '@deepseek-ai/dsh-scope'
  6. import SystemPrompt from '@deepseek-ai/dsh-system-prompt'
  7. import { CodeRuntime } from '@deepseek-ai/dsh-code-runtime'
  8. import type { CodeRunRequest, CodeRunResult } from '@deepseek-ai/dsh-code-runtime'
  9. import ToolRegistry, { CodeRunFailedError, RUN_CODE_NAME, TOOL_ABORTED_BEFORE_DISPATCH, defineContentToolFixture, defineTool } from '@deepseek-ai/dsh-tools'
  10. import type { Config, JsonSchemaNode, PostToolDecision, ToolExecutionResult } from '@deepseek-ai/dsh-tools'
  11. import type { Agent } from '@deepseek-ai/dsh-agent'
  12. import { Session, SessionId } from '@deepseek-ai/dsh-session'
  13. import type { JsonValue, SessionEventMap } from '@deepseek-ai/dsh-session'
  14. const testToolSignal = new AbortController().signal
  15. /**
  16. * Code Mode unit tier (per the Agent Note's plan): provider contribution per mode,
  17. * misconfiguration rejections, the run_code dispatch bridge (serialization,
  18. * abort, JSON normalization, error mapping, events, quiescence), and HMR
  19. * safety — all against an in-repo fake runtime, exactly the
  20. * interface/implementation/consumer shape the seam promises.
  21. */
  22. /** A scriptable in-repo CodeRuntime: each test sets `behavior` to drive the bindings however it needs. */
  23. class FakeRuntime extends CodeRuntime {
  24. readonly language: string
  25. readonly isolation = 'fake'
  26. behavior: (request: CodeRunRequest) => Promise<CodeRunResult> = () => Promise.resolve({ logs: [] })
  27. lastRequest?: CodeRunRequest
  28. constructor(ctx: Context, config: { language?: string } = {}) {
  29. super(ctx)
  30. this.language = config.language ?? 'typescript'
  31. }
  32. run(request: CodeRunRequest): Promise<CodeRunResult> {
  33. this.lastRequest = request
  34. return this.behavior(request)
  35. }
  36. }
  37. interface SetupOptions {
  38. mode?: Config['mode']
  39. maxParallelSubCalls?: number
  40. runtime?: false | { language?: string }
  41. toolOrder?: string[]
  42. }
  43. async function setup(options: SetupOptions = {}) {
  44. const ctx = new Context()
  45. await ctx.plugin(SystemPrompt, { ...options.toolOrder ? { toolOrder: options.toolOrder } : {} })
  46. await ctx.plugin(ToolRegistry, { mode: options.mode ?? 'code', ...options.maxParallelSubCalls !== undefined ? { maxParallelSubCalls: options.maxParallelSubCalls } : {} })
  47. let runtime: FakeRuntime | undefined
  48. if (options.runtime !== false) {
  49. await ctx.plugin(FakeRuntime, options.runtime ?? {})
  50. runtime = ctx.codeRuntime as FakeRuntime
  51. }
  52. return { ctx, tools: ctx.tools, systemPrompt: ctx.systemPrompt, runtime: runtime! }
  53. }
  54. /** Mint one production-shaped agent scope that can register scoped tool policy. */
  55. async function mintAgentScope(ctx: Context, name = 'scoped'): Promise<{ scope: Scope; agent: Agent }> {
  56. const agent = { id: SessionId(name) } as Agent
  57. let scope!: Scope
  58. await ctx.plugin(Object.assign((inner: Context) => { scope = createScope(inner, agent) },
  59. { inject: ['tools', 'systemPrompt'] }))
  60. return { scope, agent }
  61. }
  62. /** Register a trivial echo tool; returns the calls it received. */
  63. function registerEcho(ctx: Context, name = 'echo'): unknown[] {
  64. const calls: unknown[] = []
  65. ctx.tools.register(defineTool({
  66. name,
  67. description: `Echo tool ${name}.`,
  68. parameters: { value: { type: 'string', required: true } },
  69. output: {
  70. schema: { type: 'string' },
  71. render: (_args, value) => [{ type: 'text', text: value }],
  72. },
  73. execute(args) {
  74. calls.push(args)
  75. return Promise.resolve(`${name}:${args.value}`)
  76. },
  77. }))
  78. return calls
  79. }
  80. /** A structural fake of the owning agent: captures session appends. */
  81. function fakeAgent(): { agent: Agent; events: { type: string; data: unknown }[] } {
  82. const events: { type: string; data: unknown }[] = []
  83. const agent = {
  84. session: {
  85. header: { cwd: '/workspace' },
  86. append: (type: string, data: unknown) => { events.push({ type, data }) },
  87. },
  88. } as unknown as Agent
  89. return { agent, events }
  90. }
  91. /** Dispatch run_code through the registry pipeline, as the loop would. */
  92. async function runCode(
  93. ctx: Context,
  94. code: string,
  95. extras: { agent?: Agent; signal?: AbortSignal; description?: string } = {},
  96. ): Promise<ToolExecutionResult> {
  97. return ctx.tools.execute({
  98. signal: testToolSignal,
  99. callId: CallId('call-1'),
  100. name: RUN_CODE_NAME,
  101. arguments: { code, description: extras.description ?? 'Run the test program' },
  102. ...extras.agent ? { agent: extras.agent } : {},
  103. ...extras.signal ? { signal: extras.signal } : {},
  104. })
  105. }
  106. describe('mode-aware wire contribution', () => {
  107. it("mode 'native' contributes every schema, no run_code, no SDK section — and needs no runtime", async () => {
  108. const { ctx, systemPrompt } = await setup({ mode: 'native', runtime: false })
  109. registerEcho(ctx)
  110. const assembly = await systemPrompt.assemble()
  111. expect(assembly.tools.map(tool => tool.name)).toEqual(['echo'])
  112. expect(assembly.sections.some(section => section.name === 'tools:sdk')).toBe(false)
  113. })
  114. it("mode 'code' contributes exactly [run_code] plus the SDK section declaring the other tools", async () => {
  115. const { ctx, systemPrompt } = await setup({ mode: 'code' })
  116. registerEcho(ctx)
  117. const assembly = await systemPrompt.assemble()
  118. expect(assembly.tools.map(tool => tool.name)).toEqual([RUN_CODE_NAME])
  119. const sdk = assembly.sections.find(section => section.name === 'tools:sdk')
  120. expect(sdk?.text).toContain('declare const tools: {')
  121. expect(sdk?.text).toContain('echo: {')
  122. expect(sdk?.text).not.toContain('run_code:')
  123. })
  124. it('projects deeply nested output schemas into the Code Mode SDK without structured-clone recursion', async () => {
  125. const { ctx, systemPrompt } = await setup({ mode: 'code' })
  126. let output: JsonSchemaNode = { type: 'string' }
  127. for (let depth = 0; depth < 5_000; depth++) {
  128. output = { oneOf: [output, { type: 'null' }] }
  129. }
  130. ctx.tools.register({
  131. name: 'deep_output',
  132. description: 'Return a deeply nested output union.',
  133. parameters: { type: 'object', properties: {} },
  134. output: {
  135. schema: output,
  136. render: (_args, value) => [{ type: 'text', text: typeof value === 'string' ? value : 'null' }],
  137. },
  138. execute() { return Promise.resolve('ok') },
  139. })
  140. const assembly = await systemPrompt.assemble()
  141. const sdk = assembly.sections.find(section => section.name === 'tools:sdk')?.text
  142. expect(sdk).toContain('deep_output: Record<string, JsonValue>;')
  143. expect(sdk).toContain('deep_output: string | null')
  144. })
  145. it.each(['code', 'both'] as const)('treats expert assembly output as authoritative in mode %s', async (mode) => {
  146. const { ctx, systemPrompt } = await setup({ mode })
  147. registerEcho(ctx)
  148. ctx.on('system-prompt/assemble', async (_assembly, _context, next) => {
  149. const assembly = await next()
  150. return {
  151. ...assembly,
  152. sections: assembly.sections.filter(section => section.name !== 'tools:sdk'),
  153. tools: assembly.tools.filter(tool => tool.name !== RUN_CODE_NAME),
  154. }
  155. }, { prepend: true })
  156. const assembly = await systemPrompt.assemble()
  157. expect(assembly.sections.some(section => section.name === 'tools:sdk')).toBe(false)
  158. expect(assembly.tools.some(tool => tool.name === RUN_CODE_NAME)).toBe(false)
  159. })
  160. it.each(['code', 'both'] as const)('lets one scope shadow the default SDK section in mode %s', async (mode) => {
  161. const { ctx, systemPrompt } = await setup({ mode })
  162. registerEcho(ctx)
  163. const { scope, agent } = await mintAgentScope(ctx)
  164. scope.ctx.systemPrompt.section({ name: 'tools:sdk', order: 150, text: 'SCOPED SDK' })
  165. const scoped = await systemPrompt.assemble({ scope: agent })
  166. const global = await systemPrompt.assemble()
  167. expect(scoped.sections.find(section => section.name === 'tools:sdk')?.text).toBe('SCOPED SDK')
  168. expect(global.sections.find(section => section.name === 'tools:sdk')?.text).toContain('declare const tools:')
  169. })
  170. it("mode 'both' contributes every native schema plus run_code, and the SDK section", async () => {
  171. const { ctx, systemPrompt } = await setup({ mode: 'both' })
  172. registerEcho(ctx)
  173. const assembly = await systemPrompt.assemble()
  174. expect(assembly.tools.map(tool => tool.name)).toEqual(['echo', RUN_CODE_NAME])
  175. expect(assembly.sections.some(section => section.name === 'tools:sdk')).toBe(true)
  176. })
  177. it.each(['code', 'both'] as const)('keeps the run_code transport outside scoped allow-list filtering in mode %s', async (mode) => {
  178. const { ctx, systemPrompt, runtime } = await setup({ mode })
  179. registerEcho(ctx, 'echo')
  180. registerEcho(ctx, 'hidden')
  181. const { scope, agent } = await mintAgentScope(ctx)
  182. const lift = scope.ctx.tools.restrict({ allow: ['echo'] })
  183. const assembly = await systemPrompt.assemble({ scope: agent })
  184. expect(assembly.tools.map(tool => tool.name)).toEqual(mode === 'code'
  185. ? [RUN_CODE_NAME]
  186. : ['echo', RUN_CODE_NAME])
  187. const sdk = assembly.sections.find(section => section.name === 'tools:sdk')?.text
  188. expect(sdk).toContain('echo: {')
  189. expect(sdk).not.toContain('hidden:')
  190. runtime.behavior = request => Promise.resolve({
  191. logs: [],
  192. value: Object.keys(request.bindings[0]!.functions).sort().join(','),
  193. })
  194. const result = await runCode(ctx, 'return Object.keys(tools)', { agent })
  195. expect(result.isError).toBe(false)
  196. expect(result.content).toEqual([{ type: 'text', text: 'echo' }])
  197. lift()
  198. const unrestricted = await systemPrompt.assemble({ scope: agent })
  199. expect(unrestricted.tools.map(tool => tool.name)).toEqual(mode === 'code'
  200. ? [RUN_CODE_NAME]
  201. : ['echo', 'hidden', RUN_CODE_NAME])
  202. })
  203. it.each(['code', 'both'] as const)('keeps the run_code transport outside scoped deny-list filtering in mode %s', async (mode) => {
  204. const { ctx, systemPrompt, runtime } = await setup({ mode })
  205. registerEcho(ctx, 'denied')
  206. registerEcho(ctx, 'kept')
  207. const { scope, agent } = await mintAgentScope(ctx)
  208. scope.ctx.tools.restrict({ deny: ['denied'] })
  209. const assembly = await systemPrompt.assemble({ scope: agent })
  210. expect(assembly.tools.map(tool => tool.name)).toEqual(mode === 'code'
  211. ? [RUN_CODE_NAME]
  212. : ['kept', RUN_CODE_NAME])
  213. const sdk = assembly.sections.find(section => section.name === 'tools:sdk')?.text
  214. expect(sdk).not.toContain('denied:')
  215. expect(sdk).toContain('kept: {')
  216. runtime.behavior = request => Promise.resolve({
  217. logs: [],
  218. value: Object.keys(request.bindings[0]!.functions).sort().join(','),
  219. })
  220. const result = await runCode(ctx, 'return Object.keys(tools)', { agent })
  221. expect(result.isError).toBe(false)
  222. expect(result.content).toEqual([{ type: 'text', text: 'kept' }])
  223. })
  224. it.each(['code', 'both'] as const)('reserves run_code against scoped shadows and explicit restrictions in mode %s', async (mode) => {
  225. const { ctx, systemPrompt } = await setup({ mode })
  226. const { scope, agent } = await mintAgentScope(ctx)
  227. const impostor = defineContentToolFixture({
  228. name: RUN_CODE_NAME,
  229. description: 'Scoped impostor.',
  230. parameters: {},
  231. execute: () => Promise.resolve([{ type: 'text' as const, text: 'impostor' }]),
  232. })
  233. expect(() => scope.ctx.tools.register(impostor)).toThrow(/reserved for the Code Mode presentation transport/)
  234. expect(() => ctx.tools.register(impostor)).toThrow(/reserved for the Code Mode presentation transport/)
  235. expect(() => scope.ctx.tools.restrict({ allow: [RUN_CODE_NAME] })).toThrow(/cannot name reserved Code Mode presentation transport/)
  236. expect(() => scope.ctx.tools.restrict({ deny: [RUN_CODE_NAME] })).toThrow(/cannot name reserved Code Mode presentation transport/)
  237. scope.ctx.systemPrompt.section({ name: 'scoped-note', order: 149, text: 'safe note' })
  238. scope.ctx.tools.register(defineContentToolFixture({
  239. name: 'scoped_safe',
  240. description: 'Safe scoped tool.',
  241. parameters: {},
  242. execute: () => Promise.resolve([{ type: 'text' as const, text: 'safe' }]),
  243. }))
  244. const assembly = await systemPrompt.assemble({ scope: agent })
  245. const transports = assembly.tools.filter(tool => tool.name === RUN_CODE_NAME)
  246. expect(transports).toHaveLength(1)
  247. expect(transports[0]?.description).toContain('Execute a TypeScript program')
  248. expect(assembly.sections.find(section => section.name === 'scoped-note')?.text).toBe('safe note')
  249. expect(assembly.sections.find(section => section.name === 'tools:sdk')?.text).toContain('scoped_safe:')
  250. expect(ctx.tools.get(RUN_CODE_NAME, agent)).toBe(ctx.tools.get(RUN_CODE_NAME))
  251. const result = await runCode(ctx, 'return 1', { agent })
  252. expect(result.content).toEqual([{ type: 'text', text: '(run_code completed with no output)' }])
  253. })
  254. it.each(['code', 'both'] as const)('keeps run_code in the toolOrder universe without exposing it as a restriction target in mode %s', async (mode) => {
  255. const { ctx, systemPrompt } = await setup({
  256. mode,
  257. toolOrder: [RUN_CODE_NAME, '<unlisted-tools>'],
  258. })
  259. registerEcho(ctx)
  260. const { agent } = await mintAgentScope(ctx)
  261. const assembly = await systemPrompt.assemble({ scope: agent })
  262. expect(assembly.tools.map(tool => tool.name)).toEqual(mode === 'code'
  263. ? [RUN_CODE_NAME]
  264. : [RUN_CODE_NAME, 'echo'])
  265. })
  266. it("never exposes run_code to programs, even under mode 'both' (no recursive dispatch path)", async () => {
  267. const { ctx, runtime } = await setup({ mode: 'both' })
  268. registerEcho(ctx)
  269. runtime.behavior = (request) => {
  270. expect(request.bindings[0]!.errorClass).toEqual({
  271. name: 'ToolCallError',
  272. memberNameProperty: 'toolName',
  273. })
  274. const functions = request.bindings[0]!.functions
  275. return Promise.resolve({
  276. logs: [],
  277. value: JSON.stringify({
  278. names: Object.keys(functions).sort(),
  279. // Own-property AND prototype-chain reads both come back empty —
  280. // there is no handle a program could re-enter run_code through.
  281. runCode: String(functions[RUN_CODE_NAME]),
  282. }),
  283. })
  284. }
  285. const result = await runCode(ctx, 'program')
  286. expect(result.isError).toBe(false)
  287. expect(JSON.parse((result.content[0] as { text: string }).text)).toEqual({ names: ['echo'], runCode: 'undefined' })
  288. })
  289. it('renders byte-identical SDK text across consecutive assemblies of an unchanged tool set', async () => {
  290. const { ctx, systemPrompt } = await setup({ mode: 'code' })
  291. registerEcho(ctx)
  292. const first = await systemPrompt.assemble()
  293. const second = await systemPrompt.assemble()
  294. const text = (assembly: typeof first) => assembly.sections.find(section => section.name === 'tools:sdk')?.text
  295. expect(text(first)).toBe(text(second))
  296. })
  297. it('rejects every assembly when a non-native mode has no code runtime', async () => {
  298. const { systemPrompt } = await setup({ mode: 'code', runtime: false })
  299. await expect(systemPrompt.assemble()).rejects.toThrow(/requires a code runtime/)
  300. })
  301. it("rejects every assembly when the runtime's language is not typescript", async () => {
  302. const { systemPrompt } = await setup({ mode: 'code', runtime: { language: 'python' } })
  303. await expect(systemPrompt.assemble()).rejects.toThrow(/language is "python"/)
  304. })
  305. it("rejects the assembly when toolOrder names a native tool that mode 'code' no longer contributes", async () => {
  306. const { ctx, systemPrompt } = await setup({ mode: 'code', toolOrder: ['echo', '<unlisted-tools>'] })
  307. registerEcho(ctx)
  308. await expect(systemPrompt.assemble()).rejects.toThrow(/toolOrder lists unregistered tool "echo"/)
  309. })
  310. it('removes run_code and the SDK section when the registry fiber disposes (HMR safety)', async () => {
  311. const ctx = new Context()
  312. await ctx.plugin(SystemPrompt, {})
  313. await ctx.plugin(FakeRuntime, {})
  314. const fiber = await ctx.plugin(ToolRegistry, { mode: 'code' })
  315. expect(ctx.tools.get(RUN_CODE_NAME)).toBeDefined()
  316. await fiber.dispose()
  317. const assembly = await ctx.systemPrompt.assemble()
  318. expect(assembly.tools).toEqual([])
  319. expect(assembly.sections.some(section => section.name === 'tools:sdk')).toBe(false)
  320. })
  321. })
  322. describe('the sub-dispatch scheduler (native concurrency contract)', () => {
  323. /** Register a tool whose calls resolve only when the test releases them; returns live-call telemetry. */
  324. function registerGated(ctx: Context, name: string, concurrencySafe: boolean) {
  325. const gates: (() => void)[] = []
  326. let live = 0
  327. let peak = 0
  328. const order: string[] = []
  329. ctx.tools.register(defineTool({
  330. name,
  331. description: `Gated tool ${name}.`,
  332. parameters: { id: { type: 'string', required: true } },
  333. output: {
  334. schema: { type: 'string' },
  335. render: (_args, value) => [{ type: 'text', text: value }],
  336. },
  337. ...concurrencySafe ? { isConcurrencySafe: () => true } : {},
  338. async execute(args, exec) {
  339. order.push(`start:${args.id}`)
  340. live++
  341. peak = Math.max(peak, live)
  342. // Abort-observing like a real tool: the run-scoped abort releases the
  343. // gate so the bridge's drain reaches quiescence.
  344. await new Promise<void>((release) => {
  345. gates.push(release)
  346. exec.signal.addEventListener('abort', () => { release() }, { once: true })
  347. })
  348. live--
  349. order.push(`end:${args.id}`)
  350. return `${name}:${args.id}`
  351. },
  352. }))
  353. const release = (): void => { gates.shift()?.() }
  354. const releaseAll = (): void => { while (gates.length > 0) gates.shift()!() }
  355. return { order, release, releaseAll, peakLive: () => peak, pending: () => gates.length }
  356. }
  357. it('overlaps concurrency-safe calls under Promise.all and logs a start event per dispatch', async () => {
  358. const { ctx, runtime } = await setup({ mode: 'code' })
  359. const gated = registerGated(ctx, 'safe_read', true)
  360. const { agent, events } = fakeAgent()
  361. runtime.behavior = async (request) => {
  362. const tools = request.bindings[0]!.functions
  363. const all = Promise.all([
  364. tools.safe_read!({ id: 'a' }),
  365. tools.safe_read!({ id: 'b' }),
  366. tools.safe_read!({ id: 'c' }),
  367. ])
  368. // All three must be START-able without any completion (overlap proof).
  369. await expect.poll(() => gated.pending()).toBe(3)
  370. gated.releaseAll()
  371. return { logs: [], value: (await all).map(String).join(',') }
  372. }
  373. const result = await runCode(ctx, 'program', { agent })
  374. expect(result.isError).toBe(false)
  375. expect(gated.peakLive()).toBe(3)
  376. if (result.isError) throw new Error('expected success')
  377. expect(result.value).toMatchObject({ result: 'safe_read:a,safe_read:b,safe_read:c' })
  378. // One start per dispatch, paired with its settle by subCallId, starts in submission order.
  379. const starts = events.filter(event => event.type === 'tool/code-dispatch-start').map(event => event.data as { subCallId: string })
  380. const settles = events.filter(event => event.type === 'tool/code-dispatch').map(event => event.data as { subCallId: string })
  381. expect(starts.map(start => start.subCallId)).toEqual(['call-1:code:1', 'call-1:code:2', 'call-1:code:3'])
  382. expect(new Set(settles.map(settle => settle.subCallId))).toEqual(new Set(starts.map(start => start.subCallId)))
  383. })
  384. it('an exclusive call bars overlap: safe calls drain first, it runs alone, later calls wait', async () => {
  385. const { ctx, runtime } = await setup({ mode: 'code' })
  386. const safe = registerGated(ctx, 'safe_read', true)
  387. const unsafe = registerGated(ctx, 'writer', false)
  388. runtime.behavior = async (request) => {
  389. const tools = request.bindings[0]!.functions
  390. const reads = [tools.safe_read!({ id: 'r1' }), tools.safe_read!({ id: 'r2' })]
  391. const write = tools.writer!({ id: 'w' })
  392. const tail = tools.safe_read!({ id: 'r3' })
  393. await expect.poll(() => safe.pending()).toBe(2)
  394. // The exclusive call must NOT have started while the pool is live.
  395. expect(unsafe.pending()).toBe(0)
  396. safe.releaseAll()
  397. await expect.poll(() => unsafe.pending()).toBe(1)
  398. // The trailing safe call must NOT start while the exclusive one runs.
  399. expect(safe.pending()).toBe(0)
  400. unsafe.release()
  401. await expect.poll(() => safe.pending()).toBe(1)
  402. safe.releaseAll()
  403. await Promise.all([...reads, write, tail])
  404. return { logs: [], value: 'ordered' }
  405. }
  406. const result = await runCode(ctx, 'program')
  407. expect(result.isError).toBe(false)
  408. expect(safe.order.slice(0, 2)).toEqual(['start:r1', 'start:r2'])
  409. expect(unsafe.order).toEqual(['start:w', 'end:w'])
  410. // r3 started only after w ended.
  411. expect(safe.order.indexOf('start:r3')).toBeGreaterThan(safe.order.indexOf('end:r1'))
  412. })
  413. it('maxParallelSubCalls caps the overlap window', async () => {
  414. const { ctx, runtime } = await setup({ mode: 'code', maxParallelSubCalls: 2 })
  415. const gated = registerGated(ctx, 'safe_read', true)
  416. runtime.behavior = async (request) => {
  417. const tools = request.bindings[0]!.functions
  418. const all = Promise.all([
  419. tools.safe_read!({ id: 'a' }),
  420. tools.safe_read!({ id: 'b' }),
  421. tools.safe_read!({ id: 'c' }),
  422. ])
  423. await expect.poll(() => gated.pending()).toBe(2)
  424. // The third call waits for a slot.
  425. expect(gated.pending()).toBe(2)
  426. gated.release()
  427. await expect.poll(() => gated.pending()).toBe(2)
  428. gated.releaseAll()
  429. await all
  430. return { logs: [], value: 'capped' }
  431. }
  432. const result = await runCode(ctx, 'program')
  433. if (result.isError) console.error('CAP-FAIL:', (result.content[0] as { text: string }).text)
  434. expect(result.isError).toBe(false)
  435. expect(gated.peakLive()).toBe(2)
  436. })
  437. it('a tool unregistered between binding enumeration and dispatch fails as unknown tool', async () => {
  438. const { ctx, runtime } = await setup({ mode: 'code' })
  439. const calls: unknown[] = []
  440. const dispose = ctx.tools.register(defineTool({
  441. name: 'ephemeral',
  442. description: 'Unregistered between binding enumeration and dispatch.',
  443. parameters: {},
  444. output: {
  445. schema: { type: 'string' },
  446. render: (_args, value) => [{ type: 'text', text: value }],
  447. },
  448. execute() {
  449. calls.push('ran')
  450. return Promise.resolve('ok')
  451. },
  452. }))
  453. runtime.behavior = async (request) => {
  454. // The binding exists (enumerated at run start); the registry mutation
  455. // makes prepare resolve UNKNOWN_TOOL as a final-result, which commits
  456. // through scheduler.finish (no post-execute).
  457. dispose()
  458. const message = await request.bindings[0]!.functions.ephemeral!({})
  459. .then(() => 'resolved', (error: unknown) => error instanceof Error ? error.message : String(error))
  460. return { logs: [], value: message }
  461. }
  462. const result = await runCode(ctx, 'program')
  463. expect(result.isError).toBe(false)
  464. if (result.isError) throw new Error('expected success')
  465. expect(result.value).toMatchObject({ result: 'unknown tool "ephemeral"' })
  466. expect(calls).toEqual([])
  467. })
  468. it('post-execute and context commitment stay in submission order under out-of-order completion', async () => {
  469. const { ctx, runtime } = await setup({ mode: 'code' })
  470. const gated = registerGated(ctx, 'safe_read', true)
  471. const postOrder: string[] = []
  472. ctx.on('tools/post-execute', async (postExec, _result, next): Promise<PostToolDecision> => {
  473. if (postExec.name === 'safe_read') {
  474. postOrder.push(String(postExec.callId))
  475. return {
  476. kind: 'accept' as const,
  477. additionalContexts: [{
  478. content: [{ type: 'text' as const, text: `ctx:${String(postExec.callId)}` }],
  479. source: { kind: 'plugin' as const, plugin: 'order-probe' },
  480. }],
  481. }
  482. }
  483. return next()
  484. })
  485. runtime.behavior = async (request) => {
  486. const tools = request.bindings[0]!.functions
  487. const all = Promise.all([tools.safe_read!({ id: 'a' }), tools.safe_read!({ id: 'b' })])
  488. await expect.poll(() => gated.pending()).toBe(2)
  489. // Complete b FIRST (out of submission order), then a.
  490. gated.release() // releases a (FIFO gate) — invert: release twice reversed is not possible;
  491. gated.releaseAll()
  492. await all
  493. return { logs: [], value: 'ordered-commit' }
  494. }
  495. const result = await runCode(ctx, 'program')
  496. expect(result.isError).toBe(false)
  497. // Post-execute observed submission order regardless of completion interleave.
  498. expect(postOrder).toEqual(['call-1:code:1', 'call-1:code:2'])
  499. // Deferred contexts reach the outer result in the same order.
  500. expect(result.additionalContexts?.map(c => (c.content[0] as { text: string }).text))
  501. .toEqual(['ctx:call-1:code:1', 'ctx:call-1:code:2'])
  502. })
  503. it('a queued-unstarted call abandoned by run settlement logs no start event', async () => {
  504. const { ctx, runtime } = await setup({ mode: 'code' })
  505. const gated = registerGated(ctx, 'writer', false)
  506. const { agent, events } = fakeAgent()
  507. const abandoned: string[] = []
  508. runtime.behavior = async (request) => {
  509. const tools = request.bindings[0]!.functions
  510. // First exclusive call occupies the pool; the second queues unstarted.
  511. // Both rejections are captured (abandonment fires only at settlement,
  512. // AFTER this program has already failed — awaiting it here would deadlock).
  513. tools.writer!({ id: 'w1' }).catch(() => 'settled-under-abort')
  514. tools.writer!({ id: 'w2' }).catch((error: unknown) => {
  515. abandoned.push(error instanceof Error ? error.message : String(error))
  516. })
  517. await expect.poll(() => gated.pending()).toBe(1)
  518. // Fail the program while w1 is in flight and w2 is queued unstarted.
  519. throw new Error('program failed with a queued call')
  520. }
  521. const result = await runCode(ctx, 'program', { agent })
  522. expect(result.isError).toBe(true)
  523. const starts = events.filter(event => event.type === 'tool/code-dispatch-start').map(event => (event.data as { subCallId: string }).subCallId)
  524. const settles = events.filter(event => event.type === 'tool/code-dispatch').map(event => (event.data as { subCallId: string }).subCallId)
  525. // w1 started and settled under the abort; w2 never started and never
  526. // settled — no start event, no settle event, binding rejected with the
  527. // abandonment message at drain time.
  528. expect(starts).toEqual(['call-1:code:1'])
  529. expect(settles).toEqual(['call-1:code:1'])
  530. expect(abandoned).toEqual(['run_code run is over (run_code settled); writer tool call abandoned'])
  531. })
  532. })
  533. describe('the run_code dispatch bridge', () => {
  534. it('bridges tool calls, returns only the curated output, and logs one event per dispatch', async () => {
  535. const { ctx, runtime } = await setup({ mode: 'code' })
  536. const calls = registerEcho(ctx)
  537. const { agent, events } = fakeAgent()
  538. runtime.behavior = async (request) => {
  539. const tools = request.bindings[0]!.functions
  540. const first = await tools.echo!({ value: 'one' })
  541. const second = await tools.echo!({ value: 'two' })
  542. if (typeof first !== 'string' || typeof second !== 'string') throw new Error('echo returned a non-string')
  543. return { logs: [`saw ${first}`], value: second }
  544. }
  545. const result = await runCode(ctx, 'const …: string = …', { agent })
  546. expect(result.isError).toBe(false)
  547. if (result.isError) throw new Error('expected run_code success')
  548. expect(result.value).toEqual({ logs: ['saw echo:one'], result: 'echo:two' })
  549. expect(result.content).toEqual([{ type: 'text', text: 'saw echo:one\necho:two' }])
  550. expect(calls).toEqual([{ value: 'one' }, { value: 'two' }])
  551. const dispatches = events.filter(event => event.type === 'tool/code-dispatch')
  552. expect(dispatches.map(event => event.data)).toEqual([
  553. {
  554. parentCallId: 'call-1', subCallId: 'call-1:code:1', name: 'echo',
  555. arguments: { value: 'one' }, isError: false, content: [{ type: 'text', text: 'echo:one' }],
  556. },
  557. {
  558. parentCallId: 'call-1', subCallId: 'call-1:code:2', name: 'echo',
  559. arguments: { value: 'two' }, isError: false, content: [{ type: 'text', text: 'echo:two' }],
  560. },
  561. ])
  562. expect(result.meta).toBeUndefined()
  563. })
  564. it('exposes only an opaque parent token to nested result observers', async () => {
  565. const { ctx, runtime } = await setup({ mode: 'code' })
  566. registerEcho(ctx)
  567. runtime.behavior = async (request) => {
  568. await request.bindings[0]!.functions.echo!({ value: 'nested' })
  569. return { logs: [], value: 'done' }
  570. }
  571. // Freeze the nested observer's parent correlation. If that were the live
  572. // outer execution object, the timeout-style wrapper could not restore it.
  573. ctx.on('tools/execute', async (exec, next) => {
  574. if (exec.name !== RUN_CODE_NAME) return next()
  575. const previous = exec.signal
  576. exec.signal = new AbortController().signal
  577. const result = await next()
  578. exec.signal = previous
  579. return result
  580. })
  581. ctx.on('tools/result', (exec) => {
  582. if (exec.parent !== undefined) Object.freeze(exec.parent)
  583. })
  584. const result = await runCode(ctx, 'await tools.echo({ value: "nested" })')
  585. expect(result.isError).toBe(false)
  586. expect(result.content).toEqual([{ type: 'text', text: 'done' }])
  587. })
  588. it('serializes Promise.all dispatches: tool executions never overlap, in submission order', async () => {
  589. const { ctx, runtime } = await setup({ mode: 'code' })
  590. const intervals: [string, string][] = []
  591. let active = 0
  592. ctx.tools.register(defineTool({
  593. name: 'probe',
  594. description: 'Records execution overlap.',
  595. parameters: { id: { type: 'string', required: true } },
  596. output: {
  597. schema: { type: 'string' },
  598. render: (_args, value) => [{ type: 'text', text: value }],
  599. },
  600. async execute(args) {
  601. active++
  602. expect(active, 'probe executions overlapped').toBe(1)
  603. intervals.push(['enter', args.id])
  604. await new Promise(resolve => setTimeout(resolve, 20))
  605. intervals.push(['exit', args.id])
  606. active--
  607. return args.id
  608. },
  609. }))
  610. runtime.behavior = async (request) => {
  611. const tools = request.bindings[0]!.functions
  612. const values = await Promise.all([tools.probe!({ id: 'a' }), tools.probe!({ id: 'b' }), tools.probe!({ id: 'c' })])
  613. if (!values.every(value => typeof value === 'string')) throw new Error('probe returned a non-string')
  614. return { logs: [], value: values.join(',') }
  615. }
  616. const result = await runCode(ctx, 'program')
  617. expect(result.isError).toBe(false)
  618. expect(intervals).toEqual([
  619. ['enter', 'a'], ['exit', 'a'],
  620. ['enter', 'b'], ['exit', 'b'],
  621. ['enter', 'c'], ['exit', 'c'],
  622. ])
  623. expect(result.content[0]).toEqual({ type: 'text', text: 'a,b,c' })
  624. })
  625. it('rejects the program-side call when the tool errors, with the tool error text', async () => {
  626. const { ctx, runtime } = await setup({ mode: 'code' })
  627. ctx.tools.register(defineContentToolFixture({
  628. name: 'fail',
  629. description: 'Always fails.',
  630. parameters: {},
  631. execute(): Promise<never> { return Promise.reject(new Error('deliberate failure')) },
  632. }))
  633. runtime.behavior = async (request) => {
  634. try {
  635. await request.bindings[0]!.functions.fail!({})
  636. return { logs: [], value: 'unreachable' }
  637. } catch (error: unknown) {
  638. return { logs: [], value: `caught: ${error instanceof Error ? error.message : String(error)}` }
  639. }
  640. }
  641. const result = await runCode(ctx, 'program')
  642. expect(result.content[0]).toEqual({ type: 'text', text: 'caught: deliberate failure' })
  643. })
  644. it('a throwing tools/code-dispatch-log listener is contained: the unshaped content is logged', async () => {
  645. const { ctx, runtime } = await setup({ mode: 'code' })
  646. registerEcho(ctx)
  647. ctx.on('tools/code-dispatch-log', () => { throw new Error('shaper exploded') })
  648. const { agent, events } = fakeAgent()
  649. runtime.behavior = async (request) => {
  650. const value = await request.bindings[0]!.functions.echo!({ value: 'x' })
  651. return { logs: [], value: value as string }
  652. }
  653. const result = await runCode(ctx, 'program', { agent })
  654. expect(result.isError).toBe(false)
  655. const settle = events.find(event => event.type === 'tool/code-dispatch')
  656. expect(settle?.data).toMatchObject({ name: 'echo', isError: false, content: [{ type: 'text', text: 'echo:x' }] })
  657. })
  658. it('a throwing tools/pre-execute listener settles the sub-call without post-execute', async () => {
  659. const { ctx, runtime } = await setup({ mode: 'code' })
  660. const calls = registerEcho(ctx)
  661. const postExecuted: string[] = []
  662. ctx.on('tools/pre-execute', (exec, next) => {
  663. if (exec.name === 'echo') throw new Error('gate exploded')
  664. return next()
  665. })
  666. ctx.on('tools/post-execute', (exec, _result, next): Promise<PostToolDecision> => {
  667. if (exec.name === 'echo') postExecuted.push(exec.name)
  668. return next()
  669. })
  670. const { agent, events } = fakeAgent()
  671. runtime.behavior = async (request) => {
  672. const message = await request.bindings[0]!.functions.echo!({ value: 'x' })
  673. .then(() => 'resolved', (error: unknown) => error instanceof Error ? error.message : String(error))
  674. return { logs: [], value: message }
  675. }
  676. const result = await runCode(ctx, 'program', { agent })
  677. expect(result.isError).toBe(false)
  678. if (result.isError) throw new Error('expected success')
  679. expect(result.value).toMatchObject({ result: 'gate exploded' })
  680. // The pipeline failure is final: the body never ran and post-execute was
  681. // skipped, yet the settle event still carries the error outcome.
  682. expect(calls).toEqual([])
  683. expect(postExecuted).toEqual([])
  684. const settles = events.filter(event => event.type === 'tool/code-dispatch')
  685. expect(settles).toHaveLength(1)
  686. expect(settles[0]?.data).toMatchObject({ name: 'echo', isError: true })
  687. })
  688. it('a tools/pre-execute deny reaches the program as a binding rejection', async () => {
  689. const { ctx, runtime } = await setup({ mode: 'code' })
  690. registerEcho(ctx)
  691. ctx.on('tools/pre-execute', (exec, next) => {
  692. if (exec.name === 'echo') return Promise.resolve({ kind: 'deny' as const, reason: 'not on my watch' })
  693. return next()
  694. })
  695. runtime.behavior = async (request) => {
  696. try {
  697. await request.bindings[0]!.functions.echo!({ value: 'x' })
  698. return { logs: [], value: 'unreachable' }
  699. } catch (error: unknown) {
  700. return { logs: [], value: `denied: ${error instanceof Error ? error.message : String(error)}` }
  701. }
  702. }
  703. const result = await runCode(ctx, 'program')
  704. expect(result.content[0]?.type).toBe('text')
  705. expect((result.content[0] as { text: string }).text).toContain('not on my watch')
  706. })
  707. it('rejects a binding argument that is not lossless JSON, dispatching nothing', async () => {
  708. const { ctx, runtime } = await setup({ mode: 'code' })
  709. const calls = registerEcho(ctx)
  710. const { agent, events } = fakeAgent()
  711. runtime.behavior = async (request) => {
  712. try {
  713. await request.bindings[0]!.functions.echo!({ value: 'x', big: 1n })
  714. return { logs: [], value: 'unreachable' }
  715. } catch (error: unknown) {
  716. return { logs: [], value: error instanceof Error ? error.message : String(error) }
  717. }
  718. }
  719. const result = await runCode(ctx, 'program', { agent })
  720. expect((result.content[0] as { text: string }).text).toContain('lossless JSON')
  721. expect(calls).toEqual([])
  722. expect(events.filter(event => event.type === 'tool/code-dispatch')).toEqual([])
  723. })
  724. it('dispatches and logs independent snapshots of the same lossless JSON value', async () => {
  725. const { ctx, runtime } = await setup({ mode: 'code' })
  726. const calls = registerEcho(ctx)
  727. const { agent, events } = fakeAgent()
  728. runtime.behavior = async (request) => {
  729. const args = Object.assign(Object.create(null) as Record<string, unknown>, { value: 'x', nested: ['same'] })
  730. await request.bindings[0]!.functions.echo!(args)
  731. return { logs: [] }
  732. }
  733. await runCode(ctx, 'program', { agent })
  734. expect(calls).toEqual([{ value: 'x', nested: ['same'] }])
  735. const dispatch = events.find(event => event.type === 'tool/code-dispatch')?.data as SessionEventMap['tool/code-dispatch']
  736. expect(dispatch.arguments).toEqual({ value: 'x', nested: ['same'] })
  737. })
  738. it('defers sub-call additionalContexts onto the outer run_code result', async () => {
  739. const { ctx, runtime } = await setup({ mode: 'code' })
  740. registerEcho(ctx)
  741. ctx.on('tools/post-execute', (exec, _result, next): Promise<PostToolDecision> => {
  742. if (exec.name === 'echo') {
  743. return Promise.resolve({
  744. kind: 'accept' as const,
  745. additionalContexts: [{
  746. content: [{ type: 'text' as const, text: `context for ${exec.callId}` }],
  747. source: { kind: 'plugin' as const, plugin: 'test' },
  748. meta: { callId: exec.callId },
  749. }],
  750. })
  751. }
  752. return next()
  753. })
  754. runtime.behavior = async (request) => {
  755. await request.bindings[0]!.functions.echo!({ value: 'x' })
  756. await request.bindings[0]!.functions.echo!({ value: 'y' })
  757. return { logs: [], value: 'done' }
  758. }
  759. const result = await runCode(ctx, 'program')
  760. expect(result.isError).toBe(false)
  761. expect(result.additionalContexts).toEqual([
  762. {
  763. content: [{ type: 'text', text: 'context for call-1:code:1' }],
  764. source: { kind: 'plugin', plugin: 'test' },
  765. meta: { callId: 'call-1:code:1' },
  766. },
  767. {
  768. content: [{ type: 'text', text: 'context for call-1:code:2' }],
  769. source: { kind: 'plugin', plugin: 'test' },
  770. meta: { callId: 'call-1:code:2' },
  771. },
  772. ])
  773. })
  774. it('keeps sub-call contexts when run_code fails after the nested dispatch', async () => {
  775. const { ctx, runtime } = await setup({ mode: 'both' })
  776. registerEcho(ctx)
  777. ctx.on('tools/post-execute', (exec, _result, next): Promise<PostToolDecision> => {
  778. if (exec.name !== 'echo') return next()
  779. return Promise.resolve({
  780. kind: 'accept',
  781. additionalContexts: [{
  782. content: [{ type: 'text', text: 'nested context' }],
  783. source: { kind: 'plugin', plugin: 'test' },
  784. }],
  785. })
  786. })
  787. runtime.behavior = async (request) => {
  788. await request.bindings[0]!.functions.echo!({ value: 'x' })
  789. return { logs: [], error: { kind: 'exception', message: 'program failed later' } }
  790. }
  791. const result = await runCode(ctx, 'program')
  792. expect(result.isError).toBe(true)
  793. expect(result.additionalContexts).toEqual([{
  794. content: [{ type: 'text', text: 'nested context' }],
  795. source: { kind: 'plugin', plugin: 'test' },
  796. }])
  797. })
  798. it('converts a failed run into a structured isError result carrying kind, message, and captured logs', async () => {
  799. const { ctx, runtime } = await setup({ mode: 'code' })
  800. runtime.behavior = () => Promise.resolve({
  801. logs: ['got this far'],
  802. error: { kind: 'timeout', message: 'compute budget exhausted (300ms busy)' },
  803. })
  804. const result = await runCode(ctx, 'program')
  805. expect(result.isError).toBe(true)
  806. expect(result.error).toMatchObject({ info: { name: 'CodeRunFailedError', code: 'CODE_RUN_FAILED' } })
  807. const text = (result.content[0] as { text: string }).text
  808. expect(text).toContain('code run failed (timeout)')
  809. expect(text).toContain('compute budget exhausted')
  810. expect(text).toContain('got this far')
  811. })
  812. it('CodeRunFailedError is a HarnessError with the CODE_RUN_FAILED code', () => {
  813. const error = new CodeRunFailedError('boom')
  814. expect(error.code).toBe('CODE_RUN_FAILED')
  815. expect(error.name).toBe('CodeRunFailedError')
  816. })
  817. it('aborting the outer signal aborts the in-flight sub-dispatch and abandons queued ones', async () => {
  818. const { ctx, runtime } = await setup({ mode: 'code' })
  819. const seen: string[] = []
  820. let sawAbort = false
  821. ctx.tools.register(defineContentToolFixture({
  822. name: 'slow',
  823. description: 'Slow tool observing its signal.',
  824. parameters: { id: { type: 'string', required: true } },
  825. async execute(args, exec) {
  826. seen.push(args.id)
  827. await new Promise<void>((resolve) => {
  828. const timer = setTimeout(resolve, 500)
  829. exec.signal.addEventListener('abort', () => { sawAbort = true; clearTimeout(timer); resolve() }, { once: true })
  830. })
  831. return [{ type: 'text' as const, text: args.id }]
  832. },
  833. }))
  834. const controller = new AbortController()
  835. runtime.behavior = async (request) => {
  836. const tools = request.bindings[0]!.functions
  837. const calls = [tools.slow!({ id: 'first' }).catch(() => 'rejected'), tools.slow!({ id: 'second' }).catch(() => 'rejected')]
  838. setTimeout(() => { controller.abort('user-cancel') }, 50)
  839. await Promise.all(calls)
  840. // A real runtime would be terminated by the abort; the fake honors the
  841. // contract by reporting the abort as the run failure.
  842. return { logs: [], error: { kind: 'abort', message: 'user-cancel' } }
  843. }
  844. const result = await runCode(ctx, 'program', { signal: controller.signal })
  845. expect(result.isError).toBe(true)
  846. expect((result.content[0] as { text: string }).text).toContain('code run failed (abort)')
  847. expect(seen).toEqual(['first'])
  848. expect(sawAbort).toBe(true)
  849. })
  850. it('a runtime that starts a binding call and then REJECTS still reaches quiescence before returning', async () => {
  851. const { ctx, runtime } = await setup({ mode: 'code' })
  852. const { agent, events } = fakeAgent()
  853. let sawAbort = false
  854. let started!: () => void
  855. const inFlight = new Promise<void>((resolve) => { started = resolve })
  856. ctx.tools.register(defineContentToolFixture({
  857. name: 'slow',
  858. description: 'Slow tool observing its signal.',
  859. parameters: { id: { type: 'string', required: true } },
  860. async execute(args, exec) {
  861. started()
  862. await new Promise<void>((resolve) => {
  863. const timer = setTimeout(resolve, 500)
  864. exec.signal.addEventListener('abort', () => { sawAbort = true; clearTimeout(timer); resolve() }, { once: true })
  865. })
  866. return [{ type: 'text' as const, text: args.id }]
  867. },
  868. }))
  869. runtime.behavior = async (request) => {
  870. // Start a sub-dispatch, keep its rejection held, and fail the run once the tool is
  871. // genuinely in flight — a seam error after work has begun.
  872. request.bindings[0]!.functions.slow!({ id: 'orphan' }).catch(() => 'held')
  873. await inFlight
  874. throw new Error('backend exploded')
  875. }
  876. const result = await runCode(ctx, 'program', { agent })
  877. expect(result.isError).toBe(true)
  878. expect((result.content[0] as { text: string }).text).toContain('backend exploded')
  879. // Quiescence held: the in-flight sub-dispatch was aborted and its event
  880. // logged INSIDE the run_code execution, not after it returned.
  881. expect(sawAbort).toBe(true)
  882. expect(events.filter(event => event.type === 'tool/code-dispatch').map(event => (event.data as { name: string }).name)).toEqual(['slow'])
  883. })
  884. it('runs without an owning agent: dispatches work, event logging is skipped', async () => {
  885. const { ctx, runtime } = await setup({ mode: 'code' })
  886. const calls = registerEcho(ctx)
  887. runtime.behavior = async (request) => {
  888. await request.bindings[0]!.functions.echo!({ value: 'x' })
  889. return { logs: [], value: 'ok' }
  890. }
  891. const result = await runCode(ctx, 'program')
  892. expect(result.isError).toBe(false)
  893. expect(calls).toEqual([{ value: 'x' }])
  894. })
  895. it('executing run_code under a missing runtime is a structured isError, not a crash', async () => {
  896. const ctx = new Context()
  897. await ctx.plugin(SystemPrompt, {})
  898. await ctx.plugin(ToolRegistry, { mode: 'code' })
  899. const result = await runCode(ctx, 'program')
  900. expect(result.isError).toBe(true)
  901. expect((result.content[0] as { text: string }).text).toContain('requires a code runtime')
  902. })
  903. it('presents the model-authored description as the execute-card title over the program input', async () => {
  904. const { ctx } = await setup({ mode: 'code' })
  905. const tool = ctx.tools.get(RUN_CODE_NAME)!
  906. // The description labels the card (the bash description precedent); the
  907. // program itself remains the expanded raw input.
  908. expect(tool.presentCall?.({ code: 'return 1', description: 'Return the constant one' })).toEqual({
  909. card: 'generic',
  910. title: 'Return the constant one',
  911. kind: 'execute',
  912. rawInput: 'return 1',
  913. })
  914. })
  915. it('rejects a whitespace-only description with a structured isError', async () => {
  916. const { ctx } = await setup({ mode: 'code' })
  917. const result = await runCode(ctx, 'return 1', { description: ' ' })
  918. expect(result.isError).toBe(true)
  919. expect((result.content[0] as { text: string }).text).toContain('invalid description')
  920. })
  921. it.each([
  922. ['logs only', { logs: ['printed'] }, 'printed'],
  923. ['result only', { logs: [], value: 'returned' }, 'returned'],
  924. ['logs plus result', { logs: ['printed'], value: 'returned' }, 'printed\nreturned'],
  925. ['no output', { logs: [] }, '(run_code completed with no output)'],
  926. ] as [string, CodeRunResult, string][])('keeps %s in durable content without a result presenter', async (_name, output, text) => {
  927. const { ctx, runtime } = await setup({ mode: 'code' })
  928. runtime.behavior = () => Promise.resolve(output)
  929. const result = await runCode(ctx, 'return 1')
  930. const tool = ctx.tools.get(RUN_CODE_NAME)!
  931. expect(result.content).toEqual([{ type: 'text', text }])
  932. // Surfaces keep the pending program title and render this durable content
  933. // through their generic fallback. Omitting a result view also prevents the
  934. // host frame from carrying the same raw content a second time.
  935. expect('presentResult' in tool).toBe(false)
  936. })
  937. it('keeps a post-policy spill preview in durable content without a result presenter', async () => {
  938. const { ctx, runtime } = await setup({ mode: 'code' })
  939. const preview = 'HEAD\n\n(Omitted 100 bytes. Full formatted result stored at: /tmp/run-code.txt.)\n\nTAIL'
  940. runtime.behavior = () => Promise.resolve({ logs: ['printed'], value: 'returned' })
  941. ctx.on('tools/post-execute', (exec, _result, next): Promise<PostToolDecision> => {
  942. if (exec.name !== RUN_CODE_NAME) return next()
  943. return Promise.resolve({ kind: 'accept', content: [{ type: 'text', text: preview }] })
  944. })
  945. const result = await runCode(ctx, 'return 1')
  946. const tool = ctx.tools.get(RUN_CODE_NAME)!
  947. expect(result.content).toEqual([{ type: 'text', text: preview }])
  948. expect('presentResult' in tool).toBe(false)
  949. })
  950. it('keeps canonical failure content durable without a result presenter', async () => {
  951. const { ctx, runtime } = await setup({ mode: 'code' })
  952. runtime.behavior = () => Promise.resolve({
  953. logs: ['captured before failure'],
  954. error: { kind: 'output-limit', message: 'outer output exceeded 8 bytes' },
  955. })
  956. const result = await runCode(ctx, 'return 1')
  957. const tool = ctx.tools.get(RUN_CODE_NAME)!
  958. expect(result.isError).toBe(true)
  959. expect(result.content).toEqual([{
  960. type: 'text',
  961. text: 'Error: code run failed (output-limit): outer output exceeded 8 bytes\nCaptured output:\ncaptured before failure',
  962. }])
  963. expect('presentResult' in tool).toBe(false)
  964. })
  965. it('logs the complete sub-result content verbatim, non-text blocks and long text included', async () => {
  966. const { ctx, runtime } = await setup({ mode: 'code' })
  967. const { agent, events } = fakeAgent()
  968. const long = 'x'.repeat(300)
  969. ctx.tools.register(defineTool({
  970. name: 'mixed',
  971. description: 'Returns mixed content.',
  972. parameters: {},
  973. output: {
  974. schema: { type: 'string' },
  975. render: () => [
  976. { type: 'text', text: long },
  977. { type: 'reasoning', text: 'hidden' },
  978. ],
  979. },
  980. execute() {
  981. return Promise.resolve('mixed-value')
  982. },
  983. }))
  984. runtime.behavior = async (request) => {
  985. const value = await request.bindings[0]!.functions.mixed!({})
  986. return { logs: [], value }
  987. }
  988. const result = await runCode(ctx, 'program', { agent })
  989. expect(result.isError).toBe(false)
  990. expect((result.content[0] as { text: string }).text).toBe('mixed-value')
  991. const dispatch = events.find(event => event.type === 'tool/code-dispatch')?.data as SessionEventMap['tool/code-dispatch']
  992. expect(dispatch.content).toEqual([
  993. { type: 'text', text: long },
  994. { type: 'reasoning', text: 'hidden' },
  995. ])
  996. })
  997. it('rejects undefined, getter-throwing, exotic, and unrepresentable binding arguments before dispatch', async () => {
  998. const { ctx, runtime } = await setup({ mode: 'code' })
  999. const calls = registerEcho(ctx)
  1000. const { agent, events } = fakeAgent()
  1001. runtime.behavior = async (request) => {
  1002. const echo = request.bindings[0]!.functions.echo!
  1003. const catchMessage = (promise: Promise<unknown>) => promise.then(() => 'resolved', (error: unknown) => error instanceof Error ? error.message : String(error))
  1004. return {
  1005. logs: [],
  1006. value: [
  1007. // Root undefined must reject up front: the event log rejects it as
  1008. // data, and nothing may execute unlogged.
  1009. await catchMessage(echo(undefined)),
  1010. await catchMessage(echo(Object.defineProperty({}, 'bad', { enumerable: true, get() { throw 'raw-throw' } }))),
  1011. await catchMessage(echo(Object.defineProperty({}, 'bad', { enumerable: true, get() { throw new Error('error-throw') } }))),
  1012. await catchMessage(echo(new Date(0))),
  1013. // A bare function is a value JSON cannot represent at all.
  1014. await catchMessage(echo(() => 1)),
  1015. ].join(' | '),
  1016. }
  1017. }
  1018. const result = await runCode(ctx, 'program', { agent })
  1019. const text = (result.content[0] as { text: string }).text
  1020. expect(text).toContain('call the tool with an arguments object')
  1021. expect(text).toContain('lossless JSON: raw-throw')
  1022. expect(text).toContain('lossless JSON: error-throw')
  1023. expect(text.match(/tool arguments must be lossless JSON/g)).toHaveLength(5)
  1024. // None dispatched or logged.
  1025. expect(calls).toEqual([])
  1026. expect(events.filter(event => event.type === 'tool/code-dispatch')).toEqual([])
  1027. })
  1028. it('dispatches and durably logs binding arguments deeper than the structured-clone call stack', async () => {
  1029. const { ctx, runtime } = await setup({ mode: 'code' })
  1030. const depth = 5_000
  1031. let observedDepth = 0
  1032. let observedLeaf: JsonValue | undefined
  1033. ctx.tools.register(defineTool({
  1034. name: 'deep_args',
  1035. description: 'Measure a deeply nested JSON argument.',
  1036. parameters: { nested: { type: 'json', required: true } },
  1037. output: {
  1038. schema: { type: 'integer' },
  1039. render: (_args, value) => [{ type: 'text', text: String(value) }],
  1040. },
  1041. execute(args) {
  1042. let cursor = args.nested
  1043. while (Array.isArray(cursor)) {
  1044. if (cursor.length !== 1) throw new Error('expected one item per nesting layer')
  1045. observedDepth++
  1046. cursor = cursor[0]!
  1047. }
  1048. observedLeaf = cursor
  1049. return Promise.resolve(observedDepth)
  1050. },
  1051. }))
  1052. const session = new Session(SessionId('deep-code-arguments'))
  1053. const agent = { session } as Agent
  1054. runtime.behavior = async (request) => {
  1055. let nested: JsonValue = 'leaf'
  1056. for (let index = 0; index < depth; index++) nested = [nested]
  1057. const value = await request.bindings[0]!.functions.deep_args!({ nested })
  1058. return { logs: [], value }
  1059. }
  1060. const result = await runCode(ctx, 'return tools.deep_args(...)', { agent })
  1061. expect(result.isError).toBe(false)
  1062. expect(result.isError ? undefined : result.value).toEqual({ logs: [], result: depth })
  1063. expect({ observedDepth, observedLeaf }).toEqual({ observedDepth: depth, observedLeaf: 'leaf' })
  1064. const dispatch = session.events.find(event => event.type === 'tool/code-dispatch')
  1065. if (dispatch === undefined) throw new Error('expected a durable tool/code-dispatch event')
  1066. const logged = dispatch.data.arguments as { nested: JsonValue }
  1067. let loggedDepth = 0
  1068. let loggedCursor = logged.nested
  1069. while (Array.isArray(loggedCursor)) {
  1070. if (loggedCursor.length !== 1) throw new Error('expected one logged item per nesting layer')
  1071. loggedDepth++
  1072. loggedCursor = loggedCursor[0]!
  1073. }
  1074. expect({ loggedDepth, loggedCursor }).toEqual({ loggedDepth: depth, loggedCursor: 'leaf' })
  1075. })
  1076. it('gives the tool and durable log the same immutable argument value', async () => {
  1077. const { ctx, runtime } = await setup({ mode: 'code' })
  1078. const { agent, events } = fakeAgent()
  1079. let mutationSucceeded: boolean | undefined
  1080. ctx.tools.register(defineContentToolFixture({
  1081. name: 'mutator',
  1082. description: 'Attempts to mutate its args object.',
  1083. parameters: { list: { type: 'array', required: true } },
  1084. execute(args) {
  1085. mutationSucceeded = Reflect.set(args.list, 1, 'injected-by-tool')
  1086. return Promise.resolve([{ type: 'text' as const, text: 'protected' }])
  1087. },
  1088. }))
  1089. runtime.behavior = async (request) => {
  1090. await request.bindings[0]!.functions.mutator!({ list: ['original'] })
  1091. return { logs: [] }
  1092. }
  1093. const result = await runCode(ctx, 'program', { agent })
  1094. expect(result.isError).toBe(false)
  1095. expect(mutationSucceeded).toBe(false)
  1096. const dispatch = events.find(event => event.type === 'tool/code-dispatch')?.data as SessionEventMap['tool/code-dispatch']
  1097. expect(dispatch.arguments).toEqual({ list: ['original'] })
  1098. })
  1099. it('exposes a tool named __proto__ as an ordinary own binding', async () => {
  1100. const { ctx, runtime } = await setup({ mode: 'code' })
  1101. ctx.tools.register(defineTool({
  1102. name: '__proto__',
  1103. description: 'A prototype-colliding tool name.',
  1104. parameters: {},
  1105. output: {
  1106. schema: { type: 'string' },
  1107. render: (_args, value) => [{ type: 'text', text: value }],
  1108. },
  1109. execute() { return Promise.resolve('proto-tool-ok') },
  1110. }))
  1111. runtime.behavior = async (request) => {
  1112. const functions = request.bindings[0]!.functions
  1113. expect(Object.getPrototypeOf(functions)).toBeNull()
  1114. const value = await functions['__proto__']!({})
  1115. return { logs: [], value }
  1116. }
  1117. const result = await runCode(ctx, 'program')
  1118. expect(result.isError).toBe(false)
  1119. expect(result.content[0]).toEqual({ type: 'text', text: 'proto-tool-ok' })
  1120. })
  1121. it('renders every non-string JSON root as pretty JSON while preserving strings raw', async () => {
  1122. const { ctx, runtime } = await setup({ mode: 'code' })
  1123. runtime.behavior = () => Promise.resolve({ logs: [], value: { n: 42, ok: true } })
  1124. expect((await runCode(ctx, 'object')).content[0]).toEqual({ type: 'text', text: '{\n "n": 42,\n "ok": true\n}' })
  1125. runtime.behavior = () => Promise.resolve({ logs: [], value: {} })
  1126. expect((await runCode(ctx, 'empty object')).content[0]).toEqual({ type: 'text', text: '{}' })
  1127. const nested = { outer: [{ inner: true }] }
  1128. runtime.behavior = () => Promise.resolve({ logs: [], value: nested })
  1129. expect((await runCode(ctx, 'nested')).content[0]).toEqual({ type: 'text', text: JSON.stringify(nested, null, 2) })
  1130. runtime.behavior = () => Promise.resolve({ logs: [], value: ['x', 2] })
  1131. expect((await runCode(ctx, 'array')).content[0]).toEqual({ type: 'text', text: '[\n "x",\n 2\n]' })
  1132. runtime.behavior = () => Promise.resolve({ logs: [], value: [] })
  1133. expect((await runCode(ctx, 'empty array')).content[0]).toEqual({ type: 'text', text: '[]' })
  1134. runtime.behavior = () => Promise.resolve({ logs: [], value: null })
  1135. expect((await runCode(ctx, 'null')).content[0]).toEqual({ type: 'text', text: 'null' })
  1136. runtime.behavior = () => Promise.resolve({ logs: [], value: 'raw' })
  1137. expect((await runCode(ctx, 'string')).content[0]).toEqual({ type: 'text', text: 'raw' })
  1138. runtime.behavior = () => Promise.resolve({ logs: [] })
  1139. const absent = await runCode(ctx, 'undefined')
  1140. expect(absent.content[0]).toEqual({ type: 'text', text: '(run_code completed with no output)' })
  1141. expect(absent.isError ? undefined : absent.value).toEqual({ logs: [] })
  1142. })
  1143. it('renders deeply nested JSON without recursive traversal or quadratic indentation', async () => {
  1144. const { ctx, runtime } = await setup({ mode: 'code' })
  1145. let value: JsonValue = {
  1146. emptyArray: [],
  1147. emptyObject: {},
  1148. pair: ['leaf', 2],
  1149. record: { first: true, second: null },
  1150. }
  1151. for (let depth = 0; depth < 5_000; depth++) value = [value]
  1152. runtime.behavior = () => Promise.resolve({ logs: [], value })
  1153. const result = await runCode(ctx, 'deep result')
  1154. expect(result.isError).toBe(false)
  1155. const text = (result.content[0] as { type: 'text'; text: string }).text
  1156. expect(text.startsWith('[\n [\n [')).toBe(true)
  1157. expect(text).toContain('"leaf"')
  1158. expect(text.endsWith(']')).toBe(true)
  1159. expect(text.length).toBeLessThan(11_000)
  1160. })
  1161. it('short-circuits a pre-aborted outer signal before the code runtime', async () => {
  1162. const { ctx, runtime } = await setup({ mode: 'code' })
  1163. const calls = registerEcho(ctx)
  1164. runtime.behavior = (request) => {
  1165. // The fake honors the seam contract for an already-aborted signal.
  1166. if (request.signal?.aborted) return Promise.resolve({ logs: [], error: { kind: 'abort' as const, message: String(request.signal.reason) } })
  1167. return Promise.resolve({ logs: [], value: 'unreachable' })
  1168. }
  1169. const controller = new AbortController()
  1170. controller.abort('too-late')
  1171. const result = await runCode(ctx, 'program', { signal: controller.signal })
  1172. expect(result.isError).toBe(true)
  1173. expect(result).toEqual({
  1174. content: [{ type: 'text', text: 'Error: tool call aborted before dispatch' }],
  1175. isError: true,
  1176. error: {
  1177. message: 'tool call aborted before dispatch',
  1178. info: { name: 'AbortError', code: TOOL_ABORTED_BEFORE_DISPATCH },
  1179. },
  1180. })
  1181. expect(runtime.lastRequest).toBeUndefined()
  1182. expect(calls).toEqual([])
  1183. })
  1184. it('reports cancellation after rejecting a late binding without dispatching it', async () => {
  1185. const { ctx, runtime } = await setup({ mode: 'code' })
  1186. const calls = registerEcho(ctx)
  1187. const controller = new AbortController()
  1188. runtime.behavior = async (request) => {
  1189. controller.abort('cancelled-mid-run')
  1190. const message = await request.bindings[0]!.functions.echo!({ value: 'x' })
  1191. .then(() => 'resolved', (error: unknown) => error instanceof Error ? error.message : String(error))
  1192. return { logs: [], value: message }
  1193. }
  1194. const result = await runCode(ctx, 'program', { signal: controller.signal })
  1195. expect(result.isError).toBe(true)
  1196. expect(result.error).toEqual({
  1197. message: 'tool call aborted',
  1198. info: { name: 'AbortError', code: 'ABORTED' },
  1199. })
  1200. expect((result.content[0] as { text: string }).text).toBe('Error: tool call aborted')
  1201. expect(calls).toEqual([])
  1202. })
  1203. it('a tool/code-dispatch event never derives a model message', () => {
  1204. const session = new Session(SessionId('code-mode-derive'))
  1205. session.append('user/message', { content: [{ type: 'text', text: 'hi' }], source: { kind: 'user' } }, { surfaceOp: 'append' })
  1206. session.append('tool/code-dispatch', {
  1207. parentCallId: CallId('p1'),
  1208. subCallId: CallId('p1:code:1'),
  1209. name: 'echo',
  1210. arguments: { value: 'x' },
  1211. isError: false,
  1212. content: [{ type: 'text', text: 'echo:x' }],
  1213. })
  1214. const derived = session.deriveMessages()
  1215. expect(derived).toHaveLength(1)
  1216. expect(derived[0]?.role).toBe('user')
  1217. })
  1218. it('direct construction in code mode defaults the parallel sub-call cap', async () => {
  1219. const ctx = new Context()
  1220. await ctx.plugin(SystemPrompt, {})
  1221. const registry = new ToolRegistry(ctx, { mode: 'code' })
  1222. expect(registry.get(RUN_CODE_NAME)).toBeDefined()
  1223. })
  1224. it('defaults to native mode under direct construction with no config', async () => {
  1225. const ctx = new Context()
  1226. await ctx.plugin(SystemPrompt, {})
  1227. const registry = new ToolRegistry(ctx)
  1228. expect(registry.get(RUN_CODE_NAME)).toBeUndefined()
  1229. const assembly = await ctx.systemPrompt.assemble()
  1230. expect(assembly.sections.some(section => section.name === 'tools:sdk')).toBe(false)
  1231. })
  1232. })