deepseek-harness/packages/core/agent-loop/src/index.ts

/**
 * THE concrete agent plugin: creates ReactLoopAgents, runs their loops, and
 * registers them in ctx.agents. Deliberately thin — every behavior beyond
 * "call the model, run the tools, repeat" belongs to plugins on the event
 * taxonomy.
 *
 * @module @deepseek-ai/dsh-agent-loop
 */

import { Context, Service } from 'cordis'
import { randomUUID } from 'node:crypto'
import z from 'schemastery'
import type { AgentFactory, AgentHandle, AgentId, AgentOptions, CreateAgentOptions, ResumeAgentOptions, SessionStartSource } from '@deepseek-ai/dsh-agent'
import type {} from '@deepseek-ai/dsh-llm'
import { SessionId } from '@deepseek-ai/dsh-session'
import type { Session } from '@deepseek-ai/dsh-session'
import type {} from '@deepseek-ai/dsh-system-prompt'
import type {} from '@deepseek-ai/dsh-tools'
import type { SessionPersistence } from '@deepseek-ai/dsh-session-persistence'
import { ReactLoopAgent } from './agent.ts'

export { ReactLoopAgent } from './agent.ts'
export { Inbox, type InboxMessage } from './inbox.ts'
export { runLoop } from './loop.ts'

declare module 'cordis' {
  interface Context {
    agentLoop: AgentLoop
  }
}

/**
 * Plugin config: the agents to create — or resume, via `resumeSessionId` —
 * declaratively at startup, so a cordis.yml deployment needs no code.
 */
export interface Config {
  /** Agents created from configuration at startup. */
  agents: (AgentOptions & {
    id: AgentId
    /**
     * If set, the config agent RESUMES this persisted session id instead of
     * starting a fresh `${id}-session-<uuid>`. Sourced from an env var in
     * cordis.yml (`resumeSessionId: !!js process.env.RESUME_SESSION_ID`), so a
     * demo can continue a prior conversation without code changes. Requires a
     * `dsh-session-persistence` backend; the resume is deferred until that
     * service is available (via `ctx.inject`) and the loaded session's events
     * seed the live session so history continues.
     *
     * The schema accepts a plain string at runtime (cordis.yml values are
     * untyped); the brand is compile-time only — the config format is the
     * boundary where an id enters, so the TYPE declares the brand here.
     */
    resumeSessionId?: SessionId
  })[]
}

/**
 * The agent-loop plugin (`ctx.agentLoop`): creates {@link ReactLoopAgent}s, runs
 * their loops, and registers them in `ctx.agents`. Also implements the
 * {@link AgentFactory} seam, so plugins create/resume agents through
 * `ctx.agents` (the interface) without depending on this concrete package.
 *
 * The loop itself is deliberately thin — every behavior beyond "call the
 * model, run the tools, repeat" belongs to plugins listening on the event
 * taxonomy declared in @deepseek-ai/dsh-agent.
 */
export class AgentLoop extends Service implements AgentFactory {
  static inject = ['agents', 'sessions', 'llm', 'tools', 'systemPrompt']

  // The schema validates plain strings (cordis.yml config values are untyped at
  // runtime); the {@link Config} TYPE declares the branded `id`/`resumeSessionId`
  // because the config format is the boundary where an id enters. The brand is a
  // zero-cost compile-time cast, so the runtime schema stays string-based and we
  // assert the branded view once here — the single schema boundary.
  static Config = z.object({
    agents: z.array(z.object({
      id: z.string().required(),
      model: z.string(),
      resumeSessionId: z.string(),
    })).default([]),
  }) as unknown as z<Config>

