| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103 |
- /**
- * Concrete session-query service with SQLite FTS5 over the live-preferred corpus.
- *
- * @module @deepseek-ai/dsh-session-query-sqlite
- */
- import { createHash, randomUUID } from 'node:crypto'
- import type { DatabaseSync } from 'node:sqlite'
- import { Context, Service, type Fiber } from '@deepseek-ai/cordis'
- import z from '@deepseek-ai/schemastery'
- import type { Session, SessionEvent, SessionHeader, SessionId } from '@deepseek-ai/dsh-session'
- import type SessionPersistence from '@deepseek-ai/dsh-session-persistence'
- import type {
- SessionPersistenceRevision,
- SessionPersistenceSnapshot,
- } from '@deepseek-ai/dsh-session-persistence'
- import SessionQueryEngine, {
- SESSION_QUERY_DEFAULT_PERSISTED_INSPECT_CONCURRENCY,
- SESSION_QUERY_READ_WINDOW_MAX,
- SessionQueryError,
- SessionSearchCursor,
- assertSessionHeadersCompatible,
- buildSessionEventSearchDocuments,
- } from '@deepseek-ai/dsh-session-query'
- import type {
- Config as SessionQueryConfig,
- SessionEventSearchDocument,
- SessionEventSearchHit,
- SessionEventSearchPage,
- SessionEventSearchRequest,
- SessionSearchExecContext,
- SessionSearchHit,
- SessionSearchCursor as SessionSearchCursorValue,
- SessionSearchPage,
- SessionSearchRequest,
- } from '@deepseek-ai/dsh-session-query'
- import {
- type JournalMode,
- openSearchDatabase,
- } from './schema.ts'
- import {
- type NormalizedEventRequest,
- type NormalizedSessionRequest,
- FTS_HIGHLIGHT_END,
- FTS_HIGHLIGHT_START,
- assertFts5OuterPredicateCount,
- assertPortableBindingCount,
- buildEventWhere,
- buildSessionWhere,
- makeSnippet,
- normalizeEventRequest,
- normalizeSessionRequest,
- quoteFtsData,
- requestFingerprint,
- sanitizeFtsText,
- SQLITE_MAX_PAGE_LIMIT,
- } from './query.ts'
- export {
- SESSION_QUERY_SQLITE_APPLICATION_ID,
- SESSION_QUERY_SQLITE_SCHEMA_VERSION,
- type JournalMode,
- } from './schema.ts'
- /** Boot-context slot for a launcher-owned absolute path to this process's derived query index. */
- export const SESSION_QUERY_SQLITE_PATH_KEY = 'launcherSessionQueryPath'
- declare module '@deepseek-ai/cordis' {
- interface Context {
- /** Launcher-owned absolute path to this process's disposable derived query index. */
- launcherSessionQueryPath?: string
- }
- }
- /** Default result page size. */
- export const SESSION_QUERY_SQLITE_DEFAULT_LIMIT = 20
- /** Maximum accepted result page size. */
- export const SESSION_QUERY_SQLITE_MAX_LIMIT = 100
- /** Default maximum snippet length in Unicode code points. */
- export const SESSION_QUERY_SQLITE_SNIPPET_CHARS = 240
- // One transient source change gets a retry; repeated churn fails rather than monopolizing the queue.
- const STABLE_OBSERVATION_ATTEMPTS = 2
- /** SQLite module/handle opening phase; `never` disables full-text search entirely. */
- export type OpenAt = 'startup' | 'first-search' | 'never'
- /** Combined session-query configuration backed by SQLite full-text search. */
- export interface Config extends SessionQueryConfig {
- /**
- * Dedicated derived-index path; `:memory:` is supported for ephemeral
- * indexes. Missing directories and database files are created owner-only on
- * POSIX filesystems; existing modes are preserved.
- */
- path: string
- /**
- * Open the SQLite module and handle at service activation or the first
- * search, or `never` to disable full-text search: the inherited exact
- * reads, filters, and traces stay available, while `searchSessions` and
- * `searchEvents` fail with `SESSION_QUERY_SEARCH_DISABLED` and SQLite is
- * never imported or opened. Defaults to `startup`.
- */
- openAt?: OpenAt
- /** SQLite journal mode. Defaults to `wal`. */
- journalMode?: JournalMode
- /** Page size when a request omits `limit`. At most `Number.MAX_SAFE_INTEGER - 1`; defaults to 20. */
- defaultLimit?: number
- /** Largest accepted page size. At most `Number.MAX_SAFE_INTEGER - 1`; defaults to 100. */
- maxLimit?: number
- /** Maximum snippet length in Unicode code points. Defaults to 240. */
- snippetChars?: number
- /** Maximum concurrent persisted-log inspections in one inherited batch read. Defaults to 4. */
- persistedInspectConcurrency?: number
- }
- interface ResolvedConfig {
- path: string
- openAt: OpenAt
- journalMode: JournalMode
- defaultLimit: number
- maxLimit: number
- snippetChars: number
- readWindowMax: number
- persistedInspectConcurrency: number
- }
- interface ObservedSession {
- header: SessionHeader
- documents: SessionEventSearchDocument[]
- fingerprint: string
- }
- interface ObservedPersistedSession {
- header: SessionHeader
- revision: SessionPersistenceRevision
- loaded?: ObservedSession
- }
- interface PersistenceBinding {
- readonly identity: symbol
- readonly service?: SessionPersistence
- }
- interface Observation {
- persistenceBinding: PersistenceBinding
- persisted: Map<SessionId, ObservedPersistedSession>
- live: Map<SessionId, ObservedSession>
- }
- interface IndexedPersistedRow {
- id: string
- revision: string
- generation: number
- }
- interface IndexedLiveRow {
- id: string
- fingerprint: string
- persisted: number
- generation: number
- }
- interface SessionHeaderRow {
- session_id: string
- version: number
- created_at: number
- cwd: string | null
- parent_session: string | null
- seed_length: number | null
- delegation_depth: number | null
- agent_preset: string | null
- }
- interface SearchRow extends SessionHeaderRow {
- live: number
- persisted: number
- seq: number
- type: string
- time: number
- surface: string
- marked_text: string
- match_count: number
- document_length: number
- }
- interface CursorPayload {
- version: 1
- instance: string
- scope: 'sessions' | 'events'
- fingerprint: string
- generation: string
- offset: number
- }
- /** Concrete SQLite owner of the combined `ctx.sessionQuery` service. */
- export class SqliteSessionQueryEngine extends SessionQueryEngine {
- static override inject = ['sessions']
- static Config: z<Config> = z.object({
- path: z.string().required(),
- openAt: z.union(['startup', 'first-search', 'never'] as const).default('startup'),
- journalMode: z.union(['wal', 'delete', 'truncate', 'persist'] as const).default('wal'),
- defaultLimit: z.number().step(1).min(1).max(SQLITE_MAX_PAGE_LIMIT).default(SESSION_QUERY_SQLITE_DEFAULT_LIMIT),
- maxLimit: z.number().step(1).min(1).max(SQLITE_MAX_PAGE_LIMIT).default(SESSION_QUERY_SQLITE_MAX_LIMIT),
- snippetChars: z.number().step(1).min(1).default(SESSION_QUERY_SQLITE_SNIPPET_CHARS),
- readWindowMax: z.number().step(1).min(0).default(SESSION_QUERY_READ_WINDOW_MAX),
- persistedInspectConcurrency: z.number()
- .step(1)
- .min(1)
- .max(Number.MAX_SAFE_INTEGER)
- .default(SESSION_QUERY_DEFAULT_PERSISTED_INSPECT_CONCURRENCY),
- })
- /** Validated and defaulted backend configuration. */
- readonly config: ResolvedConfig
- private readonly _instance = randomUUID()
- private _ready: Promise<void> | undefined
- private _db: DatabaseSync | undefined
- private _persistenceBinding: PersistenceBinding = { identity: Symbol() }
- private _lastPersistenceIdentity: symbol | undefined
- private _persistenceEpoch = 0
- private _globalGeneration = 0
- private _localGeneration = 0
- private _tail: Promise<void> = Promise.resolve()
- private _closed = false
- private _closePromise: Promise<void> | undefined
- private readonly _optionalPersistenceFiber: Fiber
- constructor(ctx: Context, config: Config) {
- // The assignment expression resolves before the base constructor can
- // register `ctx.sessionQuery`; keep that same validated value afterward.
- super(ctx, config = resolveConfig(config))
- this.config = config as ResolvedConfig
- this._optionalPersistenceFiber = ctx.inject(['sessionPersistence'], (childCtx: Context) => {
- const service = childCtx.sessionPersistence
- const binding = { identity: Symbol(), service }
- this._persistenceBinding = binding
- childCtx.effect(() => () => {
- /* v8 ignore next -- a stale optional-service disposer cannot clear a replacement */
- if (this._persistenceBinding !== binding) return
- this._persistenceBinding = { identity: Symbol() }
- }, 'sessionQuerySqlite.persistenceBinding')
- })
- ctx.effect(() => {
- return () => this._optionalPersistenceFiber.dispose()
- }, 'sessionQuerySqlite.optionalPersistence')
- ctx.effect(() => async () => this.close(), 'sessionQuerySqlite.close')
- }
- /** Open eagerly only when activation owns the configured readiness boundary. */
- protected async [Service.init](): Promise<void> {
- if (this.config.openAt === 'startup') await this._ensureReady(undefined)
- }
- override async searchSessions(
- request: SessionSearchRequest,
- exec?: SessionSearchExecContext,
- ): Promise<SessionSearchPage<SessionSearchHit>> {
- this._assertSearchEnabled()
- const normalized = normalizeSessionRequest(request, this.config)
- const signal = exec?.signal
- return this._serialized(signal, async () => {
- await this._ensureReady(signal)
- const persistenceBinding = await this._reconcile(signal)
- assertNotAborted(signal)
- const generation = String(this._globalGeneration)
- const fingerprint = requestFingerprint(normalized)
- const offset = normalized.cursor === undefined
- ? 0
- : decodeCursor(normalized.cursor, this._instance, 'sessions', fingerprint, generation)
- const rows = this._querySessions(normalized, offset, persistenceBinding)
- return page(rows, normalized.limit, row => this._sessionHit(row), cursorOffset => encodeCursor({
- version: 1,
- instance: this._instance,
- scope: 'sessions',
- fingerprint,
- generation,
- offset: cursorOffset,
- }), offset)
- })
- }
- override async searchEvents(
- request: SessionEventSearchRequest,
- exec?: SessionSearchExecContext,
- ): Promise<SessionEventSearchPage> {
- this._assertSearchEnabled()
- const normalized = normalizeEventRequest(request, this.config)
- const signal = exec?.signal
- return this._serialized(signal, async () => {
- await this._ensureReady(signal)
- const persistenceBinding = await this._reconcile(signal)
- assertNotAborted(signal)
- const target = this._targetObservation(normalized.sessionId, persistenceBinding)
- const fingerprint = requestFingerprint(normalized)
- const offset = normalized.cursor === undefined
- ? 0
- : decodeCursor(normalized.cursor, this._instance, 'events', fingerprint, target.generation)
- const rows = this._queryEvents(normalized, offset, persistenceBinding)
- return {
- session: target.header,
- ...page(rows, normalized.limit, row => this._eventHit(row), cursorOffset => encodeCursor({
- version: 1,
- instance: this._instance,
- scope: 'events',
- fingerprint,
- generation: target.generation,
- offset: cursorOffset,
- }), offset),
- }
- })
- }
- /** Close the database after every accepted operation reaches quiescence. */
- close(): Promise<void> {
- this._closePromise ??= this._close()
- return this._closePromise
- }
- /**
- * Refuse full-text calls under `openAt: 'never'` before any request
- * normalization or SQLite work, so a disabled deployment never imports
- * node:sqlite, opens the index, or observes sources.
- */
- private _assertSearchEnabled(): void {
- if (this.config.openAt !== 'never') return
- throw new SessionQueryError(
- 'session search is disabled: this deployment configures the session-query index with openAt "never"',
- 'SESSION_QUERY_SEARCH_DISABLED',
- )
- }
- private async _close(): Promise<void> {
- this._closed = true
- await this._tail
- if (this._ready !== undefined) {
- try {
- await this._ready
- } catch {
- // Opening already closed a partially-created handle; disposal only waits.
- }
- }
- this._db?.close()
- this._db = undefined
- }
- private async _open(): Promise<void> {
- this._db = await openSearchDatabase(this.config.path, this.config.journalMode)
- const state = this._db.prepare(
- 'SELECT global_generation FROM search_state WHERE singleton = 1',
- ).get() as { global_generation: number }
- this._globalGeneration = state.global_generation
- this._localGeneration = state.global_generation
- }
- private async _ensureReady(signal: AbortSignal | undefined): Promise<void> {
- this._ready ??= this._open()
- try {
- await waitWithAbort(this._ready, signal)
- } catch (error: unknown) {
- if (isAbort(error)) throw error
- throw new SessionQueryError(
- `session-search SQLite index failed to open: ${errorMessage(error)}`,
- 'SESSION_QUERY_INDEX_FAILED',
- { cause: error },
- )
- }
- }
- private async _serialized<T>(signal: AbortSignal | undefined, operation: () => Promise<T>): Promise<T> {
- if (this._isClosed()) throw indexClosed()
- let release!: () => void
- const gate = new Promise<void>((resolve) => { release = resolve })
- const prior = this._tail
- this._tail = prior.then(() => gate)
- try {
- await waitWithAbort(prior, signal)
- } catch (error: unknown) {
- release()
- throw error
- }
- if (this._isClosed()) {
- release()
- throw indexClosed()
- }
- try {
- assertNotAborted(signal)
- return await operation()
- } finally {
- release()
- }
- }
- private async _reconcile(signal: AbortSignal | undefined): Promise<PersistenceBinding> {
- assertNotAborted(signal)
- const db = this._requireDb()
- const persistedRows = db.prepare(
- 'SELECT id, revision, generation FROM persisted_sessions',
- ).all() as unknown as IndexedPersistedRow[]
- const liveRows = db.prepare(
- 'SELECT id, fingerprint, persisted, generation FROM temp.live_sessions',
- ).all() as unknown as IndexedLiveRow[]
- const persistedById = new Map(persistedRows.map(row => [row.id as SessionId, row]))
- const liveById = new Map(liveRows.map(row => [row.id as SessionId, row]))
- const observation = await this._observeStable(persistedById, signal)
- assertNotAborted(signal)
- const persistentChanges = observation.persistenceBinding.service === undefined
- ? []
- : [...observation.persisted.values()].filter(entry => entry.loaded !== undefined)
- const persistentDeletes = observation.persistenceBinding.service === undefined
- ? []
- : persistedRows.filter(row => !observation.persisted.has(row.id as SessionId))
- const liveChanges = [...observation.live.values()].filter((entry) => {
- const indexed = liveById.get(entry.header.id)
- const persisted = observation.persisted.has(entry.header.id) ? 1 : 0
- return indexed?.fingerprint !== entry.fingerprint || indexed.persisted !== persisted
- })
- const liveDeletes = liveRows.filter(row => !observation.live.has(row.id as SessionId))
- const pointerChanged = this._lastPersistenceIdentity !== undefined
- && this._lastPersistenceIdentity !== observation.persistenceBinding.identity
- const hasWrites = persistentChanges.length > 0
- || persistentDeletes.length > 0
- || liveChanges.length > 0
- || liveDeletes.length > 0
- let nextMainGeneration = this._mainGeneration()
- let nextLocalGeneration = this._localGeneration
- if (persistentChanges.length > 0 || persistentDeletes.length > 0) nextMainGeneration += 1
- const liveReplacements = liveChanges.map((entry) => {
- nextLocalGeneration = Math.max(nextLocalGeneration, nextMainGeneration) + 1
- return {
- entry,
- generation: nextLocalGeneration,
- persisted: observation.persisted.has(entry.header.id),
- }
- })
- if (hasWrites) {
- let began = false
- try {
- db.exec('BEGIN IMMEDIATE')
- began = true
- for (const row of persistentDeletes) this._deleteSession('persisted', row.id as SessionId)
- for (const entry of persistentChanges) {
- /* v8 ignore next -- observation loads every entry whose revision differs */
- if (entry.loaded === undefined) throw new Error(`missing loaded revision for session "${entry.header.id}"`)
- this._replacePersistedSession(entry.loaded, entry.revision, nextMainGeneration)
- }
- if (persistentChanges.length > 0 || persistentDeletes.length > 0) {
- db.prepare('UPDATE search_state SET global_generation = ? WHERE singleton = 1').run(nextMainGeneration)
- }
- for (const row of liveDeletes) this._deleteSession('live', row.id as SessionId)
- for (const { entry, generation, persisted } of liveReplacements) {
- this._replaceLiveSession(entry, generation, persisted)
- }
- db.exec('COMMIT')
- } catch (error: unknown) {
- /* v8 ignore next -- a BEGIN failure has no transaction to roll back; the common wrapper still reports it. */
- if (began) {
- /* v8 ignore next 5 -- ROLLBACK failure requires a SQLite double fault; the original failure remains actionable. */
- try {
- db.exec('ROLLBACK')
- } catch {
- // The original SQLite failure remains the actionable cause.
- }
- }
- throw new SessionQueryError(
- `session-search reconciliation failed: ${errorMessage(error)}`,
- 'SESSION_QUERY_INDEX_FAILED',
- { cause: error },
- )
- }
- }
- if (hasWrites || pointerChanged) this._globalGeneration += 1
- if (pointerChanged) this._persistenceEpoch += 1
- this._localGeneration = nextLocalGeneration
- this._lastPersistenceIdentity = observation.persistenceBinding.identity
- return observation.persistenceBinding
- }
- private async _observeStable(
- indexed: ReadonlyMap<SessionId, IndexedPersistedRow>,
- signal: AbortSignal | undefined,
- ): Promise<Observation> {
- for (let attempt = 0; attempt < STABLE_OBSERVATION_ATTEMPTS; attempt += 1) {
- assertNotAborted(signal)
- const persistenceBinding = this._persistenceBinding
- const persistence = persistenceBinding.service
- const initiallyLive = new Set(this.ctx.sessions.list().map(session => session.id))
- let persisted = new Map<SessionId, ObservedPersistedSession>()
- if (persistence !== undefined) {
- try {
- const canReuseIndexed = this._lastPersistenceIdentity === undefined
- || this._lastPersistenceIdentity === persistenceBinding.identity
- const before = await persistence.listSnapshots(signal)
- assertNotAborted(signal)
- persisted = materializePersistenceSnapshots(before)
- for (const entry of persisted.values()) {
- if (canReuseIndexed && indexed.get(entry.header.id)?.revision === entry.revision) continue
- // Skip work already shadowed by a live owner. `inspect()` is
- // non-mutating, so an owner attaching after this check cannot cause
- // crash-repair side effects; the live-membership retry below makes
- // the returned observation live-preferred.
- if (initiallyLive.has(entry.header.id) || this.ctx.sessions.get(entry.header.id) !== undefined) continue
- assertNotAborted(signal)
- const loaded = await persistence.inspect(entry.header.id, signal)
- assertNotAborted(signal)
- assertSessionHeadersCompatible(entry.header, loaded.meta)
- entry.loaded = observeSession(loaded.meta, loaded.events)
- }
- assertNotAborted(signal)
- const afterSnapshots = await persistence.listSnapshots(signal)
- assertNotAborted(signal)
- const after = materializePersistenceSnapshots(afterSnapshots)
- if (!samePersistenceSnapshots(persisted, after)) continue
- if (this._persistenceBinding !== persistenceBinding) continue
- } catch (error: unknown) {
- if (isAbort(error) || signal?.aborted) {
- throw new SessionQueryError('session-search aborted', 'SESSION_QUERY_ABORTED', {
- cause: error,
- })
- }
- if (this._persistenceBinding !== persistenceBinding) continue
- if (error instanceof SessionQueryError) throw error
- throw new SessionQueryError(
- `session-search persistence observation failed: ${errorMessage(error)}`,
- 'SESSION_QUERY_PERSISTENCE_FAILED',
- { cause: error },
- )
- }
- }
- const live = new Map<SessionId, ObservedSession>()
- for (const session of this.ctx.sessions.list()) {
- const observed = observeLive(session)
- const durable = persisted.get(session.id)
- if (durable !== undefined) assertSessionHeadersCompatible(observed.header, durable.header)
- live.set(session.id, observed)
- }
- if (!sameSessionIds(initiallyLive, live)) continue
- return { persistenceBinding, persisted, live }
- }
- throw new SessionQueryError(
- 'session-search persistence observation did not stabilize after one retry',
- 'SESSION_QUERY_PERSISTENCE_FAILED',
- )
- }
- private _mainGeneration(): number {
- const row = this._requireDb().prepare(
- 'SELECT global_generation FROM search_state WHERE singleton = 1',
- ).get() as { global_generation: number }
- return row.global_generation
- }
- private _deleteSession(source: 'persisted' | 'live', id: SessionId): void {
- const db = this._requireDb()
- if (source === 'persisted') {
- db.prepare('DELETE FROM persisted_docs WHERE session_id = ?').run(id)
- db.prepare('DELETE FROM persisted_sessions WHERE id = ?').run(id)
- } else {
- db.prepare('DELETE FROM temp.live_docs WHERE session_id = ?').run(id)
- db.prepare('DELETE FROM temp.live_sessions WHERE id = ?').run(id)
- }
- }
- private _replacePersistedSession(
- entry: ObservedSession,
- revision: SessionPersistenceRevision,
- generation: number,
- ): void {
- this._deleteSession('persisted', entry.header.id)
- const db = this._requireDb()
- db.prepare(`
- INSERT INTO persisted_sessions
- (id, version, created_at, cwd, parent_session, seed_length, delegation_depth, agent_preset, revision, generation)
- VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
- `).run(
- ...headerBindings(entry.header),
- revision,
- generation,
- )
- const insert = db.prepare(`
- INSERT INTO persisted_docs (text, session_id, seq, type, time, surface, codepoint_length)
- VALUES (?, ?, ?, ?, ?, ?, ?)
- `)
- for (const document of entry.documents) {
- const text = sanitizeFtsText(document.text)
- insert.run(
- text,
- document.sessionId,
- document.seq,
- document.type,
- document.time,
- document.surface,
- Array.from(text).length,
- )
- }
- }
- private _replaceLiveSession(entry: ObservedSession, generation: number, persisted: boolean): void {
- this._deleteSession('live', entry.header.id)
- const db = this._requireDb()
- db.prepare(`
- INSERT INTO temp.live_sessions
- (id, version, created_at, cwd, parent_session, seed_length, delegation_depth, agent_preset, fingerprint, persisted, generation)
- VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
- `).run(
- ...headerBindings(entry.header),
- entry.fingerprint,
- persisted ? 1 : 0,
- generation,
- )
- const insert = db.prepare(`
- INSERT INTO temp.live_docs (text, session_id, seq, type, time, surface, codepoint_length)
- VALUES (?, ?, ?, ?, ?, ?, ?)
- `)
- for (const document of entry.documents) {
- const text = sanitizeFtsText(document.text)
- insert.run(
- text,
- document.sessionId,
- document.seq,
- document.type,
- document.time,
- document.surface,
- Array.from(text).length,
- )
- }
- }
- private _querySessions(
- request: NormalizedSessionRequest,
- offset: number,
- persistenceBinding: PersistenceBinding,
- ): SearchRow[] {
- const selected = selectedDocumentsSql()
- const sessionWhere = buildSessionWhere(request.sessionFilters)
- const eventWhere = buildEventWhere(request.eventFilters)
- assertFts5OuterPredicateCount(sessionWhere.predicateCount + eventWhere.predicateCount)
- const where = [sessionWhere.sql, eventWhere.sql].filter(Boolean).join(' AND ')
- const bindings = [
- ...selectedDocumentsParams(request.query, persistenceBinding.service !== undefined),
- ...sessionWhere.params,
- ...eventWhere.params,
- request.limit + 1,
- offset,
- ]
- assertPortableBindingCount(bindings.length)
- // The browser fixture mirrors these rank keys in
- // `packages/client/connection/src/client/fixture.ts`; update both together.
- return this._requireDb().prepare(`
- ${selected.sql},
- filtered AS (
- SELECT * FROM matched ${where.length === 0 ? '' : `WHERE ${where}`}
- ),
- ranked AS (
- SELECT *, ROW_NUMBER() OVER (
- PARTITION BY session_id
- ORDER BY match_count DESC, document_length ASC, time DESC, seq DESC
- ) AS event_rank
- FROM filtered
- )
- SELECT * FROM ranked
- WHERE event_rank = 1
- ORDER BY match_count DESC, document_length ASC, time DESC, session_id ASC, seq DESC
- LIMIT ? OFFSET ?
- `).all(...bindings) as unknown as SearchRow[]
- }
- private _queryEvents(
- request: NormalizedEventRequest,
- offset: number,
- persistenceBinding: PersistenceBinding,
- ): SearchRow[] {
- const selected = selectedDocumentsSql()
- const eventWhere = buildEventWhere(request.filters)
- assertFts5OuterPredicateCount(1 + eventWhere.predicateCount)
- const where = ['session_id = ?', eventWhere.sql].filter(Boolean).join(' AND ')
- const bindings = [
- ...selectedDocumentsParams(request.query, persistenceBinding.service !== undefined),
- request.sessionId,
- ...eventWhere.params,
- request.limit + 1,
- offset,
- ]
- assertPortableBindingCount(bindings.length)
- return this._requireDb().prepare(`
- ${selected.sql}
- SELECT * FROM matched
- WHERE ${where}
- ORDER BY match_count DESC, document_length ASC, time DESC, seq DESC
- LIMIT ? OFFSET ?
- `).all(...bindings) as unknown as SearchRow[]
- }
- private _targetObservation(
- sessionId: SessionId,
- persistenceBinding: PersistenceBinding,
- ): { header: SessionHeader; generation: string } {
- const db = this._requireDb()
- const live = db.prepare(
- `SELECT
- id AS session_id, version, created_at, cwd, parent_session, seed_length, delegation_depth, agent_preset, generation
- FROM temp.live_sessions
- WHERE id = ?`,
- ).get(sessionId) as (SessionHeaderRow & { generation: number }) | undefined
- if (live !== undefined) {
- return { header: rowHeader(live), generation: `live:${live.generation}` }
- }
- if (persistenceBinding.service !== undefined) {
- const persisted = db.prepare(
- `SELECT
- id AS session_id, version, created_at, cwd, parent_session, seed_length, delegation_depth, agent_preset, generation
- FROM persisted_sessions
- WHERE id = ?`,
- ).get(sessionId) as (SessionHeaderRow & { generation: number }) | undefined
- if (persisted !== undefined) {
- return {
- header: rowHeader(persisted),
- generation: `persisted:${this._persistenceEpoch}:${persisted.generation}`,
- }
- }
- }
- throw new SessionQueryError(
- `session "${sessionId}" not found`,
- 'SESSION_QUERY_SESSION_NOT_FOUND',
- )
- }
- private _sessionHit(row: SearchRow): SessionSearchHit {
- return {
- header: rowHeader(row),
- live: row.live === 1,
- persisted: row.persisted === 1,
- bestMatch: this._eventHit(row),
- }
- }
- private _eventHit(row: SearchRow): SessionEventSearchHit {
- return {
- sessionId: row.session_id as SessionId,
- seq: row.seq,
- type: row.type as SessionEventSearchHit['type'],
- time: row.time,
- surface: row.surface as SessionEventSearchHit['surface'],
- snippet: makeSnippet(row.marked_text, this.config.snippetChars),
- }
- }
- private _requireDb(): DatabaseSync {
- /* v8 ignore next -- callers await `_ready`; this guards lifecycle misuse */
- if (this._db === undefined) throw indexClosed()
- return this._db
- }
- private _isClosed(): boolean {
- return this._closed
- }
- }
- /**
- * The header columns both session upserts bind, in the order their INSERT
- * lists them. The two statements differ only in what they append after these.
- * @param header - the session header being written.
- * @returns one bound value per header column.
- */
- function headerBindings(header: SessionHeader): (string | number | null)[] {
- return [
- header.id,
- header.version,
- header.createdAt,
- header.cwd ?? null,
- header.parentSession ?? null,
- header.seedLength ?? null,
- header.delegationDepth ?? null,
- header.agentPreset ?? null,
- ]
- }
- function selectedDocumentsSql(): { sql: string } {
- return {
- sql: `WITH candidates AS (
- SELECT
- pd.session_id AS session_id,
- ps.version AS version,
- ps.created_at AS created_at,
- ps.cwd AS cwd,
- ps.parent_session AS parent_session,
- ps.seed_length AS seed_length,
- ps.delegation_depth AS delegation_depth,
- ps.agent_preset AS agent_preset,
- 0 AS live,
- 1 AS persisted,
- CAST(pd.seq AS INTEGER) AS seq,
- pd.type AS type,
- CAST(pd.time AS INTEGER) AS time,
- pd.surface AS surface,
- highlight(persisted_docs, 0, ?, ?) AS marked_text,
- CAST(pd.codepoint_length AS INTEGER) AS document_length
- FROM persisted_docs AS pd
- JOIN persisted_sessions AS ps ON ps.id = pd.session_id
- WHERE persisted_docs MATCH ?
- AND ? = 1
- AND NOT EXISTS (SELECT 1 FROM temp.live_sessions AS ls WHERE ls.id = pd.session_id)
- UNION ALL
- SELECT
- ld.session_id AS session_id,
- ls.version AS version,
- ls.created_at AS created_at,
- ls.cwd AS cwd,
- ls.parent_session AS parent_session,
- ls.seed_length AS seed_length,
- ls.delegation_depth AS delegation_depth,
- ls.agent_preset AS agent_preset,
- 1 AS live,
- CASE WHEN ? = 1 THEN ls.persisted ELSE 0 END AS persisted,
- CAST(ld.seq AS INTEGER) AS seq,
- ld.type AS type,
- CAST(ld.time AS INTEGER) AS time,
- ld.surface AS surface,
- highlight(live_docs, 0, ?, ?) AS marked_text,
- CAST(ld.codepoint_length AS INTEGER) AS document_length
- FROM temp.live_docs AS ld
- JOIN temp.live_sessions AS ls ON ls.id = ld.session_id
- WHERE live_docs MATCH ?
- ), matched AS (
- SELECT *,
- (
- length(CAST(marked_text AS BLOB))
- - length(CAST(replace(marked_text, ?, '') AS BLOB))
- ) / ? AS match_count
- FROM candidates
- )`,
- }
- }
- function selectedDocumentsParams(query: string, persistenceVisible: boolean): Array<string | number> {
- const expression = quoteFtsData(query)
- const visible = persistenceVisible ? 1 : 0
- return [
- FTS_HIGHLIGHT_START,
- FTS_HIGHLIGHT_END,
- expression,
- visible,
- visible,
- FTS_HIGHLIGHT_START,
- FTS_HIGHLIGHT_END,
- expression,
- FTS_HIGHLIGHT_START,
- Buffer.byteLength(FTS_HIGHLIGHT_START, 'utf8'),
- ]
- }
- function observeLive(session: Session): ObservedSession {
- return observeSession(session.header, session.events)
- }
- function observeSession(header: SessionHeader, events: readonly SessionEvent[]): ObservedSession {
- const detachedHeader = structuredClone(header)
- const detachedEvents = events.map(event => structuredClone(event))
- return {
- header: detachedHeader,
- documents: buildSessionEventSearchDocuments(detachedHeader.id, detachedEvents),
- fingerprint: createHash('sha256')
- .update(JSON.stringify({ header: detachedHeader, events: detachedEvents }))
- .digest('base64url'),
- }
- }
- function materializePersistenceSnapshots(
- snapshots: readonly SessionPersistenceSnapshot[],
- ): Map<SessionId, ObservedPersistedSession> {
- if (!isRuntimeArray(snapshots)) throw new Error('persistence snapshots must be an array')
- const result = new Map<SessionId, ObservedPersistedSession>()
- for (const snapshot of snapshots) {
- if (typeof snapshot.revision !== 'string') {
- throw new Error('persistence snapshot revision must be a string')
- }
- const header = structuredClone(snapshot.header)
- if (result.has(header.id)) {
- throw new Error(`persistence listed duplicate session "${header.id}"`)
- }
- result.set(header.id, { header, revision: snapshot.revision })
- }
- return result
- }
- function samePersistenceSnapshots(
- before: ReadonlyMap<SessionId, ObservedPersistedSession>,
- after: ReadonlyMap<SessionId, ObservedPersistedSession>,
- ): boolean {
- if (before.size !== after.size) return false
- for (const [id, first] of before) {
- const second = after.get(id)
- if (
- second === undefined
- || first.revision !== second.revision
- || !sameHeader(first.header, second.header)
- ) return false
- }
- return true
- }
- function sameSessionIds(
- before: ReadonlySet<SessionId>,
- after: ReadonlyMap<SessionId, ObservedSession>,
- ): boolean {
- if (before.size !== after.size) return false
- for (const id of before) {
- if (!after.has(id)) return false
- }
- return true
- }
- function sameHeader(a: SessionHeader, b: SessionHeader): boolean {
- return a.version === b.version
- && a.id === b.id
- && a.createdAt === b.createdAt
- && a.cwd === b.cwd
- && a.parentSession === b.parentSession
- && a.seedLength === b.seedLength
- && (a.delegationDepth ?? 0) === (b.delegationDepth ?? 0)
- && a.agentPreset === b.agentPreset
- }
- function rowHeader(row: SessionHeaderRow): SessionHeader {
- return {
- version: row.version,
- id: row.session_id as SessionId,
- createdAt: row.created_at,
- ...row.cwd === null ? {} : { cwd: row.cwd },
- ...row.parent_session === null ? {} : { parentSession: row.parent_session as SessionId },
- ...row.seed_length === null ? {} : { seedLength: row.seed_length },
- ...row.delegation_depth === null ? {} : { delegationDepth: row.delegation_depth },
- ...row.agent_preset === null ? {} : { agentPreset: row.agent_preset },
- }
- }
- function page<Row, Item>(
- rows: readonly Row[],
- limit: number,
- convert: (row: Row) => Item,
- nextCursor: (offset: number) => SessionSearchCursorValue,
- offset: number,
- ): SessionSearchPage<Item> {
- const hasMore = rows.length > limit
- return {
- items: rows.slice(0, limit).map(convert),
- ...hasMore ? { nextCursor: nextCursor(offset + limit) } : {},
- }
- }
- function encodeCursor(payload: CursorPayload): SessionSearchCursorValue {
- return SessionSearchCursor(Buffer.from(JSON.stringify(payload), 'utf8').toString('base64url'))
- }
- function decodeCursor(
- cursor: SessionSearchCursorValue,
- instance: string,
- scope: CursorPayload['scope'],
- fingerprint: string,
- generation: string,
- ): number {
- let decoded: Partial<CursorPayload>
- try {
- decoded = JSON.parse(Buffer.from(cursor, 'base64url').toString('utf8')) as Partial<CursorPayload>
- } catch (error: unknown) {
- throw invalidCursor(error)
- }
- if (
- decoded.version !== 1
- || decoded.instance !== instance
- || decoded.scope !== scope
- || decoded.fingerprint !== fingerprint
- || !Number.isSafeInteger(decoded.offset)
- || decoded.offset === undefined
- || decoded.offset < 0
- ) {
- throw invalidCursor(new Error('cursor does not belong to this normalized request'))
- }
- if (decoded.generation !== generation) {
- throw new SessionQueryError(
- 'session-search cursor is stale because its relevant corpus changed',
- 'SESSION_QUERY_STALE_CURSOR',
- )
- }
- return decoded.offset
- }
- function invalidCursor(cause: unknown): SessionQueryError {
- return new SessionQueryError(
- 'session-search cursor is invalid',
- 'SESSION_QUERY_INVALID_CURSOR',
- { cause },
- )
- }
- function resolveConfig(config: Config): ResolvedConfig {
- const resolved: ResolvedConfig = {
- path: config.path,
- openAt: config.openAt ?? 'startup',
- journalMode: config.journalMode ?? 'wal',
- defaultLimit: config.defaultLimit ?? SESSION_QUERY_SQLITE_DEFAULT_LIMIT,
- maxLimit: config.maxLimit ?? SESSION_QUERY_SQLITE_MAX_LIMIT,
- snippetChars: config.snippetChars ?? SESSION_QUERY_SQLITE_SNIPPET_CHARS,
- readWindowMax: config.readWindowMax ?? SESSION_QUERY_READ_WINDOW_MAX,
- persistedInspectConcurrency: config.persistedInspectConcurrency
- ?? SESSION_QUERY_DEFAULT_PERSISTED_INSPECT_CONCURRENCY,
- }
- if (typeof resolved.path !== 'string' || resolved.path.trim().length === 0) {
- throw invalidConfig('path must not be blank')
- }
- const openPhases: readonly string[] = ['startup', 'first-search', 'never']
- if (!openPhases.includes(resolved.openAt)) throw invalidConfig('openAt is not supported')
- assertPageLimit('defaultLimit', resolved.defaultLimit)
- assertPageLimit('maxLimit', resolved.maxLimit)
- assertPositiveInteger('snippetChars', resolved.snippetChars)
- if (!Number.isInteger(resolved.readWindowMax) || resolved.readWindowMax < 0) {
- throw invalidConfig('readWindowMax must be a non-negative integer')
- }
- if (
- !Number.isSafeInteger(resolved.persistedInspectConcurrency)
- || resolved.persistedInspectConcurrency < 1
- ) {
- throw invalidConfig('persistedInspectConcurrency must be a positive safe integer')
- }
- if (resolved.defaultLimit > resolved.maxLimit) {
- throw invalidConfig('defaultLimit must be less than or equal to maxLimit')
- }
- const journalModes: readonly string[] = ['wal', 'delete', 'truncate', 'persist']
- if (!journalModes.includes(resolved.journalMode)) throw invalidConfig('journalMode is not supported')
- return resolved
- }
- function assertPositiveInteger(name: string, value: number): void {
- if (!Number.isInteger(value) || value < 1) throw invalidConfig(`${name} must be a positive integer`)
- }
- function assertPageLimit(name: string, value: number): void {
- if (!Number.isSafeInteger(value) || value < 1 || value > SQLITE_MAX_PAGE_LIMIT) {
- throw invalidConfig(`${name} must be an integer between 1 and ${SQLITE_MAX_PAGE_LIMIT}`)
- }
- }
- function invalidConfig(detail: string): SessionQueryError {
- return new SessionQueryError(
- `session-search SQLite config: ${detail}`,
- 'SESSION_QUERY_INVALID_CONFIG',
- )
- }
- function indexClosed(): SessionQueryError {
- return new SessionQueryError('session-search SQLite index is closed', 'SESSION_QUERY_INDEX_FAILED')
- }
- function assertNotAborted(signal: AbortSignal | undefined): void {
- if (signal?.aborted) {
- throw new SessionQueryError('session-search aborted', 'SESSION_QUERY_ABORTED')
- }
- }
- function waitWithAbort<T>(promise: Promise<T>, signal: AbortSignal | undefined): Promise<T> {
- if (signal === undefined) return promise
- if (signal.aborted) return Promise.reject(new SessionQueryError('session-search aborted', 'SESSION_QUERY_ABORTED'))
- return new Promise<T>((resolve, reject) => {
- const onAbort = () => {
- reject(new SessionQueryError('session-search aborted', 'SESSION_QUERY_ABORTED'))
- }
- signal.addEventListener('abort', onAbort, { once: true })
- promise.then(
- (value) => {
- signal.removeEventListener('abort', onAbort)
- resolve(value)
- },
- (error: unknown) => {
- signal.removeEventListener('abort', onAbort)
- reject(asError(error))
- },
- )
- })
- }
- function isAbort(error: unknown): boolean {
- return error instanceof SessionQueryError && error.code === 'SESSION_QUERY_ABORTED'
- }
- function asError(error: unknown): Error {
- return error instanceof Error
- ? error
- : new Error('session-search dependency rejected with a non-Error value', { cause: error })
- }
- function errorMessage(error: unknown): string {
- return error instanceof Error ? error.message : 'unknown error'
- }
- function isRuntimeArray(value: unknown): boolean {
- return Array.isArray(value)
- }
- export default SqliteSessionQueryEngine
|