Files
apes-sidebar/tests/sidechat-seed-validation.spec.ts
T
Menghuan1918 6586e3e2d3 feat: adapt to DSH 0.1.7-alpha.1 and yield the read-only previews
DSH 0.1.7-alpha.1 is 1299 commits past 0.1.6-alpha.2 and rewrites four
contracts this plugin was built on. The peer floor moves to
^0.1.7-alpha.1 (semver's prerelease rule means ^0.1.6-alpha.2 can never
match a 0.1.7 prerelease); 0.1.6-alpha.2 and earlier stay on v0.19.1.
Released as 0.21.0-alpha.1 (dist-tag alpha).

Hard breaks:
- dsh-settings was rewritten: register(ns, schema) is gone, a form is
  addressed by the plugin row's Loader entry id and read from the
  module's exported Config. The preferences are merged into Config and
  marked volatile — which requires DSH's own schemastery, because only
  that build wraps a volatile field in the cosmokit reference the
  loader's volatile commit walks. With the public package a settings
  write reports success and revision 1 while the effective value never
  changes.
- ui-primitives renamed its whole icon family (IconXxx14/16 ->
  IconXxxRegular/Medium): 26 imported symbols, 17 files. The failing
  mode is render-time, not load-time. Five call sites that relied on the
  old 14px default now pass size={14} explicitly.
- Session format v4 rejects source.kind === 'plugin'; the side-chat
  boundary injection now writes plugin:dsh-better-sidebar, the same kind
  DSH's own v3->v4 migration produces, so historical threads survive.
  Tool results moved to role 'tool' with top-level content/isError; all
  four parsers accept both shapes.
- The client session snapshot dropped subagentsByParent/jobsBySession
  and the on-demand subagent-catalog observation API. The Tasks page
  reads projectionsBySession and a new jobs.list route.

Yields and convergence:
- The read-only previews go to DSH's documentpreview (Office->PDF, a
  spreadsheet worker, zoom, per-directory refresh); editor.canOpen
  refuses those 26 extensions. Markdown, HTML (with its sandbox
  switches) and the editable code buffer stay.
- The host browser kind is desktop-profile-only now, so the web e2e
  lanes expect no browser entry and assert its absence.
- Link takeover claims only urlTarget links and passes the rest to the
  host, fixing a regression from the 0.1.6 round: the fallback pointed
  at a 'browser' type the plugin no longer registers, so http links in
  its own markdown did nothing.

Also fixed, found along the way:
- The file tree refreshes live (new directory watch over the plugin's
  own socket), since the plugin owns the `files` kind.
- ctx.sessions.list has no `current` field at either tag; the three
  readers were dead. They now use ctx.sidebarRight.mounted.
- package.json.files was missing lib/client-locale.js.
- Two genuinely dead call sites: sessions.openSubagent/open/
  refreshSubagents do not exist on the current baseline, so the
  topology click, the jump-back and the retry were all no-ops.
- The test harness window shim lacked addEventListener, which the 0.1.7
  primitives call at module-evaluation time; and the e2e token exchange
  needs Playwright's request stack, not Node's fetch.
2026-09-22 17:09:08 +08:00

295 lines
14 KiB
TypeScript