  constructor(ctx: Context, public config: Config) {
    super(ctx, 'agentLoop')
    // Provide the agent-creation factory to the registry (effect-scoped: the
    // slot is cleared on dispose).
    ctx.effect(() => this.ctx.agents.setFactory(this), 'agentLoop.setFactory()')
    // The prompt variables the shipped loop provides, registered once. The
    // sections themselves (`harness:identity`, `deployment:persona`) belong to
    // dsh-system-prompt — they must survive a swapped loop plugin — but
    // `{{model}}`/`{{cwd}}` are runtime facts of the agents THIS loop drives:
    // it assembles with `{ agent }` each step (loop.ts), and the variables
    // project the agent's configured model and its session workspace from that
    // context. A provider returns undefined when the fact is absent
    // (renderPrompt then rejects a persona that claims it — fail loud).
    ctx.systemPrompt.variable('model', context => context.agent?.options.model)
    ctx.systemPrompt.variable('cwd', context => context.agent?.session.header.cwd)
    for (const { id, resumeSessionId, ...options } of config.agents) {
      if (resumeSessionId !== undefined && resumeSessionId !== '') {
        // Resume a prior session instead of starting fresh. resume() needs
        // `ctx.sessionPersistence`, which may load AFTER this plugin (cordis.yml
        // lists the backend later). `ctx.inject(['sessionPersistence'], cb)`
        // runs `cb` with a child ctx once the service exists; the child reads
        // the persistence and hands it to resumeWith (which uses this.ctx — the
        // parent — for sessions/registry, all in AgentLoop's static inject). A
        // failed resume is contained + logged: startup must not crash.
        ctx.effect(() => {
          const fiber = this.ctx.inject(['sessionPersistence'], (childCtx: Context) => {
            void this.resumeWith(childCtx.sessionPersistence, { agentId: id, resumeSessionId, agentOptions: options })
              .catch((error: unknown) => {
                this.ctx.logger.warn(`agent "${id}": config-driven resume of "${resumeSessionId}" failed: ${String(error)}`)
              })
          })
          return () => void fiber.dispose()
        }, `agentLoop.resume(${id})`)
      } else {
        this.create(id, options)
      }
    }
  }

  /**
   * Config-driven create: an agent on a FRESH, non-colliding session id per run
   * (`${id}-session-<uuid>`, no cwd). Used for `cordis.yml`-configured agents
   * and as the shared core for the programmatic factory {@link createAgent}.
   *
   * Why a per-run id, not a fixed `${id}-session`: once a durable persistence
   * backend is loaded, a fixed id collides on the second run — the backend
   * refuses to re-create an id whose log already exists on disk (the SessionId
   * is the identity). A fresh id means each run is a new session.
   *
   * TODO(demo): each run starting a brand-new session is fine for demos but is
   * NOT real conversation continuity. A production config-driven agent needs a
   * deliberate resume-or-create policy (resume the prior session if one exists,
   * else start fresh) or an explicit caller-chosen session id — revisit when the
   * UI/ACP path owns session selection.
   * @param id - the agent id; also seeds the generated session id.
   * @param options - loop options (model, limits, …); defaults applied per option.
   * @returns the running agent, owned by the calling fiber (no handle).
   */
  create(id: AgentId, options: AgentOptions = {}): ReactLoopAgent {
    this.assertAgentIdFree(id)
    // Config/programmatic path: prepare the session and let start() fold its
    // lifecycle into the agent's composite effect (so a fiber unload tears the
    // session + agent down as one ordered chain, capturing the loop's closing
    // flush). The whole effect is owned by THIS fiber; no AgentHandle is needed.
    const session = this.ctx.sessions.prepare(SessionId(`${id}-session-${randomUUID()}`), { meta: {} })
    const { agent } = this.start(id, options, session, 'startup')
    return agent
  }

  /**
   * Programmatic factory create ({@link AgentFactory}): an agent on a
   * caller-supplied `sessionId` (NOT `${id}-session`), with optional session
   * metadata (validated `cwd`, lineage) and an optional `seed` event prefix. The
   * ACP bridge uses this so the client-generated session id becomes the
   * live/persisted session id; the in-process FORK subagent backend passes a
   * `seed` (a balanced completed-turn prefix of the parent's log) so the child
   * starts with the parent's context. Returns an {@link AgentHandle} the owner
   * disposes to tear down exactly this agent.
   * @param options - agent id, caller-supplied session id, optional seed/meta,
   *   and agent options.
   * @returns the handle whose dispose tears down exactly this agent.
   */
  createAgent(options: CreateAgentOptions): AgentHandle {
    // Check the agent id BEFORE preparing the session: register() would reject a
    // duplicate id only AFTER the session enters the store, leaving an orphaned
    // live session (and lazy persistence state) that blocks reuse of that id.
    this.assertAgentIdFree(options.agentId)
    const session = this.ctx.sessions.prepare(options.sessionId, {
      ...options.seed !== undefined ? { seed: options.seed } : {},
      meta: options.meta ?? {},
    })
    // A seeded (forked) create is still a fresh start, NOT a resume — `resume`
    // is reserved for reloading a PERSISTED session via resume()/resumeWith().
    return this.startOwned(options.agentId, options.agentOptions ?? {}, session, 'startup')
  }

