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
306 lines
16 KiB
TypeScript
306 lines
16 KiB
TypeScript
/**
|
|
* The concrete Agent implementation: ReactLoopAgent plus its inbox. Everything
|
|
* observable happens through session events and the agent/* event taxonomy —
|
|
* plugins never need this class.
|
|
*
|
|
* @module dsh-agent-loop/agent
|
|
*/
|
|
|
|
import type { Context } from 'cordis'
|
|
import type { AgentId, AgentOptions, AgentStatus, SendOptions } from '@deepseek-ai/dsh-agent'
|
|
import type { Agent } from '@deepseek-ai/dsh-agent'
|
|
import type { ContentBlock, MessageSource } from '@deepseek-ai/dsh-llm'
|
|
import type { Session } from '@deepseek-ai/dsh-session'
|
|
import { Inbox } from './inbox.ts'
|
|
import { isTurnOpen, lastTurnNumber, runLoop } from './loop.ts'
|
|
|
|
/**
|
|
* The concrete {@link Agent} implementation owned by the agent-loop plugin.
|
|
*
|
|
* Owns the inbox (queued + steering FIFOs), the per-step AbortController, and
|
|
* the loop driver. Everything observable happens through session events and
|
|
* the agent/* event taxonomy — plugins never need this class.
|
|
*/
|
|
export class ReactLoopAgent implements Agent {
|
|
/**
|
|
* The queued + steering FIFOs behind {@link send}/{@link steer}. Public so
|
|
* the driver loop can drain it; {@link cancel} clears it wholesale.
|
|
*/
|
|
readonly inbox = new Inbox()
|
|
|
|
private _status: AgentStatus = 'idle'
|
|
private currentAbort: AbortController | undefined
|
|
/**
|
|
* Turn-scoped cancel marker, set by {@link cancel} and read/cleared by the
|
|
* driver loop (via the LoopHandle) at every point a turn could start or
|
|
* continue. Armed ONLY when there is something to cancel (a running turn, an
|
|
* in-flight step, or queued/steering work), so an idle no-op cancel cannot
|
|
* leave it set to wrongly drop a later prompt.
|
|
*/
|
|
private cancelRequested = false
|
|
/**
|
|
* The resolved reason for the pending {@link cancel} (`reason ?? 'cancelled'`),
|
|
* read by the driver loop's marker branches so a turn dropped in a
|
|
* marker-only window (pre-step / continuation, where no `AbortController`
|
|
* carries the reason) ends with the SAME `{kind:'aborted', reason}` the
|
|
* mid-step abort path produces from `abort.signal.reason`. Without this the
|
|
* caller's `cancel(reason)` would be silently replaced by the literal
|
|
* 'cancelled' whenever the cancel landed outside a running step — making the
|
|
* logged reason race-dependent and the public `reason?` param half-effective.
|
|
*/
|
|
private cancelReason = 'cancelled'
|
|
private disposed: Promise<void>
|
|
private resolveDisposed!: () => void
|
|
/** Resolves when the driver loop has fully exited (tests/disposal). */
|
|
done: Promise<void> = Promise.resolve()
|
|
/**
|
|
* Pending {@link whenIdle} waiters, resolved by {@link settleIdleWaiters} when
|
|
* the agent next settles out of `running`. Kept as internal agent state (NOT
|
|
* an effect-scoped `ctx.on` listener) so a concurrent fiber disposal — which
|
|
* runs the agent's own listeners' disposers — cannot drop the waiter before
|
|
* the `disposed` transition fires and leave the promise hanging.
|
|
*/
|
|
private idleWaiters: (() => void)[] = []
|
|
|
|
constructor(
|
|
private ctx: Context,
|
|
public readonly id: AgentId,
|
|
public readonly options: AgentOptions,
|
|
public readonly session: Session,
|
|
) {
|
|
const { promise, resolve } = Promise.withResolvers<void>()
|
|
this.disposed = promise
|
|
this.resolveDisposed = resolve
|
|
}
|
|
|
|
get status(): AgentStatus {
|
|
return this._status
|
|
}
|
|
|
|
private setStatus(status: AgentStatus): void {
|
|
if (this._status === status || this._status === 'disposed') return
|
|
this._status = status
|
|
// Release quiescence waiters on a transition OUT of running BEFORE emitting
|
|
// (the disposer handles the disposed transition separately). Settling first
|
|
// means a throwing `agent/status` subscriber cannot starve a `whenIdle()`
|
|
// waiter (docs/defensive-patterns.md "contain callback exceptions" — a lifecycle await must
|
|
// not hang on one bad listener).
|
|
if (status !== 'running') this.settleIdleWaiters()
|
|
try {
|
|
this.ctx.emit('agent/status', this, status)
|
|
} catch (error: unknown) {
|
|
this.ctx.logger.warn(`agent "${this.id}": agent/status listener threw on ${status}: ${String(error)}`)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Resolve and clear all pending {@link whenIdle} waiters. Called on a
|
|
* running→idle transition (from {@link setStatus}) and on disposal (from the
|
|
* {@link start} disposer, which chains `done` for true loop-exit quiescence).
|
|
*/
|
|
private settleIdleWaiters(): void {
|
|
const waiters = this.idleWaiters
|
|
this.idleWaiters = []
|
|
for (const resolve of waiters) resolve()
|
|
}
|
|
|
|
private resolveSource(options?: SendOptions): MessageSource {
|
|
return options?.source ?? { kind: 'user' }
|
|
}
|
|
|
|
send(content: ContentBlock[], options?: SendOptions): void {
|
|
if (this._status === 'disposed') throw new Error(`agent "${this.id}" is disposed`)
|
|
const source = this.resolveSource(options)
|
|
this.inbox.enqueue({ content, source })
|
|
this.ctx.emit('agent/queued', this, content, { source, steering: false })
|
|
}
|
|
|
|
steer(content: ContentBlock[], options?: SendOptions): void {
|
|
if (this._status === 'disposed') throw new Error(`agent "${this.id}" is disposed`)
|
|
if (this._status !== 'running') { this.send(content, options); return }
|
|
const source = this.resolveSource(options)
|
|
this.inbox.steer({ content, source })
|
|
this.ctx.emit('agent/queued', this, content, { source, steering: true })
|
|
}
|
|
|
|
inject(content: ContentBlock[], options?: SendOptions): void {
|
|
if (this._status === 'disposed') throw new Error(`agent "${this.id}" is disposed`)
|
|
const source = this.resolveSource(options)
|
|
if (isTurnOpen(this.session)) {
|
|
// A turn is open in the LOG (decided from the log, not agent status —
|
|
// status can be `running` with no turn open): the context/message is
|
|
// turn-enclosed by that turn, so append it directly.
|
|
this.session.append('context/message', { content, source }, { surfaceOp: 'append' })
|
|
return
|
|
}
|
|
// No turn open: wrap the injection in a one-shot turn so every event stays
|
|
// turn-enclosed (the durability/replay boundary is the turn).
|
|
const turn = lastTurnNumber(this.session) + 1
|
|
// Once turn/start enters the log, a turn/end is OWED no matter what — even
|
|
// if a throwing `session/event` listener escapes from the turn/start append
|
|
// (Session.append pushes the event BEFORE notifying listeners) or the
|
|
// context/message append throws (non-serializable content, throwing
|
|
// listener). The finally re-checks the log via isTurnOpen() and closes the
|
|
// turn if one was actually opened, so the log never carries a permanently
|
|
// open injection turn that would corrupt later turns/replay. (If the
|
|
// turn/start append throws BEFORE pushing — non-serializable trigger, which
|
|
// can't happen for our fixed trigger — no turn was opened and none is owed.)
|
|
try {
|
|
this.session.append('turn/start', { turn, trigger: { kind: 'injection', source } })
|
|
this.session.append('context/message', { content, source }, { surfaceOp: 'append' })
|
|
} finally {
|
|
// Close the turn if turn/start made it into the log. Contain a throwing
|
|
// turn/end listener: Session.append pushes before notifying, so a throw
|
|
// here still leaves turn/end in the log (the turn is balanced) — swallow
|
|
// it so it neither replaces the original exception nor skips the flush
|
|
// decision below. (It surfaces through the flush path is not needed; the
|
|
// turn-balance contract is what matters and it holds.)
|
|
if (isTurnOpen(this.session)) {
|
|
try {
|
|
this.session.append('turn/end', { turn, reason: { kind: 'completed' } })
|
|
} catch {
|
|
// turn/end is already in the log (pushed before the listener threw),
|
|
// so the turn is balanced; the throw is the listener's bug.
|
|
}
|
|
}
|
|
// Decide the durability checkpoint from the LOG, not a flag: a turn was
|
|
// recorded iff this turn's turn/start is logged (it may have been closed
|
|
// by a throwing-listener turn/end above, which still counts). A
|
|
// `turnRecorded` boolean set after append('turn/end') would be skipped by
|
|
// a throwing turn/end listener, losing the flush for a balanced in-memory
|
|
// turn (crash before the next turn/dispose would drop the idle injection).
|
|
const turnRecorded = this.session.events.some(e => e.type === 'turn/start' && e.data.turn === turn)
|
|
// Checkpoint the one-shot turn for durability, exactly as the loop does at
|
|
// every turn/end. The loop is NOT running (we are idle), so nothing else
|
|
// will flush this turn. Fire-and-forget with error containment: inject()
|
|
// is synchronous, and a persistence backend failing must not throw into
|
|
// the caller (e.g. a tool-bash task-done callback). Disposal still drains
|
|
// independently, so a slow flush is safe. A flush failure is reported via
|
|
// agent/error (step 0 — the idle-injection convention, there is no real
|
|
// step) AND the logger, mirroring the loop's post-turn/end flush path so
|
|
// plugins monitoring agent/error see idle-injection persistence failures
|
|
// too. A throwing agent/error listener is contained.
|
|
if (turnRecorded) {
|
|
void Promise.resolve(this.ctx.parallel('session/flush', this.session)).catch((error: unknown) => {
|
|
const err = error instanceof Error ? error : new Error(String(error))
|
|
this.ctx.logger.warn(`agent "${this.id}": flush after idle injection failed: ${err.message}`)
|
|
try {
|
|
this.ctx.emit('agent/error', this, turn, 0, err)
|
|
} catch {
|
|
// contained: the failure is already logged; a throwing agent/error
|
|
// listener must not escape this fire-and-forget catch.
|
|
}
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
cancel(reason?: string): void {
|
|
// Arm-gate: only mark a cancellation when there is actually work to cancel —
|
|
// a running turn, an in-flight step, or queued/steering work. An idle cancel
|
|
// with nothing pending is a true no-op; arming the marker then would wrongly
|
|
// drop the NEXT legitimate prompt (the marker is consumed only at the loop's
|
|
// turn-decision points, which an idle parked loop does not reach until woken
|
|
// by a real send()). Note the gate canNOT be `status === 'running'` alone:
|
|
// the pre-step window (a send() queued but the loop not yet flipped to
|
|
// running) has status `idle` with `hasQueued` true, and the marker exists
|
|
// precisely to cover it.
|
|
if (this._status === 'running' || this.currentAbort !== undefined || this.inbox.hasQueued || this.inbox.hasSteering) {
|
|
this.cancelRequested = true
|
|
// Capture the resolved reason for the marker-only windows (pre-step /
|
|
// continuation). The mid-step path reads it from abort.signal.reason
|
|
// below; the marker path reads it via the LoopHandle's cancelReason().
|
|
this.cancelReason = reason ?? 'cancelled'
|
|
}
|
|
// Drop all pending queued + steering work (un-started prompts never run; the
|
|
// cancelled turn's steering is not re-enqueued). Cleared directly even when
|
|
// the loop is parked in waitForQueued — there is no turn to stop and nothing
|
|
// left for the parked loop to run, so no wake is needed.
|
|
this.inbox.clear()
|
|
// Interrupt an in-flight step immediately (the running turn observes the
|
|
// abort and ends `aborted`). The marker covers the windows where no step is
|
|
// running (pre-step, continuation).
|
|
this.currentAbort?.abort(reason ?? 'cancelled')
|
|
}
|
|
|
|
/**
|
|
* Resolve once the agent has reached quiescence after settling out of
|
|
* `running`. If it is already disposed, awaits {@link done} (the loop-exit
|
|
* promise) — `agent/status('disposed')` fires in the disposer BEFORE the
|
|
* driver loop has unwound, so it is NOT itself a quiescence signal. If it is
|
|
* idle AND has no queued work, resolves immediately. Otherwise queues an
|
|
* internal waiter (see {@link idleWaiters}) released on the next
|
|
* running→idle/disposed transition, resolving on `idle` directly (the turn
|
|
* fully ended) or chaining {@link done} on `disposed` (wait for the loop to
|
|
* actually exit). Implements the {@link Agent.whenIdle} contract: a non-owner
|
|
* quiescence-observation hook, distinct from teardown (a lifecycle owner stops
|
|
* and unregisters via `AgentHandle.dispose()`, which awaits {@link done}
|
|
* directly, not through this).
|
|
*/
|
|
whenIdle(): Promise<void> {
|
|
if (this._status === 'disposed') return this.done
|
|
if (this._status !== 'running' && !this.inbox.hasQueued) return Promise.resolve()
|
|
// Register an internal waiter (resolved by settleIdleWaiters on the next
|
|
// running→idle/disposed transition), NOT an effect-scoped `ctx.on` listener:
|
|
// a concurrent fiber disposal runs this agent's listener disposers, which
|
|
// could remove a `ctx.on` waiter before the `disposed` transition fires and
|
|
// hang the promise. On disposal the disposer settles the waiter AND we chain
|
|
// `done` here for true loop-exit quiescence (status flips to disposed before
|
|
// the loop unwinds); a plain idle transition resolves directly.
|
|
return new Promise<void>((resolve) => {
|
|
this.idleWaiters.push(() => {
|
|
resolve(this._status === 'disposed' ? this.done : undefined)
|
|
})
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Start the driver loop. Returns a disposer: calling it sets status to
|
|
* `disposed`, emits `agent/status('disposed')`, resolves the disposed
|
|
* promise (unblocking the idle wait), releases any `whenIdle` waiters, and
|
|
* aborts the current request if any. The returned `agent.done` promise
|
|
* resolves once the loop exits.
|
|
* @returns the disposer — idempotent and infallible (it runs inside the
|
|
* fiber's LIFO disposal chain, where a throw would skip later disposers).
|
|
*/
|
|
start(): () => void {
|
|
this.done = runLoop(this.ctx, this, {
|
|
setStatus: (status) => { this.setStatus(status) },
|
|
setAbort: controller => void (this.currentAbort = controller),
|
|
disposed: this.disposed,
|
|
isDisposed: () => this._status === 'disposed',
|
|
isCancelled: () => this.cancelRequested,
|
|
cancelReason: () => this.cancelReason,
|
|
clearCancel: () => { this.cancelRequested = false },
|
|
// Settle whenIdle() waiters WITHOUT a status transition — the pre-step
|
|
// cancel-skip path drops the about-to-run turn and re-parks without ever
|
|
// flipping running→idle, so a waiter registered in the pre-step window
|
|
// (status idle, hasQueued was true) would otherwise hang. This emits no
|
|
// agent/status, so an ACP agent/status listener never sees a spurious idle
|
|
// that would resolve a freshly-queued prompt as cancelled.
|
|
settleIdle: () => { this.settleIdleWaiters() },
|
|
})
|
|
// The disposer must be infallible: it runs inside the fiber's LIFO
|
|
// disposal chain, where a throw would skip later disposers (e.g. the
|
|
// registry unregistration) and leave `done` pending forever.
|
|
return () => {
|
|
if (this._status === 'disposed') return
|
|
this._status = 'disposed'
|
|
this.resolveDisposed()
|
|
// Release whenIdle waiters BEFORE the (guarded) event emit — they are
|
|
// internal state that must settle even if a listener throws below. Each
|
|
// waiter chains `done`, so it resolves only once the loop actually exits.
|
|
this.settleIdleWaiters()
|
|
this.currentAbort?.abort('disposed')
|
|
// setStatus refuses transitions out of 'disposed', so emit directly —
|
|
// 'disposed' is part of the agent/status contract. Guarded: a throwing
|
|
// listener must not break the disposal chain.
|
|
try {
|
|
this.ctx.emit('agent/status', this, 'disposed')
|
|
} catch {
|
|
// listener error during disposal — nothing safe left to do with it
|
|
}
|
|
}
|
|
}
|
|
}
|