The loop recorded every model token delta as a durable `assistant/chunk` session event AND emitted an identical live `agent/stream-chunk` Cordis event one line later. Same StreamChunk, same turn/step; the emit added only the live Agent handle, which the sole consumer discarded. This is the boundary-mirror duplication the event-domain work removed for turn/step boundaries, applied to the token stream — a follow-up the boundary RFC explicitly deferred. The premise is settled: chunk persistence is authoritative (the proposal to stop persisting chunks was rejected — replay/snapshots depend on it), so `assistant/chunk` on `session/event` is the load-bearing token stream and `agent/stream-chunk` is pure redundancy. - Remove the `agent/stream-chunk` declaration + emit; drop the now-unused StreamChunk import from dsh-agent's types. - Migrate `dsh-ui-stdio` (the only live consumer; ACP already reads assistant/chunk off session/event) to render assistant/chunk in its existing session/event listener. Consolidating to one listener also makes the inReasoning dim-SGR flag deterministic across chunk/boundary events (they no longer race across two listeners). - Repoint the agent-loop tests (cancel/loop) and ui-stdio tests to the session/event assistant/chunk feed. - New RFC (implemented/simplification/2026-07-02-remove-stream-chunk-mirror); amend the boundary RFC's retained-list entry to cross-link; update architecture, cookbook, event-domain-semantics, the ACP proposal, and the regenerated cordis catalog. Snapshot goldens unchanged (ACP never used the mirror), confirming no editor-facing transcript change.
438 lines
18 KiB
TypeScript
438 lines
18 KiB
TypeScript
import { Readable } from 'node:stream'
|
|
import { describe, expect, it, vi } from 'vitest'
|
|
import { Context } from 'cordis'
|
|
import type { Agent, AgentStatus } from '@deepseek-ai/dsh-agent'
|
|
import AgentRegistry from '@deepseek-ai/dsh-agent'
|
|
import type { ContentBlock, StreamChunk } from '@deepseek-ai/dsh-llm'
|
|
import type { Session, SessionEvent } from '@deepseek-ai/dsh-session'
|
|
import { createStdioChat, type Config, type StdioRuntime } from '../src/index.ts'
|
|
|
|
/**
|
|
* Unit tests for the stdio UI plugin. They drive the REAL plugin body
|
|
* (`createStdioChat`) with an injected {@link StdioRuntime} so every render,
|
|
* input, EOF, and disposal branch runs without touching the real `process`
|
|
* streams — the I/O seam is what makes the per-file gate reachable. The
|
|
* `agents` service is real (`@deepseek-ai/dsh-agent`); a minimal fake `Agent`
|
|
* stands in for the loop, since the loop is the genuinely expensive collaborator
|
|
* and we only need its `status` + `send`/`steer` surface here.
|
|
*/
|
|
|
|
/** A controllable stdin: a Readable we push lines into and can end on demand. */
|
|
function makeInput(): Readable & { feed(line: string): void; finish(): void } {
|
|
const stream = new Readable({ read() {} }) as Readable & { feed(line: string): void; finish(): void }
|
|
stream.feed = (line: string) => stream.push(`${line}\n`)
|
|
stream.finish = () => stream.push(null)
|
|
return stream
|
|
}
|
|
|
|
/** A stdout sink that accumulates everything written, for assertions. */
|
|
function makeOutput(): { write: (s: string) => boolean; text: () => string } {
|
|
let buf = ''
|
|
return { write: (s: string) => { buf += s; return true }, text: () => buf }
|
|
}
|
|
|
|
function makeRuntime(over: Partial<StdioRuntime> = {}): {
|
|
runtime: StdioRuntime
|
|
input: ReturnType<typeof makeInput>
|
|
out: ReturnType<typeof makeOutput>
|
|
exit: ReturnType<typeof vi.fn>
|
|
} {
|
|
const input = makeInput()
|
|
const out = makeOutput()
|
|
const exit = vi.fn()
|
|
return { runtime: { input, output: { write: out.write } as never, exit, ...over }, input, out, exit }
|
|
}
|
|
|
|
/** A minimal Agent fake exposing the surface the UI touches. */
|
|
function makeAgent(id: string, status: AgentStatus = 'idle'): Agent & {
|
|
status: AgentStatus
|
|
sent: ContentBlock[][]
|
|
steered: ContentBlock[][]
|
|
} {
|
|
const sent: ContentBlock[][] = []
|
|
const steered: ContentBlock[][] = []
|
|
return {
|
|
id: id as Agent['id'],
|
|
status,
|
|
sent,
|
|
steered,
|
|
// A minimal session stub: the UI reads only `session.header.id` (to map the
|
|
// session back to its agent id for the turn-boundary label).
|
|
session: { header: { id: `${id}-session` } },
|
|
send: (content: ContentBlock[]) => void sent.push(content),
|
|
steer: (content: ContentBlock[]) => void steered.push(content),
|
|
} as never
|
|
}
|
|
|
|
/** A session stub whose `header.id` matches an agent's, for `session/event` emits. */
|
|
function makeSession(agentId: string): Session {
|
|
return { header: { id: `${agentId}-session` } } as Session
|
|
}
|
|
|
|
/** An `assistant/chunk` session event carrying one raw stream chunk. */
|
|
function chunkEvent(chunk: StreamChunk): SessionEvent {
|
|
return { type: 'assistant/chunk', seq: 0, time: 0, data: { turn: 1, step: 0, chunk } }
|
|
}
|
|
|
|
const CONFIG: Config = { welcome: 'hi there', agent: 'main' }
|
|
|
|
async function setup(config: Config = CONFIG, runtimeOver: Partial<StdioRuntime> = {}) {
|
|
const ctx = new Context()
|
|
await ctx.plugin(AgentRegistry)
|
|
const { runtime, input, out, exit } = makeRuntime(runtimeOver)
|
|
const fiber = await ctx.plugin(Object.assign((inner: Context) => {
|
|
createStdioChat(inner, config, runtime)
|
|
}, { inject: ['agents'] }))
|
|
return { ctx, fiber, input, out, exit }
|
|
}
|
|
|
|
/** Drive a fake idle timer past the 200ms flush delay. */
|
|
function flushExit(): Promise<void> {
|
|
return new Promise(resolve => setTimeout(resolve, 250))
|
|
}
|
|
|
|
describe('createStdioChat rendering', () => {
|
|
it('writes the welcome banner and prompt on start', async () => {
|
|
const { out } = await setup()
|
|
expect(out.text()).toBe('hi there\n> ')
|
|
})
|
|
|
|
it('falls back to default welcome/agent when called with empty config', async () => {
|
|
// createStdioChat is exported and may be driven directly (bypassing the
|
|
// Loader's schemastery validation), so it must default welcome/agent itself.
|
|
const { out } = await setup({})
|
|
expect(out.text()).toBe('ready.\n> ')
|
|
// And it drives the default agent id 'main'.
|
|
})
|
|
|
|
it('renders text-delta chunks verbatim', async () => {
|
|
const { ctx, out } = await setup()
|
|
ctx.emit('session/event', makeSession('main'), chunkEvent({ type: 'text-delta', index: 0, text: 'hello' }))
|
|
expect(out.text()).toContain('hello')
|
|
})
|
|
|
|
it('wraps reasoning-delta in the dim SGR and resets on the following text-delta', async () => {
|
|
const { ctx, out } = await setup()
|
|
const session = makeSession('main')
|
|
ctx.emit('session/event', session, chunkEvent({ type: 'reasoning-delta', index: 0, text: 'think' }))
|
|
ctx.emit('session/event', session, chunkEvent({ type: 'reasoning-delta', index: 0, text: 'more' }))
|
|
ctx.emit('session/event', session, chunkEvent({ type: 'text-delta', index: 0, text: 'answer' }))
|
|
expect(out.text()).toContain('\x1B[2mthinkmore\x1B[0m\nanswer')
|
|
})
|
|
|
|
it('ignores stream-chunk types it does not render', async () => {
|
|
const { ctx, out } = await setup()
|
|
const before = out.text()
|
|
ctx.emit('session/event', makeSession('main'), chunkEvent({ type: 'block-start', index: 0, blockType: 'text' }))
|
|
expect(out.text()).toBe(before)
|
|
})
|
|
|
|
it('renders turn/start and turn/end markers from the session feed', async () => {
|
|
const { ctx, out } = await setup()
|
|
const agent = makeAgent('main')
|
|
// agent/created populates the session-id → agent-id label map.
|
|
ctx.emit('agent/created', agent)
|
|
const session = makeSession('main')
|
|
ctx.emit('session/event', session, {
|
|
type: 'turn/start', seq: 1, time: 0, data: { turn: 3, trigger: { kind: 'message' } },
|
|
} as SessionEvent)
|
|
expect(out.text()).toContain('[main turn 3] ')
|
|
ctx.emit('session/event', session, {
|
|
type: 'turn/end', seq: 2, time: 0, data: { turn: 3, reason: { kind: 'completed' } },
|
|
} as SessionEvent)
|
|
expect(out.text()).toContain('\n> ')
|
|
})
|
|
|
|
it('falls back to the session id as the label when no agent is mapped', async () => {
|
|
const { ctx, out } = await setup()
|
|
// No agent/created emitted, so the label map is empty — the header id shows.
|
|
ctx.emit('session/event', makeSession('orphan'), {
|
|
type: 'turn/start', seq: 1, time: 0, data: { turn: 1, trigger: { kind: 'message' } },
|
|
} as SessionEvent)
|
|
expect(out.text()).toContain('[orphan-session turn 1] ')
|
|
})
|
|
|
|
it('seeds labels for agents already registered before the UI installs', async () => {
|
|
// The pre-created `main` agent (and any agent surviving an HMR reload of just
|
|
// this fiber) fired its `agent/created` before the UI's listener existed, so
|
|
// the live listener alone would miss it. Seeding from `ctx.agents.list()` at
|
|
// install time is what keeps its turn header showing `[main turn N]` instead
|
|
// of the raw session id.
|
|
const ctx = new Context()
|
|
await ctx.plugin(AgentRegistry)
|
|
const agent = makeAgent('main')
|
|
ctx.agents.register(agent) // registered BEFORE the UI plugin below
|
|
const { runtime, out } = makeRuntime()
|
|
await ctx.plugin(Object.assign((inner: Context) => {
|
|
createStdioChat(inner, CONFIG, runtime)
|
|
}, { inject: ['agents'] }))
|
|
ctx.emit('session/event', makeSession('main'), {
|
|
type: 'turn/start', seq: 1, time: 0, data: { turn: 5, trigger: { kind: 'message' } },
|
|
} as SessionEvent)
|
|
expect(out.text()).toContain('[main turn 5] ')
|
|
})
|
|
|
|
it('resets dim styling at turn/end if a turn ends mid-reasoning', async () => {
|
|
const { ctx, out } = await setup()
|
|
const session = makeSession('main')
|
|
ctx.emit('session/event', session, chunkEvent({ type: 'reasoning-delta', index: 0, text: 'mid' }))
|
|
ctx.emit('session/event', session, {
|
|
type: 'turn/end', seq: 1, time: 0, data: { turn: 1, reason: { kind: 'completed' } },
|
|
} as SessionEvent)
|
|
expect(out.text()).toContain('\x1B[2mmid\x1B[0m')
|
|
})
|
|
|
|
it('drops the label mapping on agent/disposed', async () => {
|
|
const { ctx, out } = await setup()
|
|
const agent = makeAgent('main')
|
|
ctx.emit('agent/created', agent)
|
|
ctx.emit('agent/disposed', agent)
|
|
// After disposal the map no longer resolves the agent id — fall back to the
|
|
// session header id.
|
|
ctx.emit('session/event', makeSession('main'), {
|
|
type: 'turn/start', seq: 1, time: 0, data: { turn: 1, trigger: { kind: 'message' } },
|
|
} as SessionEvent)
|
|
expect(out.text()).toContain('[main-session turn 1] ')
|
|
})
|
|
|
|
it('renders tool/call and tool/result session events', async () => {
|
|
const { ctx, out } = await setup()
|
|
const session = {} as Session
|
|
const callEvent = {
|
|
type: 'tool/call', seq: 1, time: 0,
|
|
data: { turn: 1, step: 0, callId: 'c1', name: 'bash', arguments: '{"command":"ls"}' },
|
|
} as SessionEvent
|
|
ctx.emit('session/event', session, callEvent)
|
|
expect(out.text()).toContain('[tool call] bash({"command":"ls"})')
|
|
|
|
const resultEvent = {
|
|
type: 'tool/result', seq: 2, time: 0,
|
|
data: { turn: 1, step: 0, callId: 'c1', content: [{ type: 'text', text: 'file.txt' }], isError: false },
|
|
} as SessionEvent
|
|
ctx.emit('session/event', session, resultEvent)
|
|
expect(out.text()).toContain('[tool result] file.txt')
|
|
})
|
|
|
|
it('renders a todo/write session event as a glyphed checklist', async () => {
|
|
const { ctx, out } = await setup()
|
|
const session = {} as Session
|
|
ctx.emit('session/event', session, {
|
|
type: 'todo/write', seq: 1, time: 0,
|
|
data: { todos: [
|
|
{ content: 'read the code', status: 'completed' },
|
|
{ content: 'write the fix', status: 'in_progress' },
|
|
{ content: 'run the tests', status: 'pending' },
|
|
] },
|
|
} as SessionEvent)
|
|
const text = out.text()
|
|
expect(text).toContain('[todos]')
|
|
expect(text).toContain('[x] read the code')
|
|
expect(text).toContain('[~] write the fix')
|
|
expect(text).toContain('[ ] run the tests')
|
|
})
|
|
|
|
it('resets dim styling when a todo/write interrupts reasoning', async () => {
|
|
const { ctx, out } = await setup()
|
|
ctx.emit('session/event', {} as Session, chunkEvent({ type: 'reasoning-delta', index: 0, text: 'r' }))
|
|
ctx.emit('session/event', {} as Session, {
|
|
type: 'todo/write', seq: 1, time: 0,
|
|
data: { todos: [{ content: 'a task', status: 'pending' }] },
|
|
} as SessionEvent)
|
|
expect(out.text()).toContain('\x1B[2mr\x1B[0m')
|
|
})
|
|
|
|
it('resets dim styling when a tool/call interrupts reasoning', async () => {
|
|
const { ctx, out } = await setup()
|
|
const session = {} as Session
|
|
ctx.emit('session/event', session, chunkEvent({ type: 'reasoning-delta', index: 0, text: 'r' }))
|
|
ctx.emit('session/event', session, {
|
|
type: 'tool/call', seq: 1, time: 0,
|
|
data: { turn: 1, step: 0, callId: 'c1', name: 'bash', arguments: '{}' },
|
|
} as SessionEvent)
|
|
expect(out.text()).toContain('\x1B[2mr\x1B[0m')
|
|
})
|
|
|
|
it('ignores session events it does not render', async () => {
|
|
const { ctx, out } = await setup()
|
|
const before = out.text()
|
|
ctx.emit('session/event', {} as Session, {
|
|
type: 'user/message', seq: 1, time: 0,
|
|
data: { content: [{ type: 'text', text: 'hi' }], source: { kind: 'user' } },
|
|
} as SessionEvent)
|
|
expect(out.text()).toBe(before)
|
|
})
|
|
})
|
|
|
|
describe('createStdioChat input', () => {
|
|
it('sends a typed line to an idle agent', async () => {
|
|
const { ctx, input } = await setup()
|
|
const agent = makeAgent('main', 'idle')
|
|
ctx.agents.register(agent)
|
|
input.feed('do a thing')
|
|
await new Promise(r => setImmediate(r))
|
|
expect(agent.sent).toEqual([[{ type: 'text', text: 'do a thing' }]])
|
|
expect(agent.steered).toEqual([])
|
|
})
|
|
|
|
it('steers a typed line into a running agent', async () => {
|
|
const { ctx, input } = await setup()
|
|
const agent = makeAgent('main', 'running')
|
|
ctx.agents.register(agent)
|
|
input.feed('steer me')
|
|
await new Promise(r => setImmediate(r))
|
|
expect(agent.steered).toEqual([[{ type: 'text', text: 'steer me' }]])
|
|
expect(agent.sent).toEqual([])
|
|
})
|
|
|
|
it('ignores blank lines', async () => {
|
|
const { ctx, input } = await setup()
|
|
const agent = makeAgent('main')
|
|
ctx.agents.register(agent)
|
|
input.feed(' ')
|
|
await new Promise(r => setImmediate(r))
|
|
expect(agent.sent).toEqual([])
|
|
})
|
|
|
|
it('logs and drops a line when the target agent is not running', async () => {
|
|
const { ctx, input } = await setup()
|
|
const spy = vi.spyOn(ctx.logger, 'error').mockImplementation(() => {})
|
|
input.feed('nobody home')
|
|
await new Promise(r => setImmediate(r))
|
|
expect(spy).toHaveBeenCalledWith('ui-stdio: agent "%s" is not running', 'main')
|
|
})
|
|
|
|
it('drives the agent named in config, not a hardcoded id', async () => {
|
|
const { ctx, input } = await setup({ welcome: 'w', agent: 'worker' })
|
|
const agent = makeAgent('worker')
|
|
ctx.agents.register(agent)
|
|
input.feed('hi')
|
|
await new Promise(r => setImmediate(r))
|
|
expect(agent.sent).toHaveLength(1)
|
|
})
|
|
})
|
|
|
|
describe('createStdioChat EOF exit', () => {
|
|
it('exits immediately on EOF when no work was submitted', async () => {
|
|
const { input, exit } = await setup()
|
|
input.finish()
|
|
await flushExit()
|
|
expect(exit).toHaveBeenCalledWith(0)
|
|
})
|
|
|
|
it('waits for the agent to settle idle after running before exiting', async () => {
|
|
const { ctx, input, exit } = await setup()
|
|
const agent = makeAgent('main', 'idle')
|
|
ctx.agents.register(agent)
|
|
input.feed('work')
|
|
await new Promise(r => setImmediate(r))
|
|
input.finish()
|
|
await new Promise(r => setImmediate(r))
|
|
// Work submitted but no 'running' observed yet — must NOT exit.
|
|
expect(exit).not.toHaveBeenCalled()
|
|
// The turn starts, then settles.
|
|
ctx.emit('agent/status', agent, 'running')
|
|
;(agent as { status: AgentStatus }).status = 'idle'
|
|
ctx.emit('agent/status', agent, 'idle')
|
|
await flushExit()
|
|
expect(exit).toHaveBeenCalledWith(0)
|
|
})
|
|
|
|
it('schedules the exit only once when idle fires repeatedly', async () => {
|
|
const { ctx, input, exit } = await setup()
|
|
const agent = makeAgent('main', 'running')
|
|
ctx.agents.register(agent)
|
|
input.feed('work')
|
|
await new Promise(r => setImmediate(r))
|
|
ctx.emit('agent/status', agent, 'running') // sawRunning = true
|
|
input.finish()
|
|
await new Promise(r => setImmediate(r)) // let readline 'close' set stdinClosed
|
|
;(agent as { status: AgentStatus }).status = 'idle'
|
|
// Two idle signals while stdin is already closed: the first arms the timer,
|
|
// the second must hit the already-scheduled guard, not arm a second.
|
|
ctx.emit('agent/status', agent, 'idle')
|
|
ctx.emit('agent/status', agent, 'idle')
|
|
await flushExit()
|
|
expect(exit).toHaveBeenCalledTimes(1)
|
|
})
|
|
|
|
it('does not exit on an idle transition for a different agent', async () => {
|
|
const { ctx, input, exit } = await setup()
|
|
const agent = makeAgent('main', 'idle')
|
|
ctx.agents.register(agent)
|
|
input.feed('work')
|
|
await new Promise(r => setImmediate(r))
|
|
input.finish()
|
|
const other = makeAgent('other')
|
|
ctx.emit('agent/status', other, 'running')
|
|
ctx.emit('agent/status', other, 'idle')
|
|
await flushExit()
|
|
expect(exit).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('does not exit while a turn is still running at EOF', async () => {
|
|
const { ctx, input, exit } = await setup()
|
|
const agent = makeAgent('main', 'idle')
|
|
ctx.agents.register(agent)
|
|
input.feed('work')
|
|
await new Promise(r => setImmediate(r))
|
|
ctx.emit('agent/status', agent, 'running')
|
|
;(agent as { status: AgentStatus }).status = 'running'
|
|
input.finish()
|
|
// sawRunning is true, but the agent is still running — the idle gate holds.
|
|
ctx.emit('agent/status', agent, 'idle') // a stale/duplicate signal while status stays 'running'
|
|
await flushExit()
|
|
expect(exit).not.toHaveBeenCalled()
|
|
})
|
|
})
|
|
|
|
describe('createStdioChat disposal (HMR safety)', () => {
|
|
it('never exits the process when EOF arrives after fiber dispose', async () => {
|
|
const { fiber, input, exit } = await setup()
|
|
await fiber.dispose()
|
|
// A late EOF after disposal (reader.close() also fires 'close') must not exit.
|
|
input.finish()
|
|
await flushExit()
|
|
expect(exit).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('cancels a scheduled exit if disposed within the flush window', async () => {
|
|
const { fiber, input, exit } = await setup()
|
|
// EOF with no work submitted schedules the 200ms flush-then-exit timer.
|
|
input.finish()
|
|
await new Promise(r => setImmediate(r))
|
|
expect(exit).not.toHaveBeenCalled() // not yet — still inside the window
|
|
// Dispose BEFORE the timer fires: the tracked handle must be cleared.
|
|
await fiber.dispose()
|
|
await flushExit()
|
|
expect(exit).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('stops handling input after dispose', async () => {
|
|
const { ctx, fiber, input } = await setup()
|
|
const agent = makeAgent('main')
|
|
ctx.agents.register(agent)
|
|
await fiber.dispose()
|
|
// The readline interface is closed on dispose; a late line reaches no handler.
|
|
input.feed('too late')
|
|
await new Promise(r => setImmediate(r))
|
|
expect(agent.sent).toEqual([])
|
|
})
|
|
|
|
it('removes the agent/status listener on dispose', async () => {
|
|
const { ctx, fiber, input, exit } = await setup()
|
|
const agent = makeAgent('main', 'idle')
|
|
ctx.agents.register(agent)
|
|
input.feed('work')
|
|
await new Promise(r => setImmediate(r))
|
|
await fiber.dispose()
|
|
// After dispose, status transitions must neither throw nor schedule an exit
|
|
// (the listener and the EOF-exit path are both torn down).
|
|
expect(() => {
|
|
ctx.emit('agent/status', agent, 'running')
|
|
ctx.emit('agent/status', agent, 'idle')
|
|
}).not.toThrow()
|
|
await flushExit()
|
|
expect(exit).not.toHaveBeenCalled()
|
|
})
|
|
})
|