  /**
   * Resume an agent on a persisted session ({@link AgentFactory}). Loads the
   * session log + metadata via `ctx.sessionPersistence`, reconstructs the live
   * session with the loaded events (so `lastTurnNumber`/`deriveMessages`
   * continue), and starts a fresh agent on it. The live session id is the
   * resumed id, NOT `${agentId}-session`.
   *
   * Requires `ctx.sessionPersistence`; rejects with a clear error if it is not
   * configured. NOT hard-injected (that would make non-persistent demos pend
   * forever) — callers that need resume (ACP) inject `sessionPersistence`, so
   * by the time this runs the service exists.
   * @param options - the persisted session id to reload, plus agent id/options.
   * @returns the handle for the agent resumed on the reconstructed session.
   */
  async resume(options: ResumeAgentOptions): Promise<AgentHandle> {
    // Read the service through `ctx.get('sessionPersistence')` — a direct
    // global-store lookup keyed by the isolate symbol — NOT
    // `this.ctx.sessionPersistence`. AgentLoop deliberately does NOT inject
    // `sessionPersistence` (injecting it would pend non-persistent demos
    // forever). The `ctx.<name>` property proxy resolves a service by an
    // ancestor-only walk of the current fiber's parent chain; from AgentLoop's
    // own fiber (which lacks the inject) that walk never reaches the sibling
    // backend fiber and throws "cannot get property … without inject". Worse,
    // when the call arrives via a traceable shadow (e.g. the ACP bridge child
    // fiber → `ctx.agents.resume()` → `this.factory.resume()`), the walk starts
    // at the shadow's origin fiber and fails the same way. `ctx.get(name)`
    // sidesteps the fiber walk entirely (a store lookup by the global isolate
    // key), so resume works from any caller fiber. It is strict by default: a
    // backend that is not ACTIVE (absent, or mid-teardown) reads as undefined
    // and we reject below, rather than handing back an unusable handle.
    const persistence = this.ctx.get('sessionPersistence')
    if (persistence === undefined) {
      throw new Error('cannot resume: session persistence is not configured (load a dsh-session-persistence backend)')
    }
    return this.resumeWith(persistence, options)
  }

  /**
   * Resume against an EXPLICIT persistence handle. Factored out of {@link resume}
   * so the config-driven path can pass the handle it obtained from a
   * `ctx.inject(['sessionPersistence'], …)` child context: `this.ctx` (the
   * service's own fiber) did not inject `sessionPersistence`, so reading it
   * there from inside the inject child trips the cordis inject guard. The
   * sessions store + registry are still read through `this.ctx` (both are in
   * AgentLoop's static inject, so they resolve fine).
   */
  private async resumeWith(persistence: SessionPersistence, options: ResumeAgentOptions): Promise<AgentHandle> {
    this.assertAgentIdFree(options.agentId)
    const { meta, events } = await persistence.load(options.resumeSessionId)
    // Re-check the agent id AFTER the await: the pre-load check above can go
    // stale while load() is pending (a concurrent resume/create may register the
    // same id). Re-checking immediately before prepare()/start keeps the
    // "no orphaned session on a duplicate id" guarantee under concurrency.
    this.assertAgentIdFree(options.agentId)
    // Reconstruct the live session with the FULL persisted header (createdAt,
    // cwd, lineage) so resume preserves identity, not just the cwd. The seed
    // events make lastTurnNumber/deriveMessages continue; the backend already
    // has state (cursor) from the load above, so onCreated is a no-op and the
    // seed is not re-persisted. prepare() (not create()) so the session
    // lifecycle folds into the agent's composite effect (ordered teardown).
    const session = this.ctx.sessions.prepare(options.resumeSessionId, {
      seed: events,
      meta: {
        createdAt: meta.createdAt,
        ...meta.cwd !== undefined ? { cwd: meta.cwd } : {},
        ...meta.parentSession !== undefined ? { parentSession: meta.parentSession } : {},
        // Reconstruct the seed boundary from the persisted header, NOT from
        // `events.length` (the resume seeds the WHOLE stored log).
        ...meta.seedLength !== undefined ? { seedLength: meta.seedLength } : {},
      },
    })
    return this.startOwned(options.agentId, options.agentOptions ?? {}, session, 'resume')
  }

  /**
   * Reject a duplicate agent id BEFORE the session is entered into the store, so
   * a failed factory call never leaves an orphaned live session (and lazy
   * persistence state) behind. `register()` enforces the same uniqueness, but
   * only after the session has already entered the store.
   */
  private assertAgentIdFree(id: AgentId): void {
    if (this.ctx.agents.get(id) !== undefined) {
      throw new Error(`agent "${id}" is already registered`)
    }
  }

