| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791 |
- import { describe, expect, expectTypeOf, it } from 'vitest'
- import { Context } from '@deepseek-ai/cordis'
- import LlmRuntime, { createUserMessage, ToolCallId, HarnessError, type ContentBlock } from '@deepseek-ai/dsh-llm'
- import SessionStore, { Session, SessionId } from '@deepseek-ai/dsh-session'
- import SessionProjectionRegistry from '@deepseek-ai/dsh-session-projection'
- import SystemPrompt from '@deepseek-ai/dsh-system-prompt'
- import AgentRegistry, { type Agent } from '@deepseek-ai/dsh-agent'
- import AgentLoop from '@deepseek-ai/dsh-agent-loop'
- import ApprovalService, { type ApprovalOutcome, type ApprovalRequest } from '@deepseek-ai/dsh-user-approval'
- import ToolRuntime, {
- defineContentToolFixture, defineTool, JsonSchemaError, parameterSchemaSpecToJsonSchema, validateArgs, ToolArgsError, ToolNotFoundError,
- TOOL_ABORTED, TOOL_ABORTED_BEFORE_DISPATCH,
- type InferArgs, type ParameterSchemaSpec, type PreToolDecision, type PostToolDecision,
- type JsonSchemaNode, type ToolDefinition, type ToolDispatchExecution, type ToolExecutionResult, type ToolExecutionToken,
- } from '@deepseek-ai/dsh-tools'
- import type { JsonValue } from '@deepseek-ai/dsh-util-values'
- const testToolSignal = new AbortController().signal
- async function setup() {
- const ctx = new Context()
- await ctx.plugin(SystemPrompt)
- await ctx.plugin(ToolRuntime)
- return ctx
- }
- const echoTool = defineTool({
- name: 'echo',
- description: 'echo arguments back',
- parameters: { text: { type: 'string' } },
- output: {
- schema: { type: 'string' },
- render: (_args, value) => [{ type: 'text', text: value }],
- },
- async execute(args) {
- return args.text ?? ''
- },
- })
- describe('ToolRuntime', () => {
- it('registers tools, exposes schemas, and feeds the system-prompt assembly', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- expect(ctx.tools.schemas()).toEqual([{
- name: 'echo',
- description: 'echo arguments back',
- parameters: { type: 'object', properties: { text: { type: 'string' } } },
- }])
- // schemas() result must not leak execute — ToolSchema deliberately has no
- // 'execute' key, so widen through unknown to probe for the absent property
- expect((ctx.tools.schemas()[0] as unknown as Record<string, unknown>).execute).toBeUndefined()
- const assembly = await ctx.systemPrompt.assemble()
- expect(assembly.tools.map(t => t.name)).toEqual(['echo'])
- })
- it('schemas() drops host callbacks — they must never reach the model', async () => {
- const ctx = await setup()
- // Tool definitions contain output, finalization, execution, and presentation
- // callbacks. schemas() is an explicit allowlist so none can reach the model.
- ctx.tools.register(defineContentToolFixture({
- name: 'present',
- description: 'has presenters',
- parameters: { x: { type: 'string', required: true } },
- async execute() { return [] },
- finalizeContent: (_exec, result) => result.content,
- presentCall: args => ({ card: 'generic', title: args.x }),
- presentResult: (args, result) => ({ card: 'generic', title: args.x, content: result.content }),
- }))
- const schema = ctx.tools.schemas()[0] as unknown as Record<string, unknown>
- expect(Object.keys(schema).sort()).toEqual(['description', 'name', 'parameters'])
- expect(schema.finalizeContent).toBeUndefined()
- expect(schema.presentCall).toBeUndefined()
- expect(schema.presentResult).toBeUndefined()
- expect(schema.execute).toBeUndefined()
- })
- it('schemas() excludes timeoutMs — the budget must never reach the model', async () => {
- const ctx = await setup()
- ctx.tools.register(defineContentToolFixture({
- name: 'budgeted', description: 'has a budget', parameters: {}, timeoutMs: 5_000,
- async execute() { return [{ type: 'text' as const, text: 'ok' }] },
- }))
- const schema = ctx.tools.schemas().find(s => s.name === 'budgeted')
- expect(schema).toBeDefined()
- expect('timeoutMs' in (schema as object)).toBe(false)
- })
- it('executes a tool and returns its content', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- let observed: ToolExecutionResult | undefined
- ctx.on('tools/result', (_exec, result) => { observed = result })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result).toEqual({ content: [{ type: 'text', text: 'hi' }], isError: false, value: 'hi' })
- expect(observed).toEqual(result)
- })
- it('projects presentation metadata from the canonical value', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'meta-tool',
- output: {
- ...echoTool.output,
- presentationMeta: () => ({ diffs: [{ path: 'a', oldText: null, newText: 'x' }] }),
- },
- async execute() {
- return 'ok'
- },
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'meta-tool', arguments: {} })
- expect(result).toEqual({
- content: [{ type: 'text', text: 'ok' }],
- isError: false,
- meta: { diffs: [{ path: 'a', oldText: null, newText: 'x' }] },
- value: 'ok',
- })
- })
- it('omits meta when no presentation projector is declared', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'no-meta-tool',
- async execute() {
- return 'ok'
- },
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'no-meta-tool', arguments: {} })
- expect(result).toEqual({ content: [{ type: 'text', text: 'ok' }], isError: false, value: 'ok' })
- expect('meta' in result).toBe(false)
- })
- it('normalizes a contract-violating non-cloneable result before final notification', async () => {
- const ctx = await setup()
- let observedError: boolean | undefined
- ctx.on('tools/result', (_exec, result) => { observedError = result.isError })
- ctx.tools.register({
- ...echoTool,
- name: 'bad-meta',
- output: {
- ...echoTool.output,
- presentationMeta: () => (() => undefined) as unknown as JsonValue,
- },
- async execute() {
- return 'ok'
- },
- })
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('bad-meta'), name: 'bad-meta', arguments: {},
- })
- expect(result.isError).toBe(true)
- expect(result.content[0]?.type === 'text' && result.content[0].text).toContain('Error:')
- expect(result.error).toMatchObject({ info: { name: 'ToolOutputError', code: 'INVALID_TOOL_OUTPUT' } })
- expect(observedError).toBe(true)
- })
- it('finalizes errors discovered while snapshotting non-content result fields', async () => {
- const ctx = await setup()
- let finalizeCalls = 0
- ctx.tools.register({
- ...echoTool,
- name: 'throwing-meta',
- output: {
- ...echoTool.output,
- presentationMeta() {
- const meta = {}
- Object.defineProperty(meta, 'value', {
- enumerable: true,
- get() { throw new Error('snapshot failed: '.repeat(100)) },
- })
- return meta
- },
- },
- finalizeContent(_exec, result) {
- finalizeCalls += 1
- const block = result.content[0]
- if (block?.type !== 'text') return undefined
- return [{ type: 'text', text: block.text.slice(0, 32) }]
- },
- async execute() {
- return 'body'
- },
- })
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('throwing-meta'), name: 'throwing-meta', arguments: {},
- })
- expect(result.isError).toBe(true)
- const block = result.content[0]
- expect(block?.type).toBe('text')
- expect(block?.type === 'text' ? block.text : '').toMatch(/^Error: tool "throwing-meta"/)
- expect(block?.type === 'text' ? block.text : '').toHaveLength(32)
- expect(finalizeCalls).toBe(1)
- })
- it('normalizes a throwing final content callback without invoking it again', async () => {
- const ctx = await setup()
- let finalizeCalls = 0
- ctx.tools.register({
- ...echoTool,
- name: 'throwing-finalizer',
- finalizeContent() {
- finalizeCalls += 1
- throw new Error('finalizer violated its total contract')
- },
- })
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('throwing-finalizer'), name: 'throwing-finalizer', arguments: {},
- })
- expect(result).toEqual({
- content: [{ type: 'text', text: 'Error: finalizer violated its total contract' }],
- isError: true,
- error: { message: 'finalizer violated its total contract' },
- })
- expect(finalizeCalls).toBe(1)
- })
- it('requires every raw registration to declare its canonical output', async () => {
- const ctx = await setup()
- const missingOutput = {
- name: 'legacy-content-tool',
- description: 'missing output',
- parameters: {},
- execute: async () => [{ type: 'text', text: 'legacy' }],
- } as unknown as ToolDefinition
- expect(() => ctx.tools.register(missingOutput))
- .toThrow('must declare output { schema, render, presentationMeta? }')
- })
- it('rejects lossy and schema-mismatched body values before post-execute', async () => {
- const ctx = await setup()
- ctx.tools.register(defineTool({
- name: 'lossy-output',
- description: 'lossy',
- parameters: {},
- output: { schema: { type: 'json' }, render: () => [] },
- execute: async () => (() => undefined) as unknown as JsonValue,
- }))
- ctx.tools.register(defineTool({
- name: 'wrong-output',
- description: 'wrong schema',
- parameters: {},
- output: { schema: { type: 'string' }, render: () => [] },
- execute: async () => 42 as unknown as string,
- }))
- const lossy = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('lossy'), name: 'lossy-output', arguments: {} })
- const mismatch = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('mismatch'), name: 'wrong-output', arguments: {} })
- expect(lossy.error).toMatchObject({ info: { name: 'ToolOutputError', code: 'INVALID_TOOL_OUTPUT' } })
- expect(lossy.content[0]?.type === 'text' ? lossy.content[0].text : '').toContain('not lossless JSON')
- expect(mismatch.error).toMatchObject({ info: { name: 'ToolOutputError', code: 'INVALID_TOOL_OUTPUT' } })
- expect(mismatch.content[0]?.type === 'text' ? mismatch.content[0].text : '').toContain('"value" must be a string')
- })
- it('classifies a throwing body snapshot as invalid tool output', async () => {
- const ctx = await setup()
- const hostile = Object.defineProperty({}, 'value', {
- enumerable: true,
- get: () => { throw new Error('body snapshot getter exploded') },
- })
- ctx.tools.register(defineTool({
- name: 'hostile-body',
- description: 'hostile body',
- parameters: {},
- output: { schema: { type: 'json' }, render: () => [] },
- execute: async () => hostile as JsonValue,
- }))
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('hostile-body'), name: 'hostile-body', arguments: {},
- })
- expect(result.error?.message).toContain('value snapshot failed: body snapshot getter exploded')
- expect(result.error?.info).toEqual({ name: 'ToolOutputError', code: 'INVALID_TOOL_OUTPUT' })
- })
- it.each(['render', 'presentationMeta'] as const)('contains a throwing output.%s projector as one failed call', async (projector) => {
- const ctx = await setup()
- ctx.tools.register(defineTool({
- name: `throwing-${projector}`,
- description: projector,
- parameters: {},
- output: {
- schema: { type: 'string' },
- render: () => {
- if (projector === 'render') throw new Error('renderer exploded')
- return [{ type: 'text', text: 'ok' }]
- },
- presentationMeta: () => {
- if (projector === 'presentationMeta') throw new Error('metadata exploded')
- return null
- },
- },
- execute: async () => 'ok',
- }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId(projector), name: `throwing-${projector}`, arguments: {} })
- expect(result.isError).toBe(true)
- expect(result.error?.message)
- .toContain(projector === 'render' ? 'renderer exploded' : 'metadata exploded')
- expect(result.error?.info).toEqual({ name: 'ToolOutputError', code: 'INVALID_TOOL_OUTPUT' })
- expect('value' in result).toBe(false)
- })
- it.each(['render', 'presentationMeta'] as const)('contains a throwing output.%s snapshot as one failed call', async (projector) => {
- const ctx = await setup()
- const hostile = Object.defineProperty({}, 'value', {
- enumerable: true,
- get: () => { throw new Error('snapshot getter exploded') },
- })
- ctx.tools.register(defineTool({
- name: `hostile-${projector}`,
- description: projector,
- parameters: {},
- output: {
- schema: { type: 'string' },
- render: () => projector === 'render'
- ? hostile as unknown as ContentBlock[]
- : [{ type: 'text', text: 'ok' }],
- presentationMeta: () => projector === 'presentationMeta'
- ? hostile as unknown as JsonValue
- : null,
- },
- execute: async () => 'ok',
- }))
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId(`hostile-${projector}`), name: `hostile-${projector}`, arguments: {},
- })
- expect(result.error?.message).toContain('snapshot getter exploded')
- expect(result.error?.info).toEqual({ name: 'ToolOutputError', code: 'INVALID_TOOL_OUTPUT' })
- })
- it('keeps value/meta through content replacement and recomputes both projections after value replacement', async () => {
- const ctx = await setup()
- ctx.tools.register(defineTool({
- name: 'projected',
- description: 'projected',
- parameters: {},
- output: {
- schema: {
- type: 'object',
- additionalProperties: false,
- properties: { text: { type: 'string', required: true } },
- },
- render: (_args, value) => [{ type: 'text', text: `render:${value.text}` }],
- presentationMeta: (_args, value) => ({ projected: value.text }),
- },
- execute: async () => ({ text: 'body' }),
- }))
- let replacement: 'content' | 'value' = 'content'
- ctx.on('tools/post-execute', async () => {
- if (replacement === 'content') {
- return { kind: 'accept', content: [{ type: 'text', text: 'policy content' }] }
- }
- return {
- kind: 'accept',
- value: { text: 'policy value' },
- additionalContexts: [createUserMessage({
- content: [{ type: 'text', text: 'value context' }], source: { kind: 'plugin', plugin: 'test' },
- })],
- }
- })
- const content = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('content'), name: 'projected', arguments: {} })
- replacement = 'value'
- const value = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('value'), name: 'projected', arguments: {} })
- expect(content).toEqual({
- isError: false,
- value: { text: 'body' },
- content: [{ type: 'text', text: 'policy content' }],
- meta: { projected: 'body' },
- })
- expect(value).toEqual({
- isError: false,
- value: { text: 'policy value' },
- content: [{ type: 'text', text: 'render:policy value' }],
- meta: { projected: 'policy value' },
- additionalContexts: [{
- id: expect.any(String) as unknown,
- role: 'user',
- content: [{ type: 'text', text: 'value context' }],
- source: { kind: 'plugin', plugin: 'test' },
- }],
- })
- })
- it('fails a post-execute decision that replaces both projections or supplies an invalid value', async () => {
- const both = await setup()
- both.tools.register(echoTool)
- both.on('tools/post-execute', async () => ({
- kind: 'accept',
- value: 'replacement',
- content: [{ type: 'text', text: 'also replacement' }],
- } as unknown as PostToolDecision))
- const bothResult = await both.tools.execute({ signal: testToolSignal, callId: ToolCallId('both'), name: 'echo', arguments: {} })
- expect(bothResult).toMatchObject({
- isError: true,
- error: { message: 'tools/post-execute accept decision cannot replace both value and content' },
- })
- const invalid = await setup()
- invalid.tools.register(echoTool)
- invalid.on('tools/post-execute', async () => ({ kind: 'accept', value: 1 }))
- const invalidResult = await invalid.tools.execute({ signal: testToolSignal, callId: ToolCallId('invalid'), name: 'echo', arguments: {} })
- expect(invalidResult.error).toMatchObject({ info: { code: 'INVALID_TOOL_OUTPUT' } })
- expect('value' in invalidResult).toBe(false)
- })
- it('turns a post-execute block into a valueless failure', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async () => ({
- kind: 'block',
- feedback: [{ type: 'text', text: 'blocked by policy' }],
- }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('block'), name: 'echo', arguments: { text: 'secret' } })
- expect(result).toEqual({
- isError: true,
- error: { message: 'blocked by policy' },
- content: [{ type: 'text', text: 'blocked by policy' }],
- })
- expect('value' in result).toBe(false)
- })
- it('replaces a canonical value without manufacturing additional context', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async () => ({ kind: 'accept', value: 'replacement' }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('replace-value'), name: 'echo', arguments: {} })
- expect(result).toEqual({
- isError: false,
- value: 'replacement',
- content: [{ type: 'text', text: 'replacement' }],
- })
- })
- it.each([
- [[], 'tool result blocked by post-execute policy'],
- [[{ type: 'reasoning', text: 'private rationale' }], '[reasoning content]'],
- ] as const)('derives a stable failure message from non-text or empty block feedback', async (feedback, message) => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async () => ({ kind: 'block', feedback: [...feedback] }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('block-message'), name: 'echo', arguments: {} })
- expect(result.error?.message).toBe(message)
- })
- it('contains a non-JSON post-execute failure projection as a safe final error', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async () => ({
- kind: 'block',
- feedback: [{ type: 'text', text: 'blocked', invalid: () => undefined } as never],
- }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('invalid-block'), name: 'echo', arguments: {} })
- expect(result).toMatchObject({
- isError: true,
- error: { message: 'tool result must be losslessly JSON-serializable' },
- })
- })
- it('rejects value replacement on a failed dispatch', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'throw-before-replace',
- async execute() { throw new Error('body failed') },
- })
- ctx.on('tools/post-execute', async () => ({ kind: 'accept', value: 'replacement' }))
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('failed-replace'), name: 'throw-before-replace', arguments: {},
- })
- expect(result.error?.message).toBe('tools/post-execute cannot replace the value of a failed result')
- })
- it('fails value replacement when the owning tool disappears before post-policy resolves', async () => {
- const ctx = await setup()
- const dispose = ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async () => {
- dispose()
- return { kind: 'accept', value: 'replacement' }
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('post-disposed'), name: 'echo', arguments: {} })
- expect(result.error).toEqual({
- message: 'unknown tool "echo"',
- info: { name: 'ToolNotFoundError', code: 'UNKNOWN_TOOL' },
- })
- })
- it('normalizes wrapper-authored failure metadata and contexts', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/execute', async () => ({
- isError: true,
- error: { message: 'wrapped failure' },
- content: [{ type: 'text', text: 'wrapper content' }],
- meta: { wrapped: true },
- additionalContexts: [createUserMessage({
- content: [{ type: 'text', text: 'wrapper context' }], source: { kind: 'plugin', plugin: 'test' },
- })],
- }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('wrapper-failure'), name: 'echo', arguments: {} })
- expect(result).toEqual({
- isError: true,
- error: { message: 'wrapped failure' },
- content: [{ type: 'text', text: 'wrapper content' }],
- meta: { wrapped: true },
- additionalContexts: [{
- id: expect.any(String) as unknown,
- role: 'user',
- content: [{ type: 'text', text: 'wrapper context' }],
- source: { kind: 'plugin', plugin: 'test' },
- }],
- })
- })
- it('fails wrapper-authored success normalization when the owning tool disappears', async () => {
- const ctx = await setup()
- const dispose = ctx.tools.register(echoTool)
- ctx.on('tools/execute', async () => {
- dispose()
- return { isError: false, value: 'replacement', content: [] }
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('wrapper-disposed'), name: 'echo', arguments: {} })
- expect(result.error).toEqual({
- message: 'unknown tool "echo"',
- info: { name: 'ToolNotFoundError', code: 'UNKNOWN_TOOL' },
- })
- })
- it('suppresses presentation metadata only for nested composite dispatches', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'meta-suppression',
- output: { ...echoTool.output, presentationMeta: () => ({ card: true }) },
- })
- const direct = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('direct'), name: 'meta-suppression', arguments: {} })
- const nested = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('nested'),
- name: 'meta-suppression',
- arguments: {},
- parent: Symbol('outer') as ToolExecutionToken,
- })
- expect(direct.meta).toEqual({ card: true })
- expect(nested.meta).toBeUndefined()
- expect(nested.isError ? undefined : nested.value).toBe('')
- })
- it('carries a nested conclusion on the nested result for its composite to forward', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'terminal-nested',
- async execute(_args, exec) {
- exec.concludeTurn()
- return 'terminal'
- },
- })
- // A composite that forwards the marker from the nested result — the Code
- // Mode dispatch shape. A recovering composite (nested failure swallowed)
- // has no marker to forward: ToolExecutionFailure types concludesTurn as
- // never, so only an authoritative nested success can conclude the run.
- let call = 0
- ctx.tools.register({
- ...echoTool,
- name: 'composite',
- async execute(_args, exec) {
- call += 1
- const nested = await ctx.tools.execute({
- signal: exec.signal, callId: ToolCallId(`nested-${call}`), name: 'terminal-nested', arguments: {}, parent: exec.token,
- })
- if (nested.concludesTurn) exec.concludeTurn()
- return nested.isError ? 'nested failed, composite recovered' : 'nested succeeded'
- },
- })
- // A policy converts the nested success into an error: the failed result
- // carries no marker, so the recovering composite does not conclude.
- const veto = ctx.on('tools/post-execute', async (exec, _result, next): Promise<PostToolDecision> => {
- if (exec.name !== 'terminal-nested') return next()
- return { kind: 'block', feedback: [{ type: 'text', text: 'nested success rejected' }] }
- })
- const recovered = await ctx.tools.execute({
- signal: testToolSignal, callId: ToolCallId('composite-vetoed'), name: 'composite', arguments: {},
- })
- expect(recovered.isError).toBe(false)
- expect(recovered.concludesTurn).toBeUndefined()
- veto()
- // The same nested call succeeding carries the marker; the composite
- // forwards it onto its own successful result.
- const concluded = await ctx.tools.execute({
- signal: testToolSignal, callId: ToolCallId('composite-ok'), name: 'composite', arguments: {},
- })
- expect(concluded.isError).toBe(false)
- expect(concluded.concludesTurn).toBe(true)
- })
- it('returns isError results for unknown tools and throwing tools', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'boom',
- async execute() {
- throw new Error('exploded')
- },
- })
- const unknown = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'nope', arguments: {} })
- expect(unknown.isError).toBe(true)
- expect(unknown.content[0]).toMatchObject({ text: 'Error: unknown tool "nope"' })
- // An unknown tool is a routable failure class, same as a tool-thrown one.
- expect(unknown.error).toEqual({
- message: 'unknown tool "nope"',
- info: { name: 'ToolNotFoundError', code: 'UNKNOWN_TOOL' },
- })
- const thrown = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c2'), name: 'boom', arguments: {} })
- expect(thrown.isError).toBe(true)
- expect(thrown.content[0]).toMatchObject({ text: 'Error: exploded' })
- })
- it('normalizes a hostile thrown value whose inspection and coercion both throw', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'hostile-throw',
- async execute() {
- throw new Proxy({}, {
- getPrototypeOf: () => { throw new Error('prototype trap') },
- has: () => { throw new Error('has trap') },
- get: () => { throw new Error('get trap') },
- })
- },
- })
- await expect(ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('hostile'), name: 'hostile-throw', arguments: {},
- })).resolves.toMatchObject({
- isError: true,
- content: [{ type: 'text', text: 'Error: <unprintable thrown value>' }],
- })
- })
- it('ToolNotFoundError carries a stable message and code', async () => {
- const { HarnessError } = await import('@deepseek-ai/dsh-llm')
- const err = new ToolNotFoundError('ghost')
- expect(err).toBeInstanceOf(HarnessError)
- expect(err.name).toBe('ToolNotFoundError')
- expect(err.code).toBe('UNKNOWN_TOOL')
- expect(err.message).toBe('unknown tool "ghost"')
- })
- it('lets a tools/pre-execute listener deny a call (permission pattern)', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- let postSawFrozen = false
- ctx.on('tools/pre-execute', async (exec, next): Promise<PreToolDecision> => {
- if (exec.name === 'echo') return { kind: 'deny', reason: 'denied by policy' }
- return next()
- })
- ctx.on('tools/post-execute', async (_exec, result, next) => {
- postSawFrozen = Object.isFrozen(result)
- expect(Reflect.set(result, 'content', [])).toBe(false)
- return next()
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: denied by policy' })
- expect(postSawFrozen).toBe(true)
- })
- it('an ask decision degrades to deny when no approval seam is mounted', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> =>
- ({ kind: 'ask', reason: 'needs approval' }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: needs approval' })
- })
- it('an ask decision with no reason degrades to deny with a default message', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> => ({ kind: 'ask' }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: tool "echo" requires approval (not yet supported)' })
- })
- describe('ask routing through ctx.approval', () => {
- function fakeAgent(): Agent {
- const session = Session.create(SessionId('approval-fake-agent'))
- session.append('turn/start', { turn: 1 })
- return { session } as unknown as Agent
- }
- async function approvalSetup() {
- const ctx = new Context()
- await ctx.plugin(LlmRuntime)
- await ctx.plugin(SessionStore)
- await ctx.plugin(SessionProjectionRegistry)
- await ctx.plugin(SystemPrompt)
- await ctx.plugin(ToolRuntime)
- await ctx.plugin(AgentRegistry)
- await ctx.plugin(AgentLoop, { agents: [] })
- await ctx.plugin(ApprovalService)
- ctx.tools.register(echoTool)
- return ctx
- }
- it('dispatches the tool when the answerer grants allowed-once, forwarding the ask fields', async () => {
- const ctx = await approvalSetup()
- const agent = fakeAgent()
- const controller = new AbortController()
- const seen: ApprovalRequest[] = []
- ctx.on('approval/request', (req) => {
- seen.push(req)
- return Promise.resolve<ApprovalOutcome>('allowed-once')
- })
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> =>
- ({ kind: 'ask', reason: 'hook wants a human' }))
- const result = await ctx.tools.execute({
- callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' }, agent, signal: controller.signal,
- })
- expect(result).toMatchObject({ isError: false, content: [{ type: 'text', text: 'hi' }] })
- expect(seen).toHaveLength(1)
- expect(seen[0]).toMatchObject({ agent, toolName: 'echo', callId: 'c1', reason: 'hook wants a human' })
- expect(seen[0]?.signal).toBe(controller.signal)
- })
- it('denies with the user-rejection reason on rejected', async () => {
- const ctx = await approvalSetup()
- ctx.on('approval/request', () => Promise.resolve<ApprovalOutcome>('rejected'))
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> => ({ kind: 'ask' }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: {}, agent: fakeAgent() })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: the user rejected tool "echo"' })
- })
- it('denies with the cancellation reason on cancelled', async () => {
- const ctx = await approvalSetup()
- ctx.on('approval/request', () => Promise.resolve<ApprovalOutcome>('cancelled'))
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> => ({ kind: 'ask' }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: {}, agent: fakeAgent() })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: approval for tool "echo" was cancelled' })
- })
- it('returns ABORTED_BEFORE_DISPATCH when caller cancellation overtakes approval', async () => {
- const ctx = await approvalSetup()
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<ApprovalOutcome>()
- let dispatched = 0
- ctx.tools.register({
- ...echoTool,
- name: 'approval-probe',
- async execute() { dispatched += 1; return [] },
- })
- ctx.on('approval/request', () => {
- entered.resolve(undefined)
- return release.promise
- })
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> => ({ kind: 'ask' }))
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('approval-cancelled'),
- name: 'approval-probe',
- arguments: {},
- agent: fakeAgent(),
- signal: controller.signal,
- })
- await entered.promise
- controller.abort('caller cancelled approval')
- release.resolve('allowed-once')
- await expect(pending).resolves.toMatchObject({
- isError: true,
- error: { info: { name: 'AbortError', code: TOOL_ABORTED_BEFORE_DISPATCH } },
- })
- expect(dispatched).toBe(0)
- })
- it('denies with the no-channel reason when the seam is mounted but nobody answers', async () => {
- const ctx = await approvalSetup()
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> => ({ kind: 'ask' }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: {}, agent: fakeAgent() })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: tool "echo" requires approval, but no approval channel is available' })
- })
- it('denies an agent-less execution without asking — nothing to route or audit through', async () => {
- const ctx = await approvalSetup()
- let asked = false
- ctx.on('approval/request', () => {
- asked = true
- return Promise.resolve<ApprovalOutcome>('allowed-once')
- })
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> => ({ kind: 'ask' }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: {} })
- expect(asked).toBe(false)
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: tool "echo" requires approval, but the call has no agent to route it through' })
- })
- it('turns a rogue outcome from a NON-conforming approval stand-in into an isError result', async () => {
- // ApprovalService normalizes rogue answers itself; this pins the
- // registry's own exhaustiveness backstop by shadowing the service with a
- // stand-in that violates the outcome contract.
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.provide('approval', { request: () => Promise.resolve('yolo') } as unknown as ApprovalService)
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> => ({ kind: 'ask' }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: {}, agent: fakeAgent() })
- expect(result.isError).toBe(true)
- const text = result.content[0]?.type === 'text' ? result.content[0].text : ''
- expect(text).toContain('unreachable')
- })
- })
- it('a tools/post-execute listener can replace the result content (accept) ', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async (_exec, _result, _next): Promise<PostToolDecision> =>
- ({ kind: 'accept', content: [{ type: 'text', text: 'rewritten' }] }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result.isError).toBe(false)
- expect(result.content[0]).toMatchObject({ text: 'rewritten' })
- })
- it('a tools/post-execute block turns the call into an isError with corrective feedback', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async (_exec, _result, _next): Promise<PostToolDecision> =>
- ({ kind: 'block', feedback: [{ type: 'text', text: 'output rejected: try again' }] }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'output rejected: try again' })
- })
- it('runs the snapshotted final content transform after outer pipeline normalization', async () => {
- const ctx = await setup()
- const dispose = ctx.tools.register(defineContentToolFixture({
- name: 'bounded',
- description: 'bounded result',
- parameters: {},
- async execute() { return [{ type: 'text', text: 'body' }] },
- finalizeContent(exec, result) {
- expect(exec.name).toBe('bounded')
- expect(result.isError).toBe(true)
- return [{ type: 'text', text: 'bounded failure' }]
- },
- }))
- ctx.on('tools/pre-execute', async () => {
- dispose()
- throw new HarnessError('policy failed', 'POLICY_FAILED')
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('bounded'), name: 'bounded', arguments: {} })
- expect(result).toEqual({
- content: [{ type: 'text', text: 'bounded failure' }],
- isError: true,
- error: {
- message: 'policy failed',
- info: { name: 'HarnessError', code: 'POLICY_FAILED' },
- },
- })
- })
- it('keeps the normalized content when the final content transform returns undefined', async () => {
- const ctx = await setup()
- let finalized = 0
- ctx.tools.register({
- ...echoTool,
- name: 'identity-finalizer',
- finalizeContent() {
- finalized += 1
- return undefined
- },
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('identity-finalizer'), name: 'identity-finalizer', arguments: {} })
- expect(result.isError).toBe(false)
- expect(result.content).toEqual([{ type: 'text', text: '' }])
- expect(finalized).toBe(1)
- })
- it('a block decision can ALSO attach additionalContexts', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async (_exec, _result, _next): Promise<PostToolDecision> =>
- ({
- kind: 'block',
- feedback: [{ type: 'text', text: 'rejected' }],
- additionalContexts: [createUserMessage({
- content: [{ type: 'text', text: 'why it was rejected' }], source: { kind: 'plugin', plugin: 'test' },
- })],
- }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'rejected' })
- expect(result.additionalContexts).toMatchObject([{ content: [{ text: 'why it was rejected' }], source: { kind: 'plugin', plugin: 'test' } }])
- })
- it('post-execute additionalContexts ride on the result for the loop to buffer', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async (_exec, _result, _next): Promise<PostToolDecision> =>
- ({ kind: 'accept', additionalContexts: [createUserMessage({
- content: [{ type: 'text', text: 'fyi' }], source: { kind: 'plugin', plugin: 'test' },
- })] }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result.additionalContexts).toMatchObject([{ content: [{ text: 'fyi' }], source: { kind: 'plugin', plugin: 'test' } }])
- })
- it('preserves tool-deferred, execute-wrapper, and post-execute contexts in order', async () => {
- const ctx = await setup()
- ctx.tools.register(defineContentToolFixture({
- name: 'composite',
- description: 'composite',
- parameters: {},
- async execute(_args, exec) {
- exec.deferContext(createUserMessage({
- content: [{ type: 'text', text: 'nested-1' }], source: { kind: 'plugin', plugin: 'nested-1' },
- }))
- exec.deferContext(createUserMessage({
- content: [{ type: 'text', text: 'nested-2' }], source: { kind: 'plugin', plugin: 'nested-2' },
- }))
- return [{ type: 'text', text: 'done' }]
- },
- }))
- ctx.on('tools/execute', async (_exec, next) => {
- const result = await next()
- return {
- ...result,
- additionalContexts: [
- ...result.additionalContexts ?? [],
- createUserMessage({
- content: [{ type: 'text', text: 'wrapper' }], source: { kind: 'plugin', plugin: 'wrapper' },
- }),
- ],
- }
- })
- ctx.on('tools/post-execute', async (_exec, _result, next): Promise<PostToolDecision> => {
- const downstream = await next()
- return {
- ...downstream,
- additionalContexts: [
- createUserMessage({
- content: [{ type: 'text', text: 'post' }], source: { kind: 'plugin', plugin: 'post' },
- }),
- ...downstream.additionalContexts ?? [],
- ],
- }
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('composite'), name: 'composite', arguments: {} })
- expect(result.additionalContexts?.map(context => context.source)).toEqual([
- { kind: 'plugin', plugin: 'nested-1' },
- { kind: 'plugin', plugin: 'nested-2' },
- { kind: 'plugin', plugin: 'wrapper' },
- { kind: 'plugin', plugin: 'post' },
- ])
- })
- it('keeps deferred contexts when a composite tool throws, but drops them when the outer call is blocked', async () => {
- const ctx = await setup()
- ctx.tools.register(defineContentToolFixture({
- name: 'failing-composite',
- description: 'failing composite',
- parameters: {},
- async execute(_args, exec) {
- exec.deferContext(createUserMessage({
- content: [{ type: 'text', text: 'nested' }], source: { kind: 'plugin', plugin: 'nested' },
- }))
- throw new Error('outer failure')
- },
- }))
- const failed = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('failed'), name: 'failing-composite', arguments: {} })
- expect(failed.isError).toBe(true)
- expect(failed.additionalContexts?.map(context => context.source)).toEqual([{ kind: 'plugin', plugin: 'nested' }])
- ctx.on('tools/post-execute', async (): Promise<PostToolDecision> => ({
- kind: 'block',
- feedback: [{ type: 'text', text: 'blocked' }],
- additionalContexts: [createUserMessage({
- content: [{ type: 'text', text: 'block-only' }], source: { kind: 'plugin', plugin: 'blocker' },
- })],
- }))
- const blocked = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('blocked'), name: 'failing-composite', arguments: {} })
- expect(blocked.isError).toBe(true)
- expect(blocked.additionalContexts?.map(context => context.source)).toEqual([{ kind: 'plugin', plugin: 'blocker' }])
- })
- it('composes pre + post waterfalls around dispatch (sandbox-wrap pattern)', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- const order: string[] = []
- ctx.on('tools/pre-execute', async (_exec, next) => {
- order.push('pre:before')
- const decision = await next()
- order.push('pre:after')
- return decision
- })
- ctx.on('tools/post-execute', async (_exec, _result, next) => {
- order.push('post:before')
- const decision = await next()
- order.push('post:after')
- return decision
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'x' } })
- expect(result.isError).toBe(false)
- // pre runs fully (gate) before dispatch, then post runs over the result.
- expect(order).toEqual(['pre:before', 'pre:after', 'post:before', 'post:after'])
- })
- it('runs tools/execute after an allowed pre-execute, around dispatch, and before post-execute', async () => {
- const ctx = await setup()
- const order: string[] = []
- ctx.tools.register(defineContentToolFixture({
- name: 'traced',
- description: 'echo',
- parameters: { text: { type: 'string' } },
- async execute(args) {
- order.push('dispatch')
- return [{ type: 'text' as const, text: args.text ?? '' }]
- },
- }))
- ctx.on('tools/pre-execute', async (_exec, next) => { order.push('pre'); return next() })
- ctx.on('tools/execute', async (_exec: ToolDispatchExecution, next: () => Promise<ToolExecutionResult>): Promise<ToolExecutionResult> => {
- order.push('execute:before')
- const result = await next()
- order.push('execute:after')
- return result
- })
- ctx.on('tools/post-execute', async (_exec, _result, next) => { order.push('post'); return next() })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'traced', arguments: { text: 'hi' } })
- expect(result).toEqual({ content: [{ type: 'text', text: 'hi' }], isError: false, value: [{ type: 'text', text: 'hi' }] })
- // The around-dispatch extension point wraps dispatch; pre gates before it, post runs over its result.
- expect(order).toEqual(['pre', 'execute:before', 'dispatch', 'execute:after', 'post'])
- })
- it('skips dispatch when caller cancellation arrives while pre-execute awaits', async () => {
- const ctx = await setup()
- let dispatched = 0
- ctx.tools.register({
- ...echoTool,
- name: 'must-not-run',
- async execute() { dispatched += 1; return [] },
- })
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<undefined>()
- ctx.on('tools/pre-execute', async (_exec, next) => {
- entered.resolve(undefined)
- await release.promise
- return await next()
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('cancelled-in-pre'), name: 'must-not-run', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled in policy')
- release.resolve(undefined)
- await expect(pending).resolves.toMatchObject({
- content: [{ type: 'text', text: 'Error: tool call aborted before dispatch' }],
- isError: true,
- error: { info: { name: 'AbortError', code: TOOL_ABORTED_BEFORE_DISPATCH } },
- })
- expect(dispatched).toBe(0)
- })
- it('preserves a pre-execute denial that settles after cancellation', async () => {
- const ctx = await setup()
- let dispatched = 0
- ctx.tools.register({
- ...echoTool,
- name: 'denied-after-cancel',
- async execute() { dispatched += 1; return [] },
- })
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<undefined>()
- ctx.on('tools/pre-execute', async () => {
- entered.resolve(undefined)
- await release.promise
- return { kind: 'deny', reason: 'policy denied the call' }
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('denied-after-cancel'), name: 'denied-after-cancel', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled while policy decided')
- release.resolve(undefined)
- await expect(pending).resolves.toEqual({
- content: [{ type: 'text', text: 'Error: policy denied the call' }],
- isError: true,
- error: { message: 'policy denied the call' },
- })
- expect(dispatched).toBe(0)
- })
- it('preserves an async pre-execute failure that settles after cancellation', async () => {
- const ctx = await setup()
- let dispatched = 0
- ctx.tools.register({
- ...echoTool,
- name: 'must-not-run',
- async execute() { dispatched += 1; return [] },
- })
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<undefined>()
- ctx.on('tools/pre-execute', async () => {
- entered.resolve(undefined)
- await release.promise
- throw new Error('gate interrupted')
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('cancelled-pre-error'), name: 'must-not-run', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled in policy')
- release.resolve(undefined)
- await expect(pending).resolves.toEqual({
- content: [{ type: 'text', text: 'Error: gate interrupted' }],
- isError: true,
- error: { message: 'gate interrupted' },
- })
- expect(dispatched).toBe(0)
- })
- it('rechecks caller cancellation after an async around-dispatch wrapper delegates', async () => {
- const ctx = await setup()
- let dispatched = 0
- ctx.tools.register({
- ...echoTool,
- name: 'must-not-run',
- async execute() { dispatched += 1; return [] },
- })
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<undefined>()
- const replacement = new AbortController()
- ctx.on('tools/execute', async (exec, next) => {
- const upstream = exec.signal
- exec.signal = replacement.signal
- try {
- entered.resolve(undefined)
- await release.promise
- return await next()
- } finally {
- exec.signal = upstream
- }
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('cancelled-in-around'), name: 'must-not-run', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled in wrapper')
- release.resolve(undefined)
- await expect(pending).resolves.toMatchObject({
- isError: true,
- error: { info: { name: 'AbortError', code: TOOL_ABORTED_BEFORE_DISPATCH } },
- })
- expect(dispatched).toBe(0)
- })
- it('skips dispatch when an around wrapper supplies an already-aborted signal', async () => {
- const ctx = await setup()
- let dispatched = 0
- ctx.tools.register({
- ...echoTool,
- name: 'must-not-run',
- async execute() { dispatched += 1; return [] },
- })
- const replacement = AbortSignal.abort('wrapper cancelled')
- ctx.on('tools/execute', async (exec, next) => {
- const upstream = exec.signal
- exec.signal = replacement
- try {
- return await next()
- } finally {
- exec.signal = upstream
- }
- })
- const controller = new AbortController()
- const result = await ctx.tools.execute({
- callId: ToolCallId('cancelled-wrapper'), name: 'must-not-run', arguments: {}, signal: controller.signal,
- })
- expect(result.error).toEqual({
- message: 'tool call aborted before dispatch',
- info: { name: 'AbortError', code: TOOL_ABORTED_BEFORE_DISPATCH },
- })
- expect(dispatched).toBe(0)
- })
- it('uses ABORTED_BEFORE_DISPATCH when cancellation overtakes a wrapper short-circuit', async () => {
- const ctx = await setup()
- let dispatched = 0
- ctx.tools.register({
- ...echoTool,
- name: 'short-circuited',
- async execute() { dispatched += 1; return [] },
- })
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<undefined>()
- ctx.on('tools/execute', async () => {
- entered.resolve(undefined)
- await release.promise
- return {
- value: 'wrapper success',
- content: [{ type: 'text', text: 'wrapper success' }],
- isError: false,
- additionalContexts: [createUserMessage({
- content: [{ type: 'text', text: 'wrapper context' }],
- source: { kind: 'plugin', plugin: 'wrapper' },
- })],
- }
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('cancelled-short-circuit'),
- name: 'short-circuited',
- arguments: {},
- signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled while wrapper waited')
- release.resolve(undefined)
- await expect(pending).resolves.toMatchObject({
- content: [{ type: 'text', text: 'Error: tool call aborted before dispatch' }],
- isError: true,
- error: { info: { name: 'AbortError', code: TOOL_ABORTED_BEFORE_DISPATCH } },
- additionalContexts: [{ source: { kind: 'plugin', plugin: 'wrapper' } }],
- })
- expect(dispatched).toBe(0)
- })
- it('replaces a late wrapper success with ABORTED and preserves deferred contexts', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'completed-before-wrapper',
- async execute(_args, exec) {
- exec.deferContext(createUserMessage({
- content: [{ type: 'text', text: 'completed child work' }],
- source: { kind: 'plugin', plugin: 'child' },
- }))
- return 'body complete'
- },
- })
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<undefined>()
- ctx.on('tools/execute', async (_exec, next) => {
- const result = await next()
- entered.resolve(undefined)
- await release.promise
- return result
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('cancelled-after-body'), name: 'completed-before-wrapper', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled while wrapper settled')
- release.resolve(undefined)
- await expect(pending).resolves.toMatchObject({
- content: [{ type: 'text', text: 'Error: tool call aborted' }],
- isError: true,
- error: { info: { name: 'AbortError', code: TOOL_ABORTED } },
- additionalContexts: [{ source: { kind: 'plugin', plugin: 'child' } }],
- })
- })
- it('replaces a late post-execute success with ABORTED and preserves contexts', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'completed-before-post',
- async execute(_args, exec) {
- exec.deferContext(createUserMessage({
- content: [{ type: 'text', text: 'completed child work' }],
- source: { kind: 'plugin', plugin: 'child' },
- }))
- return 'body complete'
- },
- })
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<undefined>()
- ctx.on('tools/post-execute', async (_exec, _result, next) => {
- const decision = await next()
- entered.resolve(undefined)
- await release.promise
- return {
- ...decision,
- additionalContexts: [createUserMessage({
- content: [{ type: 'text', text: 'post context' }],
- source: { kind: 'plugin', plugin: 'post' },
- })],
- }
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('cancelled-in-post'), name: 'completed-before-post', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled while post policy waits')
- release.resolve(undefined)
- await expect(pending).resolves.toMatchObject({
- content: [{ type: 'text', text: 'Error: tool call aborted' }],
- isError: true,
- error: { info: { name: 'AbortError', code: TOOL_ABORTED } },
- additionalContexts: [
- { source: { kind: 'plugin', plugin: 'child' } },
- { source: { kind: 'plugin', plugin: 'post' } },
- ],
- })
- })
- it('preserves an around-dispatch failure that settles after cancellation', async () => {
- const ctx = await setup()
- let dispatched = 0
- ctx.tools.register({
- ...echoTool,
- name: 'wrapper-failure',
- async execute() { dispatched += 1; return [] },
- })
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<undefined>()
- ctx.on('tools/execute', async () => {
- entered.resolve(undefined)
- await release.promise
- throw new HarnessError('wrapper failed', 'WRAPPER_FAILURE')
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('wrapper-failure'), name: 'wrapper-failure', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled while wrapper failed')
- release.resolve(undefined)
- await expect(pending).resolves.toMatchObject({
- content: [{ type: 'text', text: 'Error: wrapper failed' }],
- isError: true,
- error: { info: { name: 'HarnessError', code: 'WRAPPER_FAILURE' } },
- })
- expect(dispatched).toBe(0)
- })
- it('preserves a tool-owned failure after the body observes cancellation', async () => {
- const ctx = await setup()
- const entered = Promise.withResolvers<undefined>()
- ctx.tools.register({
- ...echoTool,
- name: 'tool-failure',
- execute(_args, exec) {
- entered.resolve(undefined)
- return new Promise<never>((_resolve, reject) => {
- exec.signal.addEventListener('abort', () => {
- reject(new HarnessError('tool failed', 'TOOL_FAILURE'))
- }, { once: true })
- })
- },
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('tool-failure'), name: 'tool-failure', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled running body')
- await expect(pending).resolves.toMatchObject({
- content: [{ type: 'text', text: 'Error: tool failed' }],
- isError: true,
- error: { info: { name: 'HarnessError', code: 'TOOL_FAILURE' } },
- })
- })
- it('preserves a post-policy failure that settles after cancellation', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<undefined>()
- ctx.on('tools/post-execute', async () => {
- entered.resolve(undefined)
- await release.promise
- throw new HarnessError('post-policy failed', 'POST_FAILURE')
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('post-failure'), name: 'echo', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('cancelled while post-policy failed')
- release.resolve(undefined)
- await expect(pending).resolves.toMatchObject({
- content: [{ type: 'text', text: 'Error: post-policy failed' }],
- isError: true,
- error: { info: { name: 'HarnessError', code: 'POST_FAILURE' } },
- })
- })
- it('fuses caller cancellation back into a wrapper replacement for the running body', async () => {
- const ctx = await setup()
- const entered = Promise.withResolvers<undefined>()
- const replacement = new AbortController()
- let bodySignal: AbortSignal | undefined
- ctx.tools.register({
- ...echoTool,
- name: 'cooperative',
- execute(_args, exec) {
- bodySignal = exec.signal
- entered.resolve(undefined)
- if (exec.signal.aborted) return Promise.resolve('stopped')
- return new Promise<string>((resolve) => {
- exec.signal.addEventListener('abort', () => { resolve('stopped') }, { once: true })
- })
- },
- })
- ctx.on('tools/execute', async (exec, next) => {
- const upstream = exec.signal
- exec.signal = replacement.signal
- try {
- return await next()
- } finally {
- exec.signal = upstream
- }
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('cancelled-body'), name: 'cooperative', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- expect(bodySignal).not.toBe(controller.signal)
- expect(bodySignal).not.toBe(replacement.signal)
- controller.abort('cancel running body')
- await expect(pending).resolves.toMatchObject({
- isError: true,
- error: { info: { name: 'AbortError', code: TOOL_ABORTED } },
- })
- expect(bodySignal?.aborted).toBe(true)
- expect(replacement.signal.aborted).toBe(false)
- })
- it('restores the required caller signal after around dispatch', async () => {
- const ctx = await setup()
- let postSignal: AbortSignal | undefined
- ctx.on('tools/execute', async (exec, next) => {
- const upstream = exec.signal
- exec.signal = new AbortController().signal
- try {
- return await next()
- } finally {
- exec.signal = upstream
- }
- })
- ctx.on('tools/post-execute', async (exec, _result, next) => {
- postSignal = exec.signal
- return next()
- })
- const controller = new AbortController()
- await ctx.tools.execute({
- callId: ToolCallId('restored-signal'), name: 'echo', arguments: {}, signal: controller.signal,
- })
- expect(postSignal).toBe(controller.signal)
- })
- it('waits for an uncooperative started body before returning ABORTED', async () => {
- const ctx = await setup()
- const entered = Promise.withResolvers<undefined>()
- const release = Promise.withResolvers<string>()
- ctx.tools.register({
- ...echoTool,
- name: 'uncooperative',
- execute(_args, exec) {
- exec.deferContext(createUserMessage({
- content: [{ type: 'text', text: 'nested outcome' }],
- source: { kind: 'plugin', plugin: 'nested' },
- }))
- entered.resolve(undefined)
- return release.promise
- },
- })
- const controller = new AbortController()
- const pending = ctx.tools.execute({
- callId: ToolCallId('drain-body'), name: 'uncooperative', arguments: {}, signal: controller.signal,
- })
- await entered.promise
- controller.abort('must still drain')
- const state = await Promise.race([
- pending.then(() => 'settled' as const),
- Promise.resolve('pending' as const),
- ])
- expect(state).toBe('pending')
- release.resolve('settled')
- await expect(pending).resolves.toMatchObject({
- isError: true,
- error: { info: { name: 'AbortError', code: TOOL_ABORTED } },
- additionalContexts: [{ source: { kind: 'plugin', plugin: 'nested' } }],
- })
- })
- it('materializes a pre-aborted call and publishes one result without entering pipeline phases', async () => {
- const ctx = await setup()
- const phases = { pre: 0, around: 0, body: 0, post: 0, result: 0 }
- const callerArguments = { nested: { value: 1 } }
- const callerSignal = AbortSignal.abort('already cancelled')
- let argumentReads = 0
- let observedArguments: unknown
- let observedExecution: object | undefined
- let observedToken: symbol | undefined
- let observedSignal: AbortSignal | undefined
- let observedResult: ToolExecutionResult | undefined
- ctx.tools.register({
- ...echoTool,
- name: 'domain-abort',
- async execute() { phases.body += 1; return [] },
- })
- ctx.on('tools/pre-execute', async (_exec, next) => { phases.pre += 1; return next() })
- ctx.on('tools/execute', async (_exec, next) => { phases.around += 1; return next() })
- ctx.on('tools/post-execute', async (_exec, _result, next) => { phases.post += 1; return next() })
- ctx.on('tools/result', (exec, result) => {
- phases.result += 1
- observedExecution = exec
- observedArguments = exec.arguments
- observedToken = exec.token
- observedSignal = exec.signal
- observedResult = result
- })
- const result = await ctx.tools.execute({
- callId: ToolCallId('pre-aborted'),
- name: 'domain-abort',
- get arguments() { argumentReads += 1; return callerArguments },
- signal: callerSignal,
- })
- expect(argumentReads).toBe(1)
- expect(phases).toEqual({ pre: 0, around: 0, body: 0, post: 0, result: 1 })
- expect(result).toEqual({
- content: [{ type: 'text', text: 'Error: tool call aborted before dispatch' }],
- isError: true,
- error: {
- message: 'tool call aborted before dispatch',
- info: { name: 'AbortError', code: TOOL_ABORTED_BEFORE_DISPATCH },
- },
- })
- expect(observedResult).toBe(result)
- expect(Object.isFrozen(observedExecution)).toBe(true)
- expect(typeof observedToken).toBe('symbol')
- expect(observedSignal).toBe(callerSignal)
- expect(Object.isFrozen(result)).toBe(true)
- expect(observedArguments).not.toBe(callerArguments)
- expect(Object.isFrozen(observedArguments)).toBe(true)
- expect(Object.isFrozen((observedArguments as { nested: object }).nested)).toBe(true)
- })
- it('lets argument materialization failure win over a pre-aborted signal', async () => {
- const ctx = await setup()
- let observed = 0
- ctx.on('tools/result', () => { observed += 1 })
- const result = await ctx.tools.execute({
- callId: ToolCallId('invalid-pre-aborted'),
- name: 'missing',
- arguments: { invalid: () => undefined },
- signal: AbortSignal.abort('already cancelled'),
- })
- expect(result).toEqual({
- content: [{ type: 'text', text: 'Error: tool execution arguments must be losslessly JSON-serializable' }],
- isError: true,
- error: { message: 'tool execution arguments must be losslessly JSON-serializable' },
- })
- expect(observed).toBe(1)
- })
- it('a pre-execute deny short-circuits before tools/execute (the seam never runs)', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- let entered = false
- ctx.on('tools/pre-execute', async (_exec, _next): Promise<PreToolDecision> => ({ kind: 'deny', reason: 'nope' }))
- ctx.on('tools/execute', async (_exec: ToolDispatchExecution, next: () => Promise<ToolExecutionResult>): Promise<ToolExecutionResult> => {
- entered = true
- return next()
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: nope' })
- expect(entered).toBe(false) // A denied call never enters the around-dispatch extension point.
- })
- it('a thrown tool is normalized to an isError result BEFORE a tools/execute listener sees next()', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'boom',
- async execute() { throw new HarnessError('kaboom', 'BOOM') },
- })
- let seen: { isError: boolean; error?: unknown } | undefined
- ctx.on('tools/execute', async (_exec: ToolDispatchExecution, next: () => Promise<ToolExecutionResult>): Promise<ToolExecutionResult> => {
- const result = await next()
- // The base next() IS dispatch-with-normalization: the wrapper sees the
- // normalized isError result, never a raw throw from the tool body.
- seen = { isError: result.isError, error: result.error }
- return result
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'boom', arguments: {} })
- expect(seen).toEqual({
- isError: true,
- error: { message: 'kaboom', info: { name: 'HarnessError', code: 'BOOM' } },
- })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: kaboom' })
- })
- it('freezes core dispatch outcomes before around and post listeners can observe them', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- const mutationAttempts: boolean[] = []
- ctx.on('tools/execute', async (_exec, next) => {
- const result = await next()
- mutationAttempts.push(Reflect.set(result, 'value', 'around mutation'))
- return result
- })
- ctx.on('tools/post-execute', async (_exec, result, next) => {
- mutationAttempts.push(Reflect.set(result, 'value', 'post mutation'))
- return next()
- })
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('frozen-canonical'), name: 'echo', arguments: { text: 'original' },
- })
- expect(mutationAttempts).toEqual([false, false])
- expect(result.isError ? undefined : result.value).toBe('original')
- })
- it('a thrown tool normalized inside tools/execute still reaches post-execute', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'boom',
- async execute() { throw new Error('exploded') },
- })
- let postSaw: boolean | undefined
- ctx.on('tools/execute', async (_exec: ToolDispatchExecution, next: () => Promise<ToolExecutionResult>): Promise<ToolExecutionResult> => next())
- ctx.on('tools/post-execute', async (_exec, result, next) => {
- postSaw = result.isError
- return next()
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'boom', arguments: {} })
- expect(postSaw).toBe(true) // the normalized isError still flows through post-execute
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: exploded' })
- })
- it('re-fuses the caller signal with an around-dispatch replacement for the body', async () => {
- const ctx = await setup()
- let seenSignal: AbortSignal | undefined
- ctx.tools.register({
- ...echoTool,
- name: 'signal-probe',
- async execute(_args, exec) {
- seenSignal = exec.signal
- return 'ok'
- },
- })
- const upstream = new AbortController().signal
- const replacement = new AbortController().signal
- ctx.on('tools/execute', async (exec: ToolDispatchExecution, next: () => Promise<ToolExecutionResult>): Promise<ToolExecutionResult> => {
- expect(exec.signal).toBe(upstream)
- // Cordis next() ignores passed arguments, so a wrapper mutates exec in
- // place (the documented "mutate the shared object, then delegate" idiom).
- exec.signal = replacement
- return next()
- })
- await ctx.tools.execute({ callId: ToolCallId('c1'), name: 'signal-probe', arguments: {}, signal: upstream })
- expect(seenSignal).toBeDefined()
- expect(seenSignal).not.toBe(upstream)
- expect(seenSignal).not.toBe(replacement)
- })
- it('a tools/execute listener can short-circuit dispatch by returning a result without next()', async () => {
- const ctx = await setup()
- let dispatched = false
- ctx.tools.register({
- ...echoTool,
- name: 'never-runs',
- async execute() { dispatched = true; return 'unreachable' },
- })
- ctx.on('tools/execute', async (_exec: ToolDispatchExecution, _next: () => Promise<ToolExecutionResult>): Promise<ToolExecutionResult> =>
- ({ content: [{ type: 'text', text: 'ignored authored content' }], isError: false, value: 'short-circuited' }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'never-runs', arguments: {} })
- expect(dispatched).toBe(false) // returning without next() skips core dispatch
- expect(result.content[0]).toMatchObject({ text: 'short-circuited' })
- })
- it('revalidates a cached canonical result returned from a different dispatch', async () => {
- const ctx = await setup()
- ctx.tools.register({ ...echoTool, name: 'string-output', async execute() { return 'cached' } })
- let objectBodyRan = false
- ctx.tools.register(defineTool({
- name: 'object-output',
- description: 'Return one closed object.',
- parameters: {},
- output: {
- schema: {
- type: 'object',
- properties: { ok: { type: 'boolean', required: true } },
- additionalProperties: false,
- },
- render: (_args, value) => [{ type: 'text', text: String(value.ok) }],
- },
- execute() {
- objectBodyRan = true
- return Promise.resolve({ ok: true })
- },
- }))
- let cached: ToolExecutionResult | undefined
- ctx.on('tools/execute', async (exec, next) => {
- if (exec.name === 'string-output') {
- cached = await next()
- return cached
- }
- if (exec.name === 'object-output') {
- if (cached === undefined) throw new Error('expected the first dispatch result')
- return cached
- }
- return next()
- })
- const first = await ctx.tools.execute({
- signal: testToolSignal, callId: ToolCallId('cached-first'), name: 'string-output', arguments: {},
- })
- const second = await ctx.tools.execute({
- signal: testToolSignal, callId: ToolCallId('cached-second'), name: 'object-output', arguments: {},
- })
- expect(first.isError ? undefined : first.value).toBe('cached')
- expect(objectBodyRan).toBe(false)
- expect(second).toMatchObject({
- isError: true,
- error: { info: { name: 'ToolOutputError', code: 'INVALID_TOOL_OUTPUT' } },
- })
- })
- it('preserves additionalContexts supplied by an around-dispatch result', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/execute', async () => ({
- content: [{ type: 'text', text: 'short-circuited with context' }],
- isError: false,
- value: 'short-circuited with context',
- additionalContexts: [createUserMessage({
- content: [{ type: 'text', text: 'from around dispatch' }],
- source: { kind: 'plugin', plugin: 'test' },
- })],
- }))
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('around-context'), name: 'echo', arguments: {},
- })
- expect(result.additionalContexts).toEqual([{
- id: expect.any(String) as unknown,
- role: 'user',
- content: [{ type: 'text', text: 'from around dispatch' }],
- source: { kind: 'plugin', plugin: 'test' },
- }])
- })
- it('returns an isError result when a tools/execute listener throws', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/execute', async () => { throw new Error('wrapper broke') })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result).toEqual({
- content: [{ type: 'text', text: 'Error: wrapper broke' }],
- error: { message: 'wrapper broke' },
- isError: true,
- })
- })
- it('returns an isError result when a tools/pre-execute listener throws', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/pre-execute', async () => {
- throw new Error('permission hook broke')
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result).toEqual({
- content: [{ type: 'text', text: 'Error: permission hook broke' }],
- error: { message: 'permission hook broke' },
- isError: true,
- })
- })
- it('returns an isError result when a tools/post-execute listener throws', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/post-execute', async () => {
- throw new Error('post hook broke')
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result).toEqual({
- content: [{ type: 'text', text: 'Error: post hook broke' }],
- error: { message: 'post hook broke' },
- isError: true,
- })
- })
- it('preserves structured error info when a tools/pre-execute listener throws HarnessError', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- ctx.on('tools/pre-execute', async () => {
- throw new HarnessError('denied', 'DENIED')
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'echo', arguments: { text: 'hi' } })
- expect(result).toMatchObject({
- isError: true,
- error: { message: 'denied', info: { name: 'HarnessError', code: 'DENIED' } },
- })
- })
- it('schemas() snapshots tool schemas instead of exposing registry objects', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- const first = ctx.tools.schemas()
- const firstParameters = first[0]!.parameters as { properties: Record<string, unknown> }
- firstParameters.properties['mutated'] = { type: 'string' }
- first[0]!.description = 'mutated'
- expect(ctx.tools.schemas()).toEqual([{
- name: 'echo',
- description: 'echo arguments back',
- parameters: { type: 'object', properties: { text: { type: 'string' } } },
- }])
- })
- it('schemas() snapshots deeply nested parameters without using structured-clone recursion', async () => {
- const ctx = await setup()
- const depth = 5_000
- let nested: JsonSchemaNode = { type: 'string' }
- for (let index = 0; index < depth; index++) nested = { oneOf: [nested, { type: 'null' }] }
- ctx.tools.register({
- ...echoTool,
- name: 'deep-schema',
- parameters: { type: 'object', properties: { nested } },
- })
- const projected = ctx.tools.schemas()[0]!.parameters as JsonSchemaNode
- let cursor = projected.properties!.nested!
- let layers = 0
- while (cursor.oneOf !== undefined) {
- cursor = cursor.oneOf[0]!
- layers++
- }
- expect(layers).toBe(depth)
- expect(cursor).toEqual({ type: 'string' })
- })
- it('rejects schema projection when a raw registration is not lossless JSON', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'lossy-schema',
- parameters: { type: 'object', default: Number.NaN },
- })
- expect(() => ctx.tools.schemas())
- .toThrow('tool "lossy-schema" parameters must be lossless JSON before schema projection')
- })
- it('rejects a non-positive or non-finite registration timeout', async () => {
- const ctx = await setup()
- expect(() => ctx.tools.register({ ...echoTool, name: 'zero-timeout', timeoutMs: 0 }))
- .toThrow('timeoutMs must be a positive finite number')
- expect(() => ctx.tools.register({ ...echoTool, name: 'infinite-timeout', timeoutMs: Number.POSITIVE_INFINITY }))
- .toThrow('timeoutMs must be a positive finite number')
- })
- it('rejects duplicate names and unregisters on fiber dispose (HMR safety)', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- expect(() => ctx.tools.register(echoTool)).toThrow('already registered')
- const fiber = await ctx.plugin(Object.assign((inner: Context) => {
- inner.tools.register({ ...echoTool, name: 'scoped' })
- }, { inject: ['tools'] }))
- expect(ctx.tools.schemas().map(t => t.name)).toEqual(['echo', 'scoped'])
- await fiber.dispose()
- expect(ctx.tools.schemas().map(t => t.name)).toEqual(['echo'])
- })
- it('returns a callable disposer from register() that unregisters the tool', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- const dispose = ctx.tools.register({ ...echoTool, name: 'disposable' })
- expect(ctx.tools.schemas().map(t => t.name)).toEqual(['echo', 'disposable'])
- dispose()
- expect(ctx.tools.schemas().map(t => t.name)).toEqual(['echo'])
- })
- it('rolls back the tool entry when a tools/change listener throws (P1-1)', async () => {
- const ctx = await setup()
- let threw = false
- ctx.on('tools/change', () => {
- if (!threw) { threw = true; throw new Error('boom change listener') }
- })
- // The throwing emit must roll the entry back, not leak it.
- expect(() => ctx.tools.register(echoTool)).toThrow('boom change listener')
- expect(ctx.tools.get('echo')).toBeUndefined() // rolled back, not leaked
- expect(ctx.tools.schemas()).toHaveLength(0)
- // A subsequent listener-free register of the SAME name succeeds and is
- // exposed exactly once (the duplicate-name check is not wedged).
- const dispose = ctx.tools.register(echoTool)
- expect(ctx.tools.schemas().map(t => t.name)).toEqual(['echo'])
- dispose()
- expect(ctx.tools.get('echo')).toBeUndefined()
- })
- it('register() returns the EXACT effect disposer: a composite yield nests the teardown in order', async () => {
- // Registry methods return the exact Cordis effect disposer so a composite yield places
- // unregistration at its LIFO position. A wrapper would create a concurrent sibling; this async
- // probe yields during earlier teardown and would then observe the tool already removed.
- const ctx = await setup()
- const order: string[] = []
- const fiber = await ctx.plugin(Object.assign((inner: Context) => {
- inner.effect(function* () {
- yield () => { order.push('disposed-last') }
- yield inner.tools.register({ ...echoTool, name: 'nested' })
- order.push('registered')
- yield async () => {
- await new Promise(resolve => setTimeout(resolve, 0))
- order.push(inner.tools.get('nested') ? 'first: still registered' : 'first: already gone')
- }
- })
- }, { inject: ['tools'] }))
- await fiber.dispose()
- expect(order).toEqual(['registered', 'first: still registered', 'disposed-last'])
- expect(ctx.tools.get('nested')).toBeUndefined()
- })
- })
- describe('defineTool / schema DSL', () => {
- it('converts ParameterSchemaSpec to standard JSON Schema with required array', () => {
- const spec = {
- path: { type: 'string', required: true, description: 'Absolute path' },
- offset: { type: 'number' },
- limit: { type: 'number', description: 'Max lines' },
- } satisfies ParameterSchemaSpec
- const jsonSchema = parameterSchemaSpecToJsonSchema(spec)
- expect(jsonSchema).toEqual({
- type: 'object',
- properties: {
- path: { type: 'string', description: 'Absolute path' },
- offset: { type: 'number' },
- limit: { type: 'number', description: 'Max lines' },
- },
- required: ['path'],
- })
- })
- it('handles empty spec (no properties, no required)', () => {
- expect(parameterSchemaSpecToJsonSchema({})).toEqual({
- type: 'object',
- properties: {},
- })
- })
- it('handles nested object spec', () => {
- const spec = {
- config: {
- type: 'object',
- additionalProperties: true,
- required: true,
- properties: {
- host: { type: 'string', required: true },
- port: { type: 'number' },
- },
- },
- } satisfies ParameterSchemaSpec
- const jsonSchema = parameterSchemaSpecToJsonSchema(spec)
- expect(jsonSchema).toEqual({
- type: 'object',
- properties: {
- config: {
- type: 'object',
- additionalProperties: true,
- properties: {
- host: { type: 'string' },
- port: { type: 'number' },
- },
- required: ['host'],
- },
- },
- required: ['config'],
- })
- })
- it('defineTool returns a valid ToolDefinition with typed execute', async () => {
- const ctx = await setup()
- const tool = defineTool({
- name: 'typed-echo',
- description: 'A typed echo tool',
- parameters: {
- text: { type: 'string', required: true },
- uppercase: { type: 'boolean' },
- },
- output: {
- schema: { type: 'string' },
- render: (_args, value) => [{ type: 'text', text: value }],
- },
- async execute(args) {
- // args is typed: { text: string; uppercase?: boolean }
- const result = args.uppercase ? args.text.toUpperCase() : args.text
- return result
- },
- })
- ctx.tools.register(tool)
- expect(ctx.tools.schemas()).toEqual([{
- name: 'typed-echo',
- description: 'A typed echo tool',
- parameters: {
- type: 'object',
- properties: {
- text: { type: 'string' },
- uppercase: { type: 'boolean' },
- },
- required: ['text'],
- },
- }])
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('c1'),
- name: 'typed-echo',
- arguments: { text: 'hello', uppercase: true },
- })
- expect(result.isError).toBe(false)
- expect(result.isError ? undefined : result.value).toBe('HELLO')
- expect(result.content).toEqual([{ type: 'text', text: 'HELLO' }])
- })
- it('type-level: InferArgs maps required properties to non-optional', () => {
- // Compile-time check: if this compiles, InferArgs is correct.
- // args.a is string (required), args.b is number|undefined (optional).
- const tool = defineTool({
- name: 'type-check',
- description: '',
- parameters: { a: { type: 'string' as const, required: true as const }, b: { type: 'number' as const } },
- output: { schema: { type: 'string' }, render: () => [] },
- async execute(args) {
- expect(typeof args.a).toBe('string')
- void args
- return args.a
- },
- })
- void tool
- })
- it('registry round-trips a defineTool definition (register→schemas→execute)', async () => {
- const ctx = await setup()
- ctx.tools.register(defineTool({
- name: 'roundtrip',
- description: 'Round-trip test',
- parameters: {
- req: { type: 'string', required: true },
- opt: { type: 'number', description: 'Optional number' },
- },
- output: {
- schema: { type: 'string' },
- render: (_args, value) => [{ type: 'text', text: value }],
- },
- async execute(args) {
- return `${args.req}:${args.opt ?? 'none'}`
- },
- }))
- // Schema round-trip: schemas() returns standard JSON Schema
- const schemas = ctx.tools.schemas()
- expect(schemas).toHaveLength(1)
- expect(schemas[0]!.parameters).toEqual({
- type: 'object',
- properties: {
- req: { type: 'string' },
- opt: { type: 'number', description: 'Optional number' },
- },
- required: ['req'],
- })
- // Execution round-trip
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('c1'),
- name: 'roundtrip',
- arguments: { req: 'hello' },
- })
- expect(result.isError).toBe(false)
- expect(result.content).toEqual([{ type: 'text', text: 'hello:none' }])
- })
- it('still accepts raw JSON-Schema ToolDefinition directly (MCP interop)', async () => {
- const ctx = await setup()
- ctx.tools.register({
- name: 'raw-tool',
- description: 'Raw JSON Schema tool (like an MCP adapter would register)',
- parameters: {
- type: 'object',
- properties: { path: { type: 'string' } },
- required: ['path'],
- },
- output: {
- schema: { type: 'string' },
- render: (_args, value) => [{ type: 'text', text: value as string }],
- },
- async execute(args: unknown) {
- const p = args as { path: string }
- return p.path
- },
- })
- const schemas = ctx.tools.schemas()
- expect(schemas[0]!.parameters).toEqual({
- type: 'object',
- properties: { path: { type: 'string' } },
- required: ['path'],
- })
- const result = await ctx.tools.execute({
- signal: testToolSignal,
- callId: ToolCallId('c1'),
- name: 'raw-tool',
- arguments: { path: '/tmp' },
- })
- expect(result.isError).toBe(false)
- expect(result.content).toEqual([{ type: 'text', text: '/tmp' }])
- })
- })
- describe('schema DSL edge cases', () => {
- it('emits enum values in JSON Schema property', () => {
- const spec = {
- color: { type: 'string', enum: ['red', 'green', 'blue'], description: 'Color choice' },
- } satisfies ParameterSchemaSpec
- const jsonSchema = parameterSchemaSpecToJsonSchema(spec)
- expect(jsonSchema.properties['color']).toMatchObject({
- type: 'string',
- enum: ['red', 'green', 'blue'],
- description: 'Color choice',
- })
- })
- it('emits default value in JSON Schema property', () => {
- const spec = {
- limit: { type: 'number', default: 25 },
- } satisfies ParameterSchemaSpec
- const jsonSchema = parameterSchemaSpecToJsonSchema(spec)
- expect(jsonSchema.properties['limit']).toMatchObject({
- type: 'number',
- default: 25,
- })
- })
- it('handles array items without nested properties (plain type array)', () => {
- const spec = {
- tags: { type: 'array', items: { type: 'string' } },
- } satisfies ParameterSchemaSpec
- const jsonSchema = parameterSchemaSpecToJsonSchema(spec)
- expect(jsonSchema.properties['tags']).toEqual({
- type: 'array',
- items: { type: 'string' },
- })
- })
- it('handles enum and default together in one property', () => {
- const spec = {
- level: { type: 'string', enum: ['low', 'high'], default: 'low' },
- } satisfies ParameterSchemaSpec
- const jsonSchema = parameterSchemaSpecToJsonSchema(spec)
- expect(jsonSchema.properties['level']).toMatchObject({
- type: 'string',
- enum: ['low', 'high'],
- default: 'low',
- })
- })
- it('omits description, enum, default keys when not specified', () => {
- const spec = {
- bare: { type: 'string' },
- } satisfies ParameterSchemaSpec
- const jsonSchema = parameterSchemaSpecToJsonSchema(spec)
- const prop = jsonSchema.properties['bare'] as Record<string, unknown>
- expect(prop).toEqual({ type: 'string' })
- expect('description' in prop).toBe(false)
- expect('enum' in prop).toBe(false)
- expect('default' in prop).toBe(false)
- })
- it('handles array with no items (items omitted)', () => {
- const spec = {
- raw: { type: 'array' },
- } satisfies ParameterSchemaSpec
- const jsonSchema = parameterSchemaSpecToJsonSchema(spec)
- expect(jsonSchema.properties['raw']).toEqual({
- type: 'array',
- })
- })
- it('handles nested object with all-optional properties (no required array)', () => {
- const spec = {
- config: {
- type: 'object',
- additionalProperties: true,
- properties: {
- host: { type: 'string' },
- port: { type: 'number' },
- },
- },
- } satisfies ParameterSchemaSpec
- const jsonSchema = parameterSchemaSpecToJsonSchema(spec)
- expect(jsonSchema.properties['config']).toMatchObject({
- type: 'object',
- properties: {
- host: { type: 'string' },
- port: { type: 'number' },
- },
- })
- const config = jsonSchema.properties['config'] as Record<string, unknown>
- expect('required' in config).toBe(false)
- })
- })
- describe('schema DSL optional and nested contracts', () => {
- it('InferArgs makes non-required keys genuinely optional (omittable)', () => {
- type Args = InferArgs<{
- path: { type: 'string'; required: true }
- limit: { type: 'number' }
- }>
- expectTypeOf<Args>().toEqualTypeOf<{ path: string; limit?: number }>()
- const omitted: Args = { path: '/tmp' }
- expect(omitted.limit).toBeUndefined()
- })
- it('InferArgs recurses into array items, including arrays of objects', () => {
- type Args = InferArgs<{
- names: { type: 'array'; required: true; items: { type: 'string' } }
- servers: {
- type: 'array'
- items: {
- type: 'object'
- additionalProperties: true
- properties: {
- host: { type: 'string'; required: true }
- port: { type: 'number' }
- }
- }
- }
- }>
- expectTypeOf<Args>().toEqualTypeOf<{
- names: string[]
- servers?: ({ host: string; port?: number } & Record<string, JsonValue>)[]
- }>()
- })
- it('runtime JSON Schema matches the array-of-objects inference', () => {
- const spec = {
- servers: {
- type: 'array',
- items: {
- type: 'object',
- additionalProperties: true,
- properties: {
- host: { type: 'string', required: true },
- port: { type: 'number' },
- },
- },
- },
- } satisfies ParameterSchemaSpec
- expect(parameterSchemaSpecToJsonSchema(spec)).toEqual({
- type: 'object',
- properties: {
- servers: {
- type: 'array',
- items: {
- type: 'object',
- additionalProperties: true,
- properties: {
- host: { type: 'string' },
- port: { type: 'number' },
- },
- required: ['host'],
- },
- },
- },
- })
- })
- it('reports messages from non-Error throws (throw { message })', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'object-thrower',
- async execute() {
- // testing non-Error throws on purpose
- throw { message: 'denied by object' }
- },
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'object-thrower', arguments: {} })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: denied by object' })
- })
- it('reports messages from throws of non-objects (throw "string")', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'string-thrower',
- async execute() {
- // testing primitive throws on purpose
- throw 'kaboom'
- },
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'string-thrower', arguments: {} })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({ text: 'Error: kaboom' })
- })
- it('reports messages from throws of objects without message property', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'object-no-message',
- async execute() {
- // testing object throw without .message
- throw { code: 500 }
- },
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'object-no-message', arguments: {} })
- expect(result.isError).toBe(true)
- const firstContent = result.content[0]!
- expect(firstContent.type).toBe('text')
- if (firstContent.type === 'text') {
- expect(firstContent.text).toBe('Error: [object Object]')
- }
- })
- })
- describe('ToolRuntime.get', () => {
- it('get() returns the registered tool definition', async () => {
- const ctx = await setup()
- ctx.tools.register(echoTool)
- const tool = ctx.tools.get('echo')
- expect(tool).toBeDefined()
- expect(tool!.name).toBe('echo')
- })
- it('get() returns undefined for unknown tool names', async () => {
- const ctx = await setup()
- expect(ctx.tools.get('nope')).toBeUndefined()
- })
- })
- describe('validateArgs (the runtime-validation Agent Note, part 1)', () => {
- it('returns [] for valid args and is total over malformed input', () => {
- const spec = {
- path: { type: 'string', required: true },
- limit: { type: 'number' },
- } satisfies ParameterSchemaSpec
- expect(validateArgs(spec, { path: '/tmp' })).toEqual([])
- expect(validateArgs(spec, { path: '/tmp', limit: 5 })).toEqual([])
- // never throws regardless of shape
- expect(validateArgs(spec, null)).toHaveLength(1)
- expect(validateArgs(spec, 'nope')).toHaveLength(1)
- expect(validateArgs(spec, [])).toHaveLength(1)
- })
- it('flags a missing required key and a required key present as undefined', () => {
- const spec = { path: { type: 'string', required: true } } satisfies ParameterSchemaSpec
- expect(validateArgs(spec, {})).toEqual(['missing required property "path"'])
- expect(validateArgs(spec, { path: undefined })).toEqual(['missing required property "path"'])
- })
- it('allows extra keys (no additionalProperties:false) and omitted optionals', () => {
- const spec = { path: { type: 'string', required: true } } satisfies ParameterSchemaSpec
- expect(validateArgs(spec, { path: '/tmp', extra: 1 })).toEqual([])
- })
- it('does not apply defaults (validation only)', () => {
- const spec = { limit: { type: 'number', default: 25 } } satisfies ParameterSchemaSpec
- // absent optional is valid, and validation does not synthesize the default
- expect(validateArgs(spec, {})).toEqual([])
- })
- it('type-checks primitives', () => {
- const spec = {
- s: { type: 'string' },
- n: { type: 'number' },
- b: { type: 'boolean' },
- } satisfies ParameterSchemaSpec
- expect(validateArgs(spec, { s: 1 })).toEqual(['"s" must be a string'])
- expect(validateArgs(spec, { n: 'x' })).toEqual(['"n" must be a number'])
- expect(validateArgs(spec, { b: 'x' })).toEqual(['"b" must be a boolean'])
- })
- it('checks enum membership', () => {
- const spec = { color: { type: 'string', enum: ['red', 'green'] } } satisfies ParameterSchemaSpec
- expect(validateArgs(spec, { color: 'red' })).toEqual([])
- expect(validateArgs(spec, { color: 'blue' })).toEqual(['"color" must be one of ["red","green"]'])
- })
- it('enforces type-correct scalar enum declarations', () => {
- const spec = { n: { type: 'number', enum: [1, 2] } } satisfies ParameterSchemaSpec
- expect(validateArgs(spec, { n: 1 })).toEqual([])
- expect(validateArgs(spec, { n: 3 })).toEqual(['"n" must be one of [1,2]'])
- const invalid = { n: { type: 'number', enum: ['1', '2'] } } as unknown as ParameterSchemaSpec
- expect(() => validateArgs(invalid, { n: 1 })).toThrow(JsonSchemaError)
- })
- it('rejects an unknown schema type at the author boundary', () => {
- const spec = { x: { type: 'weird' } } as unknown as ParameterSchemaSpec
- expect(() => validateArgs(spec, { x: 1 })).toThrow(JsonSchemaError)
- })
- it('recurses into nested objects (and an object without properties only type-checks)', () => {
- const spec = {
- config: {
- type: 'object',
- additionalProperties: true,
- required: true,
- properties: { host: { type: 'string', required: true }, port: { type: 'number' } },
- },
- bag: { type: 'object', additionalProperties: true },
- } satisfies ParameterSchemaSpec
- expect(validateArgs(spec, { config: { host: 'h' }, bag: { anything: true } })).toEqual([])
- expect(validateArgs(spec, { config: { port: 9 }, bag: 5 })).toEqual([
- 'missing required property "config.host"',
- '"bag" must be an object',
- ])
- })
- it('recurses into array items (and an array without items only type-checks)', () => {
- const spec = {
- tags: { type: 'array', items: { type: 'string' } },
- raw: { type: 'array' },
- } satisfies ParameterSchemaSpec
- expect(validateArgs(spec, { tags: ['a', 'b'], raw: [1, {}, 'x'] })).toEqual([])
- expect(validateArgs(spec, { tags: ['a', 2] })).toEqual(['"tags[1]" must be a string'])
- // a non-array value for an array-typed prop
- expect(validateArgs(spec, { tags: 'nope' })).toEqual(['"tags" must be an array'])
- })
- it('validates arrays of objects element-wise', () => {
- const spec = {
- servers: {
- type: 'array',
- items: { type: 'object', additionalProperties: true, properties: { host: { type: 'string', required: true } } },
- },
- } satisfies ParameterSchemaSpec
- expect(validateArgs(spec, { servers: [{ host: 'a' }, {}] })).toEqual([
- 'missing required property "servers[1].host"',
- ])
- })
- })
- describe('defineTool validation (the runtime-validation Agent Note, part 1)', () => {
- it('returns an isError result with the violations when the model sends bad args', async () => {
- const ctx = await setup()
- ctx.tools.register(defineContentToolFixture({
- name: 'reader',
- description: 'reads a path',
- parameters: { path: { type: 'string', required: true } },
- async execute(args) {
- return [{ type: 'text', text: args.path }]
- },
- }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'reader', arguments: {} })
- expect(result.isError).toBe(true)
- expect(result.content[0]).toMatchObject({
- text: 'Error: invalid arguments: missing required property "path"',
- })
- })
- it('runs execute normally when args are valid', async () => {
- const ctx = await setup()
- ctx.tools.register(defineContentToolFixture({
- name: 'reader',
- description: 'reads a path',
- parameters: { path: { type: 'string', required: true } },
- async execute(args) {
- return [{ type: 'text', text: `read ${args.path}` }]
- },
- }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'reader', arguments: { path: '/x' } })
- expect(result).toEqual({
- content: [{ type: 'text', text: 'read /x' }],
- isError: false,
- value: [{ type: 'text', text: 'read /x' }],
- })
- })
- it('ToolArgsError carries a stable code and the violation list', () => {
- const err = new ToolArgsError(['missing required property "a"', '"b" must be a number'])
- expect(err).toBeInstanceOf(Error)
- expect(err.name).toBe('ToolArgsError')
- expect(err.code).toBe('INVALID_ARGS')
- expect(err.violations).toEqual(['missing required property "a"', '"b" must be a number'])
- expect(err.message).toBe('invalid arguments: missing required property "a"; "b" must be a number')
- })
- it('a schema-invalid call surfaces the structured error on the result', async () => {
- const ctx = await setup()
- ctx.tools.register(defineContentToolFixture({
- name: 'reader',
- description: 'reads a path',
- parameters: { path: { type: 'string', required: true } },
- async execute(args) {
- return [{ type: 'text', text: args.path }]
- },
- }))
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'reader', arguments: {} })
- expect(result.isError).toBe(true)
- expect(result.error).toEqual({
- message: 'invalid arguments: missing required property "path"',
- info: { name: 'ToolArgsError', code: 'INVALID_ARGS' },
- })
- })
- it('a tool throwing a HarnessError surfaces its name and code', async () => {
- const { HarnessError } = await import('@deepseek-ai/dsh-llm')
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'coded',
- async execute() {
- throw new HarnessError('disk full', 'ENOSPC')
- },
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'coded', arguments: {} })
- expect(result.isError).toBe(true)
- expect(result.error).toEqual({ message: 'disk full', info: { name: 'HarnessError', code: 'ENOSPC' } })
- expect(result.content[0]).toMatchObject({ text: 'Error: disk full' })
- })
- it('a non-HarnessError throw retains only its message', async () => {
- const ctx = await setup()
- ctx.tools.register({
- ...echoTool,
- name: 'plain',
- async execute() {
- throw new Error('just a message')
- },
- })
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'plain', arguments: {} })
- expect(result.isError).toBe(true)
- expect(result.error).toEqual({ message: 'just a message' })
- expect(result.content[0]).toMatchObject({ text: 'Error: just a message' })
- })
- it('raw-registered tools are NOT validated by defineTool (MCP keeps its own)', async () => {
- const ctx = await setup()
- // A raw ToolDefinition: no defineTool wrapping, so no validateArgs guard.
- ctx.tools.register({
- name: 'raw',
- description: 'raw tool',
- parameters: { type: 'object', properties: { path: { type: 'string' } }, required: ['path'] },
- output: {
- schema: { type: 'string' },
- render: (_args, value) => [{ type: 'text', text: value as string }],
- },
- async execute(args: unknown) {
- return typeof args
- },
- })
- // Missing the "required" path — but raw tools validate their own input, so
- // this reaches execute rather than being rejected by the harness.
- const result = await ctx.tools.execute({ signal: testToolSignal, callId: ToolCallId('c1'), name: 'raw', arguments: {} })
- expect(result.isError).toBe(false)
- })
- it('attaches a positive-finite timeoutMs to the definition', () => {
- const tool = defineContentToolFixture({
- name: 'x', description: 'd', parameters: {}, timeoutMs: 30_000,
- async execute() { return [{ type: 'text' as const, text: 'ok' }] },
- })
- expect(tool.timeoutMs).toBe(30_000)
- })
- it('omits timeoutMs when not declared', () => {
- const tool = defineContentToolFixture({
- name: 'x', description: 'd', parameters: {},
- async execute() { return [{ type: 'text' as const, text: 'ok' }] },
- })
- expect(tool.timeoutMs).toBeUndefined()
- })
- it('throws when timeoutMs is zero or negative', () => {
- const make = (ms: number) => defineContentToolFixture({
- name: 'x', description: 'd', parameters: {}, timeoutMs: ms,
- async execute() { return [{ type: 'text' as const, text: 'ok' }] },
- })
- expect(() => make(0)).toThrow('timeoutMs must be a positive finite number')
- expect(() => make(-5)).toThrow('positive finite number')
- })
- it('throws when timeoutMs is non-finite', () => {
- expect(() => defineContentToolFixture({
- name: 'x', description: 'd', parameters: {}, timeoutMs: Infinity,
- async execute() { return [{ type: 'text' as const, text: 'ok' }] },
- })).toThrow('positive finite number')
- })
- })
- describe('defineTool presentation (presentCall / presentResult)', () => {
- it('preserves inline enum and const literals in inferred arguments', () => {
- defineTool({
- name: 'literal-args',
- description: 'literal arguments',
- parameters: {
- mode: { type: 'string', enum: ['read', 'write'], required: true },
- attempt: { type: 'integer', const: 1 },
- },
- output: {
- schema: { type: 'null' },
- render: () => [],
- },
- async execute(args) {
- expectTypeOf(args).toEqualTypeOf<{ mode: 'read' | 'write'; attempt?: 1 }>()
- return null
- },
- })
- })
- it('threads presentCall/presentResult onto the ToolDefinition with typed args', () => {
- const tool = defineContentToolFixture({
- name: 'demo',
- description: 'demo',
- parameters: { path: { type: 'string', required: true }, n: { type: 'number' } },
- async execute() { return [{ type: 'text', text: 'ok' }] },
- presentCall(args) {
- // args is typed { path: string; n?: number } — zero casts.
- expectTypeOf(args).toEqualTypeOf<{ path: string; n?: number }>()
- return { card: 'generic', title: `Open ${args.path}`, kind: 'read', rawInput: args.path }
- },
- presentResult(args, result) {
- return { card: 'generic', title: `Opened ${args.path}`, content: result.content }
- },
- })
- expect(tool.presentCall!({ path: '/a', n: 2 })).toEqual({ card: 'generic', title: 'Open /a', kind: 'read', rawInput: '/a' })
- expect(tool.presentResult!({ path: '/a' }, { content: [{ type: 'text', text: 'x' }], isError: false }))
- .toEqual({ card: 'generic', title: 'Opened /a', content: [{ type: 'text', text: 'x' }] })
- })
- it('a tool without presentCall/presentResult leaves them undefined (UI falls back generically)', () => {
- const tool = defineContentToolFixture({
- name: 'plain',
- description: 'plain',
- parameters: { x: { type: 'string', required: true } },
- async execute() { return [] },
- })
- expect(typeof tool.presentCall).toBe('undefined')
- expect(typeof tool.presentResult).toBe('undefined')
- })
- it('presentCall/presentResult validate softly: malformed args return undefined, never throw (display runs on replay)', () => {
- const tool = defineContentToolFixture({
- name: 'demo',
- description: 'demo',
- parameters: { path: { type: 'string', required: true } },
- async execute() { return [] },
- presentCall: args => ({ card: 'generic', title: args.path }),
- presentResult: (args, result) => ({ card: 'generic', title: args.path, content: result.content }),
- })
- // Unlike execute (which throws ToolArgsError on a mismatch), the display
- // methods soft-validate and fall back to undefined so a UI never crashes
- // replaying an old/foreign log entry. The ToolDefinition methods take
- // `unknown`, so malformed shapes pass without a cast.
- expect(tool.presentCall?.({})).toBeUndefined()
- expect(tool.presentResult?.({ wrong: 1 }, { content: [], isError: false })).toBeUndefined()
- })
- })
|