File size: 41,094 Bytes
d04f74a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 | /**
* 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 { SESSION_FORMAT_VERSION, SessionSeq } from '@deepseek-ai/dsh-session'
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, SessionLogOffset } 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_DEFAULT_PREPARED_SESSION_CACHE_SIZE,
SESSION_QUERY_READ_WINDOW_MAX,
SessionQueryError,
SessionSearchCursor,
assertSessionHeadersCompatible,
buildSessionEventSearchDocuments,
readColdSessionLog,
} 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 reads in one inherited batch read. Defaults to 4. */
persistedReadConcurrency?: number
/** Maximum cold prepared-Session observations the inherited reader retains for reuse. Defaults to 5. */
preparedSessionCacheSize?: number
}
interface ResolvedConfig {
path: string
openAt: OpenAt
journalMode: JournalMode
defaultLimit: number
maxLimit: number
snippetChars: number
readWindowMax: number
persistedReadConcurrency: number
preparedSessionCacheSize: number
}
interface ObservedSession {
header: SessionHeader
inheritedEventCount: SessionLogOffset
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),
persistedReadConcurrency: z.number()
.step(1)
.min(1)
.max(Number.MAX_SAFE_INTEGER)
.default(SESSION_QUERY_DEFAULT_PERSISTED_INSPECT_CONCURRENCY),
preparedSessionCacheSize: z.number()
.step(1)
.min(1)
.max(Number.MAX_SAFE_INTEGER)
.default(SESSION_QUERY_DEFAULT_PREPARED_SESSION_CACHE_SIZE),
})
/** 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 listOptions = signal === undefined ? undefined : { signal }
const before = await persistence.list(listOptions)
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. The cold read is
// non-mutating (interrupted turns are balanced in memory only), so
// an owner attaching after this check cannot cause 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 readColdSessionLog(persistence, entry.header.id, signal)
assertNotAborted(signal)
assertSessionHeadersCompatible(entry.header, loaded.header)
entry.loaded = observeSession(loaded.header, loaded.inheritedEventCount, loaded.events)
}
assertNotAborted(signal)
const afterSnapshots = await persistence.list(listOptions)
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, entry.inheritedEventCount),
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.inheritedEventCount),
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)
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: SessionSeq(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,
inheritedEventCount: SessionLogOffset,
): (string | number | null)[] {
return [
header.id,
header.version,
header.createdAt,
header.cwd ?? null,
header.parentSession ?? null,
header.isSeeded ? inheritedEventCount : 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 {
// oxlint-disable-next-line typescript/no-deprecated -- Existing Session history read; migration deferred.
return observeSession(session.header, session.inheritedEventCount, session.snapshotEvents())
}
function observeSession(
header: SessionHeader,
inheritedEventCount: SessionLogOffset,
events: readonly SessionEvent[],
): ObservedSession {
const detachedHeader = structuredClone(header)
const detachedEvents = events.map(event => structuredClone(event))
return {
header: detachedHeader,
inheritedEventCount,
documents: buildSessionEventSearchDocuments(detachedHeader.id, detachedEvents),
fingerprint: createHash('sha256')
.update(JSON.stringify({ header: detachedHeader, inheritedEventCount, 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.id === b.id
&& a.createdAt === b.createdAt
&& a.cwd === b.cwd
&& a.parentSession === b.parentSession
&& a.isSeeded === b.isSeeded
&& (a.delegationDepth ?? 0) === (b.delegationDepth ?? 0)
&& a.agentPreset === b.agentPreset
}
function rowHeader(row: SessionHeaderRow): SessionHeader {
return {
version: SESSION_FORMAT_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 },
isSeeded: row.seed_length !== null,
...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,
persistedReadConcurrency: config.persistedReadConcurrency
?? SESSION_QUERY_DEFAULT_PERSISTED_INSPECT_CONCURRENCY,
preparedSessionCacheSize: config.preparedSessionCacheSize
?? SESSION_QUERY_DEFAULT_PREPARED_SESSION_CACHE_SIZE,
}
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.persistedReadConcurrency)
|| resolved.persistedReadConcurrency < 1
) {
throw invalidConfig('persistedReadConcurrency must be a positive safe integer')
}
if (
!Number.isSafeInteger(resolved.preparedSessionCacheSize)
|| resolved.preparedSessionCacheSize < 1
) {
throw invalidConfig('preparedSessionCacheSize 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
|