  /**
   * Shared: construct a ReactLoopAgent over a PREPARED (not-yet-entered)
   * session, then build the ONE composite effect that owns the whole agent
   * lifecycle — session entry, registry registration, and the loop. Keeping all
   * three in a SINGLE effect (not sibling effects) is load-bearing: a fiber
   * unload disposes sibling effects CONCURRENTLY (`Promise.all`), which would
   * race the session detach against the loop's closing flush and drop the
   * closing `turn/end`. Inside one effect the disposers run as an ORDERED LIFO
   * chain — the runtime awaits each disposer's returned promise before the next:
   *
   *   yield session-detach   (disposed LAST  — detach onAppend + remove entry)
   *   yield register         (disposed 2nd   — unregister)
   *   yield stop-and-drain   (disposed FIRST — request loop stop, await agent.done)
   *
   * So on teardown: the loop is stopped and AWAITED to exit (its final
   * `session/flush` + `turn/end` fire through the still-attached `onAppend`),
   * THEN the agent is unregistered, THEN the session is detached — capturing the
   * closing events before detach, whether the trigger is the handle's `dispose()`
   * OR a fiber unload. Rollback safety: each yield runs before the next mutation,
   * so a throwing `session/created`/`agent/created` listener unwinds the
   * already-yielded disposers instead of leaking.
   *
   * `source` says why the session began ({@link SessionStartSource}); it is
   * emitted as `agent/session-start` once, AFTER the agent is registered (so a
   * listener can resolve the agent via `ctx.agents.get(id)` and `inject()` into
   * it) and BEFORE the loop starts its first turn. The emit is contained: a
   * throwing session-start listener must not abort agent construction — it is
   * logged, and the agent still starts. (Unlike a turn-boundary throw, there is
   * no open turn here to balance; the durable evidence of a session-start hook
   * is whatever it `inject()`ed.)
   *
   * Returns the agent plus the composite effect's disposer (`disposeAgent`).
   */
  private start(
    id: AgentId, options: AgentOptions, session: Session, source: SessionStartSource,
  ): { agent: ReactLoopAgent; disposeAgent: () => Promise<void> } {
    const agent = new ReactLoopAgent(this.ctx, id, options, session)
    const dispose = this.ctx.effect(function* (this: AgentLoop) {
      yield this.ctx.sessions.enter(session)
      this.ctx.sessions.announce(session)
      yield this.ctx.agents.register(agent)
      // Fire AFTER register (a listener can ctx.agents.get(id) + inject()) and
      // BEFORE the loop's first turn. Contained: a throwing listener is logged,
      // never aborts construction (no open turn to balance here).
      try {
        this.ctx.emit('agent/session-start', agent, source)
      } catch (error: unknown) {
        this.ctx.logger.warn(`agent "${id}": agent/session-start listener threw: ${String(error)}`)
      }
      const stop = agent.start()
      // Disposed FIRST (LIFO): request loop stop (sync), then AWAIT the loop's
      // actual exit so its closing flush lands while onAppend (yielded above,
      // disposed later) is still attached.
      yield async () => { stop(); await agent.done }
    }.bind(this), 'agentLoop.start()')
    return { agent, disposeAgent: async () => { await dispose() } }
  }

  /**
   * Build an {@link AgentHandle} for a PREPARED session + a fresh agent. The
   * handle's `dispose()` runs the composite effect's disposer (see
   * {@link start}) — which stops the loop, awaits its exit (final flush
   * captured), unregisters the agent, and detaches the session, in that order.
   * The same composite effect is what a fiber unload disposes, so both teardown
   * triggers honor the ordering identically.
   *
   * `dispose()` is MEMOIZED: the underlying cordis effect disposer is
   * single-shot (a second call returns immediately because the effect's epoch is
   * already cleared, NOT awaiting the in-flight teardown), so concurrent/repeated
   * `dispose()` calls would otherwise resolve before the first call's
   * `await agent.done` + final flush completed. Memoizing the promise makes every
   * caller observe the SAME quiescence boundary, honoring the
   * `AgentHandle.dispose(): Promise<void>` contract (mirrors the ACP `quiesce()`
   * helper).
   */
  private startOwned(id: AgentId, options: AgentOptions, session: Session, source: SessionStartSource): AgentHandle {
    const { agent, disposeAgent } = this.start(id, options, session, source)
    let disposing: Promise<void> | undefined
    return { agent, dispose: () => (disposing ??= disposeAgent()) }
  }
}

export default AgentLoop