/**
* Seed-validator integration test: the seed built by {@link buildSidechatInheritance}
* must be accepted by the REAL dsh-session validator (`Session.create`).
*
* Regression: the seed copy originally stripped the event envelope's
* `surfaceOp` marker, and the real validator rejects surface-eligible events
* (user/message, assistant/message, tool/result) without it — the live host
* surfaced it as "invalid seed event at index N: ... requires a surfaceOp
* marker" during real thread creation. This test runs the ACTUAL validator,
* not a mock, so the class of bug cannot silently return.
*/
import { describe, expect, it } from 'vitest'
import { Session, SessionLogOffset, SESSION_FORMAT_VERSION } from '@deepseek-ai/dsh-session'
import type { SessionId } from '@deepseek-ai/dsh-session'
import type { InboxState } from '@deepseek-ai/dsh-agent'
import { snapshotSubagentDescriptor } from '@deepseek-ai/dsh-subagent'
import type { SidebarSessionEvent } from '../src/context-types.ts'
import { buildSidechatInheritance } from '../src/sidechat-core.ts'
/** One live-style event with the surface marker message events carry, and
* the REAL message shapes the validator demands (id/role/source/content;
* a tool/result carries the first-class role-'tool' message 0.1.7 writes —
* v4 refuses the retired role-'user' + `tool-result` wrapper). */
function ev(type: string, seq: number, data: Record<string, unknown>): SidebarSessionEvent {
const event: SidebarSessionEvent = { type, seq, time: seq * 1000, data }
if (type === 'user/message' || type === 'assistant/message' || type === 'tool/result') {
return { ...event, surfaceOp: 'append' } as SidebarSessionEvent
}
return event
}
function userMessage(text: string): Record<string, unknown> {
return { id: `m-${text}`, role: 'user', content: [{ type: 'text', text }], source: { kind: 'user' } }
}
function assistantMessage(text: string): Record<string, unknown> {
return {
id: `m-${text}`,
role: 'assistant',
content: [{ type: 'text', text }],
source: { kind: 'model', provider: 'test', model: 'model-x' },
}
}
/** The 0.1.7 tool/result message: first-class tool role, result blocks and
* `isError` at the message's own top level (dsh-llm's createToolResultMessage). */
function toolResultMessage(callId: string, text: string, isError = false): Record<string, unknown> {
return {
id: `m-${callId}`,
role: 'tool',
source: { kind: 'tool', callId },
toolCallId: callId,
content: [{ type: 'text', text }],
isError,
}
}
/** The retired 0.1.6 shape: a role-'user' message wrapping the result in one
* `tool-result` content block. Historical logs still carry it, but the v4
* seed validator refuses it — the plugin's own readers must still read it. */
function legacyToolResultMessage(callId: string, text: string, isError = false): Record<string, unknown> {
return {
id: `m-${callId}`,
role: 'user',
source: { kind: 'tool', callId },
content: [{ type: 'tool-result', toolCallId: callId, isError, content: [{ type: 'text', text }] }],
}
}
/** A parent log with a completed turn, a pending question, and an open
* in-progress turn (the exact shape a mid-stream thread creation sees).
* DSH 0.1.5 logs nothing for the in-flight step: its deltas are
* process-local `agent/assistant-stream` frames, not session events. */
function parentLog(): SidebarSessionEvent[] {
return [
ev('user/message', 0, userMessage('first question')),
ev('turn/start', 1, { turn: 1 }),
ev('step/start', 2, { turn: 1, step: 1 }),
ev('assistant/message', 3, { turn: 1, step: 1, message: assistantMessage('first answer'), stream: [] }),
ev('step/end', 4, { turn: 1, step: 1 }),
ev('turn/end', 5, { turn: 1, reason: { kind: 'completed' } }),
ev('user/message', 6, userMessage('pending question')),
ev('turn/start', 7, { turn: 2 }),
ev('step/start', 8, { turn: 2, step: 1 }),
]
}
describe('sidechat seed against the real dsh-session validator', () => {
it('accepts a seed with a completed turn + pending user message + synthetically closed open turn', () => {
const { seed, snapshot } = buildSidechatInheritance(parentLog())
expect(snapshot).toBeNull()
// The REAL validator: this throws when an envelope field was stripped
// (the reported regression) or the turn balance is off.
const child = Session.create('session-validator-test' as SessionId, seed as never)
const types = child.snapshotEvents().map(event => event.type)
expect(types).toEqual([
'user/message', 'turn/start', 'step/start', 'assistant/message', 'step/end', 'turn/end',
'user/message', 'turn/start', 'step/start', 'step/end', 'turn/end',
'session/end-seed',
])
// The synthetic close is honest: the frozen turn ends interrupted.
const turnEnd = child.snapshotEvents().findLast(event => event.type === 'turn/end')
expect(turnEnd?.data).toEqual({ turn: 2, reason: { kind: 'interrupted' } })
})
it('accepts a dangling-tool-call fallback seed (cut before the open turn)', () => {
const log = [
...parentLog().slice(0, 7),
ev('turn/start', 7, { turn: 2 }),
ev('step/start', 8, { turn: 2, step: 1 }),
ev('tool/call', 9, { turn: 2, step: 1, callId: 'c1', name: 'bash', arguments: '{"cmd":"sleep"}' }),
]
const { seed, snapshot } = buildSidechatInheritance(log)
expect(snapshot).not.toBeNull()
const child = Session.create('session-validator-fallback' as SessionId, seed as never)
expect(child.snapshotEvents().map(event => event.type).at(-1)).toBe('session/end-seed')
})
it('refuses the retired 0.1.6 tool-result wrapper (why every fixture uses the tool-role message)', () => {
const legacy = [
ev('user/message', 0, userMessage('q')),
ev('turn/start', 1, { turn: 1 }),
ev('step/start', 2, { turn: 1, step: 1 }),
ev('tool/call', 3, { turn: 1, step: 1, callId: 'c1', name: 'bash', arguments: '{}' }),
ev('tool/result', 4, { turn: 1, step: 1, message: legacyToolResultMessage('c1', 'ok') }),
ev('turn/end', 5, { turn: 1, reason: { kind: 'completed' } }),
]
// Session format v4 made tool results first-class role-'tool' messages;
// a seed still carrying the wrapper cannot be adopted at all.
expect(() => Session.create('session-validator-legacy' as SessionId, legacy as never))
.toThrow(/message must have role "tool"/)
})
it('still READS a legacy 0.1.6-shaped tool result when building the snapshot (compat)', () => {
// Historical logs keep the wrapper shape forever, so the plugin's own
// readers must keep reading it even though the validator refuses it.
const log = [
ev('user/message', 0, userMessage('q')),
ev('turn/start', 1, { turn: 1 }),
ev('step/start', 2, { turn: 1, step: 1 }),
ev('tool/call', 3, { turn: 1, step: 1, callId: 'c1', name: 'bash', arguments: '{"cmd":"ls"}' }),
ev('tool/result', 4, { turn: 1, step: 1, message: legacyToolResultMessage('c1', 'legacy ok') }),
// A second call with no result yet: the open turn cannot be closed
// honestly, so the inheritance falls back to the snapshot — where the
// legacy-shaped result above must still surface.
ev('tool/call', 5, { turn: 1, step: 1, callId: 'c2', name: 'bash', arguments: '{"cmd":"sleep"}' }),
]
const { snapshot } = buildSidechatInheritance(log)
expect(snapshot).not.toBeNull()
expect(snapshot).toContain('Result: legacy ok')
})
it('accepts the durable subagent descriptor the routes append to the seed', () => {
// Regression guard for the catalog-corrupt fix: a cold thread WITHOUT a
// descriptor renders as a 'corrupt' diagnostic in the host subagents.list.
// The descriptor is a log-only event appended INSIDE the seed (before the
// end-seed marker); the real validator must accept the combined seed.
const { seed } = buildSidechatInheritance(parentLog())
const descriptor = snapshotSubagentDescriptor({
mode: 'continuable',
provider: 'sidechat',
label: 'Side: test',
agentProvider: 'test',
agentModel: 'model-x',
})
const withDescriptor = [
...seed,
{ type: 'subagent/descriptor', seq: seed.length, time: Date.now(), data: descriptor },
]
const child = Session.create('session-validator-descriptor' as SessionId, withDescriptor as never)
const types = child.snapshotEvents().map(event => event.type)
expect(types.at(-2)).toBe('subagent/descriptor')
expect(types.at(-1)).toBe('session/end-seed')
})
})
describe('sidechat seed fork markers vs the reconstructed inbox', () => {
/**
* Regression: the thread-create call originally passed `seed` WITHOUT the
* fork-marker pair (`meta.isSeeded: true` + `inheritedEventCount`). A seed
* without them is REPLAY history, not an inherited prefix, so the child's
* ownEvents() includes the whole seed and its inbox fold replays the
* parent's `agent/inbox/spliced` events — inheriting whatever input sat
* UNCLAIMED in the parent at the click moment (a queued follow-up, or a
* tool-result context spliced into next-step between step boundaries of a
* long-running turn). The first side prompt then claimed and SENT that stale
* message before the boundary + question.
*
* The fold below is the standard inbox projection's rule
* (`inboxProjectionDefinition` in `@deepseek-ai/dsh-agent-loop/inbox`,
* which 0.1.5 does not re-export from the package root): pending input is
* reconstructed from the session's OWN splice events, so the
* `inheritedEventCount` the marker pair supplies is exactly what keeps the
* inherited prefix out of it.
*/
const pendingMessage = (id: string, kind: string, text: string) => ({
id,
role: 'user',
content: [{ type: 'text', text }],
source: { kind },
})
const inboxOver = (session: Session): { nextTurn: number; nextStep: number } => {
let state: InboxState = { 'next-turn': [], 'next-step': [] }
for (const event of session.ownEvents()) {
if (event.type !== 'agent/inbox/spliced') continue
const splice = event.data
const list = state[splice.target]
state = {
...state,
[splice.target]: list.toSpliced(splice.start, splice.removedCount ?? 0, ...splice.inserted),
}
}
return { nextTurn: state['next-turn'].length, nextStep: state['next-step'].length }
}
/** The shape the routes pass since the fix: isSeeded + inheritedEventCount. */
const forkMarkedSession = (id: string, seed: readonly SidebarSessionEvent[]): Session =>
Session.create(
id as SessionId,
seed as never,
{ version: SESSION_FORMAT_VERSION, id: id as SessionId, createdAt: Date.now(), isSeeded: true },
SessionLogOffset(seed.length),
)
/** Real loop order: inbox insert → turn/start → claim deletion → step/start
* → user/message. One completed, fully claimed turn (seq 0-7). */
const completedTurnLog = (): SidebarSessionEvent[] => [
ev('agent/inbox/spliced', 0, { target: 'next-turn', start: 0, inserted: [pendingMessage('m-q', 'user', 'q')] }),
ev('turn/start', 1, { turn: 1 }),
ev('agent/inbox/spliced', 2, { target: 'next-turn', start: 0, removedCount: 1, inserted: [] }),
ev('step/start', 3, { turn: 1, step: 1 }),
ev('user/message', 4, pendingMessage('m-q', 'user', 'q')),
ev('assistant/message', 5, { turn: 1, step: 1, message: assistantMessage('a'), stream: [] }),
ev('step/end', 6, { turn: 1, step: 1 }),
ev('turn/end', 7, { turn: 1, reason: { kind: 'completed' } }),
]
/** Mid-turn with an UNCLAIMED tool-result context in next-step (seq 15). */
const midTurnLog = (): SidebarSessionEvent[] => [
...completedTurnLog(),
ev('agent/inbox/spliced', 8, { target: 'next-turn', start: 0, inserted: [pendingMessage('m-q2', 'user', 'q2')] }),
ev('turn/start', 9, { turn: 2 }),
ev('agent/inbox/spliced', 10, { target: 'next-turn', start: 0, removedCount: 1, inserted: [] }),
ev('step/start', 11, { turn: 2, step: 1 }),
ev('user/message', 12, pendingMessage('m-q2', 'user', 'q2')),
ev('tool/call', 13, { turn: 2, step: 1, callId: 'c1', name: 'bash', arguments: '{}' }),
ev('tool/result', 14, { turn: 2, step: 1, message: toolResultMessage('c1', 'ok') }),
ev('agent/inbox/spliced', 15, {
target: 'next-step',
start: 0,
inserted: [pendingMessage('m-ctx', 'tool', 'tool bash finished: exit 0 ... now continue the plan')],
}),
]
it('inherits the parent\'s UNCLAIMED next-step tool context without the fork markers (root cause)', () => {
// Parent mid-turn (user queue empty): the bash tool returned and spliced
// its follow-up context into next-step; the next step boundary has not
// claimed it yet. The reported long-context scenario.
const { seed } = buildSidechatInheritance(midTurnLog())
// OLD call shape (seed only): the whole seed counts as own events and the
// phantom context is inherited as pending input.
const unmarked = Session.create('session-inbox-unmarked' as SessionId, seed as never)
expect(unmarked.ownEvents().length).toBe(seed.length + 1)
expect(inboxOver(unmarked)).toEqual({ nextTurn: 0, nextStep: 1 })
})
it('inherits the parent\'s QUEUED follow-up (next-turn) without the fork markers', () => {
const queued = pendingMessage('m-queued', 'user', 'queued second message')
const log: SidebarSessionEvent[] = [
...completedTurnLog(),
ev('agent/inbox/spliced', 8, { target: 'next-turn', start: 0, inserted: [queued] }),
]
const { seed } = buildSidechatInheritance(log)
const unmarked = Session.create('session-inbox-unmarked-turn' as SessionId, seed as never)
expect(inboxOver(unmarked)).toEqual({ nextTurn: 1, nextStep: 0 })
})
it('the fork-marker pair (isSeeded + inheritedEventCount) leaves the inherited inbox empty', () => {
// Same mid-turn log as the root-cause case, plus the descriptor the
// routes append — exactly what sidechat.start passes to agents.create.
const { seed } = buildSidechatInheritance(midTurnLog())
const withDescriptor = [
...seed,
{
type: 'subagent/descriptor',
seq: seed.length,
time: Date.now(),
data: snapshotSubagentDescriptor({ mode: 'continuable', provider: 'sidechat', label: 'Side: test' }),
} as unknown as SidebarSessionEvent,
]
const marked = forkMarkedSession('session-inbox-marked', withDescriptor)
// Only the end-seed marker is own; the transcript cut is unchanged.
expect(marked.ownEvents().map(event => event.type)).toEqual(['session/end-seed'])
expect(marked.snapshotEvents().map(event => event.type).at(-1)).toBe('session/end-seed')
expect(inboxOver(marked)).toEqual({ nextTurn: 0, nextStep: 0 })
})
})