| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038 |
- /**
- * 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 { Message } 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 } from './surface.ts'
- import type { SessionSurface } from './surface.ts'
- import { foldRequestHeader } from './request-header.ts'
- export * from './types.ts'
- export type { AssistantMessage, ToolResultMessage, UserMessage } from '@deepseek-ai/dsh-llm'
- export { isJsonValue, snapshotJsonValue } from './json.ts'
- export type { JsonValue } from './json.ts'
- export { interruptedTurnClosers, TOOL_NOT_STARTED, TOOL_OUTCOME_UNKNOWN } from './repair.ts'
- export { decodeStorageRecord, packChunkRuns } from './chunk-rows.ts'
- export type { ChunkRow, StorageRecord } from './chunk-rows.ts'
- export type { SessionSurface, SurfaceFoldReplacement, SurfaceFoldResult } from './surface.ts'
- export { foldSurface, isSurfaceEvent, isSurfaceEligibleType } from './surface.ts'
- export { canonicalHeader, foldRequestHeader, headerEquals } from './request-header.ts'
- /**
- * Find the latest closed message-triggered turn, ignoring other triggers and
- * between-turn events.
- * @param events - session events, or an owned suffix, to inspect.
- * @returns the latest matching turn end, or `undefined`.
- */
- export function findLastMessageTurnEnd(
- events: readonly SessionEvent[],
- ): SessionEvent<'turn/end'> | undefined {
- const messageTurns = new Set<number>()
- let latest: SessionEvent<'turn/end'> | undefined
- for (const event of events) {
- if (event.type === 'turn/start') {
- if (event.data.trigger.kind === 'message') messageTurns.add(event.data.turn)
- continue
- }
- if (event.type === 'turn/end' && messageTurns.delete(event.data.turn)) latest = event
- }
- return latest
- }
- declare module 'cordis' {
- interface Context {
- sessions: SessionStore
- }
- interface Events {
- /**
- * Creation announcement during session publication. A synchronous throw vetoes and rolls
- * back with a paired disposal; detach requested during dispatch is deferred.
- * A returned-promise rejection is logged but cannot retroactively veto this
- * synchronous boundary.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners
- * receive only sessions entered through that agent's context.
- * @param session - the session just entered and announced.
- * @dshScopeScan unsupported
- * @mode emit
- */
- 'session/created'(this: Scoped<Session>, session: Session): void
- /**
- * Emitted once when an announced session leaves the store, including
- * publication rollback, but never for an entry whose creation announcement
- * did not begin. Listener failures are logged and contained.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`) reuses the owner scope.
- * @param session - the session that is no longer live in the store.
- * @dshScopeScan unsupported
- * @mode emit
- */
- 'session/disposed'(this: Scoped<Session>, session: Session): void
- /**
- * Post-commit, fire-and-forget append feed. The listener snapshot resolves
- * before the log push, but callbacks run after it; observer failures are
- * logged and contained without making the committed append fail.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners
- * receive only events from sessions entered through that agent's context.
- * @param session - the session whose log grew.
- * @param event - the appended event, exactly as recorded.
- * @dshScopeScan unsupported
- * @mode emit
- */
- 'session/event'(this: Scoped<Session>, session: Session, event: SessionEvent): void
- /**
- * Awaited parallel durability checkpoint: every listener runs and the
- * caller awaits all of them, with no waterfall veto. Dispatch through
- * {@link SessionStore.flush}. Scope-filtered dispatch
- * (`@deepseek-ai/dsh-scope`) reuses the session's owner scope.
- * @param session - the session whose buffered events must reach durable storage.
- * @dshScopeScan unsupported
- * @mode parallel
- */
- 'session/flush'(this: Scoped<Session>, session: Session): Promise<void> | void
- }
- }
- /** 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.isSafeInteger(record.createdAt)
- || record.createdAt < 0) {
- throw new Error('session header createdAt must be a non-negative safe integer')
- }
- 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')
- }
- if (record.delegationDepth !== undefined
- && (typeof record.delegationDepth !== 'number' || !Number.isSafeInteger(record.delegationDepth) || record.delegationDepth < 0)) {
- throw new Error('session header delegationDepth must be a non-negative safe integer')
- }
- return deepFreeze(record as unknown as SessionHeader)
- }
- /**
- * Detach one event while preserving deep immutability for its identified message.
- * @param event - event imported across a query or persistence boundary.
- * @returns a detached event snapshot with a validated, deeply frozen message.
- */
- export function snapshotSessionEvent<T extends SessionEvent>(event: T): T {
- const snapshot = structuredClone(event)
- assertMessageEventShape(
- snapshot,
- `session event at seq ${snapshot.seq}`,
- )
- switch (snapshot.type) {
- case 'user/message':
- deepFreeze(snapshot.data)
- break
- case 'assistant/message':
- case 'tool/result':
- case 'steering/message':
- deepFreeze(snapshot.data.message)
- break
- default:
- // SessionEventMap is merge-extensible; plugin-owned events carry no core message.
- break
- }
- return snapshot
- }
- /** 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
- if (event['type'] === 'request/header-delta') {
- throw new Error(`seed event at index ${index} uses unsupported legacy request/header-delta format`)
- }
- 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`)
- }
- assertCurrentLlmShape(event, index)
- assertCurrentTurnEndShape(event, index)
- }
- /** Reject obsolete request headers and malformed messages at the seed/load boundary. */
- function assertCurrentLlmShape(event: Record<string, unknown>, index: number): void {
- const data = event['data']
- const record = typeof data === 'object' && data !== null
- ? data as Record<string, unknown>
- : undefined
- if (event['type'] === 'request/header') {
- const header = record?.['header']
- const config = typeof header === 'object' && header !== null ? (header as Record<string, unknown>)['config'] : undefined
- if (!hasProviderModel(config)) throw new Error(`seed request/header at index ${index} lacks provider/model`)
- const reasoningEffort = (config as Record<string, unknown>)['reasoningEffort']
- if (reasoningEffort !== undefined
- && (typeof reasoningEffort !== 'string' || reasoningEffort.length === 0)) {
- throw new Error(`seed request/header at index ${index} has an invalid reasoningEffort`)
- }
- }
- const type = event['type']
- if (type !== 'user/message' && type !== 'assistant/message'
- && type !== 'tool/result' && type !== 'steering/message') return
- assertMessageEventShape(event, `seed ${type} at index ${index}`)
- }
- /** Validate only the event-specific invariants needed to safely replay a message. */
- function assertMessageEventShape(event: Record<string, unknown>, subject: string): void {
- const type = event['type']
- if (type !== 'user/message' && type !== 'assistant/message'
- && type !== 'tool/result' && type !== 'steering/message') return
- const data = event['data']
- const record = typeof data === 'object' && data !== null
- ? data as Record<string, unknown>
- : undefined
- const message = type === 'user/message' ? record : record?.['message']
- if (typeof message !== 'object' || message === null
- || typeof (message as Record<string, unknown>)['id'] !== 'string'
- || (message as Record<string, unknown>)['id'] === '') {
- throw new Error(`${subject} lacks an identified message`)
- }
- const messageRecord = message as Record<string, unknown>
- const expectedRole = type === 'assistant/message' ? 'assistant' : 'user'
- if (messageRecord['role'] !== expectedRole) {
- throw new Error(`${subject} message must have role "${expectedRole}"`)
- }
- const source = messageRecord['source']
- if (typeof source !== 'object' || source === null
- || typeof (source as Record<string, unknown>)['kind'] !== 'string'
- || (source as Record<string, unknown>)['kind'] === '') {
- throw new Error(`${subject} message has invalid source`)
- }
- if (!Array.isArray(messageRecord['content'])) {
- throw new Error(`${subject} message has invalid content`)
- }
- const sourceRecord = source as Record<string, unknown>
- if (type === 'assistant/message') {
- if (sourceRecord['kind'] !== 'model' || !hasProviderModel(sourceRecord)) {
- throw new Error(`${subject} message must have model source`)
- }
- return
- }
- if (type !== 'tool/result') return
- if (sourceRecord['kind'] !== 'tool'
- || typeof sourceRecord['callId'] !== 'string'
- || sourceRecord['callId'] === '') {
- throw new Error(`${subject} message must have tool source`)
- }
- const content = messageRecord['content'] as unknown[]
- const block = content[0]
- if (content.length !== 1 || typeof block !== 'object' || block === null
- || (block as Record<string, unknown>)['type'] !== 'tool-result'
- || !Array.isArray((block as Record<string, unknown>)['content'])) {
- throw new Error(`${subject} message must contain one tool-result block`)
- }
- if ((block as Record<string, unknown>)['toolCallId'] !== sourceRecord['callId']) {
- throw new Error(`${subject} message has mismatched tool call ids`)
- }
- }
- /** Reject legacy aborted outcomes that persisted caller-owned reason detail. */
- function assertCurrentTurnEndShape(event: Record<string, unknown>, index: number): void {
- if (event['type'] !== 'turn/end') return
- const data = event['data']
- /* v8 ignore next -- this migration recognizes only the legacy object shape; format-wide payload validation is separate. */
- if (typeof data !== 'object' || data === null) return
- const reason = (data as Record<string, unknown>)['reason']
- /* v8 ignore next -- non-object reasons cannot carry the legacy aborted detail this migration removes. */
- if (typeof reason !== 'object' || reason === null || Array.isArray(reason)) return
- const record = reason as Record<string, unknown>
- if (record['kind'] === 'aborted'
- && (Object.keys(record).length !== 1 || !Object.hasOwn(record, 'kind'))) {
- throw new Error(`seed turn/end at index ${index} uses unsupported reason-bearing aborted format`)
- }
- }
- /** Whether an unknown value carries the current provider/model pair. */
- function hasProviderModel(value: unknown): boolean {
- if (typeof value !== 'object' || value === null) return false
- const pair = value as Record<string, unknown>
- return typeof pair['provider'] === 'string' && pair['provider'].length > 0
- && typeof pair['model'] === 'string' && pair['model'].length > 0
- }
- /** Reject request-header vocabulary removed with the legacy delta codec. */
- function assertSupportedRequestHeader(type: string, data: unknown, location: string): void {
- if (type === 'request/header-delta') {
- throw new Error(`${location} uses unsupported legacy request/header-delta format`)
- }
- if (type === 'request/header'
- && data !== null && typeof data === 'object' && !Array.isArray(data)
- && (data as Record<string, unknown>)['reason'] === 'fallback') {
- throw new Error(`${location} uses unsupported legacy request/header reason "fallback"`)
- }
- }
- 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[] = []
- /** Single incremental owner of surface acceptance and projection state. */
- private readonly surfaceManager = new SurfaceManager(this.log)
- /** The ordered surface over this session's event log. */
- get surface(): SessionSurface {
- return this.surfaceManager
- }
- /**
- * 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
- /** The session identity, derived from its durable header's single copy. */
- get id(): SessionId {
- return this.header.id
- }
- /**
- * The first seq appended IN THIS PROCESS: the length of the constructor
- * seed (0 without one). Events below it entered through construction —
- * replay, fork, or resume — and were never published on the `session/event`
- * firehose (constructor seeds do not emit), so consumers that replay the
- * log as a publication substitute (telemetry adoption) start here. Distinct
- * from `header.seedLength`, the DURABLE fork-lineage boundary: a resumed
- * session's constructor seed is its full stored log, while its header keeps
- * the original fork value — this field is the in-process construction fact
- * and is deliberately not persisted.
- */
- readonly firstLiveSeq: number
- constructor(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.
- for (const [index, source] of seed.entries()) {
- // 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)
- assertSupportedRequestHeader(snapshot.type, snapshot.data, `seed event at index ${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`)
- }
- // A seed is accepted incrementally through the same transition as a
- // live append and a full-log fold. The candidate is planned before it
- // enters `log`, so a failure cannot partially mutate the surface.
- try {
- this.surfaceManager.validateNext(snapshot)
- } catch (error: unknown) {
- throw new Error(`invalid seed event at index ${index}: ${error instanceof Error ? error.message : 'invalid surface metadata'}`)
- }
- this.log.push(deepFreeze(snapshot))
- }
- }
- this.firstLiveSeq = this.log.length
- 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 ordered surface; `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), or when the candidate violates the
- * canonical surface contract (marker shape and eligibility, unique
- * earlier provenance, positional replacement validity, and complete
- * shadowed-node coverage). 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`)
- }
- assertSupportedRequestHeader(type, dataSnapshot, `session event "${type}"`)
- const surfaceMetadataSnapshot = snapshotJsonValue(surfaceMetadata)
- if (surfaceMetadataSnapshot === undefined) {
- throw new Error(`session event "${type}" carries non-JSON-serializable surface metadata`)
- }
- const entry = attachments.get(this)
- if (entry?.appending) {
- throw new Error('session append cannot reenter while another append is being published')
- }
- const event = deepFreeze({
- type,
- seq: this.log.length,
- time: Date.now(),
- data: dataSnapshot,
- ...(surfaceMetadataSnapshot as { surfaceOp?: unknown; sourceEventSeqs?: unknown }),
- } as unknown as SessionEvent<T>)
- this.surfaceManager.validateNext(event as SessionEvent)
- if (entry !== undefined) entry.appending = true
- try {
- 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 ordered sequences 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 SessionSurface.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 surface = this.surface
- const nodes = surface.nodes
- const generation = surface.replaceGeneration
- if (generation !== this.derivedGeneration) {
- this.derived = []
- this.derivedNodes = 0
- this.derivedGeneration = generation
- }
- for (const seq of nodes.slice(this.derivedNodes)) {
- // Surface sequences are built from this.log — 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[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(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 Agent Note). The returned message is
- * the already frozen message nested in the event wrapper and shared by
- * delivery, durable history, and model requests.
- * @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) {
- // Ordinary prompts, injected context, and mid-turn steering project
- // identically in user role: the event's model-facing content stays
- // verbatim. Steering's `turn` is log-only. Do NOT
- // re-add per-type framing (e.g. `<context>`/`<steering>`) here: framing is
- // caller-owned — a producer bakes it into `content`, as workspace-context
- // does with `<system-reminder>` — or, if reintroduced, must be driven by
- // the event `meta` map and a dedicated renderer, keeping this projection a
- // verbatim pass-through. See the deferred design note in
- // ../../../../.agents/notes/implemented/simplification/2026-07-20-unwrap-injected-content-envelopes.md
- case 'user/message': {
- return event.data
- }
- case 'steering/message': {
- return event.data.message
- }
- 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.message.content.length === 0) return null
- return event.data.message
- }
- case 'tool/result': {
- return event.data.message
- }
- 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 selected prefix ends inside an
- * open 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`, seed
- * and parent lineage, and delegation depth) 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 },
- ...meta?.delegationDepth === undefined ? {} : { delegationDepth: meta.delegationDepth },
- }
- 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 stable prefix of a live source.
- * `boundary` is an inclusive source event seq; omitted means the source's
- * current last event. The selected slice may end with a between-turn event
- * but must not end inside an open turn.
- *
- * @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',
- )
- }
- const lastTurnBoundary = events.slice(0, boundary + 1)
- .findLast(event => event.type === 'turn/start' || event.type === 'turn/end')
- if (lastTurnBoundary?.type === 'turn/start') {
- throw new SessionForkError(
- `fork boundary ${boundary} in session "${session.id}" ends inside open turn ${lastTurnBoundary.data.turn}`,
- '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
|