Add @deepseek-ai/dsh-tool-todo (a new packages/todo/ group): a model-facing
todo_write(todos: [{content, status}]) tool with whole-list-replace semantics.
Each call appends the full list as a todo/write event to the calling agent's
session log; the current list is the most recent such event (last-write-wins).
Single-owner — a non-agent caller is rejected. Beyond the schema's
type/required/enum checks, execute rejects empty/duplicate content and more than
one in_progress task, narrowing the loosely-typed args into a real TodoItem[].
Both UIs render off the existing session/event: the stdio UI prints a glyphed
checklist; the ACP bridge maps the list to a `plan` sessionUpdate (todosToPlan
synthesizes the priority ACP requires; status maps 1:1). Wired into the
coding-agent, acp-agent, and snapshot example configs with a system-prompt nudge.
Tests: unit (schema, validation, append/replace, no-agent rejection, presentCall,
HMR-safety, Loader export-shape guard), full-loop integration through the agent
loop, the ACP todosToPlan mapping + stream-update arm, the stdio render arm, and
a session/load replay that re-emits the plan. New-group TS wiring added to
tsconfig.base/json/build. RFC + a doc-inventory sweep (architecture, packages
README, AGENTS layout, cookbook group list, example READMEs) ship with it.
The todo-plan ACP snapshot scenario is recorded separately (needs an API key).
158 lines
6.8 KiB
TypeScript
158 lines
6.8 KiB
TypeScript
import { describe, expect, it } from 'vitest'
|
|
import { Context } from 'cordis'
|
|
import Loader from '@cordisjs/plugin-loader'
|
|
import { CallId } from '@deepseek-ai/dsh-llm'
|
|
import SystemPrompt from '@deepseek-ai/dsh-system-prompt'
|
|
import ToolRegistry from '@deepseek-ai/dsh-tools'
|
|
import { Session, SessionId } from '@deepseek-ai/dsh-session'
|
|
import type { TodoItem } from '@deepseek-ai/dsh-session'
|
|
import { AgentId, type Agent } from '@deepseek-ai/dsh-agent'
|
|
import * as tool from '../src/index.ts'
|
|
|
|
/**
|
|
* Drives the REAL plugin body: mounts `dsh-tool-todo` on a real `ToolRegistry`
|
|
* and invokes the registered `todo_write` tool through `ctx.tools.execute`,
|
|
* with a fake parent Agent carrying a real `Session` — so the append the tool
|
|
* makes is observable on a genuine session log (only the agent wrapper is a
|
|
* stand-in; the session and the tool are the shipping code).
|
|
*/
|
|
|
|
/** A parent Agent backed by a real Session — the tool reads `agent.session`. */
|
|
function agentWithSession(id = 'parent-1'): Agent & { session: Session } {
|
|
const session = new Session(SessionId(id))
|
|
return { id: AgentId(id), session } as unknown as Agent & { session: Session }
|
|
}
|
|
|
|
async function setup(): Promise<Context> {
|
|
const ctx = new Context()
|
|
await ctx.plugin(SystemPrompt)
|
|
await ctx.plugin(ToolRegistry)
|
|
await ctx.plugin(tool)
|
|
return ctx
|
|
}
|
|
|
|
let callCounter = 0
|
|
function callTodo(ctx: Context, args: unknown, over: { agent?: Agent | undefined } = {}) {
|
|
const agent = 'agent' in over ? over.agent : agentWithSession()
|
|
return ctx.tools.execute({
|
|
callId: CallId(`call-${++callCounter}`),
|
|
name: 'todo_write',
|
|
arguments: args,
|
|
...agent ? { agent } : {},
|
|
})
|
|
}
|
|
|
|
function text(result: { content: { type: string; text?: string }[] }): string {
|
|
return result.content.filter(b => b.type === 'text').map(b => b.text).join('')
|
|
}
|
|
|
|
describe('dsh-tool-todo', () => {
|
|
it('registers a `todo_write` tool whose schema is an array of {content,status}', async () => {
|
|
const ctx = await setup()
|
|
const schema = ctx.tools.schemas().find(s => s.name === 'todo_write')
|
|
expect(schema).toBeDefined()
|
|
const props = (schema!.parameters as { properties?: Record<string, unknown> }).properties ?? {}
|
|
expect(Object.keys(props)).toEqual(['todos'])
|
|
const todos = props.todos as { type: string; items?: { properties?: Record<string, { type: string; enum?: string[] }> } }
|
|
expect(todos.type).toBe('array')
|
|
const itemProps = todos.items?.properties ?? {}
|
|
expect(Object.keys(itemProps).sort()).toEqual(['content', 'status'])
|
|
expect(itemProps.status?.enum).toEqual(['pending', 'in_progress', 'completed'])
|
|
})
|
|
|
|
it('appends a todo/write event carrying the whole list to the calling session', async () => {
|
|
const ctx = await setup()
|
|
const agent = agentWithSession('writer')
|
|
const todos: TodoItem[] = [
|
|
{ content: 'plan', status: 'in_progress' },
|
|
{ content: 'build', status: 'pending' },
|
|
]
|
|
const result = await callTodo(ctx, { todos }, { agent })
|
|
expect(result.isError).toBe(false)
|
|
expect(text(result)).toContain('1 pending, 1 in progress, 0 completed')
|
|
|
|
const event = agent.session.events.findLast(e => e.type === 'todo/write')!
|
|
expect(event.data.todos).toEqual(todos)
|
|
})
|
|
|
|
it('replaces the list on a second call (last-write-wins on the log)', async () => {
|
|
const ctx = await setup()
|
|
const agent = agentWithSession('writer-2')
|
|
await callTodo(ctx, { todos: [{ content: 'a', status: 'pending' }] }, { agent })
|
|
await callTodo(ctx, { todos: [
|
|
{ content: 'a', status: 'completed' },
|
|
{ content: 'b', status: 'in_progress' },
|
|
] }, { agent })
|
|
|
|
const current = agent.session.events.findLast(e => e.type === 'todo/write')!.data.todos
|
|
expect(current).toEqual([
|
|
{ content: 'a', status: 'completed' },
|
|
{ content: 'b', status: 'in_progress' },
|
|
])
|
|
})
|
|
|
|
it('rejects a malformed status before execute runs (registry arg-validation)', async () => {
|
|
const ctx = await setup()
|
|
const result = await callTodo(ctx, { todos: [{ content: 'x', status: 'doing' }] })
|
|
expect(result.isError).toBe(true)
|
|
})
|
|
|
|
it('rejects a non-array todos argument', async () => {
|
|
const ctx = await setup()
|
|
const result = await callTodo(ctx, { todos: 'nope' })
|
|
expect(result.isError).toBe(true)
|
|
})
|
|
|
|
it.each([
|
|
{ label: 'empty content', todos: [{ content: ' ', status: 'pending' }], fragment: 'non-empty' },
|
|
{ label: 'duplicate content', todos: [{ content: 'dup', status: 'pending' }, { content: 'dup', status: 'completed' }], fragment: 'duplicate' },
|
|
{ label: 'two in_progress', todos: [{ content: 'a', status: 'in_progress' }, { content: 'b', status: 'in_progress' }], fragment: 'in_progress' },
|
|
])('rejects $label as an isError result', async ({ todos, fragment }) => {
|
|
const ctx = await setup()
|
|
const result = await callTodo(ctx, { todos })
|
|
expect(result.isError).toBe(true)
|
|
expect(text(result)).toContain(fragment)
|
|
})
|
|
|
|
it('rejects a non-agent caller (the list has no owning session)', async () => {
|
|
const ctx = await setup()
|
|
const result = await callTodo(ctx, { todos: [{ content: 'a', status: 'pending' }] }, { agent: undefined })
|
|
expect(result.isError).toBe(true)
|
|
expect(text(result)).toContain('owning agent session')
|
|
})
|
|
|
|
it('presents the call with a stable title and the list as raw input', async () => {
|
|
const ctx = await setup()
|
|
const def = ctx.tools.get('todo_write')!
|
|
const todos = [{ content: 'a', status: 'pending' }]
|
|
expect(def.presentCall?.({ todos })).toEqual({ title: 'Update todo list', kind: 'other', rawInput: todos })
|
|
})
|
|
|
|
it('unregisters the tool when its contributing fiber is disposed (HMR-safety)', async () => {
|
|
const ctx = new Context()
|
|
await ctx.plugin(SystemPrompt)
|
|
await ctx.plugin(ToolRegistry)
|
|
const fiber = await ctx.plugin(tool)
|
|
expect(ctx.tools.schemas().some(s => s.name === 'todo_write')).toBe(true)
|
|
await fiber.dispose()
|
|
expect(ctx.tools.schemas().some(s => s.name === 'todo_write')).toBe(false)
|
|
})
|
|
|
|
it('has the namespace-plugin export shape (no stray default) so the Loader keeps name/inject/apply', () => {
|
|
// Postmortem 0001 guard: this plugin HAS `inject = ['tools']`, so a stray
|
|
// `export default apply` would collapse the module via `unwrapExports`
|
|
// (`exports.default ?? exports`), DROP `inject`, and crash at load with
|
|
// "cannot get property … without inject". Guard the shape directly.
|
|
expect('default' in tool).toBe(false)
|
|
expect(tool.name).toBe('tool-todo')
|
|
expect(tool.inject).toEqual(['tools'])
|
|
|
|
const loader = Object.create(Loader.prototype) as Loader
|
|
const unwrapped = loader.unwrapExports(tool) as Record<string, unknown>
|
|
expect(unwrapped).toBe(tool)
|
|
expect(unwrapped.name).toBe('tool-todo')
|
|
expect(unwrapped.inject).toEqual(['tools'])
|
|
expect(typeof unwrapped.apply).toBe('function')
|
|
})
|
|
})
|