| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274 |
- /**
- * 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 '@deepseek-ai/cordis'
- import { isAbsolute } from 'node:path'
- import { brandString } from '@deepseek-ai/dsh-brand'
- import { assertNever, deepFreeze, snapshotJsonValue } from '@deepseek-ai/dsh-util-values'
- 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, SessionLogOffset, SessionSeq } from './types.ts'
- import type { TypertLookup } from '@deepseek-ai/dsh-typert-protocol'
- import type { CreateSessionOptions, EpochHeader, PrepareSessionOptions, RequestContext, SessionEvent, SessionEventMap, SessionEventType, SessionHeader, SessionId, SessionSeedEventState, SurfaceIntent, SurfaceEventType } from './types.ts'
- import { deriveEventMessage, SurfaceManager, validateSessionEventData, validateSurfaceMetadata } from './surface.ts'
- import type { SessionSurface } from './surface.ts'
- import { foldRequestHeader } from './request-header.ts'
- export * from './types.ts'
- export { SessionPreparation } from './preparation.ts'
- export type { SessionPreparationOptions } from './preparation.ts'
- export type { AssistantMessage, SystemMessage, ToolResultMessage, UserMessage } from '@deepseek-ai/dsh-llm'
- export { interruptedTurnClosers, TOOL_NOT_STARTED, TOOL_OUTCOME_UNKNOWN } from './repair.ts'
- export type { SessionSurface, SurfaceFoldReplacement, SurfaceFoldResult } from './surface.ts'
- export { deriveEventMessage, foldSurface, isAppendSurfaceEvent, isReplacementSurfaceEvent, isSurfaceEvent, isSurfaceEligibleType } from './surface.ts'
- export { canonicalHeader, foldRequestHeader, headerEquals } from './request-header.ts'
- export { KNOWN_SESSION_EVENT_TYPES } from './known-event-types.ts'
- declare module '@deepseek-ai/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. 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
- }
- }
- declare module '@deepseek-ai/dsh-typert-protocol' {
- interface TypertLookupMap {
- session: TypertLookup<Session, SessionId>
- }
- }
- /** Validate and freeze one detached creation header in place. */
- function validateSessionHeader(id: SessionId, input: unknown): SessionHeader {
- if (input === null || typeof input !== 'object' || Array.isArray(input)) {
- throw new Error('session header is not a plain JSON record')
- }
- const record = input as Record<string, unknown>
- if (Object.hasOwn(record, 'seedLength')) {
- throw new Error('session header has invalid field "seedLength"')
- }
- 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 (typeof record.isSeeded !== 'boolean') {
- throw new Error('session header isSeeded must be a boolean')
- }
- if (record.origin !== undefined && record.origin !== 'subagent') {
- throw new Error('session header origin must be "subagent"')
- }
- 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')
- }
- if (record.agentPreset !== undefined && typeof record.agentPreset !== 'string') {
- throw new Error('session header agentPreset must be a string')
- }
- return deepFreeze(record as unknown as SessionHeader)
- }
- /** Validate and freeze one exclusively owned persistence header in place. */
- function validateRestoredSessionHeader(id: SessionId, input: unknown): SessionHeader {
- if (input !== null && typeof input === 'object' && !Array.isArray(input)) {
- const prototype = Reflect.getPrototypeOf(input)
- if (prototype !== Object.prototype && prototype !== null) {
- throw new Error('session header is not a plain JSON record')
- }
- }
- return validateSessionHeader(id, input)
- }
- /** 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(), isSeeded: false }
- : source
- const snapshot = snapshotJsonValue(input)
- if (snapshot === undefined) throw new Error('session header is not losslessly JSON-serializable')
- return validateSessionHeader(id, snapshot)
- }
- /**
- * Validate an exclusively owned event and deeply freeze its identified message
- * without copying the event. The caller transfers an object graph that no
- * producer retains and that shares no mutable children with another event.
- * Use {@link snapshotSessionEvent} when exclusive ownership is not guaranteed.
- * @param event - exclusively owned event imported across a trusted boundary.
- * @returns the same event object with a validated, deeply frozen message.
- * @throws when event-local surface metadata, request-header fields, or message invariants are invalid; history relations are not checked.
- */
- export function adoptSessionEvent<T extends SessionEvent>(event: T): T {
- validateSessionEventData(event, `session event at seq ${event.seq}`)
- validateSurfaceMetadata(event)
- assertMessageEventShape(
- event,
- `session event at seq ${event.seq}`,
- )
- switch (event.type) {
- case 'user/message':
- deepFreeze(event.data)
- break
- case 'system/message':
- case 'assistant/message':
- case 'tool/result':
- deepFreeze(event.data.message)
- break
- default:
- // SessionEventMap is merge-extensible; plugin-owned events carry no core message.
- break
- }
- return event
- }
- /**
- * 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 {
- return adoptSessionEvent(structuredClone(event))
- }
- /** Validate the fixed event envelope after one-pass JSON materialization. */
- function assertSessionEventEnvelope(value: unknown, index: number): asserts value is SessionEvent {
- if (value === null || typeof value !== 'object' || Array.isArray(value)) {
- throw new Error(`seed event at index ${index} has an invalid event envelope`)
- }
- const event = value as Record<string, unknown>
- for (const key in event) {
- switch (key) {
- case 'type':
- case 'seq':
- case 'time':
- case 'data':
- case 'surfaceOp':
- case 'sourceEventSeqs':
- case 'ignorable':
- break
- default:
- throw new Error(`seed event at index ${index} has an invalid event envelope`)
- }
- }
- const type = event['type']
- const seq = event['seq']
- const time = event['time']
- if (typeof type !== 'string'
- || typeof seq !== 'number' || !Number.isSafeInteger(seq) || seq < 0 || Object.is(seq, -0)
- || typeof time !== 'number' || !Number.isSafeInteger(time)
- || event['data'] === undefined
- || (event['ignorable'] !== undefined && event['ignorable'] !== true)) {
- throw new Error(`seed event at index ${index} has an invalid event envelope`)
- }
- validateSessionEventData(event as SessionEvent, `seed ${type} at index ${index}`)
- switch (type) {
- case 'request/header':
- case 'system/message':
- case 'user/message':
- case 'assistant/attempt':
- case 'assistant/message':
- case 'tool/result':
- assertCurrentLlmShape(event, index)
- break
- }
- }
- /** 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 headerRecord = record?.['header'] as Record<string, unknown>
- const config = headerRecord['config']
- if (!hasProviderModel(config)) throw new Error(`seed request/header at index ${index} lacks provider/model`)
- const configRecord = config as Record<string, unknown>
- const reasoningEffort = configRecord['reasoningEffort']
- if (reasoningEffort !== undefined
- && (typeof reasoningEffort !== 'string' || reasoningEffort.length === 0)) {
- throw new Error(`seed request/header at index ${index} has an invalid reasoningEffort`)
- }
- assertAdapterDefaults(headerRecord['adapterDefaults'], configRecord, index)
- const reason = record?.['reason']
- if (reason !== 'initial' && reason !== 'resume' && reason !== 'change' && reason !== 'series') {
- throw new Error(`seed request/header at index ${index} has an invalid reason`)
- }
- if (record?.['startsSeries'] !== undefined && record['startsSeries'] !== true) {
- throw new Error(`seed request/header at index ${index} has an invalid startsSeries marker`)
- }
- }
- const type = event['type']
- if (type === 'assistant/attempt') {
- assertAssistantSettlementShape(record, type, index)
- return
- }
- if (!isMessageEventType(type)) return
- assertMessageEventShape(event, `seed ${type} at index ${index}`)
- if (type === 'assistant/message') {
- assertAssistantSettlementShape(record, type, index)
- }
- }
- /** Validate fields used directly by restored Session lifecycle logic without replaying the embedded stream. */
- function assertAssistantSettlementShape(
- data: Record<string, unknown> | undefined,
- type: 'assistant/attempt' | 'assistant/message',
- index: number,
- ): void {
- const turn = data?.['turn']
- const step = data?.['step']
- if (typeof turn !== 'number' || !Number.isSafeInteger(turn) || turn < 0 || Object.is(turn, -0)
- || typeof step !== 'number' || !Number.isSafeInteger(step) || step < 0 || Object.is(step, -0)
- || !Array.isArray(data?.['stream'])) {
- throw new Error(`seed ${type} at index ${index} has invalid settlement fields`)
- }
- }
- const allowedAdapterKeys = new Set(['reasoningEffort', 'maxTokens'])
- /** Validate adapter-default markers imported from a durable request header. */
- function assertAdapterDefaults(
- value: unknown,
- config: Record<string, unknown>,
- index: number,
- ): void {
- if (value === undefined) return
- if (typeof value !== 'object' || value === null || Array.isArray(value)) {
- throw new Error(`seed request/header at index ${index} has invalid adapterDefaults`)
- }
- const defaults = value as Record<string, unknown>
- if (Object.keys(defaults).some(key => !allowedAdapterKeys.has(key))
- || Object.values(defaults).some(marker => marker !== true)
- || defaults['reasoningEffort'] === true && config['reasoningEffort'] === undefined
- || defaults['maxTokens'] === true && config['maxTokens'] === undefined) {
- throw new Error(`seed request/header at index ${index} has invalid adapterDefaults`)
- }
- }
- /** The four surface event types whose payload carries an identified message. */
- function isMessageEventType(type: unknown): type is SurfaceEventType {
- return type === 'system/message' || type === 'user/message'
- || type === 'assistant/message' || type === 'tool/result'
- }
- const MESSAGE_ROLE_BY_TYPE: Record<SurfaceEventType, Message['role']> = {
- 'system/message': 'system',
- 'user/message': 'user',
- 'assistant/message': 'assistant',
- 'tool/result': 'user',
- }
- /** 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 (!isMessageEventType(type)) 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 = MESSAGE_ROLE_BY_TYPE[type]
- 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 === 'system/message') {
- if (sourceRecord['kind'] !== 'plugin' || typeof sourceRecord['plugin'] !== 'string'
- || sourceRecord['plugin'] === '') {
- throw new Error(`${subject} message must have plugin source`)
- }
- return
- }
- 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`)
- }
- }
- /** 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
- }
- 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 live instances via
- * `ctx.sessions.create()` and detached instances via {@link create}.
- * Seeding with an existing event log replays/forks a session.
- * @typert object
- */
- 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,
- * and whether fork history exists). Supplied by the store via `ctx.sessions.create()`. When a
- * `Session` is created without a store-owned header, 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
- /** Number of leading events inherited from this Session's fork parent. */
- readonly inheritedEventCount: SessionLogOffset
- /** 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 with smaller seq values entered through
- * construction — replay, fork, or resume — and were never published on the
- * `session/event` firehose (constructor seeds do not emit). This offset marks
- * the constructor-input boundary for lifecycle ownership and persistence
- * adoption; consumers that need complete canonical history still start at
- * seq 0. Distinct from {@link inheritedEventCount}, the DURABLE
- * fork-lineage cut: a resumed session's constructor seed is its full stored
- * log, while the inherited count keeps the original fork value — this field is the
- * in-process construction fact.
- *
- * Not persisted itself: a seeded session projects it into the log as the
- * `session/end-seed` event, which is what a consumer reading STORED history
- * reads. Locate the LAST such event, not necessarily one at this seq — a
- * seed already ending in one is not re-marked, so reopening an untouched
- * session leaves that event at a smaller seq than `firstLiveSeq`. Prefer
- * this field in-process: it is exact before the marker reaches storage.
- *
- * When this lifecycle appends the marker, it occupies this seq before the
- * store attaches and therefore does not publish either. Otherwise this seq
- * holds an ordinary published write.
- */
- readonly firstLiveSeq: SessionLogOffset
- /**
- * Create a detached session by validating and snapshotting borrowed seed
- * events and storage metadata.
- * @param id - session identity.
- * @param seed - optional borrowed replay or fork events.
- * @param header - optional borrowed storage metadata.
- * @param inheritedEventCount - exact fork-inherited prefix length for a seeded header.
- * @returns a detached session.
- */
- static create(
- id: SessionId,
- seed?: readonly SessionEvent[],
- header?: SessionHeader,
- inheritedEventCount?: SessionLogOffset,
- ): Session {
- return new Session(id, seed, header, 'snapshot', inheritedEventCount)
- }
- /**
- * Restore a detached session by adopting an independently owned or deeply frozen seed.
- * Runtime-required event fields, event envelopes, sequence continuity, surface
- * transitions, and header fields are validated without copying or freezing events.
- * Embedded Assistant streams remain opaque until a stream consumer or storage
- * verifier reads them.
- * @param id - restored session identity.
- * @param seed - independently owned or deeply frozen events.
- * @param header - independently owned storage metadata.
- * @param inheritedEventCount - exact fork-inherited prefix length decoded from storage.
- * @param eventState - aliasing state carried from the operation that produced the seed.
- * @returns a restored detached session.
- */
- static fromRestore(
- id: SessionId,
- seed: readonly SessionEvent[],
- header: SessionHeader,
- inheritedEventCount: SessionLogOffset,
- eventState: SessionSeedEventState,
- ): Session {
- return new Session(
- id,
- seed,
- header,
- eventState,
- inheritedEventCount,
- )
- }
- private constructor(
- id: SessionId,
- seed?: readonly SessionEvent[],
- header?: SessionHeader,
- mode: 'snapshot' | SessionSeedEventState = 'snapshot',
- suppliedInheritedEventCount?: SessionLogOffset,
- ) {
- const restoredHeader = mode === 'snapshot' ? undefined : validateRestoredSessionHeader(id, header)
- if (seed !== undefined) {
- // 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 = mode === 'snapshot' ? snapshotJsonValue(source) : 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`)
- }
- // 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(mode === 'snapshot' ? deepFreeze(snapshot) : snapshot)
- }
- }
- this.firstLiveSeq = SessionLogOffset(this.log.length)
- this.header = restoredHeader ?? snapshotSessionHeader(id, header)
- if (this.header.isSeeded && seed === undefined) {
- throw new Error('seeded session requires an explicit constructor seed')
- }
- if (this.header.isSeeded && suppliedInheritedEventCount === undefined) {
- throw new Error('seeded session requires an inherited event count')
- }
- const inheritedEventCount = SessionLogOffset(suppliedInheritedEventCount ?? 0)
- if (!this.header.isSeeded && inheritedEventCount !== 0) {
- throw new Error('unseeded session inherited event count must be 0')
- }
- if (inheritedEventCount > this.log.length) {
- throw new Error('session inherited event count exceeds its event log')
- }
- if (mode === 'snapshot' && this.header.isSeeded && inheritedEventCount !== this.log.length) {
- throw new Error('seeded session constructor seed must equal its inherited prefix')
- }
- this.inheritedEventCount = inheritedEventCount
- // A fresh seeded child always owns one tagged marker at its inherited cut,
- // even when the copied prefix already ends in an ancestor marker. Restore
- // retains that durable marker and appends only the ordinary resume marker.
- if (seed !== undefined && mode === 'snapshot' && this.header.isSeeded) {
- this.append('session/end-seed', { inherited: true })
- } else if (seed !== undefined && this.log.at(-1)?.type !== 'session/end-seed') {
- this.append('session/end-seed', {})
- }
- }
- /** Cached immutable full snapshot of the private append-only log. */
- private eventsSnapshot: readonly SessionEvent[] | undefined
- /**
- * Return the immutable event stored at one exact sequence number.
- * @param seq - event sequence number.
- * @returns the accepted event, or undefined when the log does not contain it.
- */
- eventAt(seq: SessionSeq): SessionEvent | undefined {
- return this.log[seq]
- }
- /**
- * Materialize an immutable snapshot of a half-open event sequence range.
- * A full current snapshot is reused until the next append; every previously
- * returned snapshot remains stable after later appends.
- * @param fromSeq - non-negative inclusive sequence number; defaults to the log start.
- * @param toSeqExclusive - non-negative exclusive sequence number; defaults to the current end.
- * @returns a frozen array of the selected deeply frozen events.
- */
- snapshotEvents(
- fromSeq: SessionLogOffset = SessionLogOffset(0),
- toSeqExclusive: SessionLogOffset = this.seq,
- ): readonly SessionEvent[] {
- if (fromSeq === 0 && toSeqExclusive === this.log.length) {
- this.eventsSnapshot ??= Object.freeze([...this.log])
- return this.eventsSnapshot
- }
- return Object.freeze(this.log.slice(fromSeq, toSeqExclusive))
- }
- /**
- * Return this Session's events after its fork-inherited prefix.
- * @returns a fresh array containing child-owned events in log order.
- */
- ownEvents(): readonly SessionEvent[] {
- return this.snapshotEvents(this.inheritedEventCount)
- }
- /**
- * Whether one existing event position is outside the fork-inherited prefix.
- * @param seq - event position in this Session.
- * @returns true when the event belongs to this Session rather than its parent.
- */
- isOwnSeq(seq: SessionSeq): boolean {
- return seq >= this.inheritedEventCount && seq < this.seq
- }
- /** The next event's sequence number — always the log length (the `seq = log.length` contiguity contract). */
- get seq(): SessionLogOffset {
- return SessionLogOffset(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` lists the seq numbers of earlier
- * 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 model
- * history) and
- * rejected by the compiler for non-surface types like `turn/start` or
- * `assistant/attempt`. Assistant messages embed their exact provider
- * stream and cannot cite top-level source events.
- * @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
- * request-header empty-field or tool-error consistency rules, or the
- * canonical surface contract (marker shape and eligibility, unique
- * earlier source-event references, positional replacement validity, and complete
- * shadowed-node coverage). One iterative 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<T>] : []
- ): 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`)
- }
- 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: SessionSeq(this.log.length),
- time: Date.now(),
- data: dataSnapshot,
- ...(surfaceMetadataSnapshot as { surfaceOp?: unknown; sourceEventSeqs?: unknown }),
- } as unknown as SessionEvent<T>)
- validateSessionEventData(event, `session event "${type}" at seq ${event.seq}`)
- 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.snapshotEvents())`: 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
- }
- /** Cached fold of `request/context` events. */
- private contextFold: RequestContext | undefined
- private contextFoldSeq = 0
- /**
- * Return the latest resolved route metadata, or `undefined` before the first
- * `request/context` event. Each event is folded once.
- * @returns the latest immutable route metadata.
- */
- requestContext(): RequestContext | undefined {
- if (this.contextFoldSeq < this.log.length) {
- for (const event of this.log.slice(this.contextFoldSeq)) {
- if (event.type === 'request/context') this.contextFold = deepFreeze({ ...event.data })
- }
- this.contextFoldSeq = this.log.length
- }
- return this.contextFold
- }
- /** 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.
- // oxlint-disable-next-line typescript/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]
- }
- /**
- * Instance face of the pure per-node `deriveEventMessage` export from
- * `surface.ts`.
- * @param event - the event to project.
- * @returns the derived message, or null when the event produces none.
- */
- deriveEventMessage(event: SessionEvent): Message | null {
- return deriveEventMessage(event)
- }
- }
- /** 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 — the agent lifecycle
- * attaches a session-log writer to each published session's write handle;
- * a session published outside that lifecycle persists nothing.
- */
- export class SessionStore extends Service {
- private store = new Map<SessionId, SessionEntry>()
- private counter = 0
- constructor(ctx: Context) {
- super(ctx, 'sessions')
- ctx.inject(['typert'], (typeCtx) => {
- typeCtx.typert.lookups.register('session', {
- parameter: 'session',
- wire: 'sessionId',
- hostTypeSymbol: '@deepseek-ai/dsh-session#Session',
- wireTypeSymbol: '@deepseek-ai/dsh-session/types#SessionId',
- resolve: sessionId => this.get(sessionId),
- })
- })
- }
- /**
- * 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 events are published 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 driver's closing events commit, dropping them.
- *
- * @param id - the session id; omitted, the store mints `session-<n>`.
- * @param options - seed events and/or creation metadata for the header. With
- * `eventState`, every seed event is either independently owned or any
- * shared value is deeply frozen; {@link Session.fromRestore} validates and
- * adopts those values without copying or freezing them.
- * @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?: PrepareSessionOptions): Session {
- let sessionId: SessionId
- if (id === undefined) {
- do sessionId = brandString<SessionId>(`session-${++this.counter}`)
- while (this.store.has(sessionId))
- } else {
- sessionId = brandString<SessionId>(id)
- }
- if (this.store.has(sessionId)) throw new Error(`session "${sessionId}" already exists`)
- if (options !== undefined) {
- const { eventState } = options
- switch (eventState) {
- case 'detached':
- case 'shared-frozen':
- return Session.fromRestore(
- sessionId,
- options.seed,
- options.meta,
- options.inheritedEventCount,
- eventState,
- )
- case undefined:
- break
- /* v8 ignore next -- closed-union exhaustiveness guard */
- default:
- assertNever(eventState, 'SessionStore.prepare event state')
- }
- }
- 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 },
- isSeeded: meta?.isSeeded ?? false,
- ...meta?.origin === undefined ? {} : { origin: meta.origin },
- ...meta?.delegationDepth === undefined ? {} : { delegationDepth: meta.delegationDepth },
- ...meta?.agentPreset === undefined ? {} : { agentPreset: meta.agentPreset },
- }
- return Session.create(sessionId, seed, header, options?.inheritedEventCount)
- }
- /**
- * 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 API 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 checkpoint policy's per-request
- * barrier, goal-round-driver's idle checkpoint, teardown drains, and consumers
- * that flush themselves before reading storage) 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 whether at least one durability listener participated, after every
- * listener has settled successfully.
- * @throws the first registered listener failure after every listener settles.
- */
- async flush(session: Session): Promise<boolean> {
- 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.
- // oxlint-disable-next-line typescript/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 callbacks.length > 0
- }
- /** 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?: SessionSeq, 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,
- inheritedEventCount: SessionLogOffset(seed.length),
- meta: {
- ...liveSource.header.cwd !== undefined ? { cwd: liveSource.header.cwd } : {},
- parentSession: liveSource.id,
- isSeeded: true,
- },
- })
- }
- private _forkSeed(session: Session, requestedBoundary: SessionSeq | undefined): readonly SessionEvent[] {
- const lastEvent = session.snapshotEvents().at(-1)
- let boundary: SessionSeq
- 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 >= session.seq) {
- const lastSeq = lastEvent?.seq
- throw new SessionForkError(
- `fork boundary ${boundary} does not exist in session "${session.id}" (last seq: ${lastSeq ?? 'none'})`,
- 'INVALID_BOUNDARY',
- )
- }
- const boundaryEvent = session.eventAt(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 events = session.snapshotEvents(SessionLogOffset(0), SessionLogOffset(boundary + 1))
- const lastTurnBoundary = events
- .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
- }
- 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 { decodeSeqRanges, encodeSeqRanges } from './seq-ranges.ts'
- export default SessionStore
|