mirror of
https://github.com/deepseek-ai/deepseek-harness
synced 2026-08-15 21:04:50 +00:00
New doc-sync gate verify-export-jsdoc walks every module-level exported name under packages/*/*/src and requires description prose everywhere, plus @param per parameter and @returns on non-void annotated returns for function-like exports, public class methods, properties, and accessors. The parsing + check helpers move out of gen-cordis-catalog.ts into a shared scripts/jsdoc.ts so 'documented' means one thing on both gated surfaces. Deliberate exemptions (documented in the RFC): heritage-declared class members (the seam declaration is the doc's one home — the one checker query in an otherwise pure-AST walk), cordis plugin-protocol slots (name/inject/reusable/Config/apply, top-level and static), constructors, overload implementations, declare-module augmentation bodies, and re-export statements (checked at the defining module). The 203 under-documented exports the gate found at adoption are filled in this change, so the gate lands green; generated catalogs/graphs are regenerated for the shifted line pointers. RFC: docs/rfc/implemented/process/2026-07-06-export-surface-jsdoc-gate.md
207 lines
9.2 KiB
TypeScript
207 lines
9.2 KiB
TypeScript
/**
|
|
* The shared in-process subagent run driver: run a child as a child
|
|
* {@link Agent} on the SAME cordis context (`ctx.agents`) — the cheapest
|
|
* transport, reusing the agent factory's quiescent {@link AgentHandle}
|
|
* teardown. The concrete in-process backends are thin shells over this driver,
|
|
* differing ONLY in the `seed` they pass (a fresh child vs. a child seeded with
|
|
* a prefix of the parent's log); everything downstream — drive the child, read
|
|
* its final output, map the stop reason, dispose — is identical and lives here.
|
|
*
|
|
* This package owns no provider and registers nothing; it is a pure library the
|
|
* backend packages depend on, so neither backend needs to know about the other.
|
|
*
|
|
* @module @deepseek-ai/dsh-subagent-inprocess
|
|
*/
|
|
|
|
import { randomUUID } from 'node:crypto'
|
|
import type { Context } from 'cordis'
|
|
import { AgentId, type Agent, type AgentHandle, type AgentOptions } from '@deepseek-ai/dsh-agent'
|
|
import { SessionId, type SessionEvent, type TurnEndReason } from '@deepseek-ai/dsh-session'
|
|
import type { ContentBlock } from '@deepseek-ai/dsh-llm'
|
|
import type { SubagentResult, SubagentRun, SubagentStartRequest, SubagentStopReason } from '@deepseek-ai/dsh-subagent'
|
|
|
|
declare module '@deepseek-ai/dsh-agent' {
|
|
interface AgentOptions {
|
|
/**
|
|
* The agent's delegation depth in the subagent tree — 0 for a top-level
|
|
* (config/ACP-created) agent, parent depth + 1 for a subagent. Set by the
|
|
* in-process backends on every child they create so a nested spawn reads its
|
|
* parent's depth from `parent.options.subagentDepth` and the `depthLimit`
|
|
* capability can cap the tree. Merge-extensible field (the seam owns it; the
|
|
* loop neither sets nor reads it).
|
|
*/
|
|
subagentDepth?: number
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Read an agent's delegation depth (absent ⇒ a top-level agent, depth 0).
|
|
* @param agent - the agent whose options may carry `subagentDepth`.
|
|
* @returns 0 for a top-level agent, its parent's depth + 1 for a subagent.
|
|
*/
|
|
export function depthOf(agent: Agent): number {
|
|
return agent.options.subagentDepth ?? 0
|
|
}
|
|
|
|
/** Thrown when a spawn would exceed the request's `maxDepth` cap. */
|
|
export class SubagentDepthError extends Error {
|
|
constructor(public readonly attemptedDepth: number, public readonly maxDepth: number) {
|
|
super(`subagent depth ${attemptedDepth} exceeds maxDepth ${maxDepth}`)
|
|
this.name = 'SubagentDepthError'
|
|
}
|
|
}
|
|
|
|
/** Map a session `turn/end` reason to a {@link SubagentStopReason}. */
|
|
function toStopReason(reason: TurnEndReason | undefined): SubagentStopReason {
|
|
switch (reason?.kind) {
|
|
case 'completed':
|
|
return 'completed'
|
|
case 'max-tokens':
|
|
return 'max-tokens'
|
|
case 'aborted':
|
|
return 'aborted'
|
|
// `disposed` (torn down mid-turn) and `interrupted` (crash-closed) both mean
|
|
// the turn did not finish cleanly; surface them as a generic failure rather
|
|
// than a clean completion. A missing reason (no turn ran) is also an error.
|
|
case 'error':
|
|
case 'disposed':
|
|
case 'interrupted':
|
|
default:
|
|
return 'error'
|
|
}
|
|
}
|
|
|
|
/** Extra inputs the spawn/fork backends supply to {@link startInProcessRun}. */
|
|
export interface InProcessRunOptions {
|
|
/** The provider name (`spawn`/`fork`), for error context only. */
|
|
readonly providerName: string
|
|
/**
|
|
* The child session's seed: a balanced, contiguous-from-0 prefix of the
|
|
* parent's log (FORK), or `undefined` for a fresh child (SPAWN).
|
|
*/
|
|
readonly seed?: SessionEvent[]
|
|
}
|
|
|
|
/**
|
|
* Start an in-process child agent for `request` and return a {@link SubagentRun}.
|
|
*
|
|
* Drives the child as a one-shot: `send(prompt)` then `whenIdle()` (the ordering
|
|
* matters — `send` enqueues synchronously, so `whenIdle` observes the queued
|
|
* work and resolves only on the child's `running → idle` transition, never
|
|
* before the turn starts). The final `assistant/message` is the result output,
|
|
* the matching `turn/end.reason` the stop reason. `dispose()` delegates to the
|
|
* factory's {@link AgentHandle.dispose} (stop loop → await quiescence → remove
|
|
* session); `cancel()` cancels the child's in-flight turn.
|
|
*
|
|
* Throws {@link SubagentDepthError} before creating anything when the child's
|
|
* depth (parent depth + 1) would exceed `request.maxDepth`.
|
|
* @param ctx - the context whose `agents` factory creates and owns the child.
|
|
* @param request - the start request (prompt, parent, signal, per-child options).
|
|
* @param options - the backend's inputs: provider name plus the optional seed.
|
|
* @returns the live run handle for the child agent.
|
|
*/
|
|
export function startInProcessRun(
|
|
ctx: Context,
|
|
request: SubagentStartRequest,
|
|
options: InProcessRunOptions,
|
|
): SubagentRun {
|
|
const childDepth = depthOf(request.parent) + 1
|
|
if (request.maxDepth !== undefined && childDepth > request.maxDepth) {
|
|
throw new SubagentDepthError(childDepth, request.maxDepth)
|
|
}
|
|
|
|
const childId = AgentId(randomUUID())
|
|
// The child's OWN events begin after the seed (fork seeds the parent's
|
|
// completed-turn prefix; spawn seeds nothing). `readResult` scopes to this
|
|
// boundary so a child that produces no message of its own never returns the
|
|
// SEEDED parent's last assistant message as its result.
|
|
const seedLength = options.seed?.length ?? 0
|
|
const parentHeader = request.parent.session.header
|
|
// Inherit the parent's model by default (a child with no model cannot run);
|
|
// an explicit `request.agentOptions.model` overrides it. The persona needs
|
|
// no inheritance: the deployment persona is a context-wide prompt section,
|
|
// so parent and child render the same one.
|
|
const agentOptions: AgentOptions = {
|
|
...request.parent.options.model !== undefined ? { model: request.parent.options.model } : {},
|
|
...request.agentOptions,
|
|
subagentDepth: childDepth,
|
|
}
|
|
|
|
const handle: AgentHandle = ctx.agents.create({
|
|
agentId: childId,
|
|
sessionId: SessionId(randomUUID()),
|
|
meta: {
|
|
...parentHeader.cwd !== undefined ? { cwd: parentHeader.cwd } : {},
|
|
parentSession: parentHeader.id,
|
|
// Record the seed boundary so a reload (and a replay harness) can tell the
|
|
// inherited prefix from the child's OWN events. 0 for a fresh spawn.
|
|
...seedLength > 0 ? { seedLength } : {},
|
|
},
|
|
...options.seed !== undefined ? { seed: options.seed } : {},
|
|
agentOptions,
|
|
})
|
|
const child = handle.agent
|
|
|
|
// Bridge the request's abort signal to the child (the consumer also bridges
|
|
// its own exec.signal, but a backend-level bridge keeps the contract local).
|
|
// `cancelled` records that a cancel was requested at all, so the pre-turn
|
|
// cancel window — where the child clears the queued prompt before any
|
|
// `turn/end` is logged — settles as `aborted` (honoring the cancel contract)
|
|
// rather than falling through to the no-turn `error` mapping.
|
|
let cancelled = false
|
|
const requestCancel = (reason: string): void => {
|
|
cancelled = true
|
|
child.cancel(reason)
|
|
}
|
|
const onAbort = (): void => { requestCancel('subagent cancelled') }
|
|
request.signal?.addEventListener('abort', onAbort, { once: true })
|
|
|
|
const result: Promise<SubagentResult> = (async () => {
|
|
try {
|
|
// A signal already aborted BEFORE the run starts never fires an `abort`
|
|
// event (`addEventListener` only fires on the transition), so the listener
|
|
// above won't catch it — settle `aborted` without running the child rather
|
|
// than completing an already-cancelled request.
|
|
if (request.signal?.aborted) return { output: [], stopReason: 'aborted' }
|
|
child.send(request.prompt)
|
|
await child.whenIdle()
|
|
return readResult(child, seedLength, cancelled)
|
|
} finally {
|
|
request.signal?.removeEventListener('abort', onAbort)
|
|
}
|
|
})()
|
|
|
|
return {
|
|
id: childId,
|
|
result,
|
|
cancel(reason?: string): void {
|
|
requestCancel(reason ?? 'subagent cancelled')
|
|
},
|
|
async dispose(): Promise<void> {
|
|
request.signal?.removeEventListener('abort', onAbort)
|
|
await handle.dispose()
|
|
},
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Read a settled child's terminal result from its session log, scoped to the
|
|
* child's OWN events (everything at or after `seedLength` — fork seeds the
|
|
* parent's completed-turn prefix, so a child that produced no message of its
|
|
* own must NOT return the seeded parent's last assistant message). The output
|
|
* is the child's last `assistant/message` content (deep-cloned — the log is
|
|
* frozen); the stop reason is the child's last `turn/end` reason mapped to a
|
|
* {@link SubagentStopReason}. When `cancelled` is set but no `turn/end` was
|
|
* logged (a cancel landed in the pre-turn window, before any turn ran), the
|
|
* run settles `aborted` per the {@link SubagentRun.cancel} contract rather than
|
|
* the generic no-turn `error`.
|
|
*/
|
|
function readResult(child: Agent, seedLength: number, cancelled: boolean): SubagentResult {
|
|
const own = child.session.events.slice(seedLength)
|
|
const lastMessage = own.findLast((e): e is SessionEvent<'assistant/message'> => e.type === 'assistant/message')
|
|
const lastEnd = own.findLast((e): e is SessionEvent<'turn/end'> => e.type === 'turn/end')
|
|
const output: ContentBlock[] = lastMessage ? structuredClone(lastMessage.data.content) : []
|
|
if (lastEnd === undefined && cancelled) return { output, stopReason: 'aborted' }
|
|
return { output, stopReason: toStopReason(lastEnd?.data.reason) }
|
|
}
|