931 lines
42 KiB
TypeScript
931 lines
42 KiB
TypeScript
/**
|
|
* Event-sourced session service: append-only session log, in-memory store, and
|
|
* the derived LLM message history. Persistence is a plugin concern (subscribe
|
|
* to `session/event`, drain on `session/flush`).
|
|
*
|
|
* @module @deepseek-ai/dsh-session
|
|
*/
|
|
|
|
import { Context, Service } from 'cordis'
|
|
import { isAbsolute } from 'node:path'
|
|
import { deepFreeze } from '@deepseek-ai/dsh-llm'
|
|
import { scopeOf, scopeTarget } from '@deepseek-ai/dsh-scope'
|
|
import type { Scoped } from '@deepseek-ai/dsh-scope'
|
|
import type { ContentBlock, Message, MessageSource } from '@deepseek-ai/dsh-llm'
|
|
import { SESSION_FORMAT_VERSION, SessionId } from './types.ts'
|
|
import type { CreateSessionOptions, EpochHeader, SessionEvent, SessionEventMap, SessionEventType, SessionHeader, SurfaceIntent, SurfaceEventType } from './types.ts'
|
|
import { snapshotJsonValue } from './json.ts'
|
|
import { SurfaceManager, isSurfaceEligibleType } from './surface.ts'
|
|
import { foldRequestHeader } from './request-header.ts'
|
|
|
|
export * from './types.ts'
|
|
export { isJsonValue, snapshotJsonValue } from './json.ts'
|
|
export type { JsonValue } from './json.ts'
|
|
export { interruptedTurnClosers } from './repair.ts'
|
|
export type { SurfaceNode } from './surface.ts'
|
|
export { isSurfaceEvent, isSurfaceEligibleType } from './surface.ts'
|
|
export { isToolPairingBalanced } from './tool-pairing.ts'
|
|
export { applyHeaderDelta, canonicalHeader, diffHeader, foldRequestHeader, headerEquals } from './request-header.ts'
|
|
|
|
declare module 'cordis' {
|
|
interface Context {
|
|
sessions: SessionStore
|
|
}
|
|
|
|
interface Events {
|
|
/**
|
|
* A session was created in the store. A synchronous listener throw vetoes
|
|
* publication and rollback emits the matching `session/disposed` edge;
|
|
* returned-promise rejection is observed and logged but cannot retroactively
|
|
* veto this synchronous boundary. A synchronous listener that requests the
|
|
* advanced detach does not remove the entry immediately: removal and the
|
|
* paired `session/disposed` edge wait until the creation dispatch unwinds.
|
|
* Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): the carrier is the
|
|
* session's owner scope, captured when the session was ENTERED (an agent's
|
|
* session is entered through `agent.ctx`, so its events dispatch in that
|
|
* agent's scope; a bare `sessions.create()` from a plain plugin dispatches
|
|
* subject-less). A listener registered through `agent.ctx` hears only that
|
|
* agent's sessions; a plain plugin listener hears every session.
|
|
* @param session - the session just entered and announced.
|
|
* @mode emit
|
|
*/
|
|
'session/created'(this: Scoped<Session>, session: Session): void
|
|
/**
|
|
* A previously announced session left the store. Emitted exactly once on
|
|
* normal detach or publication rollback, and never for a prepared/entered
|
|
* session whose `session/created` announcement did not begin. Listener
|
|
* failures (including returned-promise rejections) are logged and contained
|
|
* per listener so teardown always reaches quiescence.
|
|
* Scope-filtered dispatch uses the same owner carrier captured at entry;
|
|
* agent-scoped listeners hear only their own session's teardown.
|
|
* @param session - the session that is no longer live in the store.
|
|
* @mode emit
|
|
*/
|
|
'session/disposed'(this: Scoped<Session>, session: Session): void
|
|
/**
|
|
* An event was appended to a session log (sync, fire-and-forget). This is
|
|
* the per-append feed a UI or invariant plugin tails. The log push is the
|
|
* commit point; synchronous throws and returned-promise rejections from
|
|
* observers are logged and contained per listener, so they cannot make a
|
|
* committed append appear to fail or starve later listeners. The exact
|
|
* callback list and Cordis internal-dispatch checks resolve before the push;
|
|
* callbacks themselves run only after it.
|
|
* Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): the carrier is the
|
|
* session's owner scope, captured when the session was ENTERED (an agent's
|
|
* session is entered through `agent.ctx`, so its events dispatch in that
|
|
* agent's scope; a bare `sessions.create()` from a plain plugin dispatches
|
|
* subject-less). A listener registered through `agent.ctx` hears only that
|
|
* agent's sessions; a plain plugin listener hears every session.
|
|
* @param session - the session whose log grew.
|
|
* @param event - the appended event, exactly as recorded.
|
|
* @mode emit
|
|
*/
|
|
'session/event'(this: Scoped<Session>, session: Session, event: SessionEvent): void
|
|
/**
|
|
* Awaited durability checkpoint. The agent loop awaits
|
|
* `ctx.sessions.flush(session)` at every turn end; persistence
|
|
* plugins (JSONL, SQLite) drain their write-behind buffers here and on
|
|
* fiber dispose. Awaited (parallel), not a waterfall: every listener runs
|
|
* and the caller waits for all of them, but none can veto. Dispatch it
|
|
* through {@link SessionStore.flush} — the store owns the carrier — never
|
|
* via a raw `ctx.parallel`.
|
|
* Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): the carrier is the
|
|
* session's owner scope, captured when the session was ENTERED (an agent's
|
|
* session is entered through `agent.ctx`, so its events dispatch in that
|
|
* agent's scope; a bare `sessions.create()` from a plain plugin dispatches
|
|
* subject-less). A listener registered through `agent.ctx` hears only that
|
|
* agent's sessions; a plain plugin listener hears every session.
|
|
* @param session - the session whose buffered events must reach durable storage.
|
|
* @mode parallel
|
|
*/
|
|
'session/flush'(this: Scoped<Session>, session: Session): Promise<void> | void
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Renders a `context/message` or `steering/message` event as a tagged
|
|
* synthetic user-role message (the system-reminder pattern: zero adapter
|
|
* burden, models distinguish it from real user prompts by the envelope).
|
|
*
|
|
* Live-adapter review has validated the tagged-envelope rendering against
|
|
* current DeepSeek behavior; provider-specific mismatches belong in that
|
|
* adapter, not in the canonical session vocabulary.
|
|
*/
|
|
function renderTagged(tag: string, content: ContentBlock[], source: MessageSource): ContentBlock[] {
|
|
const open = `<${tag} source=${JSON.stringify(source.kind)}>`
|
|
const close = `</${tag}>`
|
|
return [
|
|
{ type: 'text', text: open },
|
|
...content,
|
|
{ type: 'text', text: close },
|
|
]
|
|
}
|
|
|
|
/** Detach, validate, and freeze the creation metadata published by a session. */
|
|
function snapshotSessionHeader(id: SessionId, source?: SessionHeader): SessionHeader {
|
|
const input: unknown = source === undefined
|
|
? { version: SESSION_FORMAT_VERSION, id, createdAt: Date.now() }
|
|
: source
|
|
const snapshot = snapshotJsonValue(input)
|
|
if (snapshot === undefined) throw new Error('session header is not losslessly JSON-serializable')
|
|
if (snapshot === null || typeof snapshot !== 'object' || Array.isArray(snapshot)) {
|
|
throw new Error('session header is not a plain JSON record')
|
|
}
|
|
const record = snapshot as Record<string, unknown>
|
|
if (record.version !== SESSION_FORMAT_VERSION) {
|
|
throw new Error(`session header version must be ${SESSION_FORMAT_VERSION}, got ${String(record.version)}`)
|
|
}
|
|
if (record.id !== id) {
|
|
throw new Error(`session header id "${String(record.id)}" does not match session id "${id}"`)
|
|
}
|
|
if (typeof record.createdAt !== 'number' || !Number.isFinite(record.createdAt)) {
|
|
throw new Error('session header createdAt must be a finite number')
|
|
}
|
|
if (record.cwd !== undefined) {
|
|
if (typeof record.cwd !== 'string') throw new Error('session header cwd must be a string')
|
|
if (!isAbsolute(record.cwd)) {
|
|
throw new Error(`session header cwd must be an absolute path, got "${record.cwd}"`)
|
|
}
|
|
}
|
|
if (record.parentSession !== undefined && typeof record.parentSession !== 'string') {
|
|
throw new Error('session header parentSession must be a string')
|
|
}
|
|
if (record.seedLength !== undefined
|
|
&& (typeof record.seedLength !== 'number' || !Number.isSafeInteger(record.seedLength) || record.seedLength < 0)) {
|
|
throw new Error('session header seedLength must be a non-negative safe integer')
|
|
}
|
|
return deepFreeze(record as unknown as SessionHeader)
|
|
}
|
|
|
|
/** Validate the runtime shape of surface metadata after its JSON snapshot. */
|
|
function assertSurfaceMetadataShape(
|
|
type: string,
|
|
surfaceOp: unknown,
|
|
sourceEventSeqs: unknown,
|
|
): void {
|
|
const eligible = isSurfaceEligibleType(type)
|
|
if (!eligible) {
|
|
if (surfaceOp !== undefined || sourceEventSeqs !== undefined) {
|
|
throw new Error(`session event "${type}" is not surface-eligible and cannot carry surface metadata`)
|
|
}
|
|
return
|
|
}
|
|
if (surfaceOp === undefined) {
|
|
throw new Error(`session event "${type}" is surface-eligible and requires a surfaceOp marker`)
|
|
}
|
|
if (surfaceOp !== 'append') {
|
|
if (surfaceOp === null || typeof surfaceOp !== 'object' || Array.isArray(surfaceOp)) {
|
|
throw new Error(`session event "${type}" carries an invalid surfaceOp`)
|
|
}
|
|
const op = surfaceOp as Record<string, unknown>
|
|
const keys = Object.keys(op)
|
|
if (keys.length !== 3 || !Object.hasOwn(op, 'op') || !Object.hasOwn(op, 'start') || !Object.hasOwn(op, 'end')
|
|
|| op['op'] !== 'replace'
|
|
|| typeof op['start'] !== 'number' || !Number.isSafeInteger(op['start']) || op['start'] < 0
|
|
|| typeof op['end'] !== 'number' || !Number.isSafeInteger(op['end']) || op['end'] < 0) {
|
|
throw new Error(`session event "${type}" carries an invalid replace surfaceOp`)
|
|
}
|
|
}
|
|
if (sourceEventSeqs !== undefined) {
|
|
if (!Array.isArray(sourceEventSeqs)
|
|
|| sourceEventSeqs.some(seq => typeof seq !== 'number' || !Number.isSafeInteger(seq) || seq < 0)) {
|
|
throw new Error(`session event "${type}" sourceEventSeqs must contain non-negative safe integers`)
|
|
}
|
|
}
|
|
}
|
|
|
|
/** Validate the fixed event envelope after one-pass JSON materialization. */
|
|
function assertSessionEventEnvelope(value: Record<string, unknown>, index: number): asserts value is SessionEvent {
|
|
const event = value
|
|
const allowed = new Set(['type', 'seq', 'time', 'data', 'surfaceOp', 'sourceEventSeqs'])
|
|
if (Object.keys(event).some(key => !allowed.has(key))
|
|
|| !Object.hasOwn(event, 'type') || typeof event['type'] !== 'string'
|
|
|| !Object.hasOwn(event, 'seq') || typeof event['seq'] !== 'number'
|
|
|| !Number.isSafeInteger(event['seq']) || event['seq'] < 0
|
|
|| !Object.hasOwn(event, 'time') || typeof event['time'] !== 'number'
|
|
|| !Number.isSafeInteger(event['time']) || event['time'] < 0
|
|
|| !Object.hasOwn(event, 'data')) {
|
|
throw new Error(`seed event at index ${index} has an invalid event envelope`)
|
|
}
|
|
}
|
|
|
|
type SessionCallback = (...args: unknown[]) => unknown
|
|
|
|
/** Resolve one listener snapshot, including Cordis's internal dispatch checks. */
|
|
function collectSessionCallbacks(ctx: Context, args: unknown[]): SessionCallback[] {
|
|
return [...ctx.events.dispatch('emit', args)] as SessionCallback[]
|
|
}
|
|
|
|
/** Invoke one resolved observe-only listener snapshot with per-listener containment. */
|
|
function invokeContainedSessionObservers(
|
|
ctx: Context,
|
|
name: 'session/event' | 'session/disposed',
|
|
id: SessionId,
|
|
args: unknown[],
|
|
callbacks: SessionCallback[],
|
|
): void {
|
|
for (const callback of callbacks) {
|
|
try {
|
|
const returned: unknown = callback(...args)
|
|
void Promise.resolve(returned).catch((error: unknown) => {
|
|
ctx.logger.warn(`session "${id}": ${name} listener rejected: ${String(error)}`)
|
|
})
|
|
} catch (error: unknown) {
|
|
ctx.logger.warn(`session "${id}": ${name} listener threw: ${String(error)}`)
|
|
}
|
|
}
|
|
}
|
|
|
|
/** All mutable lifecycle state for one exact store entry. */
|
|
interface SessionEntry {
|
|
readonly id: SessionId
|
|
readonly session: Session
|
|
readonly carrier: Scoped<Session>
|
|
readonly emitCtx: Context
|
|
announced: boolean
|
|
announcing: boolean
|
|
appending: boolean
|
|
detachRequested: boolean
|
|
detach(): void
|
|
}
|
|
|
|
/** Store attachment for the append path; module-private to keep Session store-agnostic publicly. */
|
|
const attachments = new WeakMap<Session, SessionEntry>()
|
|
|
|
/**
|
|
* An event-sourced session: an append-only log of {@link SessionEvent}s.
|
|
*
|
|
* Plain class (not a Service) — create instances via `ctx.sessions.create()`.
|
|
* Seeding with an existing event log replays/forks a session.
|
|
*/
|
|
export class Session {
|
|
private log: SessionEvent[] = []
|
|
|
|
/**
|
|
* Derived surface — a cached linked list of message-producing events.
|
|
* Lazily rebuilt from `surfaceOp` markers in the log; processes only new
|
|
* events (delta) on each access — the log is append-only, so prior events
|
|
* never change.
|
|
* `append`. Undefined until first accessed (including after fork/seed).
|
|
*/
|
|
private _surface: SurfaceManager | undefined
|
|
|
|
/** The surface linked list over this session's event log. */
|
|
get surface(): SurfaceManager {
|
|
if (!this._surface) this._surface = new SurfaceManager(this.log)
|
|
return this._surface
|
|
}
|
|
|
|
/**
|
|
* Detached, deep-frozen creation metadata (format version, cwd, lineage,
|
|
* seed boundary). Supplied by the store via `ctx.sessions.create()`. When a
|
|
* `Session` is constructed bare (tests, ad-hoc replay), a minimal header is
|
|
* synthesized (stamped with the current {@link SESSION_FORMAT_VERSION}) so
|
|
* `session.header` is always present. Kept out of the event log — it is a
|
|
* storage concern, not replayable conversation state.
|
|
*/
|
|
readonly header: SessionHeader
|
|
|
|
constructor(public readonly id: SessionId, seed?: readonly SessionEvent[], header?: SessionHeader) {
|
|
if (seed) {
|
|
// Validate the seed to the SAME invariants `append` enforces, so a
|
|
// replay/fork (`ctx.sessions.create(id, { seed })`) cannot construct a
|
|
// live log that no persistence backend could store: each event's `data`
|
|
// must be JSON-serializable, and `seq` must be contiguous from 0 (the
|
|
// `seq = log.length` contract the whole system relies on). Without this,
|
|
// a bad seed would surface only later as a backend rejection or a silent
|
|
// divergence between the live log and disk.
|
|
this.log = Array.from(seed, (source, index) => {
|
|
// The seed is a persistence/replay boundary: validate and detach the
|
|
// complete event in one lossless-JSON pass.
|
|
const snapshot = snapshotJsonValue(source)
|
|
if (snapshot === undefined) {
|
|
throw new Error(`seed event at index ${index} is not losslessly JSON-serializable`)
|
|
}
|
|
assertSessionEventEnvelope(snapshot, index)
|
|
if (snapshot.seq !== index) {
|
|
throw new Error(`seed event at index ${index} has seq ${snapshot.seq} (expected ${index}); seed must be contiguous from 0`)
|
|
}
|
|
// Surface-eligible events MUST carry a surfaceOp marker — the surface is
|
|
// the sole source of derived history, so a marker-less message event
|
|
// would load fine yet vanish from deriveMessages(). `append` enforces
|
|
// this at compile time via its typed overload; a seed arrives as raw
|
|
// SessionEvent[] (replay/fork/load), bypassing that, so re-check at
|
|
// runtime here rather than silently resuming with empty history.
|
|
const structural = snapshot as SessionEvent & { surfaceOp?: unknown; sourceEventSeqs?: unknown }
|
|
try {
|
|
assertSurfaceMetadataShape(snapshot.type, structural.surfaceOp, structural.sourceEventSeqs)
|
|
} catch (error: unknown) {
|
|
throw new Error(`invalid seed event at index ${index}: ${error instanceof Error ? error.message : 'invalid surface metadata'}`)
|
|
}
|
|
return deepFreeze(snapshot)
|
|
})
|
|
}
|
|
this.header = snapshotSessionHeader(id, header)
|
|
}
|
|
|
|
/** Cached immutable public snapshot of the private append-only log. */
|
|
private eventsSnapshot: readonly SessionEvent[] | undefined
|
|
|
|
/**
|
|
* An immutable snapshot of the append-only event log. The snapshot is reused
|
|
* until the next append; a previously returned array does not grow later.
|
|
* Events and their nested data are deep-frozen at acceptance, so neither a
|
|
* cast nor ordinary JavaScript can rewrite durable history.
|
|
*/
|
|
get events(): readonly SessionEvent[] {
|
|
this.eventsSnapshot ??= Object.freeze([...this.log])
|
|
return this.eventsSnapshot
|
|
}
|
|
|
|
/** The next event's sequence number — always the log length (the `seq = log.length` contiguity contract). */
|
|
get seq(): number {
|
|
return this.log.length
|
|
}
|
|
|
|
/**
|
|
* Append one typed event to the log and synchronously notify observers via
|
|
* the store-owned, module-private publication hooks. The hot path never blocks
|
|
* on I/O — persistence plugins buffer asynchronously. Once the event enters
|
|
* the log, the append is committed: observer failures are logged and
|
|
* contained per listener, so they do not change the return value or prevent
|
|
* later listeners from observing the same accepted event.
|
|
*
|
|
* @param type - The event type (key of {@link SessionEventMap}).
|
|
* @param data - The event payload; must be JSON-serializable.
|
|
* @param opts - Surface metadata: `surfaceOp` controls how the event enters
|
|
* the surface linked list; `sourceEventSeqs` records provenance (the seq
|
|
* numbers of events this one derives from). REQUIRED for
|
|
* {@link SurfaceEventType} events (every message-producing event must
|
|
* declare how it joins the surface, the sole source of derived history) and
|
|
* rejected by the compiler for non-surface types like `turn/start` or
|
|
* `assistant/chunk`.
|
|
* @returns the logged event — its assigned `seq`/`time` plus the SNAPSHOT of
|
|
* `data` that entered the log, so reading `event.data` back sees the logged
|
|
* value, never the caller's still-mutable input.
|
|
* @throws if `data` or surface metadata is not losslessly JSON-serializable
|
|
* (BigInt, function, symbol, undefined, negative zero, non-finite number,
|
|
* circular reference, sparse array, or an exotic object such as
|
|
* Map/Set/Date/class instance). One recursive pass reads, validates, and
|
|
* copies each nested value once, so a stateful getter cannot supply one value
|
|
* to validation and another to storage. The event log is the durable source
|
|
* of truth, so a bad event fails at the append site rather than later during
|
|
* a backend flush. A synchronous internal dispatch validation failure or an
|
|
* append reentered while this acceptance/publication boundary is open also
|
|
* rejects before the log changes.
|
|
*/
|
|
append<T extends SessionEventType>(
|
|
type: T,
|
|
data: SessionEventMap[T],
|
|
...opts: T extends SurfaceEventType ? [opts: SurfaceIntent] : []
|
|
): SessionEvent<T> {
|
|
const surfaceOpts: SurfaceIntent | undefined = opts[0]
|
|
const surfaceMetadata = {
|
|
...surfaceOpts?.sourceEventSeqs === undefined ? {} : { sourceEventSeqs: surfaceOpts.sourceEventSeqs },
|
|
...surfaceOpts?.surfaceOp === undefined ? {} : { surfaceOp: surfaceOpts.surfaceOp },
|
|
}
|
|
const dataSnapshot = snapshotJsonValue(data)
|
|
if (dataSnapshot === undefined) {
|
|
throw new Error(`session event "${type}" carries non-JSON-serializable data`)
|
|
}
|
|
const surfaceMetadataSnapshot = snapshotJsonValue(surfaceMetadata)
|
|
if (surfaceMetadataSnapshot === undefined) {
|
|
throw new Error(`session event "${type}" carries non-JSON-serializable surface metadata`)
|
|
}
|
|
assertSurfaceMetadataShape(
|
|
type,
|
|
(surfaceMetadataSnapshot as { surfaceOp?: unknown }).surfaceOp,
|
|
(surfaceMetadataSnapshot as { sourceEventSeqs?: unknown }).sourceEventSeqs,
|
|
)
|
|
|
|
const entry = attachments.get(this)
|
|
if (entry?.appending) {
|
|
throw new Error('session append cannot reenter while another append is being published')
|
|
}
|
|
if (entry !== undefined) entry.appending = true
|
|
try {
|
|
const event = deepFreeze({
|
|
type,
|
|
seq: this.log.length,
|
|
time: Date.now(),
|
|
data: dataSnapshot,
|
|
...surfaceMetadataSnapshot,
|
|
} as unknown as SessionEvent<T>)
|
|
let callbacks: SessionCallback[] | undefined
|
|
const callbackArgs: unknown[] = [this, event]
|
|
if (entry !== undefined) {
|
|
callbacks = collectSessionCallbacks(entry.emitCtx, [entry.carrier, 'session/event', ...callbackArgs])
|
|
}
|
|
this.log.push(event as SessionEvent)
|
|
this.eventsSnapshot = undefined
|
|
if (callbacks !== undefined && entry !== undefined) {
|
|
invokeContainedSessionObservers(entry.emitCtx, 'session/event', entry.id, callbackArgs, callbacks)
|
|
}
|
|
return event
|
|
} finally {
|
|
if (entry !== undefined) {
|
|
entry.appending = false
|
|
if (entry.detachRequested && !entry.announcing) entry.detach()
|
|
}
|
|
}
|
|
}
|
|
|
|
/** Cached fold of the request-header events — see {@link requestHeader}. */
|
|
private headerFold: EpochHeader | undefined
|
|
/** Log position (events consumed) the header fold has reached. */
|
|
private headerFoldSeq = 0
|
|
|
|
/**
|
|
* The {@link EpochHeader} in force after the log's last header event — the
|
|
* header the NEXT request will be compared against — or undefined before
|
|
* the first `request/header` snapshot. The live, incrementally-maintained
|
|
* form of `foldRequestHeader(session.events)`: each header event is folded
|
|
* once, when first seen, so a per-step read costs O(new events).
|
|
* @returns the folded header, or undefined when no header event exists yet.
|
|
*/
|
|
requestHeader(): EpochHeader | undefined {
|
|
if (this.headerFoldSeq < this.log.length) {
|
|
// Frozen on update: the fold is session state exposed by reference — a
|
|
// consumer mutating it in place (instead of building a replacement)
|
|
// would desync every later comparison against the log, so mutation
|
|
// throws instead.
|
|
this.headerFold = deepFreeze(foldRequestHeader(this.log.slice(this.headerFoldSeq), this.headerFold))
|
|
this.headerFoldSeq = this.log.length
|
|
}
|
|
return this.headerFold
|
|
}
|
|
|
|
/** The derived-message cache: frozen projections, extended per unseen node. */
|
|
private derived: Message[] = []
|
|
/** Surface position (nodes projected) the cache has reached. */
|
|
private derivedNodes = 0
|
|
/** {@link SurfaceManager.replaceGeneration} the cache was built under. */
|
|
private derivedGeneration = 0
|
|
|
|
/**
|
|
* Derive the LLM message history by walking the session surface — the linked
|
|
* list of message-producing events maintained by `surfaceOp` markers. The
|
|
* surface is the single source of derived history: every message-producing
|
|
* append records its `surfaceOp`, so a raw event with no marker (a chunk, a
|
|
* turn boundary) is correctly absent, and a compaction `replace` deletes the
|
|
* shadowed nodes from the derivation. The projection rules are
|
|
* {@link deriveEventMessage}, folded per node.
|
|
*
|
|
* CACHED: each surface node is projected exactly once, when first seen — a
|
|
* call costs O(new nodes), and a surface rewrite (a `replace`;
|
|
* {@link SurfaceManager.replaceGeneration}) rebuilds. The returned array is
|
|
* a fresh snapshot per call (later appends never grow an array a caller
|
|
* already holds); the `Message` objects in it are SHARED and **deep-frozen**.
|
|
* Their content reuses the already frozen durable event data, so the cache
|
|
* needs no second deep clone and consumers still cannot mutate the log.
|
|
* @returns a fresh array of the shared, frozen derived history.
|
|
*/
|
|
deriveMessages(): Message[] {
|
|
const nodes = this.surface.nodes
|
|
const generation = this.surface.replaceGeneration
|
|
if (generation !== this.derivedGeneration) {
|
|
this.derived = []
|
|
this.derivedNodes = 0
|
|
this.derivedGeneration = generation
|
|
}
|
|
for (const node of nodes.slice(this.derivedNodes)) {
|
|
// Surface nodes are built from this.log — node.seq is always a valid
|
|
// index by construction. The non-null assertion expresses that invariant.
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
const msg = this.deriveEventMessage(this.log[node.seq]!)
|
|
// A surface node is one of the five message-producing types, but an
|
|
// empty-content assistant/message (a max-tokens step that hosts only
|
|
// usage) derives to null and must not enter the transcript.
|
|
if (msg) this.derived.push(deepFreeze(msg))
|
|
}
|
|
this.derivedNodes = nodes.length
|
|
return [...this.derived]
|
|
}
|
|
|
|
/**
|
|
* Project a single event into the LLM message it derives to, or null when
|
|
* it produces none — a non-surface event (chunk, boundary, log-only record)
|
|
* or an empty-content assistant/message (which exists only to host usage).
|
|
* The per-node pure function {@link deriveMessages} folds over the surface;
|
|
* an external reconstructor (or the dev invariant) folds the same function
|
|
* over a log prefix's surface to rebuild the exact messages any request was
|
|
* built from (the reconstructability RFC). The returned message wrapper is
|
|
* fresh; its content reuses the logged event's already deep-frozen durable
|
|
* data, so changing the wrapper cannot rewrite the log and changing content
|
|
* throws.
|
|
* @param event - the event to project.
|
|
* @returns the derived message, or null when the event produces none.
|
|
*/
|
|
deriveEventMessage(event: SessionEvent): Message | null {
|
|
// Intentionally non-exhaustive: only message-producing events derive
|
|
// history; turn/step boundaries, chunks, usage, and errors are
|
|
// trace/replay data.
|
|
|
|
switch (event.type) {
|
|
case 'user/message': {
|
|
return { role: 'user', content: event.data.content }
|
|
}
|
|
case 'assistant/message': {
|
|
// Skip an empty-content assistant/message: it exists only to host a
|
|
// max-tokens step's usage and must not inject a content-less assistant
|
|
// turn into the provider transcript.
|
|
if (event.data.content.length === 0) return null
|
|
return { role: 'assistant', content: event.data.content }
|
|
}
|
|
case 'tool/result': {
|
|
const { callId, content, isError } = event.data
|
|
return {
|
|
role: 'user',
|
|
content: [{ type: 'tool-result', toolCallId: callId, content, isError }],
|
|
}
|
|
}
|
|
case 'context/message': {
|
|
const { content, source } = event.data
|
|
return { role: 'user', content: renderTagged('context', content, source) }
|
|
}
|
|
case 'steering/message': {
|
|
const { content, source } = event.data
|
|
return { role: 'user', content: renderTagged('steering', content, source) }
|
|
}
|
|
default:
|
|
// A non-surface event (boundary, chunk, log-only record) projects to
|
|
// no message. Merge-extensible union: no assertNever here.
|
|
return null
|
|
}
|
|
}
|
|
}
|
|
|
|
/** A fork source: either the live session object or its live store id. */
|
|
export type SessionForkSource = Session | SessionId
|
|
|
|
/**
|
|
* Rejection codes for session forking: the fork source id is unknown to the
|
|
* live store (`SESSION_NOT_FOUND`) or names a session object that is not the
|
|
* store's live instance (`SESSION_NOT_LIVE`); the requested child id is
|
|
* already taken (`SESSION_ALREADY_EXISTS`); the boundary is not a contiguous
|
|
* existing seq (`INVALID_BOUNDARY`); or the boundary event is not a
|
|
* `turn/end` — a fork must cut on a closed turn (`OPEN_TURN`).
|
|
*/
|
|
export type SessionForkErrorCode =
|
|
| 'SESSION_NOT_FOUND'
|
|
| 'SESSION_NOT_LIVE'
|
|
| 'SESSION_ALREADY_EXISTS'
|
|
| 'INVALID_BOUNDARY'
|
|
| 'OPEN_TURN'
|
|
|
|
/** Typed error for session fork rejections. */
|
|
export class SessionForkError extends Error {
|
|
constructor(message: string, public readonly code: SessionForkErrorCode) {
|
|
super(message)
|
|
this.name = 'SessionForkError'
|
|
}
|
|
}
|
|
|
|
/**
|
|
* In-memory session store (`ctx.sessions`).
|
|
*
|
|
* Persistence is intentionally not implemented here — persistence plugins
|
|
* subscribe to `session/event` and flush on `session/flush` / dispose.
|
|
*/
|
|
export class SessionStore extends Service {
|
|
private store = new Map<SessionId, SessionEntry>()
|
|
private counter = 0
|
|
|
|
constructor(ctx: Context) {
|
|
super(ctx, 'sessions')
|
|
}
|
|
|
|
/**
|
|
* Create a session owned by the calling fiber: disposing that fiber stops
|
|
* event notification and removes the session from the store. `options.seed`
|
|
* populates the session with a copy of those events (replay/fork);
|
|
* `options.meta` attaches creation metadata (validated absolute `cwd`,
|
|
* `parentSession` lineage) as the immutable {@link SessionHeader} (the store
|
|
* fills `version`/`id`/`createdAt`).
|
|
*
|
|
* For an agent whose session must be torn down IN ORDER with its loop (so the
|
|
* loop's final flush is captured before the store attachment ends), do NOT use this
|
|
* — fold the session lifecycle into the agent's own effect via
|
|
* {@link prepare} + {@link enter} + {@link announce} (see
|
|
* `dsh-agent-loop`'s creation transaction).
|
|
*
|
|
* @param id - the session id; omitted, the store mints `session-<n>`.
|
|
* @param options - seed events and/or creation metadata for the header.
|
|
* @returns the live session, already entered and announced.
|
|
* @throws if a session with `id` already exists, metadata is not a plain
|
|
* lossless-JSON record with valid scalar fields, or `meta.cwd` is a
|
|
* non-absolute path (storage backends key directories off it).
|
|
*/
|
|
create(id?: SessionId, options?: CreateSessionOptions): Session {
|
|
const session = this.prepare(id, options)
|
|
// Single effect owned by the calling fiber. Yield the detach BEFORE
|
|
// announcing so a throwing `session/created` listener rolls the attach back
|
|
// (the generator effect disposes already-yielded disposers on a throw)
|
|
// instead of leaking the store entry and its publication hooks.
|
|
this.ctx.effect(function* (this: SessionStore) {
|
|
yield this.enter(session)
|
|
this.announce(session)
|
|
}.bind(this), 'sessions.create()')
|
|
return session
|
|
}
|
|
|
|
/**
|
|
* Build a session WITHOUT entering it into the store — validate the id/cwd and
|
|
* construct the {@link Session} (with its immutable {@link SessionHeader}).
|
|
* Pairs with {@link enter} + {@link announce}: a caller that owns a composite
|
|
* `ctx.effect` (the agent factory) folds the session lifecycle into that ONE
|
|
* effect so a fiber unload tears the session + agent down as a single ORDERED
|
|
* chain rather than as racing sibling effects — which would remove the publication hooks
|
|
* before the loop's closing `session/flush`, dropping the closing events.
|
|
*
|
|
* @param id - the session id; omitted, the store mints `session-<n>`.
|
|
* @param options - seed events and/or creation metadata for the header.
|
|
* @returns the constructed session, NOT yet in the store.
|
|
* @throws if a session with `id` already exists, metadata is not a plain
|
|
* lossless-JSON record with valid scalar fields, or `meta.cwd` is a
|
|
* non-absolute path.
|
|
*/
|
|
prepare(id?: SessionId, options?: CreateSessionOptions): Session {
|
|
let sessionId: SessionId
|
|
if (id === undefined) {
|
|
do sessionId = SessionId(`session-${++this.counter}`)
|
|
while (this.store.has(sessionId))
|
|
} else {
|
|
sessionId = SessionId(id)
|
|
}
|
|
if (this.store.has(sessionId)) throw new Error(`session "${sessionId}" already exists`)
|
|
const seed = options?.seed
|
|
const meta = options?.meta
|
|
const header: SessionHeader = {
|
|
version: SESSION_FORMAT_VERSION,
|
|
id: sessionId,
|
|
createdAt: meta?.createdAt ?? Date.now(),
|
|
...meta?.cwd === undefined ? {} : { cwd: meta.cwd },
|
|
...meta?.parentSession === undefined ? {} : { parentSession: meta.parentSession },
|
|
...meta?.seedLength === undefined ? {} : { seedLength: meta.seedLength },
|
|
}
|
|
return new Session(sessionId, seed, header)
|
|
}
|
|
|
|
/**
|
|
* Enter a {@link prepare}d session into the store: install the module-private
|
|
* append publication hooks and add it to the store. Returns the DETACH
|
|
* disposer (hooks + store removal). Does NOT emit `session/created` —
|
|
* the caller yields this disposer inside its effect and THEN calls
|
|
* {@link announce}, so a throwing `session/created` listener rolls the attach
|
|
* back instead of leaking it.
|
|
*
|
|
* Re-checks the id for a duplicate: `prepare` and `enter` are public
|
|
* cross-package primitives and a caller may interleave arbitrary work (or
|
|
* another create) between them, so a stale prepared session must NOT overwrite
|
|
* a live store entry of the same id — its detach disposer would later delete
|
|
* the REAL session. The {@link create} convenience and the agent factory call
|
|
* the two back-to-back so they never trip this, but the public seam cannot
|
|
* assume that.
|
|
*
|
|
* @param session - a {@link prepare}d session not yet in the store.
|
|
* @returns the detach disposer (publication hooks + store removal). When called from
|
|
* a synchronous `session/created` listener, removal and disposal wait until
|
|
* that creation dispatch unwinds.
|
|
* @throws if a session with this id is already in the store.
|
|
*/
|
|
enter(session: Session): () => void {
|
|
const id = session.id
|
|
const carrier = scopeTarget(session, scopeOf(this.ctx))
|
|
// This is the authoritative collision boundary after arbitrary unpublished
|
|
// preparation. Only one exact same-id transaction can publish.
|
|
if (this.store.has(id)) throw new Error(`session "${id}" already exists`)
|
|
if (attachments.has(session)) throw new Error(`session "${id}" is already attached to a store`)
|
|
const entry: SessionEntry = {
|
|
id,
|
|
session,
|
|
carrier,
|
|
emitCtx: this.ctx,
|
|
announced: false,
|
|
announcing: false,
|
|
appending: false,
|
|
detachRequested: false,
|
|
detach: () => { this.detachEntered(entry) },
|
|
}
|
|
this.store.set(id, entry)
|
|
attachments.set(session, entry)
|
|
let entered = true
|
|
const detach = (): void => {
|
|
if (!entered) return
|
|
entered = false
|
|
// A lifecycle listener may own the advanced detach capability. Keep the
|
|
// entry and its publication hooks live until synchronous creation or append
|
|
// publication unwinds, then publish the paired disposal edge.
|
|
if (entry.announcing || entry.appending) {
|
|
entry.detachRequested = true
|
|
return
|
|
}
|
|
entry.detach()
|
|
}
|
|
return detach
|
|
}
|
|
|
|
/** Remove one exact entered session and emit its paired disposal when announced. */
|
|
private detachEntered(entry: SessionEntry): void {
|
|
entry.detachRequested = false
|
|
// A stale capability cannot remove observers or storage belonging to a
|
|
// later same-id lifecycle.
|
|
/* v8 ignore next -- enter() rejects replacement while this single-shot detach capability is live. */
|
|
if (this.store.get(entry.id) !== entry) return
|
|
this.store.delete(entry.id)
|
|
attachments.delete(entry.session)
|
|
if (entry.announced) this.emitDisposed(entry)
|
|
}
|
|
|
|
/** Emit `session/created` exactly once for an {@link enter}ed session (with
|
|
* the carrier {@link enter} captured). Separate from {@link enter} so the
|
|
* caller can yield the detach disposer first (rollback safety — see
|
|
* {@link enter}).
|
|
* @param session - the entered session to announce to listeners.
|
|
* @throws if the session is not live or its announcement already began,
|
|
* including a reentrant call from a creation listener. */
|
|
announce(session: Session): void {
|
|
const entry = this.liveEntryFor(session)
|
|
if (entry.announced || entry.announcing) {
|
|
throw new Error(`session "${entry.id}" was already announced`)
|
|
}
|
|
// Mark before emit: Cordis emit may deliver to earlier listeners and then
|
|
// throw. Rollback must still pair that partial creation with disposal, and
|
|
// a listener cannot recursively create a second lifecycle edge.
|
|
entry.announced = true
|
|
const callbackArgs: unknown[] = [session]
|
|
entry.announcing = true
|
|
try {
|
|
const callbacks = collectSessionCallbacks(this.ctx, [entry.carrier, 'session/created', session])
|
|
for (const callback of callbacks) {
|
|
// Synchronous throws intentionally propagate and veto publication; the
|
|
// yielded detach then emits the paired disposal edge. An async function
|
|
// is nevertheless assignable to a void listener, so observe its returned
|
|
// promise: rejection is too late to roll back and must be logged instead
|
|
// of becoming unhandled.
|
|
const returned: unknown = callback(...callbackArgs)
|
|
void Promise.resolve(returned).catch((error: unknown) => {
|
|
this.ctx.logger.warn(`session "${entry.id}": session/created listener rejected: ${String(error)}`)
|
|
})
|
|
}
|
|
} finally {
|
|
entry.announcing = false
|
|
if (entry.detachRequested && !entry.appending) entry.detach()
|
|
}
|
|
}
|
|
|
|
/** Emit the paired teardown notification with per-listener containment. */
|
|
private emitDisposed(entry: SessionEntry): void {
|
|
const callbackArgs: unknown[] = [entry.session]
|
|
try {
|
|
const callbacks = collectSessionCallbacks(this.ctx, [entry.carrier, 'session/disposed', entry.session])
|
|
invokeContainedSessionObservers(this.ctx, 'session/disposed', entry.id, callbackArgs, callbacks)
|
|
} catch (error: unknown) {
|
|
this.ctx.logger.warn(`session "${entry.id}": session/disposed dispatch threw: ${String(error)}`)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Dispatch the awaited `session/flush` durability checkpoint for `session`,
|
|
* with the carrier captured at {@link enter}. THE flush entry point: the
|
|
* store owns the carrier, so callers (the loop's turn-end checkpoint, idle
|
|
* injection, teardown drains) must come through here rather than dispatch a
|
|
* raw `ctx.parallel('session/flush', …)` — one owner, one spelling, and the
|
|
* scoped-dispatch invariant can pin it.
|
|
* @param session - the session whose buffered events must reach durable storage.
|
|
* @returns resolves when every flush listener has settled; after all settle,
|
|
* rejects with the first registered listener failure if any listener failed.
|
|
*/
|
|
async flush(session: Session): Promise<void> {
|
|
const { carrier } = this.liveEntryFor(session)
|
|
const callbackArgs: unknown[] = [session]
|
|
const callbacks = collectSessionCallbacks(this.ctx, [carrier, 'session/flush', session])
|
|
const results = await Promise.allSettled(callbacks.map((callback) => {
|
|
try {
|
|
return callback(...callbackArgs)
|
|
} catch (error: unknown) {
|
|
// Preserve the listener's exact rejection value; flush is a caller-owned
|
|
// failure boundary, and Cordis listeners may throw arbitrary values.
|
|
// eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
|
|
return Promise.reject(error)
|
|
}
|
|
}))
|
|
const failure = results.find((result): result is PromiseRejectedResult => result.status === 'rejected')
|
|
if (failure !== undefined) throw failure.reason
|
|
}
|
|
|
|
/** Return the exact live entry; detached/prepared objects reject. */
|
|
private liveEntryFor(session: Session): SessionEntry {
|
|
const entry = attachments.get(session)
|
|
if (entry === undefined || this.store.get(entry.id) !== entry) {
|
|
throw new Error(`session "${session.id}" is not live in this store`)
|
|
}
|
|
return entry
|
|
}
|
|
|
|
/**
|
|
* Look up a live session.
|
|
* @param id - the session id to look up.
|
|
* @returns the session, or undefined when no live session has that id.
|
|
*/
|
|
get(id: SessionId): Session | undefined {
|
|
return this.store.get(id)?.session
|
|
}
|
|
|
|
/**
|
|
* All live sessions, in creation order.
|
|
* @returns a fresh array; mutating it does not affect the store.
|
|
*/
|
|
list(): Session[] {
|
|
return [...this.store.values()].map(entry => entry.session)
|
|
}
|
|
|
|
/**
|
|
* Create a live child session from a turn-enclosed prefix of a live source.
|
|
* `boundary` is an inclusive source event seq; omitted means the source's
|
|
* current last event. A non-empty selected slice must end at `turn/end`.
|
|
*
|
|
* @param source - Live source session object or id.
|
|
* @param boundary - Inclusive source event seq to fork through; omitted means
|
|
* the source's current last event, and omitted on an empty source forks an
|
|
* empty child.
|
|
* @param childSessionId - Optional child session id; omitted delegates to
|
|
* `SessionStore`'s id policy.
|
|
* @returns The created live child session.
|
|
*/
|
|
fork(source: SessionForkSource, boundary?: number, childSessionId?: SessionId): Session {
|
|
if (childSessionId !== undefined && this.get(childSessionId) !== undefined) {
|
|
throw new SessionForkError(`session "${childSessionId}" already exists`, 'SESSION_ALREADY_EXISTS')
|
|
}
|
|
const liveSource = this._resolveForkSource(source)
|
|
const seed = this._forkSeed(liveSource, boundary)
|
|
return this.create(childSessionId, {
|
|
seed,
|
|
meta: {
|
|
...liveSource.header.cwd !== undefined ? { cwd: liveSource.header.cwd } : {},
|
|
parentSession: liveSource.id,
|
|
seedLength: seed.length,
|
|
},
|
|
})
|
|
}
|
|
|
|
private _forkSeed(session: Session, requestedBoundary: number | undefined): SessionEvent[] {
|
|
const events = session.events
|
|
const lastEvent = events.at(-1)
|
|
let boundary: number
|
|
if (requestedBoundary !== undefined) {
|
|
boundary = requestedBoundary
|
|
} else {
|
|
if (lastEvent === undefined) return []
|
|
boundary = lastEvent.seq
|
|
}
|
|
if (!Number.isSafeInteger(boundary) || boundary < 0) {
|
|
throw new SessionForkError(
|
|
`fork boundary for session "${session.id}" must be a non-negative safe integer, got ${String(boundary)}`,
|
|
'INVALID_BOUNDARY',
|
|
)
|
|
}
|
|
if (boundary >= events.length) {
|
|
const lastSeq = events.at(-1)?.seq
|
|
throw new SessionForkError(
|
|
`fork boundary ${boundary} does not exist in session "${session.id}" (last seq: ${lastSeq ?? 'none'})`,
|
|
'INVALID_BOUNDARY',
|
|
)
|
|
}
|
|
|
|
const boundaryEvent = events[boundary]
|
|
if (boundaryEvent === undefined || boundaryEvent.seq !== boundary) {
|
|
throw new SessionForkError(
|
|
`fork boundary ${boundary} does not match a contiguous event seq in session "${session.id}"`,
|
|
'INVALID_BOUNDARY',
|
|
)
|
|
}
|
|
if (boundaryEvent.type !== 'turn/end') {
|
|
throw new SessionForkError(
|
|
`fork boundary ${boundary} in session "${session.id}" must be turn/end, got ${boundaryEvent.type}`,
|
|
'OPEN_TURN',
|
|
)
|
|
}
|
|
|
|
return events.slice(0, boundary + 1)
|
|
}
|
|
|
|
private _resolveForkSource(source: SessionForkSource): Session {
|
|
if (typeof source === 'string') {
|
|
const session = this.get(source)
|
|
if (session === undefined) throw new SessionForkError(`session "${source}" not found`, 'SESSION_NOT_FOUND')
|
|
return session
|
|
}
|
|
|
|
const live = this.get(source.id)
|
|
if (live === undefined) {
|
|
throw new SessionForkError(`session "${source.id}" not found`, 'SESSION_NOT_FOUND')
|
|
}
|
|
if (live !== source) throw new SessionForkError(`session "${source.id}" is not the live store instance`, 'SESSION_NOT_LIVE')
|
|
return source
|
|
}
|
|
|
|
}
|
|
|
|
export default SessionStore
|