sqlite.spec.ts 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856
  1. import { afterEach, describe, expect, it, vi } from 'vitest'
  2. import { spawn } from 'node:child_process'
  3. import { Context } from '@deepseek-ai/cordis'
  4. import { once } from 'node:events'
  5. import { chmod, mkdir, mkdtemp, rm, stat, symlink, writeFile } from 'node:fs/promises'
  6. import { tmpdir } from 'node:os'
  7. import { join } from 'node:path'
  8. import { performance } from 'node:perf_hooks'
  9. import { pathToFileURL } from 'node:url'
  10. import { DatabaseSync } from 'node:sqlite'
  11. import Loader from '@deepseek-ai/cordis-plugin-loader'
  12. import Include from '@deepseek-ai/cordis-plugin-include'
  13. import SessionStore, { SessionId, type SessionEvent } from '@deepseek-ai/dsh-session'
  14. import SessionPersistenceSqlite, {
  15. DEFAULT_BUSY_TIMEOUT_MS,
  16. SCHEMA_VERSION,
  17. } from '@deepseek-ai/dsh-session-persistence-sqlite'
  18. import {
  19. runCoordinatorContract,
  20. type CoordinatorFixture,
  21. } from '../../session-persistence/tests/coordinator-contract.ts'
  22. import {
  23. meta,
  24. runPersistenceContract,
  25. } from '../../session-persistence/tests/contract.ts'
  26. import { MAX_PACKED_DATA_BYTES } from '../src/codec.ts'
  27. import {
  28. decodeEventRow,
  29. decodeSessionRow,
  30. decodeStoreIdentity,
  31. openDatabase,
  32. validateSchemaForMutation,
  33. rowToMeta,
  34. SESSION_PERSISTENCE_SQLITE_APPLICATION_ID,
  35. type SessionRow,
  36. } from '../src/schema.ts'
  37. import { SqliteStore } from '../src/store.ts'
  38. import { sql } from '../src/sql.ts'
  39. import { testSql } from './test-sql.ts'
  40. const dirs: string[] = []
  41. afterEach(async () => {
  42. for (const directory of dirs.splice(0)) await rm(directory, { recursive: true, force: true })
  43. })
  44. async function freshDbPath(prefix = 'dsh-sqlite-'): Promise<string> {
  45. const directory = await mkdtemp(join(tmpdir(), prefix))
  46. dirs.push(directory)
  47. return join(directory, 'sessions.db')
  48. }
  49. async function backendFailure(path: string): Promise<unknown> {
  50. const ctx = new Context()
  51. await ctx.plugin(SessionStore)
  52. try {
  53. await ctx.plugin(SessionPersistenceSqlite, { path })
  54. await ctx.sessionPersistence.list()
  55. return undefined
  56. } catch (error: unknown) {
  57. return error
  58. } finally {
  59. await ctx.fiber.dispose()
  60. }
  61. }
  62. function errorMessage(error: unknown): string {
  63. return error instanceof Error ? error.message : String(error)
  64. }
  65. function databaseWithJournalFailure(
  66. nextFailure: () => Error | undefined,
  67. ): typeof DatabaseSync {
  68. return class JournalFailureDatabase extends DatabaseSync {
  69. override prepare(source: string) {
  70. if (source !== sql('journal-mode-wal')) return super.prepare(source)
  71. const statement = super.prepare(sql('journal-mode-wal'))
  72. const get = statement.get.bind(statement)
  73. Object.defineProperty(statement, 'get', {
  74. value: () => {
  75. const failure = nextFailure()
  76. if (failure !== undefined) throw failure
  77. return get()
  78. },
  79. })
  80. return statement
  81. }
  82. }
  83. }
  84. function chunk(seq: number, text = `token-${seq}`): SessionEvent {
  85. return {
  86. type: 'assistant/chunk',
  87. seq,
  88. time: 1_000 + seq,
  89. data: {
  90. turn: 1,
  91. step: 1,
  92. chunk: { type: 'text-delta', index: 0, text },
  93. },
  94. }
  95. }
  96. function chunkLog(count: number): SessionEvent[] {
  97. return [
  98. { type: 'turn/start', seq: 0, time: 1, data: { turn: 1 } },
  99. { type: 'step/start', seq: 1, time: 2, data: { turn: 1, step: 1 } },
  100. ...Array.from({ length: count }, (_, index) => chunk(index + 2)),
  101. { type: 'step/end', seq: count + 2, time: count + 3, data: { turn: 1, step: 1 } },
  102. {
  103. type: 'turn/end',
  104. seq: count + 3,
  105. time: count + 4,
  106. data: { turn: 1, reason: { kind: 'completed' } },
  107. },
  108. ]
  109. }
  110. async function measureWriteTraffic(
  111. path: string,
  112. events: readonly SessionEvent[],
  113. ): Promise<{
  114. readonly walBytes: number
  115. readonly idleWalBytes: number
  116. readonly rows: number
  117. readonly largest: number
  118. readonly inserted: number
  119. readonly changed: number
  120. readonly removed: number
  121. }> {
  122. interface PhysicalRow {
  123. readonly rowid: number
  124. readonly seq: number
  125. readonly type: string
  126. readonly time: number
  127. readonly data: string | Uint8Array
  128. readonly source_event_seqs: Uint8Array | null
  129. readonly surface_op: string | null
  130. readonly ignorable: number | null
  131. }
  132. const sameValue = (left: string | Uint8Array | null, right: string | Uint8Array | null): boolean => (
  133. typeof left === 'string' || left === null
  134. ? left === right
  135. : right instanceof Uint8Array && Buffer.from(left).equals(Buffer.from(right))
  136. )
  137. const sameRow = (left: PhysicalRow, right: PhysicalRow): boolean => (
  138. left.rowid === right.rowid
  139. && left.seq === right.seq
  140. && left.type === right.type
  141. && left.time === right.time
  142. && sameValue(left.data, right.data)
  143. && sameValue(left.source_event_seqs, right.source_event_seqs)
  144. && left.surface_op === right.surface_op
  145. && left.ignorable === right.ignorable
  146. )
  147. const ctx = new Context()
  148. await ctx.plugin(SessionStore)
  149. await ctx.plugin(SessionPersistenceSqlite, { path, writeBatchMaxDelayMs: 200 })
  150. try {
  151. const header = meta('traffic')
  152. await ctx.sessionPersistence.create(header)
  153. let previous = new Map<number, PhysicalRow>()
  154. let inserted = 0
  155. let changed = 0
  156. let removed = 0
  157. const probe = new DatabaseSync(path, { readOnly: true })
  158. try {
  159. const selectRows = probe.prepare(testSql('select-event-rows'))
  160. for (let offset = 0; offset < events.length; offset += 40) {
  161. await ctx.sessionPersistence.append(header.id, events.slice(offset, offset + 40))
  162. const current = new Map((selectRows.all(header.id) as unknown as PhysicalRow[])
  163. .map(row => [row.seq, row]))
  164. for (const [seq, row] of current) {
  165. const old = previous.get(seq)
  166. if (old === undefined) inserted += 1
  167. else if (!sameRow(old, row)) changed += 1
  168. }
  169. for (const seq of previous.keys()) if (!current.has(seq)) removed += 1
  170. previous = current
  171. }
  172. } finally {
  173. probe.close()
  174. }
  175. const db = new DatabaseSync(path, { readOnly: true })
  176. const measured = db.prepare(testSql('measure-write-traffic')).get() as { rows: number; largest: number }
  177. db.close()
  178. const walBytes = (await stat(`${path}-wal`)).size
  179. await new Promise(resolve => setTimeout(resolve, 250))
  180. return {
  181. walBytes,
  182. idleWalBytes: (await stat(`${path}-wal`)).size,
  183. rows: measured.rows,
  184. largest: measured.largest,
  185. inserted,
  186. changed,
  187. removed,
  188. }
  189. } finally {
  190. await ctx.fiber.dispose()
  191. }
  192. }
  193. runPersistenceContract('sqlite', async () => {
  194. const ctx = new Context()
  195. await ctx.plugin(SessionStore)
  196. const fiber = await ctx.plugin(SessionPersistenceSqlite, { path: ':memory:' })
  197. return {
  198. persistence: ctx.sessionPersistence,
  199. dispose: async () => { await fiber.dispose() },
  200. }
  201. })
  202. runCoordinatorContract('sqlite', async (): Promise<CoordinatorFixture> => {
  203. const directory = await mkdtemp(join(tmpdir(), 'dsh-sqlite-coord-'))
  204. const path = join(directory, 'sessions.db')
  205. return {
  206. mount: async ctx => ctx.plugin(SessionPersistenceSqlite, { path }),
  207. corruptTail: async (id) => {
  208. const db = new DatabaseSync(path)
  209. const last = db.prepare(testSql('select-last-event'))
  210. .get(id) as { seq: number; type: string; data: string }
  211. const logicalLength = last.type === 'text-chunks'
  212. ? (JSON.parse(last.data) as { texts: string[] }).texts.length
  213. : 1
  214. const next = last.seq + logicalLength
  215. db.prepare(testSql('insert-corrupt-event'))
  216. .run(id, next, 'assistant/chunk', 99, '{not valid json', null)
  217. db.close()
  218. },
  219. cleanup: async () => { await rm(directory, { recursive: true, force: true }) },
  220. }
  221. })
  222. describe('SessionPersistenceSqlite physical packing', () => {
  223. it('loads from cordis.yml and packs through the assembled service', async () => {
  224. const path = await freshDbPath('dsh-sqlite-loader-')
  225. const configPath = join(path, '..', 'cordis.yml')
  226. await writeFile(configPath, [
  227. "- name: '@deepseek-ai/dsh-session'",
  228. "- name: '@deepseek-ai/dsh-session-persistence-sqlite'",
  229. ' config:',
  230. ` path: ${JSON.stringify(path)}`,
  231. '',
  232. ].join('\n'))
  233. const ctx = new Context()
  234. ctx.baseUrl = pathToFileURL(join(path, '..')).href + '/'
  235. await ctx.plugin(Loader)
  236. ctx.loader.builtins.include = Include
  237. ctx.loader.internal = {
  238. version: 'sqlite',
  239. async import(specifier: string) {
  240. if (specifier === '@deepseek-ai/dsh-session') return SessionStore
  241. if (specifier === '@deepseek-ai/dsh-session-persistence-sqlite') {
  242. return SessionPersistenceSqlite
  243. }
  244. throw new Error(`unexpected Loader import: ${specifier}`)
  245. },
  246. } as unknown as NonNullable<typeof ctx.loader.internal>
  247. await ctx.loader.create({
  248. name: 'cordis:include',
  249. config: { path: pathToFileURL(configPath).href },
  250. })
  251. await ctx.loader.await()
  252. const header = meta('loader')
  253. const events = chunkLog(4)
  254. await ctx.sessionPersistence.create(header)
  255. await ctx.sessionPersistence.append(header.id, events)
  256. expect((await ctx.sessionPersistence.inspect(header.id)).events).toEqual(events)
  257. await ctx.fiber.dispose()
  258. const db = new DatabaseSync(path)
  259. expect(db.prepare(testSql('count-packed-events')).get())
  260. .toEqual({ count: 1 })
  261. db.close()
  262. })
  263. it('packs each append once without rewriting earlier rows and seeks inside packed rows', async () => {
  264. const path = await freshDbPath()
  265. const ctx = new Context()
  266. await ctx.plugin(SessionStore)
  267. const fiber = await ctx.plugin(SessionPersistenceSqlite, { path })
  268. const header = meta('packed')
  269. const events = chunkLog(100)
  270. await ctx.sessionPersistence.create(header)
  271. await ctx.sessionPersistence.append(header.id, events.slice(0, 3))
  272. await ctx.sessionPersistence.append(header.id, events.slice(3, 4))
  273. const before = new DatabaseSync(path, { readOnly: true })
  274. const originalRows = before.prepare(testSql('select-event-rowids')).all()
  275. before.close()
  276. await ctx.sessionPersistence.append(header.id, events.slice(4))
  277. const inspected = await ctx.sessionPersistence.inspect(header.id)
  278. expect(inspected.events).toEqual(events)
  279. for (const fromSeq of [0, 2, 25, 101, 104, 105]) {
  280. expect((await ctx.sessionPersistence.readFrom(header.id, fromSeq)).events)
  281. .toEqual(events.filter(event => event.seq >= fromSeq))
  282. }
  283. await fiber.dispose()
  284. const db = new DatabaseSync(path)
  285. expect(db.prepare(testSql('select-user-version')).get()).toEqual({ user_version: SCHEMA_VERSION })
  286. expect(db.prepare(testSql('count-events')).get()).toEqual({ count: 7 })
  287. expect(db.prepare(testSql('count-packed-events')).get())
  288. .toEqual({ count: 1 })
  289. expect(db.prepare(testSql('select-event-rowids')).all().slice(0, originalRows.length))
  290. .toEqual(originalRows)
  291. db.close()
  292. })
  293. it.runIf(process.platform !== 'win32')('bounds paced-stream WAL extent without rewriting committed rows', async () => {
  294. const events = chunkLog(1_000)
  295. const measured = await measureWriteTraffic(await freshDbPath('dsh-sqlite-traffic-'), events)
  296. expect(measured).toMatchObject({ rows: 31, inserted: 31, changed: 0, removed: 0 })
  297. expect(measured.inserted).toBe(measured.rows)
  298. expect(measured.largest).toBeLessThanOrEqual(MAX_PACKED_DATA_BYTES)
  299. expect(measured.idleWalBytes).toBe(measured.walBytes)
  300. })
  301. it('includes a packed predecessor when an overlapping scalar tail hides it', async () => {
  302. const path = await freshDbPath('dsh-sqlite-overlap-')
  303. const store = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS })
  304. const header = meta('overlap')
  305. await store.appendBatch(header, [chunk(0), chunk(1), chunk(2)], false)
  306. const db = new DatabaseSync(path)
  307. db.prepare(testSql('insert-corrupt-event'))
  308. .run(header.id, 1, 'assistant/chunk', 2, JSON.stringify(chunk(1).data), null)
  309. db.close()
  310. expect((await store.loadStoredFrom(header.id, 2))?.events).toEqual([chunk(2)])
  311. const malformed = new DatabaseSync(path)
  312. malformed.prepare(testSql('delete-session-events')).run(header.id)
  313. malformed.prepare(testSql('insert-corrupt-event'))
  314. .run(header.id, 0, 'text-chunks', 1, '{not json', 0)
  315. malformed.close()
  316. expect((await store.loadStoredFrom(header.id, 2))?.events).toEqual([])
  317. await store.close()
  318. })
  319. it('waits for a competing process within the configured busy timeout', async () => {
  320. const path = await freshDbPath('dsh-sqlite-busy-')
  321. const store = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: 1_000 })
  322. const header = meta('busy')
  323. await store.appendBatch(header, [chunk(0)], false)
  324. const holder = spawn(process.execPath, ['--input-type=module', '-e', String.raw`
  325. import { DatabaseSync } from 'node:sqlite';
  326. const db = new DatabaseSync(process.argv[1]);
  327. db.exec('BEGIN IMMEDIATE');
  328. process.stdout.write('locked\n');
  329. setTimeout(() => { db.exec('COMMIT'); db.close(); }, 100);
  330. `, path], { stdio: ['ignore', 'pipe', 'pipe'] })
  331. const exited = new Promise<number | null>((resolve, reject) => {
  332. holder.once('error', reject)
  333. holder.once('exit', resolve)
  334. })
  335. try {
  336. await once(holder.stdout, 'data')
  337. await expect(store.appendBatch(header, [chunk(1)], true)).resolves.toBeUndefined()
  338. const code = await exited
  339. expect(code).toBe(0)
  340. expect((await store.loadStored(header.id))?.events).toEqual([chunk(0), chunk(1)])
  341. } finally {
  342. if (holder.exitCode === null) holder.kill()
  343. await store.close()
  344. }
  345. })
  346. it('rejects an older SQLite physical schema', async () => {
  347. const path = await freshDbPath('dsh-sqlite-old-schema-')
  348. const seed = await openDatabase(DatabaseSync, path, 'wal', DEFAULT_BUSY_TIMEOUT_MS)
  349. seed.exec(testSql('set-user-version-16'))
  350. seed.close()
  351. await chmod(path, 0o600)
  352. await expect(openDatabase(DatabaseSync, path, 'wal', DEFAULT_BUSY_TIMEOUT_MS))
  353. .rejects.toThrow(/schema version 16.*incompatible/)
  354. })
  355. it('rejects a stale physical append without replacing the winning tail', async () => {
  356. const path = await freshDbPath('dsh-sqlite-stale-')
  357. const first = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS })
  358. const second = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS })
  359. const header = meta(SessionId('stale'))
  360. await first.appendBatch(header, [chunk(0)], false)
  361. await second.appendBatch(header, [chunk(1)], true)
  362. await expect(first.appendBatch(header, [chunk(1)], true)).rejects.toThrow(/stored next seq is 2/)
  363. expect((await first.loadStored(header.id))?.events).toEqual([chunk(0), chunk(1)])
  364. await first.close()
  365. await second.close()
  366. })
  367. it('rejects a stale repair without deleting a newer winning tail', async () => {
  368. const path = await freshDbPath('dsh-sqlite-stale-repair-')
  369. const stale = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS })
  370. const winner = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS })
  371. const header = meta(SessionId('stale-repair'))
  372. await stale.appendBatch(header, [chunk(0)], false)
  373. const db = new DatabaseSync(path)
  374. db.prepare(testSql('insert-corrupt-event')).run(header.id, 1, 'assistant/chunk', 2, '{not json', null)
  375. db.close()
  376. expect((await stale.loadStored(header.id))?.tornMarker).toBe(1)
  377. await winner.commitRepair(header, 1, [])
  378. await winner.appendBatch(header, [chunk(1), chunk(2)], true)
  379. await expect(stale.commitRepair(header, 1, [])).rejects.toThrow(/repair is stale/)
  380. expect((await stale.loadStored(header.id))?.events).toEqual([chunk(0), chunk(1), chunk(2)])
  381. await stale.close()
  382. await winner.close()
  383. })
  384. })
  385. describe('SessionPersistenceSqlite schema ownership', () => {
  386. it('accepts every configured journal mode and SQLite memory mode result', async () => {
  387. const resources = {
  388. wal: 'journal-mode-wal',
  389. delete: 'journal-mode-delete',
  390. truncate: 'journal-mode-truncate',
  391. persist: 'journal-mode-persist',
  392. } as const
  393. for (const mode of ['wal', 'delete', 'truncate', 'persist'] as const) {
  394. ;(await openDatabase(DatabaseSync, ':memory:', mode, DEFAULT_BUSY_TIMEOUT_MS)).close()
  395. const path = await freshDbPath(`dsh-sqlite-journal-${mode}-`)
  396. const db = await openDatabase(DatabaseSync, path, mode, DEFAULT_BUSY_TIMEOUT_MS)
  397. expect(db.prepare(sql(resources[mode])).get()).toEqual({ journal_mode: mode })
  398. expect(db.prepare(sql('select-trusted-schema')).get()).toEqual({ trusted_schema: 0 })
  399. expect(db.prepare(sql('select-mmap-size')).get()).toEqual({ mmap_size: 0 })
  400. expect(db.prepare(sql('select-synchronous')).get()).toEqual({ synchronous: 2 })
  401. db.close()
  402. }
  403. })
  404. it('retries a busy journal-mode transition within its retry budget', async () => {
  405. const path = await freshDbPath('dsh-sqlite-journal-busy-')
  406. let attempts = 0
  407. const BusyOnceDatabase = databaseWithJournalFailure(() => {
  408. attempts += 1
  409. return attempts === 1
  410. ? Object.assign(new Error('database is locked'), {
  411. code: 'ERR_SQLITE_ERROR',
  412. errcode: 5,
  413. errstr: 'database is locked',
  414. })
  415. : undefined
  416. })
  417. const db = await openDatabase(BusyOnceDatabase, path, 'wal', 100)
  418. expect(attempts).toBe(2)
  419. expect(db.prepare(sql('journal-mode-wal')).get()).toEqual({ journal_mode: 'wal' })
  420. expect(db.prepare(sql('select-trusted-schema')).get()).toEqual({ trusted_schema: 0 })
  421. expect(db.prepare(sql('select-mmap-size')).get()).toEqual({ mmap_size: 0 })
  422. expect(db.prepare(sql('select-synchronous')).get()).toEqual({ synchronous: 2 })
  423. db.close()
  424. })
  425. it('does not retry journal failures outside the available busy budget', async () => {
  426. for (const { errcode, timeout } of [
  427. { errcode: 5, timeout: 0 },
  428. { errcode: 6, timeout: 100 },
  429. ]) {
  430. let attempts = 0
  431. const FailingDatabase = databaseWithJournalFailure(() => {
  432. attempts += 1
  433. return Object.assign(new Error(`SQLite error ${errcode}`), { errcode })
  434. })
  435. await expect(openDatabase(
  436. FailingDatabase,
  437. await freshDbPath(`dsh-sqlite-journal-failure-${errcode}-`),
  438. 'wal',
  439. timeout,
  440. )).rejects.toThrow(`SQLite error ${errcode}`)
  441. expect(attempts).toBe(1)
  442. }
  443. })
  444. it('starts no journal retry after its open-relative cutoff', async () => {
  445. let attempts = 0
  446. const BusyDatabase = databaseWithJournalFailure(() => {
  447. attempts += 1
  448. return Object.assign(new Error('database is locked'), { errcode: 5 })
  449. })
  450. const clock = vi.spyOn(performance, 'now')
  451. .mockReturnValueOnce(0)
  452. .mockReturnValueOnce(50)
  453. .mockReturnValueOnce(100)
  454. try {
  455. await expect(openDatabase(
  456. BusyDatabase,
  457. await freshDbPath('dsh-sqlite-journal-cutoff-'),
  458. 'wal',
  459. 100,
  460. )).rejects.toThrow('database is locked')
  461. } finally {
  462. clock.mockRestore()
  463. }
  464. expect(attempts).toBe(1)
  465. })
  466. it('paces repeated busy journal-mode attempts', async () => {
  467. const attemptedAt: number[] = []
  468. const BusyTwiceDatabase = databaseWithJournalFailure(() => {
  469. attemptedAt.push(performance.now())
  470. return attemptedAt.length <= 2
  471. ? Object.assign(new Error('database is locked'), { errcode: 5 })
  472. : undefined
  473. })
  474. const db = await openDatabase(
  475. BusyTwiceDatabase,
  476. await freshDbPath('dsh-sqlite-journal-paced-'),
  477. 'wal',
  478. DEFAULT_BUSY_TIMEOUT_MS,
  479. )
  480. db.close()
  481. expect(attemptedAt).toHaveLength(3)
  482. for (let index = 1; index < attemptedAt.length; index += 1) {
  483. const previous = attemptedAt[index - 1]
  484. const current = attemptedAt[index]
  485. if (previous === undefined || current === undefined) throw new Error('missing journal attempt timestamp')
  486. expect(current - previous).toBeGreaterThanOrEqual(5)
  487. }
  488. })
  489. it('rejects unversioned, incompatible, and foreign-application databases', async () => {
  490. const unversionedPath = await freshDbPath('dsh-sqlite-unversioned-')
  491. const unversioned = new DatabaseSync(unversionedPath)
  492. unversioned.exec(testSql('create-unrelated-table'))
  493. unversioned.close()
  494. await expect(openDatabase(DatabaseSync, unversionedPath, 'wal', DEFAULT_BUSY_TIMEOUT_MS)).rejects.toThrow(/unversioned schema/)
  495. const incompatiblePath = await freshDbPath('dsh-sqlite-incompatible-')
  496. const incompatible = new DatabaseSync(incompatiblePath)
  497. incompatible.exec(testSql('set-user-version-16'))
  498. incompatible.close()
  499. await expect(openDatabase(DatabaseSync, incompatiblePath, 'wal', DEFAULT_BUSY_TIMEOUT_MS)).rejects.toThrow(/incompatible with this build/)
  500. const foreignPath = await freshDbPath('dsh-sqlite-foreign-')
  501. const foreign = new DatabaseSync(foreignPath)
  502. foreign.exec(testSql('set-user-version-17'))
  503. foreign.exec(testSql('set-application-id-12345'))
  504. foreign.close()
  505. await expect(openDatabase(DatabaseSync, foreignPath, 'wal', DEFAULT_BUSY_TIMEOUT_MS)).rejects.toThrow(/has application id 12345/)
  506. })
  507. it('rejects changed columns and non-strict owned tables', async () => {
  508. const changedPath = await freshDbPath('dsh-sqlite-columns-')
  509. ;(await openDatabase(DatabaseSync, changedPath, 'wal', DEFAULT_BUSY_TIMEOUT_MS)).close()
  510. const changed = new DatabaseSync(changedPath)
  511. changed.exec(testSql('add-unexpected-column'))
  512. changed.close()
  513. await expect(openDatabase(DatabaseSync, changedPath, 'wal', DEFAULT_BUSY_TIMEOUT_MS)).rejects.toThrow(/required schema objects/)
  514. const nonStrictPath = await freshDbPath('dsh-sqlite-nonstrict-')
  515. ;(await openDatabase(DatabaseSync, nonStrictPath, 'wal', DEFAULT_BUSY_TIMEOUT_MS)).close()
  516. const nonStrict = new DatabaseSync(nonStrictPath)
  517. nonStrict.exec(testSql('replace-events-with-nonstrict-table'))
  518. nonStrict.close()
  519. await expect(openDatabase(DatabaseSync, nonStrictPath, 'wal', DEFAULT_BUSY_TIMEOUT_MS)).rejects.toThrow(/required schema objects/)
  520. const loosePath = await freshDbPath('dsh-sqlite-loose-')
  521. const loose = new DatabaseSync(loosePath)
  522. loose.exec(testSql('create-loose-schema'))
  523. loose.close()
  524. await expect(openDatabase(DatabaseSync, loosePath, 'wal', DEFAULT_BUSY_TIMEOUT_MS)).rejects.toThrow(/required schema objects/)
  525. })
  526. it('rejects schema ownership changes observed at mutation time', async () => {
  527. const changedVersion = await openDatabase(DatabaseSync, ':memory:', 'wal', DEFAULT_BUSY_TIMEOUT_MS)
  528. changedVersion.exec(testSql('set-user-version-16'))
  529. expect(() => { validateSchemaForMutation(DatabaseSync, changedVersion, ':memory:') })
  530. .toThrow(/schema changed before mutation/)
  531. changedVersion.close()
  532. const changedApplication = await openDatabase(DatabaseSync, ':memory:', 'wal', DEFAULT_BUSY_TIMEOUT_MS)
  533. changedApplication.exec(testSql('set-application-id-12345'))
  534. expect(() => { validateSchemaForMutation(DatabaseSync, changedApplication, ':memory:') })
  535. .toThrow(/application id changed before mutation/)
  536. changedApplication.close()
  537. })
  538. it('validates creation time and restores every optional header field', () => {
  539. const base: SessionRow = {
  540. id: 'stored-header',
  541. version: 0,
  542. created_at: 1,
  543. cwd: '/project',
  544. parent_session: 'parent',
  545. seed_length: 4,
  546. origin: 'subagent',
  547. incarnation: '00000000-0000-4000-8000-000000000000',
  548. revision: 1,
  549. delegation_depth: 2,
  550. agent_preset: 'minimal',
  551. }
  552. expect(rowToMeta(decodeSessionRow(base))).toMatchObject({
  553. cwd: '/project',
  554. parentSession: 'parent',
  555. seedLength: 4,
  556. origin: 'subagent',
  557. delegationDepth: 2,
  558. agentPreset: 'minimal',
  559. })
  560. expect(() => decodeSessionRow({ ...base, created_at: -1 })).toThrow(/created_at/)
  561. expect(() => decodeSessionRow({ ...base, origin: 'external' })).toThrow(/origin/)
  562. expect(() => decodeSessionRow({ ...base, delegation_depth: -1 })).toThrow(/delegation_depth/)
  563. })
  564. it('rejects malformed SQLite row primitives generically', () => {
  565. const base: SessionRow = {
  566. id: 'stored-header',
  567. version: 0,
  568. created_at: 1,
  569. cwd: '/project',
  570. parent_session: null,
  571. seed_length: null,
  572. origin: null,
  573. incarnation: '00000000-0000-4000-8000-000000000000',
  574. revision: 1,
  575. delegation_depth: null,
  576. agent_preset: null,
  577. }
  578. for (const [value, message] of [
  579. [null, /object/],
  580. [{ ...base, id: 1 }, /id.*string/],
  581. [{ ...base, id: '' }, /id.*empty/],
  582. [{ ...base, version: '0' }, /version.*safe integer/],
  583. [{ ...base, cwd: 'relative' }, /cwd.*absolute/],
  584. [{ ...base, cwd: 1 }, /cwd.*string or null/],
  585. [{ ...base, incarnation: 'invalid' }, /incarnation.*UUID/],
  586. [{ ...base, seed_length: '1' }, /seed_length.*safe integer or null/],
  587. [{ ...base, agent_preset: 1 }, /agent_preset.*string or null/],
  588. ] as const) {
  589. expect(() => decodeSessionRow(value)).toThrow(message)
  590. }
  591. const eventRow = {
  592. seq: 0, type: 'turn/start', time: 1, data: '{}',
  593. source_event_seqs: null, surface_op: null, ignorable: null,
  594. }
  595. for (const [value, message] of [
  596. [null, /object/],
  597. [{ ...eventRow, seq: '0' }, /seq.*safe integer/],
  598. [{ ...eventRow, type: '' }, /type.*empty/],
  599. [{ ...eventRow, time: '1' }, /time.*safe integer/],
  600. [{ ...eventRow, data: 1 }, /data.*string or blob/],
  601. [{ ...eventRow, source_event_seqs: 1 }, /source_event_seqs.*blob or null/],
  602. [{ ...eventRow, ignorable: 2 }, /ignorable.*0, 1, or null/],
  603. ] as const) {
  604. expect(() => decodeEventRow(value)).toThrow(message)
  605. }
  606. expect(() => decodeStoreIdentity({ store_id: 'invalid' })).toThrow(/store_id.*UUID/)
  607. })
  608. it('rejects invalid durable metadata before exposing a session header', async () => {
  609. const path = await freshDbPath('dsh-sqlite-metadata-')
  610. const store = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS })
  611. const header = meta('invalid-metadata')
  612. await store.appendBatch(header, [chunk(0)], false)
  613. const db = new DatabaseSync(path)
  614. db.prepare(testSql('update-invalid-session-metadata')).run(header.id)
  615. db.close()
  616. await expect(store.list()).rejects.toThrow(/seed_length|origin|delegation_depth/)
  617. await expect(store.loadStored(header.id)).rejects.toThrow(/seed_length|origin|delegation_depth/)
  618. await store.close()
  619. })
  620. it('uses the shared persistence application identity', () => {
  621. expect(SESSION_PERSISTENCE_SQLITE_APPLICATION_ID).toBe(0x44534850)
  622. })
  623. })
  624. describe('SessionPersistenceSqlite edge behavior', () => {
  625. it('materializes an explicitly durable empty live session', async () => {
  626. const path = await freshDbPath('dsh-sqlite-empty-')
  627. const ctx = new Context()
  628. await ctx.plugin(SessionStore)
  629. await ctx.plugin(SessionPersistenceSqlite, { path })
  630. const session = ctx.sessions.create(SessionId('empty'), { meta: { cwd: '/workspace' } })
  631. await ctx.sessionPersistence.ensureMaterialized(session)
  632. await expect(ctx.sessionPersistence.list()).resolves.toEqual([session.header])
  633. await expect(ctx.sessionPersistence.load(session.id)).resolves.toEqual({ meta: session.header, events: [] })
  634. await ctx.fiber.dispose()
  635. })
  636. it('keeps a fresh database unopened until the first persistence operation', async () => {
  637. const path = await freshDbPath('dsh-sqlite-lazy-')
  638. const ctx = new Context()
  639. await ctx.plugin(SessionStore)
  640. await ctx.plugin(SessionPersistenceSqlite, { path })
  641. await expect(stat(path)).rejects.toMatchObject({ code: 'ENOENT' })
  642. const emitWarning = Reflect.get(process, 'emitWarning')
  643. expect(await ctx.sessionPersistence.list()).toEqual([])
  644. expect(Reflect.get(process, 'emitWarning')).toBe(emitWarning)
  645. expect(typeof (await stat(path)).size).toBe('number')
  646. await ctx.fiber.dispose()
  647. })
  648. it('disposes after path validation without opening the database', async () => {
  649. const path = await freshDbPath('dsh-sqlite-unused-')
  650. const ctx = new Context()
  651. await ctx.plugin(SessionStore)
  652. await ctx.plugin(SessionPersistenceSqlite, { path })
  653. await ctx.fiber.dispose()
  654. await expect(stat(path)).rejects.toMatchObject({ code: 'ENOENT' })
  655. const untouchedPath = await freshDbPath('dsh-sqlite-never-validated-')
  656. const untouched = new SqliteStore({
  657. path: untouchedPath,
  658. journalMode: 'wal',
  659. busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS,
  660. })
  661. await untouched.close()
  662. await expect(stat(untouchedPath)).rejects.toMatchObject({ code: 'ENOENT' })
  663. })
  664. it('uses constructor defaults and exposes locate and prepare directly', async () => {
  665. const ctx = new Context()
  666. await ctx.plugin(SessionStore)
  667. let persistence!: SessionPersistenceSqlite
  668. await ctx.plugin(Object.assign((inner: Context) => {
  669. persistence = new SessionPersistenceSqlite(inner, { path: ':memory:' })
  670. }, { inject: ['sessions'] }))
  671. const header = meta('direct-provider')
  672. const events = chunkLog(3)
  673. expect(persistence.locate(header)).toBeUndefined()
  674. await persistence.create(header)
  675. await persistence.append(header.id, events)
  676. const preparation = await persistence.prepare(header.id)
  677. expect(preparation.session.header).toEqual(header)
  678. preparation[Symbol.dispose]()
  679. await ctx.fiber.dispose()
  680. })
  681. it('keeps empty mutations inert and rolls back a repair without metadata', async () => {
  682. const store = new SqliteStore({
  683. path: ':memory:',
  684. journalMode: 'wal',
  685. busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS,
  686. })
  687. const header = meta('empty-store')
  688. await store.appendBatch(header, [], false)
  689. await store.commitRepair(header, undefined, [])
  690. expect(await store.readStoredRevision(header.id)).toBeUndefined()
  691. await expect(store.commitRepair(header, 0, [])).rejects.toThrow(/metadata row is missing/)
  692. await store.close()
  693. })
  694. it('rejects omitted torn markers and stale closer positions', async () => {
  695. const path = await freshDbPath('dsh-sqlite-repair-validation-')
  696. const store = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS })
  697. const header = meta('repair-validation')
  698. await store.appendBatch(header, [chunk(0)], false)
  699. const db = new DatabaseSync(path)
  700. db.prepare(testSql('insert-corrupt-event')).run(header.id, 1, 'assistant/chunk', 2, '{not json', null)
  701. db.close()
  702. await expect(store.commitRepair(header, undefined, [chunk(1)])).rejects.toThrow(/omitted current torn tail/)
  703. await store.commitRepair(header, 1, [])
  704. await expect(store.commitRepair(header, undefined, [chunk(2)])).rejects.toThrow(/closer starts at seq 2/)
  705. const cleared = new DatabaseSync(path)
  706. cleared.prepare(testSql('delete-session-events')).run(header.id)
  707. cleared.close()
  708. await store.commitRepair(header, undefined, [chunk(0)])
  709. expect((await store.loadStored(header.id))?.events).toEqual([chunk(0)])
  710. await store.close()
  711. })
  712. it('rejects malformed physical tail rows before appending', async () => {
  713. const path = await freshDbPath('dsh-sqlite-tail-')
  714. const store = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS })
  715. const header = meta('invalid-tail')
  716. await store.appendBatch(header, [chunk(0)], false)
  717. const db = new DatabaseSync(path)
  718. db.prepare(testSql('insert-corrupt-event'))
  719. .run(header.id, 1, 'assistant/chunk', 2, '{not json', null)
  720. db.close()
  721. await expect(store.appendBatch(header, [chunk(2)], true)).rejects.toThrow(/invalid physical tail/)
  722. await store.close()
  723. })
  724. it('rejects missing and empty store identities', async () => {
  725. for (const mode of ['missing', 'empty'] as const) {
  726. const path = await freshDbPath(`dsh-sqlite-identity-${mode}-`)
  727. const db = await openDatabase(DatabaseSync, path, 'wal', DEFAULT_BUSY_TIMEOUT_MS)
  728. if (mode === 'missing') db.exec(testSql('delete-persistence-state'))
  729. else db.exec(testSql('empty-store-id'))
  730. db.close()
  731. await chmod(path, 0o600)
  732. expect(errorMessage(await backendFailure(path))).toMatch(/no valid store identity/)
  733. }
  734. })
  735. it('rejects invalid paths during service initialization', async () => {
  736. const path = await freshDbPath('dsh-sqlite-invalid-path-')
  737. const ctx = new Context()
  738. await ctx.plugin(SessionStore)
  739. await expect(ctx.plugin(SessionPersistenceSqlite, { path: `${path}\0` })).rejects.toMatchObject({
  740. code: 'ERR_INVALID_ARG_VALUE',
  741. })
  742. await ctx.fiber.dispose()
  743. })
  744. it('rejects non-files and symbolic links', async () => {
  745. const directoryPath = await freshDbPath('dsh-sqlite-directory-')
  746. await mkdir(directoryPath)
  747. expect(errorMessage(await backendFailure(directoryPath)))
  748. .toMatch(/must be a regular file/)
  749. const linkPath = await freshDbPath('dsh-sqlite-link-')
  750. const target = join(linkPath, '..', 'target.db')
  751. await writeFile(target, '')
  752. await symlink(target, linkPath)
  753. expect(errorMessage(await backendFailure(linkPath)))
  754. .toMatch(/not a symbolic link/)
  755. const parentLinkPath = await freshDbPath('dsh-sqlite-parent-link-')
  756. const realParent = join(parentLinkPath, '..', 'real-parent')
  757. const linkedParent = join(parentLinkPath, '..', 'linked-parent')
  758. await mkdir(realParent, { mode: 0o700 })
  759. await symlink(realParent, linkedParent)
  760. expect(errorMessage(await backendFailure(join(linkedParent, 'sessions.db'))))
  761. .toMatch(/must be a real directory/)
  762. })
  763. it.runIf(
  764. process.getuid !== undefined && process.getuid() !== 0,
  765. )('rejects permissive files and writable parents', async () => {
  766. const permissivePath = await freshDbPath('dsh-sqlite-permissive-')
  767. await writeFile(permissivePath, '')
  768. await chmod(permissivePath, 0o644)
  769. expect(errorMessage(await backendFailure(permissivePath)))
  770. .toMatch(/accessible only by that user/)
  771. const writableParentPath = await freshDbPath('dsh-sqlite-parent-')
  772. await chmod(join(writableParentPath, '..'), 0o770)
  773. expect(errorMessage(await backendFailure(writableParentPath)))
  774. .toMatch(/not group\/world-writable/)
  775. })
  776. it('surfaces database creation failures after path validation', async () => {
  777. const path = await freshDbPath('dsh-sqlite-create-failure-')
  778. const store = new SqliteStore({ path, journalMode: 'wal', busyTimeoutMs: DEFAULT_BUSY_TIMEOUT_MS })
  779. await store.validatePath()
  780. const parent = join(path, '..')
  781. await rm(parent, { recursive: true })
  782. await writeFile(parent, 'not a directory')
  783. await expect(store.open()).rejects.toThrow(/ENOENT|ENOTDIR/)
  784. await store.close()
  785. })
  786. })