session.spec.ts 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302
  1. import { describe, expect, expectTypeOf, it, vi } from 'vitest'
  2. import { Context } from 'cordis'
  3. import { CallId } from '@deepseek-ai/dsh-llm'
  4. import SessionStore, { SESSION_FORMAT_VERSION, Session, SessionEvent, SessionId } from '@deepseek-ai/dsh-session'
  5. import type { CreateSessionOptions, SessionEventType, SessionHeader, SessionSurface, TodoItem } from '@deepseek-ai/dsh-session'
  6. describe('Session', () => {
  7. it('exposes one stable readonly surface view', () => {
  8. const session = new Session(SessionId('surface-view'))
  9. const surface = session.surface
  10. expectTypeOf(surface).toEqualTypeOf<SessionSurface>()
  11. expect(surface).toBe(session.surface)
  12. })
  13. it('derives message history from the event log', () => {
  14. const session = new Session(SessionId('s1'))
  15. session.append('turn/start', { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } })
  16. session.append('user/message', { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } }, { surfaceOp: 'append' })
  17. session.append('assistant/chunk', { turn: 1, step: 1, chunk: { type: 'text-delta', index: 0, text: 'hi' } })
  18. session.append('assistant/message', { provenance: { provider: 'mock', model: 'mock' },
  19. turn: 1, step: 1,
  20. content: [
  21. { type: 'text', text: 'let me check' },
  22. { type: 'tool-call', id: CallId('c1'), name: 'echo', arguments: '{}' },
  23. ],
  24. }, { surfaceOp: 'append' })
  25. session.append('tool/result', { turn: 1, step: 1, callId: CallId('c1'), content: [{ type: 'text', text: 'ok' }], isError: false }, { surfaceOp: 'append' })
  26. session.append('turn/end', { turn: 1, reason: { kind: 'completed' } })
  27. const messages = session.deriveMessages()
  28. expect(messages.map(m => m.role)).toEqual(['user', 'assistant', 'user'])
  29. // raw chunks must NOT appear in derived history
  30. expect(messages[1]!.content).toHaveLength(2)
  31. expect(messages[2]!.content[0]).toMatchObject({ type: 'tool-result', toolCallId: CallId('c1') })
  32. })
  33. it('accepts and round-trips a max-tokens turn/end reason', () => {
  34. // The max-tokens TurnEndReason variant carries no extra data, so it must
  35. // append and persist like any other reason (JSON-serializable, no fields).
  36. const session = new Session(SessionId('s1'))
  37. session.append('turn/start', { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } })
  38. session.append('turn/end', { turn: 1, reason: { kind: 'max-tokens' } })
  39. const turnEnd = session.events.findLast(e => e.type === 'turn/end')!
  40. expect(turnEnd.data.reason).toEqual({ kind: 'max-tokens' })
  41. // survives a structuredClone (the persistence-serialization boundary)
  42. expect(structuredClone(turnEnd.data.reason)).toEqual({ kind: 'max-tokens' })
  43. })
  44. it('renders context and steering messages as tagged synthetic user content', () => {
  45. const session = new Session(SessionId('s2'))
  46. session.append('context/message', {
  47. content: [{ type: 'text', text: 'file changed: a.ts' }],
  48. source: { kind: 'plugin', plugin: 'watcher' },
  49. }, { surfaceOp: 'append' })
  50. session.append('steering/message', {
  51. turn: 1,
  52. content: [{ type: 'text', text: 'focus on tests' }],
  53. source: { kind: 'user' },
  54. }, { surfaceOp: 'append' })
  55. const [contextMessage, steeringMessage] = session.deriveMessages()
  56. expect(contextMessage!.role).toBe('user')
  57. expect(contextMessage!.content[0]).toMatchObject({ type: 'text', text: '<context source="plugin">' })
  58. expect(contextMessage!.content.at(-1)).toMatchObject({ type: 'text', text: '</context>' })
  59. expect(steeringMessage!.content[0]).toMatchObject({ type: 'text', text: '<steering source="user">' })
  60. })
  61. it('renders raw context without a generic envelope while preserving structured metadata', () => {
  62. const session = new Session(SessionId('s2-raw'))
  63. const meta = {
  64. kind: 'workspace-instructions',
  65. version: 1,
  66. changes: [{ action: 'set', scope: 'pkg', path: 'pkg/AGENTS.md', digest: 'abc123' }],
  67. }
  68. session.append('context/message', {
  69. content: [{ type: 'text', text: '<system-reminder>Additional instructions from: pkg/AGENTS.md</system-reminder>' }],
  70. source: { kind: 'plugin', plugin: 'workspace-context' },
  71. envelope: 'raw',
  72. meta,
  73. }, { surfaceOp: 'append' })
  74. expect(session.deriveMessages()).toEqual([{
  75. role: 'user',
  76. content: [{ type: 'text', text: '<system-reminder>Additional instructions from: pkg/AGENTS.md</system-reminder>' }],
  77. }])
  78. const event = session.events[0]
  79. expect(event?.type === 'context/message' && event.data.meta).toEqual(meta)
  80. })
  81. it('replays identically from a seeded event log', () => {
  82. const original = new Session(SessionId('s3'))
  83. original.append('turn/start', { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } })
  84. original.append('user/message', { content: [{ type: 'text', text: 'q' }], source: { kind: 'user' } }, { surfaceOp: 'append' })
  85. original.append('assistant/message', { provenance: { provider: 'mock', model: 'mock' }, turn: 1, step: 1, content: [{ type: 'text', text: 'a' }] }, { surfaceOp: 'append' })
  86. original.append('turn/end', { turn: 1, reason: { kind: 'completed' } })
  87. const replayed = new Session(SessionId('s3-replay'), [...original.events])
  88. expect(replayed.deriveMessages()).toEqual(original.deriveMessages())
  89. expect(replayed.seq).toBe(original.seq)
  90. })
  91. it('rejects pre-provider request headers and assistant messages on seed/load', () => {
  92. const requestHeader = {
  93. type: 'request/header', seq: 0, time: 1,
  94. data: { header: { config: { model: 'old-model' } }, reason: 'initial' },
  95. } as unknown as SessionEvent
  96. expect(() => new Session(SessionId('old-header'), [requestHeader]))
  97. .toThrow('seed request/header at index 0 lacks provider/model')
  98. const assistantMessage = {
  99. type: 'assistant/message', seq: 0, time: 1,
  100. data: { turn: 1, step: 1, content: [{ type: 'text', text: 'old' }] },
  101. surfaceOp: 'append',
  102. } as unknown as SessionEvent
  103. expect(() => new Session(SessionId('old-assistant'), [assistantMessage]))
  104. .toThrow('seed assistant/message at index 0 lacks provider/model provenance')
  105. const malformedHeader = {
  106. type: 'request/header', seq: 0, time: 1,
  107. data: { header: 'old-header' },
  108. } as unknown as SessionEvent
  109. expect(() => new Session(SessionId('malformed-header'), [malformedHeader]))
  110. .toThrow('seed request/header at index 0 lacks provider/model')
  111. const unrelatedPrimitiveData = {
  112. type: 'plugin/event', seq: 0, time: 1, data: null,
  113. } as unknown as SessionEvent
  114. expect(new Session(SessionId('primitive-plugin-data'), [unrelatedPrimitiveData]).events)
  115. .toEqual([unrelatedPrimitiveData])
  116. })
  117. it('isolates the log from mutation through a derived message (append-only contract)', () => {
  118. const session = new Session(SessionId('s4'))
  119. session.append('user/message', { content: [{ type: 'text', text: 'original' }], source: { kind: 'user' } }, { surfaceOp: 'append' })
  120. session.append('tool/result', {
  121. turn: 1, step: 1, callId: CallId('c1'),
  122. content: [{ type: 'text', text: 'tool out' }], isError: false,
  123. }, { surfaceOp: 'append' })
  124. const before = structuredClone(session.events)
  125. // A misbehaving consumer tries to mutate the messages it was handed.
  126. const messages = session.deriveMessages()
  127. const userBlock = messages[0]!.content[0]!
  128. expect(() => { if (userBlock.type === 'text') userBlock.text = 'HACKED' }).toThrow(TypeError)
  129. const toolBlock = messages[1]!.content[0]!
  130. expect(() => {
  131. if (toolBlock.type === 'tool-result') toolBlock.content.push({ type: 'text', text: 'injected' })
  132. }).toThrow(TypeError)
  133. expect(() => { messages[0]!.content.push({ type: 'text', text: 'extra' }) }).toThrow(TypeError)
  134. // The returned ARRAY is the caller's own snapshot, though — reordering it
  135. // is the caller's business and never reaches the cache or the log.
  136. messages.reverse()
  137. // The log is unchanged: deep-equal to the snapshot taken before mutation.
  138. expect(session.events).toEqual(before)
  139. // And a fresh derivation still reflects the original content and order.
  140. expect(session.deriveMessages()[0]!.content).toEqual([{ type: 'text', text: 'original' }])
  141. })
  142. it('rejects non-JSON-serializable event data at the source (incl. sparse arrays)', () => {
  143. const session = new Session(SessionId('s5'))
  144. const bad = (extra: unknown) => () => session.append('user/message', { content: [{ type: 'text', text: 'x' }], source: { kind: 'user' }, extra } as never, { surfaceOp: 'append' })
  145. expect(bad(1n)).toThrow(/non-JSON-serializable/)
  146. expect(bad(() => 0)).toThrow(/non-JSON-serializable/)
  147. expect(bad(Symbol('s'))).toThrow(/non-JSON-serializable/)
  148. expect(bad(new Map())).toThrow(/non-JSON-serializable/)
  149. expect(bad(undefined)).toThrow(/non-JSON-serializable/)
  150. expect(bad(Infinity)).toThrow(/non-JSON-serializable/)
  151. // A sparse array: `every` skips the hole but JSON.stringify writes it null.
  152. // Build the hole without a sparse literal or `delete` (both linted).
  153. const sparse: unknown[] = Array(3)
  154. sparse[0] = 1
  155. sparse[2] = 3 // index 1 stays a hole
  156. expect(bad(sparse)).toThrow(/non-JSON-serializable/)
  157. // A DENSE array carrying a non-serializable element is rejected too.
  158. expect(bad([1, 2n, 3])).toThrow(/non-JSON-serializable/)
  159. // A nested non-serializable value (inside a plain object) is rejected.
  160. expect(bad({ nested: { deep: () => 0 } })).toThrow(/non-JSON-serializable/)
  161. // A circular reference is rejected (the seen-set guard, not a stack blow-up).
  162. const cyclic: Record<string, unknown> = { a: 1 }
  163. cyclic['self'] = cyclic
  164. expect(bad(cyclic)).toThrow(/non-JSON-serializable/)
  165. // The rejected appends never entered the log.
  166. expect(session.events).toHaveLength(0)
  167. })
  168. it('rejects a surface-eligible append with no surfaceOp marker (runtime guard for the union-widening loophole)', () => {
  169. const session = new Session(SessionId('s5b'))
  170. session.append('turn/start', { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } })
  171. // A widened SessionEventType bypasses the overload's conditional requirement,
  172. // so the runtime guard must still reject the missing surface marker.
  173. const widenedType = 'user/message' as SessionEventType
  174. expect(() => session.append(widenedType, { content: [{ type: 'text', text: 'hi' }], source: { kind: 'user' } }))
  175. .toThrow(/surface-eligible and requires a surfaceOp marker/)
  176. // The rejected append never entered the log (only turn/start is present).
  177. expect(session.events).toHaveLength(1)
  178. })
  179. it('accepts dense arrays and nested plain objects', () => {
  180. const session = new Session(SessionId('s6'))
  181. expect(() => session.append('user/message', { content: [{ type: 'text', text: 'x' }], source: { kind: 'user' }, extra: [1, 2, [3, { a: null, b: true }]] } as never, { surfaceOp: 'append' })).not.toThrow()
  182. expect(session.events).toHaveLength(1)
  183. })
  184. it('validates seed events: rejects a non-JSON-serializable seed', () => {
  185. // A replay/fork seed must satisfy the SAME invariant as Session.append, or
  186. // it builds a live log no backend can persist.
  187. const badSeed = [
  188. { type: 'user/message' as const, seq: 0, time: 1, data: { content: [{ type: 'text' as const, text: 'x' }], source: { kind: 'user' as const }, bad: 1n } },
  189. ] as unknown as SessionEvent[]
  190. expect(() => new Session(SessionId('seed-bad'), badSeed)).toThrow(/losslessly JSON-serializable/)
  191. })
  192. it('validates seed events: rejects a non-contiguous seq', () => {
  193. const gapSeed = [
  194. { type: 'turn/start' as const, seq: 0, time: 1, data: { turn: 1, trigger: { kind: 'message' as const, source: { kind: 'user' as const } } } },
  195. { type: 'turn/end' as const, seq: 5, time: 2, data: { turn: 1, reason: { kind: 'completed' as const } } }, // gap: expected seq 1
  196. ] as SessionEvent[]
  197. expect(() => new Session(SessionId('seed-gap'), gapSeed)).toThrow(/contiguous|seq/)
  198. })
  199. it('validates seed events: rejects a surface-eligible event missing its surfaceOp marker', () => {
  200. // A surface-eligible event (user/message) with no surfaceOp would load fine
  201. // but vanish from deriveMessages() (the surface is the sole derivation path),
  202. // so a resume/fork would silently lose history. append() forbids this at
  203. // compile time; a raw seed must be rejected at runtime to match.
  204. const markerlessSeed = [
  205. { type: 'turn/start' as const, seq: 0, time: 1, data: { turn: 1, trigger: { kind: 'message' as const, source: { kind: 'user' as const } } } },
  206. { type: 'user/message' as const, seq: 1, time: 2, data: { content: [{ type: 'text' as const, text: 'hi' }], source: { kind: 'user' as const } } },
  207. { type: 'turn/end' as const, seq: 2, time: 3, data: { turn: 1, reason: { kind: 'completed' as const } } },
  208. ] as SessionEvent[]
  209. expect(() => new Session(SessionId('seed-no-marker'), markerlessSeed)).toThrow(/requires a surfaceOp marker/)
  210. })
  211. it('accepts a well-formed contiguous serializable seed', () => {
  212. const goodSeed = [
  213. { type: 'turn/start' as const, seq: 0, time: 1, data: { turn: 1, trigger: { kind: 'message' as const, source: { kind: 'user' as const } } } },
  214. { type: 'user/message' as const, seq: 1, time: 2, data: { content: [{ type: 'text' as const, text: 'hi' }], source: { kind: 'user' as const } }, surfaceOp: 'append' as const },
  215. { type: 'turn/end' as const, seq: 2, time: 3, data: { turn: 1, reason: { kind: 'completed' as const } } },
  216. ] as SessionEvent[]
  217. const session = new Session(SessionId('seed-ok'), goodSeed)
  218. expect(session.events).toHaveLength(3)
  219. })
  220. it('reads each seed array entry once so validation and storage use the same event', () => {
  221. const accepted = {
  222. type: 'turn/start' as const,
  223. seq: 0,
  224. time: 1,
  225. data: { turn: 1, trigger: { kind: 'message' as const, source: { kind: 'user' as const } } },
  226. }
  227. const drifted = { ...accepted, seq: 99, data: { invalid: 1n } }
  228. let reads = 0
  229. const seed = new Array<SessionEvent>(1)
  230. Object.defineProperty(seed, 0, {
  231. enumerable: true,
  232. get: () => {
  233. reads += 1
  234. return reads === 1 ? accepted : drifted
  235. },
  236. })
  237. const session = new Session(SessionId('seed-entry-snapshot'), seed)
  238. expect(reads).toBe(1)
  239. expect(session.events).toEqual([accepted])
  240. })
  241. it('reads a nested seed-data getter once and stores its first JSON value', () => {
  242. let reads = 0
  243. const data = Object.defineProperty({}, 'value', {
  244. enumerable: true,
  245. get: () => {
  246. reads += 1
  247. return reads === 1 ? 'accepted' : 1n
  248. },
  249. })
  250. const seed = [{ type: 'test/unstable', seq: 0, time: 1, data }] as unknown as SessionEvent[]
  251. const session = new Session(SessionId('seed-nested-drift'), seed)
  252. expect(reads).toBe(1)
  253. expect(session.events[0]!.data).toEqual({ value: 'accepted' })
  254. })
  255. it('rejects non-JSON surface metadata in a seed event', () => {
  256. const seed = [{
  257. type: 'user/message',
  258. seq: 0,
  259. time: 1,
  260. data: { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } },
  261. surfaceOp: { op: 'replace', start: 1n, end: 2 },
  262. }] as unknown as SessionEvent[]
  263. expect(() => new Session(SessionId('seed-bad-metadata'), seed))
  264. .toThrow(/losslessly JSON-serializable/)
  265. })
  266. it('rejects exotic seed metadata before cloning can erase its prototype', () => {
  267. class ReplaceOp {
  268. readonly op = 'replace' as const
  269. readonly start = 0
  270. readonly end = 0
  271. }
  272. const seed = [{
  273. type: 'user/message',
  274. seq: 0,
  275. time: 1,
  276. data: { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } },
  277. surfaceOp: new ReplaceOp(),
  278. }] as unknown as SessionEvent[]
  279. expect(() => new Session(SessionId('seed-exotic-metadata'), seed))
  280. .toThrow(/losslessly JSON-serializable/)
  281. })
  282. it('rejects an exotic seed event shell before spreading erases its prototype', () => {
  283. class SeedEvent {
  284. readonly type = 'turn/start' as const
  285. readonly seq = 0
  286. readonly time = 1
  287. readonly data = { turn: 1, trigger: { kind: 'message' as const, source: { kind: 'user' as const } } }
  288. }
  289. const seed: SessionEvent[] = [new SeedEvent()]
  290. expect(() => new Session(SessionId('seed-exotic-shell'), seed))
  291. .toThrow(/not losslessly JSON-serializable/)
  292. })
  293. it('accepts a null-prototype seed event shell as a plain JSON record', () => {
  294. const event = Object.assign(Object.create(null) as Record<string, unknown>, {
  295. type: 'turn/start' as const,
  296. seq: 0,
  297. time: 1,
  298. data: { turn: 1, trigger: { kind: 'message' as const, source: { kind: 'user' as const } } },
  299. }) as unknown as SessionEvent
  300. const session = new Session(SessionId('seed-null-prototype'), [event])
  301. expect(session.events).toEqual([{ ...event }])
  302. })
  303. it('reads a nested seed-metadata getter once and stores its first JSON value', () => {
  304. let reads = 0
  305. const surfaceOp = Object.defineProperty({ op: 'replace', end: 0 }, 'start', {
  306. enumerable: true,
  307. get: () => {
  308. reads += 1
  309. return reads === 1 ? 0 : 1n
  310. },
  311. })
  312. const seed = [{
  313. type: 'user/message',
  314. seq: 0,
  315. time: 1,
  316. data: { content: [{ type: 'text', text: 'source' }], source: { kind: 'user' } },
  317. surfaceOp: 'append',
  318. }, {
  319. type: 'user/message',
  320. seq: 1,
  321. time: 2,
  322. data: { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } },
  323. surfaceOp,
  324. sourceEventSeqs: [0],
  325. }] as unknown as SessionEvent[]
  326. const session = new Session(SessionId('seed-unstable-metadata'), seed)
  327. const event = session.events[1]!
  328. if (event.type !== 'user/message') throw new Error('test fixture must remain a user/message')
  329. expect(reads).toBe(1)
  330. expect(event.surfaceOp).toEqual({ op: 'replace', start: 0, end: 0 })
  331. })
  332. it.each([
  333. ['an Error', new Error('validator failed'), 'validator failed'],
  334. ['a non-Error value', 'validator failed', 'invalid surface metadata'],
  335. ] as const)('adds seed context when surface validation throws %s', (_name, failure, expected) => {
  336. const originalHasOwn = Object.hasOwn
  337. const hasOwn = vi.spyOn(Object, 'hasOwn').mockImplementation((object: object, property: PropertyKey): boolean => {
  338. if ((object as Record<string, unknown>)['op'] === 'replace') throw failure
  339. return originalHasOwn(object, property)
  340. })
  341. const seed = [{
  342. type: 'user/message',
  343. seq: 0,
  344. time: 1,
  345. data: { content: [{ type: 'text', text: 'source' }], source: { kind: 'user' } },
  346. surfaceOp: 'append',
  347. }, {
  348. type: 'user/message',
  349. seq: 1,
  350. time: 2,
  351. data: { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } },
  352. surfaceOp: { op: 'replace', start: 0, end: 0 },
  353. sourceEventSeqs: [0],
  354. }] as unknown as SessionEvent[]
  355. try {
  356. expect(() => new Session(SessionId('seed-non-error-metadata-failure'), seed))
  357. .toThrow(`invalid seed event at index 1: ${expected}`)
  358. } finally {
  359. hasOwn.mockRestore()
  360. }
  361. })
  362. it('snapshots the seed: mutating the original after construction does not affect session.events', () => {
  363. const seed = [
  364. { type: 'turn/start' as const, seq: 0, time: 1, data: { turn: 1, trigger: { kind: 'message' as const, source: { kind: 'user' as const } } } },
  365. { type: 'user/message' as const, seq: 1, time: 2, data: { content: [{ type: 'text' as const, text: 'original' }], source: { kind: 'user' as const } }, surfaceOp: 'append' as const },
  366. { type: 'turn/end' as const, seq: 2, time: 3, data: { turn: 1, reason: { kind: 'completed' as const } } },
  367. ] as SessionEvent[]
  368. const session = new Session(SessionId('seed-snapshot'), seed)
  369. // Mutate the ORIGINAL seed objects after construction: a shared reference
  370. // would let this rewrite the forked log (or reintroduce non-serializable
  371. // data past validation). The snapshot must shield session.events.
  372. const um = seed[1]!
  373. ;(um.data as { content: { type: 'text'; text: string }[] }).content[0]!.text = 'HACKED'
  374. ;(um.data as Record<string, unknown>)['injected'] = 1n // would have failed validation
  375. const logged = session.events[1]!
  376. expect(logged.type === 'user/message' && (logged.data.content[0] as { text: string }).text).toBe('original')
  377. expect((logged.data as Record<string, unknown>)['injected']).toBeUndefined()
  378. })
  379. it('snapshots append data: mutating the passed object after append does not affect session.events', () => {
  380. const session = new Session(SessionId('append-snapshot'))
  381. const data = { content: [{ type: 'text' as const, text: 'original' }], source: { kind: 'user' as const } }
  382. const event = session.append('user/message', data, { surfaceOp: 'append' })
  383. // Mutate the caller's object after append returns. A shared reference would
  384. // make session.events diverge from the value that passed validation.
  385. data.content[0]!.text = 'HACKED'
  386. ;(data as Record<string, unknown>)['injected'] = 1n
  387. const logged = session.events[0]!
  388. expect(logged.type === 'user/message' && (logged.data.content[0] as { text: string }).text).toBe('original')
  389. expect((logged.data as Record<string, unknown>)['injected']).toBeUndefined()
  390. // The returned event carries the same snapshot, not the caller's input.
  391. expect((event.data.content[0] as { text: string }).text).toBe('original')
  392. })
  393. it('reads a nested append-data getter once and stores its first JSON value', () => {
  394. const session = new Session(SessionId('append-nested-drift'))
  395. let reads = 0
  396. const data = Object.defineProperty({}, 'value', {
  397. enumerable: true,
  398. get: () => {
  399. reads += 1
  400. return reads === 1 ? 'accepted' : 1n
  401. },
  402. })
  403. const event = session.append('todo/write', data as never)
  404. expect(reads).toBe(1)
  405. expect(event.data).toEqual({ value: 'accepted' })
  406. expect(session.events).toEqual([event])
  407. })
  408. it('rejects non-JSON surface metadata before appending the event', () => {
  409. const session = new Session(SessionId('append-bad-metadata'))
  410. expect(() => session.append(
  411. 'user/message',
  412. { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } },
  413. { surfaceOp: { op: 'replace', start: 1n, end: 2 } } as never,
  414. )).toThrow(/non-JSON-serializable surface metadata/)
  415. expect(session.events).toEqual([])
  416. })
  417. it('rejects exotic surface metadata before cloning can erase its prototype', () => {
  418. class ReplaceOp {
  419. readonly op = 'replace' as const
  420. readonly start = 0
  421. readonly end = 0
  422. }
  423. const session = new Session(SessionId('append-exotic-metadata'))
  424. expect(() => session.append(
  425. 'user/message',
  426. { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } },
  427. { surfaceOp: new ReplaceOp() },
  428. )).toThrow(/non-JSON-serializable surface metadata/)
  429. expect(session.events).toEqual([])
  430. })
  431. it('reads a nested append-metadata getter once and stores its first JSON value', () => {
  432. const session = new Session(SessionId('append-unstable-metadata'))
  433. const source = session.append(
  434. 'user/message',
  435. { content: [{ type: 'text', text: 'source' }], source: { kind: 'user' } },
  436. { surfaceOp: 'append' },
  437. )
  438. let reads = 0
  439. const surfaceOp = Object.defineProperty({ op: 'replace', end: 0 }, 'start', {
  440. enumerable: true,
  441. get: () => {
  442. reads += 1
  443. return reads === 1 ? 0 : 1n
  444. },
  445. })
  446. const event = session.append(
  447. 'user/message',
  448. { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } },
  449. { surfaceOp, sourceEventSeqs: [0] } as never,
  450. )
  451. expect(reads).toBe(1)
  452. expect(event.surfaceOp).toEqual({ op: 'replace', start: 0, end: 0 })
  453. expect(session.events).toEqual([source, event])
  454. })
  455. it('rejects invalid plain surface metadata shapes at append', () => {
  456. const session = new Session(SessionId('append-invalid-surface-shape'))
  457. const appendRaw = session.append.bind(session) as unknown as (
  458. type: SessionEventType,
  459. data: unknown,
  460. opts?: unknown,
  461. ) => SessionEvent
  462. const data = { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } }
  463. expect(() => appendRaw('user/message', data, { surfaceOp: 'invalid' }))
  464. .toThrow(/invalid surfaceOp/)
  465. expect(() => appendRaw('user/message', data, {
  466. surfaceOp: { op: 'replace', start: -1, end: 0 },
  467. })).toThrow(/invalid replace surfaceOp/)
  468. expect(() => appendRaw('user/message', data, {
  469. surfaceOp: 'append',
  470. sourceEventSeqs: [0, -1],
  471. })).toThrow(/non-negative safe integers/)
  472. expect(session.events).toEqual([])
  473. })
  474. it('rejects surface metadata on non-surface append and seed events', () => {
  475. const session = new Session(SessionId('non-surface-metadata'))
  476. const appendRaw = session.append.bind(session) as unknown as (
  477. type: SessionEventType,
  478. data: unknown,
  479. opts?: unknown,
  480. ) => SessionEvent
  481. expect(() => appendRaw(
  482. 'turn/start',
  483. { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } },
  484. { surfaceOp: 'append' },
  485. )).toThrow(/not surface-eligible and cannot carry surfaceOp/)
  486. expect(() => new Session(SessionId('non-surface-metadata-seed'), [{
  487. type: 'turn/start',
  488. seq: 0,
  489. time: 1,
  490. data: { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } },
  491. surfaceOp: 'append',
  492. } as unknown as SessionEvent])).toThrow(/invalid seed event.*not surface-eligible/)
  493. expect(session.events).toEqual([])
  494. })
  495. it('deep-freezes seeded and appended event snapshots', () => {
  496. const seeded = new Session(SessionId('seed-frozen'), [{
  497. type: 'turn/start',
  498. seq: 0,
  499. time: 1,
  500. data: { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } },
  501. }])
  502. const seededEvent = seeded.events[0]!
  503. if (seededEvent.type !== 'turn/start') throw new Error('test fixture must remain a turn/start')
  504. expect(Object.isFrozen(seededEvent)).toBe(true)
  505. expect(Object.isFrozen(seededEvent.data)).toBe(true)
  506. expect(Object.isFrozen(seededEvent.data.trigger)).toBe(true)
  507. expect(() => { seededEvent.data.turn = 99 }).toThrow(TypeError)
  508. const appended = new Session(SessionId('append-frozen'))
  509. const appendedEvent = appended.append('todo/write', {
  510. todos: [{ content: 'first', status: 'pending' }],
  511. })
  512. expect(Object.isFrozen(appendedEvent)).toBe(true)
  513. expect(Object.isFrozen(appendedEvent.data)).toBe(true)
  514. expect(Object.isFrozen(appendedEvent.data.todos)).toBe(true)
  515. expect(Object.isFrozen(appendedEvent.data.todos[0])).toBe(true)
  516. expect(() => { appendedEvent.data.todos[0]!.content = 'mutated' }).toThrow(TypeError)
  517. })
  518. it('returns cached frozen event-array snapshots that do not grow after append', () => {
  519. const session = new Session(SessionId('events-snapshot'))
  520. session.append('turn/start', { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } })
  521. const before = session.events
  522. const beforeEvent = before[0]!
  523. if (beforeEvent.type !== 'turn/start') throw new Error('test fixture must remain a turn/start')
  524. expect(session.events).toBe(before)
  525. expect(Object.isFrozen(before)).toBe(true)
  526. expect(() => { (before as SessionEvent[]).push(beforeEvent) }).toThrow(TypeError)
  527. expect(() => { beforeEvent.data.turn = 99 }).toThrow(TypeError)
  528. session.append('turn/end', { turn: 1, reason: { kind: 'completed' } })
  529. const after = session.events
  530. expect(before).toHaveLength(1)
  531. expect(after).toHaveLength(2)
  532. expect(after).not.toBe(before)
  533. expect(session.events).toBe(after)
  534. })
  535. it('detaches and freezes an explicitly supplied session header', () => {
  536. const input = {
  537. version: SESSION_FORMAT_VERSION,
  538. id: SessionId('header-owned'),
  539. createdAt: 123,
  540. cwd: '/accepted',
  541. parentSession: SessionId('parent'),
  542. seedLength: 2,
  543. }
  544. const session = new Session(SessionId('header-owned'), undefined, input)
  545. input.cwd = '/caller-mutated'
  546. expect(session.header).toEqual({
  547. version: SESSION_FORMAT_VERSION,
  548. id: 'header-owned',
  549. createdAt: 123,
  550. cwd: '/accepted',
  551. parentSession: 'parent',
  552. seedLength: 2,
  553. })
  554. expect(session.header).not.toBe(input)
  555. expect(Object.isFrozen(session.header)).toBe(true)
  556. expect(Reflect.set(session.header, 'cwd', '/published-mutated')).toBe(false)
  557. expect(session.id).toBe('header-owned')
  558. expect(session.header.cwd).toBe('/accepted')
  559. })
  560. it('rejects an exotic, non-JSON, or mismatched supplied header', () => {
  561. class ExoticHeader implements SessionHeader {
  562. readonly version = SESSION_FORMAT_VERSION
  563. readonly id = SessionId('header-invalid')
  564. readonly createdAt = 123
  565. }
  566. expect(() => new Session(SessionId('header-invalid'), undefined, new ExoticHeader()))
  567. .toThrow(/not losslessly JSON-serializable/)
  568. expect(() => new Session(SessionId('header-invalid'), undefined, {
  569. version: SESSION_FORMAT_VERSION,
  570. id: SessionId('header-invalid'),
  571. createdAt: 123,
  572. parentSession: 1n,
  573. } as unknown as SessionHeader)).toThrow(/not losslessly JSON-serializable/)
  574. expect(() => new Session(SessionId('header-invalid'), undefined, {
  575. version: SESSION_FORMAT_VERSION,
  576. id: SessionId('other'),
  577. createdAt: 123,
  578. })).toThrow(/does not match session id/)
  579. })
  580. it('rejects invalid scalar fields in an explicitly supplied header', () => {
  581. const base = {
  582. version: SESSION_FORMAT_VERSION,
  583. id: SessionId('header-shape'),
  584. createdAt: 123,
  585. }
  586. const cases: Array<{ header: unknown; error: RegExp }> = [
  587. { header: 1, error: /not a plain JSON record/ },
  588. { header: null, error: /not a plain JSON record/ },
  589. { header: { ...base, version: 1 }, error: /header version/ },
  590. { header: { ...base, createdAt: '123' }, error: /createdAt must be a finite number/ },
  591. { header: { ...base, cwd: 1 }, error: /header cwd must be a string/ },
  592. { header: { ...base, cwd: 'relative' }, error: /header cwd must be an absolute path/ },
  593. { header: { ...base, parentSession: 1 }, error: /header parentSession must be a string/ },
  594. { header: { ...base, seedLength: '1' }, error: /seedLength must be a non-negative safe integer/ },
  595. { header: { ...base, seedLength: 0.5 }, error: /seedLength must be a non-negative safe integer/ },
  596. { header: { ...base, seedLength: -1 }, error: /seedLength must be a non-negative safe integer/ },
  597. ]
  598. for (const { header, error } of cases) {
  599. expect(() => new Session(SessionId('header-shape'), undefined, header as SessionHeader)).toThrow(error)
  600. }
  601. })
  602. it('rejects seed records with invalid fixed-envelope fields', () => {
  603. const base = {
  604. type: 'turn/start',
  605. seq: 0,
  606. time: 1,
  607. data: { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } },
  608. }
  609. const cases: unknown[] = [
  610. { ...base, extra: true },
  611. { ...base, type: 1 },
  612. { ...base, seq: '0' },
  613. { ...base, seq: 0.5 },
  614. { ...base, seq: -1 },
  615. { ...base, time: '1' },
  616. { ...base, time: 0.5 },
  617. { ...base, time: -1 },
  618. { type: base.type, seq: base.seq, time: base.time },
  619. ]
  620. for (const [index, event] of cases.entries()) {
  621. expect(() => new Session(SessionId(`bad-envelope-${index}`), [event as SessionEvent]))
  622. .toThrow(/invalid event envelope/)
  623. }
  624. })
  625. })
  626. describe('SessionStore', () => {
  627. it('creates sessions, emits session/created and session/event', async () => {
  628. const ctx = new Context()
  629. await ctx.plugin(SessionStore)
  630. const created: Session[] = []
  631. const events: [Session, SessionEvent][] = []
  632. ctx.on('session/created', session => void created.push(session))
  633. ctx.on('session/event', (session, event) => void events.push([session, event]))
  634. const session = ctx.sessions.create()
  635. expect(created).toEqual([session])
  636. // The store-owned append publication hooks are module-private. A JavaScript caller
  637. // may create an unrelated property with the old implementation's name,
  638. // but cannot suppress the durable event feed.
  639. expect(Reflect.set(session, 'onAppend', undefined)).toBe(true)
  640. session.append('user/message', { content: [{ type: 'text', text: 'x' }], source: { kind: 'user' } }, { surfaceOp: 'append' })
  641. expect(events).toHaveLength(1)
  642. expect(events[0]![0]).toBe(session)
  643. expect(events[0]![1].type).toBe('user/message')
  644. expect(ctx.sessions.get(session.id)).toBe(session)
  645. expect(ctx.sessions.list()).toEqual([session])
  646. })
  647. it('rejects duplicate ids and supports seeding', async () => {
  648. const ctx = new Context()
  649. await ctx.plugin(SessionStore)
  650. const a = ctx.sessions.create(SessionId('fixed'))
  651. expect(() => ctx.sessions.create(SessionId('fixed'))).toThrow('already exists')
  652. a.append('user/message', { content: [{ type: 'text', text: 'q' }], source: { kind: 'user' } }, { surfaceOp: 'append' })
  653. const forked = ctx.sessions.create(SessionId('fork'), { seed: [...a.events] })
  654. expect(forked.deriveMessages()).toEqual(a.deriveMessages())
  655. })
  656. it('enter() rejects a stale prepared session whose id is already live (no overwrite)', async () => {
  657. // A stale prepared object must not replace the live same-id entry; its later
  658. // detach would otherwise remove the wrong session.
  659. const ctx = new Context()
  660. await ctx.plugin(SessionStore)
  661. const stale = ctx.sessions.prepare(SessionId('racy'))
  662. const live = ctx.sessions.create(SessionId('racy'))
  663. expect(() => ctx.sessions.enter(stale)).toThrow(/already exists/)
  664. // The live session is intact and still the store entry.
  665. expect(ctx.sessions.get(SessionId('racy'))).toBe(live)
  666. })
  667. it('prepare() + enter() + announce() register a session and emit session/created', async () => {
  668. const ctx = new Context()
  669. await ctx.plugin(SessionStore)
  670. const created: Session[] = []
  671. ctx.on('session/created', session => void created.push(session))
  672. const session = ctx.sessions.prepare(SessionId('lifecycle'))
  673. // prepare alone does NOT enter the store.
  674. expect(ctx.sessions.get(SessionId('lifecycle'))).toBeUndefined()
  675. const detach = ctx.sessions.enter(session)
  676. expect(ctx.sessions.get(SessionId('lifecycle'))).toBe(session)
  677. // enter does NOT announce.
  678. expect(created).toEqual([])
  679. ctx.sessions.announce(session)
  680. expect(created).toEqual([session])
  681. // The detach disposer removes the entry + stops notification.
  682. detach()
  683. detach() // idempotent: cannot disturb a later same-id lifecycle
  684. expect(ctx.sessions.get(SessionId('lifecycle'))).toBeUndefined()
  685. })
  686. it('prevents simultaneous attachment of one session object to two stores', async () => {
  687. const firstCtx = new Context()
  688. const secondCtx = new Context()
  689. await firstCtx.plugin(SessionStore)
  690. await secondCtx.plugin(SessionStore)
  691. const session = new Session(SessionId('owned-key'))
  692. const detachFirst = firstCtx.sessions.enter(session)
  693. expect(() => secondCtx.sessions.enter(session)).toThrow(/already attached to a store/)
  694. expect(firstCtx.sessions.get(SessionId('owned-key'))).toBe(session)
  695. detachFirst()
  696. expect(firstCtx.sessions.get(SessionId('owned-key'))).toBeUndefined()
  697. const detachSecond = secondCtx.sessions.enter(session)
  698. expect(secondCtx.sessions.get(SessionId('owned-key'))).toBe(session)
  699. detachSecond()
  700. })
  701. it('rejects direct and reentrant repeat announcements to preserve one lifecycle pair', async () => {
  702. const ctx = new Context()
  703. await ctx.plugin(SessionStore)
  704. let created = 0
  705. let disposed = 0
  706. let reentrantError = ''
  707. ctx.on('session/created', (session) => {
  708. created += 1
  709. try {
  710. ctx.sessions.announce(session)
  711. } catch (error: unknown) {
  712. reentrantError = String(error)
  713. }
  714. })
  715. ctx.on('session/disposed', () => { disposed += 1 })
  716. const session = ctx.sessions.prepare(SessionId('once'))
  717. const detach = ctx.sessions.enter(session)
  718. ctx.sessions.announce(session)
  719. expect(reentrantError).toMatch(/already announced/)
  720. expect(() => { ctx.sessions.announce(session) }).toThrow(/already announced/)
  721. detach()
  722. expect({ created, disposed }).toEqual({ created: 1, disposed: 1 })
  723. })
  724. it('defers a reentrant detach until the creation dispatch unwinds', async () => {
  725. const ctx = new Context()
  726. await ctx.plugin(SessionStore)
  727. const order: string[] = []
  728. const session = ctx.sessions.prepare(SessionId('reentrant-detach'))
  729. const detach = ctx.sessions.enter(session)
  730. ctx.on('session/created', (created) => {
  731. order.push('created:first')
  732. detach()
  733. expect(ctx.sessions.get(created.id)).toBe(created)
  734. })
  735. ctx.on('session/created', (created) => {
  736. order.push('created:second')
  737. expect(ctx.sessions.get(created.id)).toBe(created)
  738. })
  739. ctx.on('session/disposed', (disposed) => {
  740. order.push('disposed')
  741. expect(ctx.sessions.get(disposed.id)).toBeUndefined()
  742. })
  743. ctx.sessions.announce(session)
  744. expect(order).toEqual(['created:first', 'created:second', 'disposed'])
  745. expect(ctx.sessions.get(session.id)).toBeUndefined()
  746. detach()
  747. })
  748. it('rolls back create when its owner unloads from session/created', async () => {
  749. const ctx = new Context()
  750. await ctx.plugin(SessionStore)
  751. let ownerCtx!: Context
  752. const owner = await ctx.plugin(Object.assign((inner: Context) => { ownerCtx = inner }, { inject: ['sessions'] }))
  753. const id = SessionId('create-unload-race')
  754. ctx.on('session/created', (session) => {
  755. if (session.id === id) void owner.dispose()
  756. })
  757. ownerCtx.sessions.create(id)
  758. await owner.dispose()
  759. expect(ctx.sessions.get(id)).toBeUndefined()
  760. })
  761. it('synthesizes a minimal current-version header for a bare-created session', async () => {
  762. const ctx = new Context()
  763. await ctx.plugin(SessionStore)
  764. const session = ctx.sessions.create(SessionId('plain'))
  765. expect(session.header).toMatchObject({ version: SESSION_FORMAT_VERSION, id: 'plain' })
  766. expect(typeof session.header.createdAt).toBe('number')
  767. expect(session.header.cwd).toBeUndefined()
  768. expect(session.header.parentSession).toBeUndefined()
  769. })
  770. it('attaches cwd and parentSession from meta to the header', async () => {
  771. const ctx = new Context()
  772. await ctx.plugin(SessionStore)
  773. const session = ctx.sessions.create(SessionId('child'), {
  774. meta: { cwd: '/work/project', parentSession: SessionId('parent') },
  775. })
  776. expect(session.header).toMatchObject({
  777. version: SESSION_FORMAT_VERSION,
  778. id: 'child',
  779. cwd: '/work/project',
  780. parentSession: 'parent',
  781. })
  782. })
  783. it('rejects non-JSON and invalid scalar session metadata', async () => {
  784. const ctx = new Context()
  785. await ctx.plugin(SessionStore)
  786. const cases: Array<{ meta: unknown; error: RegExp }> = [
  787. { meta: { parentSession: 1n }, error: /header is not losslessly JSON-serializable/ },
  788. { meta: { cwd: 1 }, error: /header cwd must be a string/ },
  789. { meta: { parentSession: 1 }, error: /header parentSession must be a string/ },
  790. { meta: { createdAt: '123' }, error: /header createdAt must be a finite number/ },
  791. { meta: { seedLength: '1' }, error: /seedLength must be a non-negative safe integer/ },
  792. { meta: { seedLength: 0.5 }, error: /seedLength must be a non-negative safe integer/ },
  793. { meta: { seedLength: -1 }, error: /seedLength must be a non-negative safe integer/ },
  794. ]
  795. for (const [index, { meta, error }] of cases.entries()) {
  796. expect(() => ctx.sessions.prepare(SessionId(`bad-meta-${index}`), {
  797. meta: meta as NonNullable<CreateSessionOptions['meta']>,
  798. })).toThrow(error)
  799. }
  800. })
  801. it('rejects a non-absolute meta.cwd', async () => {
  802. const ctx = new Context()
  803. await ctx.plugin(SessionStore)
  804. expect(() => ctx.sessions.create(SessionId('rel'), { meta: { cwd: 'relative/path' } }))
  805. .toThrow(/cwd must be an absolute path/)
  806. // the rejected session was not registered
  807. expect(ctx.sessions.get(SessionId('rel'))).toBeUndefined()
  808. })
  809. it('a bare Session() constructed without the store still exposes a current-version header', () => {
  810. const session = new Session(SessionId('bare'))
  811. expect(session.header).toMatchObject({ version: SESSION_FORMAT_VERSION, id: 'bare' })
  812. expect(typeof session.header.createdAt).toBe('number')
  813. })
  814. it('detaches sessions when the creating fiber is disposed (HMR safety)', async () => {
  815. const ctx = new Context()
  816. await ctx.plugin(SessionStore)
  817. let session!: Session
  818. const fiber = await ctx.plugin(Object.assign((inner: Context) => {
  819. session = inner.sessions.create(SessionId('scoped'))
  820. }, { inject: ['sessions'] }))
  821. expect(ctx.sessions.get(SessionId('scoped'))).toBe(session)
  822. let observed = 0
  823. ctx.on('session/event', () => void observed++)
  824. await fiber.dispose()
  825. expect(ctx.sessions.get(SessionId('scoped'))).toBeUndefined()
  826. session.append('user/message', { content: [{ type: 'text', text: 'late' }], source: { kind: 'user' } }, { surfaceOp: 'append' })
  827. expect(observed).toBe(0)
  828. })
  829. it('pairs a partial session/created announcement with disposal during rollback', async () => {
  830. const ctx = new Context()
  831. await ctx.plugin(SessionStore)
  832. let threw = false
  833. const disposed: Session[] = []
  834. ctx.on('session/disposed', (session) => { disposed.push(session) })
  835. ctx.on('session/created', () => {
  836. if (!threw) { threw = true; throw new Error('boom created listener') }
  837. })
  838. // The throwing emit must roll the store entry back, not leak it.
  839. expect(() => ctx.sessions.create(SessionId('fixed'))).toThrow('boom created listener')
  840. expect(ctx.sessions.get(SessionId('fixed'))).toBeUndefined() // rolled back, not leaked
  841. expect(disposed.map(session => session.id)).toEqual(['fixed'])
  842. // A subsequent create of the SAME id succeeds (the already-exists check is
  843. // not wedged) and its store-owned publication hooks are correctly wired.
  844. const events: SessionEvent[] = []
  845. ctx.on('session/event', (_session, event) => void events.push(event))
  846. const session = ctx.sessions.create(SessionId('fixed'))
  847. expect(ctx.sessions.get(SessionId('fixed'))).toBe(session)
  848. session.append('user/message', { content: [{ type: 'text', text: 'hi' }], source: { kind: 'user' } }, { surfaceOp: 'append' })
  849. expect(events).toHaveLength(1)
  850. })
  851. it('contains session/event observer failures after the append commit point', async () => {
  852. const ctx = new Context()
  853. await ctx.plugin(SessionStore)
  854. const warnings: string[] = []
  855. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  856. const session = ctx.sessions.create(SessionId('contained-event'))
  857. const heard: SessionEvent[] = []
  858. let committedBeforeNotify = false
  859. ctx.on('session/event', (observedSession, event) => {
  860. committedBeforeNotify = observedSession.events.at(-1) === event
  861. throw new Error('sync event observer')
  862. })
  863. ctx.on('session/event', () => Promise.reject(new Error('async event observer')) as never)
  864. ctx.on('session/event', (_observedSession, event) => { heard.push(event) })
  865. let appended!: SessionEvent
  866. expect(() => {
  867. appended = session.append('turn/start', {
  868. turn: 1,
  869. trigger: { kind: 'message', source: { kind: 'user' } },
  870. })
  871. }).not.toThrow()
  872. expect(committedBeforeNotify).toBe(true)
  873. expect(session.events).toEqual([appended])
  874. expect(heard).toEqual([appended])
  875. await Promise.resolve()
  876. await Promise.resolve()
  877. expect(warnings).toEqual([
  878. 'session "contained-event": session/event listener threw: Error: sync event observer',
  879. 'session "contained-event": session/event listener rejected: Error: async event observer',
  880. ])
  881. })
  882. it('runs internal dispatch validation on one frozen candidate before commit and resets after a veto', async () => {
  883. const ctx = new Context()
  884. await ctx.plugin(SessionStore)
  885. const session = ctx.sessions.create(SessionId('dispatch-veto'))
  886. const validations: Array<{ event: SessionEvent; logLength: number; frozen: boolean }> = []
  887. const observed: SessionEvent[] = []
  888. let reject = true
  889. ctx.on('internal/dispatch', (_mode, name, args) => {
  890. if (name !== 'session/event') return
  891. const [observedSession, event] = args as [Session, SessionEvent]
  892. validations.push({
  893. event,
  894. logLength: observedSession.events.length,
  895. frozen: Object.isFrozen(event) && Object.isFrozen(event.data),
  896. })
  897. if (reject) {
  898. reject = false
  899. throw new Error('reject first candidate')
  900. }
  901. })
  902. ctx.on('session/event', (_observedSession, event) => { observed.push(event) })
  903. expect(() => session.append('turn/start', {
  904. turn: 1,
  905. trigger: { kind: 'message', source: { kind: 'user' } },
  906. })).toThrow('reject first candidate')
  907. expect(session.events).toEqual([])
  908. expect(observed).toEqual([])
  909. const appended = session.append('turn/start', {
  910. turn: 1,
  911. trigger: { kind: 'message', source: { kind: 'user' } },
  912. })
  913. expect(validations.map(({ logLength, frozen }) => ({ logLength, frozen }))).toEqual([
  914. { logLength: 0, frozen: true },
  915. { logLength: 0, frozen: true },
  916. ])
  917. expect(validations.map(({ event }) => event.seq)).toEqual([0, 0])
  918. expect(validations[1]!.event).toBe(appended)
  919. expect(session.events).toEqual([appended])
  920. expect(observed).toEqual([appended])
  921. })
  922. it('does not publish a surface transition rejected by internal dispatch', async () => {
  923. const ctx = new Context()
  924. await ctx.plugin(SessionStore)
  925. const session = ctx.sessions.create(SessionId('surface-dispatch-veto'))
  926. session.append('user/message', {
  927. content: [{ type: 'text', text: 'source' }],
  928. source: { kind: 'user' },
  929. }, { surfaceOp: 'append' })
  930. const surface = session.surface
  931. let reject = true
  932. ctx.on('internal/dispatch', (_mode, name) => {
  933. if (name === 'session/event' && reject) {
  934. reject = false
  935. throw new Error('reject surface candidate')
  936. }
  937. })
  938. expect(() => session.append('assistant/message', {
  939. provenance: { provider: 'mock', model: 'mock' },
  940. turn: 1,
  941. step: 1,
  942. content: [{ type: 'text', text: 'replacement' }],
  943. }, {
  944. surfaceOp: { op: 'replace', start: 0, end: 0 },
  945. sourceEventSeqs: [0],
  946. })).toThrow('reject surface candidate')
  947. expect(session.events).toHaveLength(1)
  948. expect(surface.nodes).toEqual([0])
  949. expect(surface.replaceGeneration).toBe(0)
  950. session.append('user/message', {
  951. content: [{ type: 'text', text: 'next' }],
  952. source: { kind: 'user' },
  953. }, { surfaceOp: 'append' })
  954. expect(surface.nodes).toEqual([0, 1])
  955. expect(surface.replaceGeneration).toBe(0)
  956. })
  957. it('resolves session/event dispatch before commit so instrumentation failure cannot hide a logged event', async () => {
  958. const ctx = new Context()
  959. await ctx.plugin(SessionStore)
  960. const session = ctx.sessions.create(SessionId('dispatch-check'))
  961. const observed: SessionEvent[] = []
  962. ctx.on('internal/dispatch', (_mode, name) => {
  963. if (name === 'session/event') throw new Error('dispatch instrumentation rejected the carrier')
  964. })
  965. ctx.on('session/event', (_observedSession, event) => { observed.push(event) })
  966. expect(() => session.append('turn/start', {
  967. turn: 1,
  968. trigger: { kind: 'message', source: { kind: 'user' } },
  969. })).toThrow('dispatch instrumentation rejected the carrier')
  970. expect(session.events).toEqual([])
  971. expect(observed).toEqual([])
  972. })
  973. it('contains a reentrant observer append without reordering later observers', async () => {
  974. const ctx = new Context()
  975. await ctx.plugin(SessionStore)
  976. const warnings: string[] = []
  977. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  978. const session = ctx.sessions.create(SessionId('reentrant-observer'))
  979. const heard: SessionEvent[] = []
  980. ctx.on('session/event', (observedSession) => {
  981. observedSession.append('todo/write', { todos: [] })
  982. })
  983. ctx.on('session/event', (_observedSession, event) => { heard.push(event) })
  984. const appended = session.append('turn/start', {
  985. turn: 1,
  986. trigger: { kind: 'message', source: { kind: 'user' } },
  987. })
  988. expect(session.events).toEqual([appended])
  989. expect(heard).toEqual([appended])
  990. expect(warnings).toEqual([
  991. 'session "reentrant-observer": session/event listener threw: Error: session append cannot reenter while another append is being published',
  992. ])
  993. })
  994. it('defers detach through dispatch resolution, commit, and observer publication', async () => {
  995. const ctx = new Context()
  996. await ctx.plugin(SessionStore)
  997. const order: string[] = []
  998. const session = ctx.sessions.prepare(SessionId('detach-during-append'))
  999. const detach = ctx.sessions.enter(session)
  1000. ctx.on('internal/dispatch', (_mode, name, args) => {
  1001. if (name !== 'session/event') return
  1002. const session = args[0] as Session
  1003. order.push(`resolve:${ctx.sessions.get(session.id) === session ? 'live' : 'detached'}`)
  1004. detach()
  1005. })
  1006. ctx.on('session/event', (session) => {
  1007. order.push(`observe:${ctx.sessions.get(session.id) === session ? 'live' : 'detached'}`)
  1008. })
  1009. ctx.on('session/disposed', (session) => {
  1010. order.push(`dispose:${ctx.sessions.get(session.id) === session ? 'live' : 'detached'}`)
  1011. })
  1012. ctx.sessions.announce(session)
  1013. const appended = session.append('turn/start', {
  1014. turn: 1,
  1015. trigger: { kind: 'message', source: { kind: 'user' } },
  1016. })
  1017. expect(session.events).toEqual([appended])
  1018. expect(order).toEqual(['resolve:live', 'observe:live', 'dispose:detached'])
  1019. expect(ctx.sessions.get(session.id)).toBeUndefined()
  1020. })
  1021. it('observes async session/created rejection without rolling back or starving peers', async () => {
  1022. const ctx = new Context()
  1023. await ctx.plugin(SessionStore)
  1024. const warnings: string[] = []
  1025. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  1026. const heard: string[] = []
  1027. ctx.on('session/created', () => Promise.reject(new Error('late creation failure')) as never)
  1028. ctx.on('session/created', (session) => { heard.push(session.id) })
  1029. const session = ctx.sessions.create(SessionId('async-created'))
  1030. await Promise.resolve()
  1031. await Promise.resolve()
  1032. expect(ctx.sessions.get(session.id)).toBe(session)
  1033. expect(heard).toEqual(['async-created'])
  1034. expect(warnings).toEqual([
  1035. 'session "async-created": session/created listener rejected: Error: late creation failure',
  1036. ])
  1037. })
  1038. it('contains synchronous and async session/disposed listener failures per observer', async () => {
  1039. const ctx = new Context()
  1040. await ctx.plugin(SessionStore)
  1041. const warnings: string[] = []
  1042. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  1043. const heard: string[] = []
  1044. ctx.on('session/disposed', () => { throw new Error('sync disposed') })
  1045. ctx.on('session/disposed', () => Promise.reject(new Error('async disposed')) as never)
  1046. ctx.on('session/disposed', (session) => { heard.push(session.id) })
  1047. const unannounced = ctx.sessions.prepare(SessionId('never-announced'))
  1048. const detachUnannounced = ctx.sessions.enter(unannounced)
  1049. detachUnannounced()
  1050. expect(heard).toEqual([])
  1051. const announced = ctx.sessions.prepare(SessionId('contained-disposal'))
  1052. const detach = ctx.sessions.enter(announced)
  1053. ctx.sessions.announce(announced)
  1054. expect(() => { detach() }).not.toThrow()
  1055. await Promise.resolve()
  1056. await Promise.resolve()
  1057. expect(heard).toEqual(['contained-disposal'])
  1058. expect(warnings).toEqual([
  1059. 'session "contained-disposal": session/disposed listener threw: Error: sync disposed',
  1060. 'session "contained-disposal": session/disposed listener rejected: Error: async disposed',
  1061. ])
  1062. })
  1063. it('contains internal dispatch failure after session detachment', async () => {
  1064. const ctx = new Context()
  1065. await ctx.plugin(SessionStore)
  1066. const warnings: string[] = []
  1067. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  1068. const heard: Session[] = []
  1069. ctx.on('internal/dispatch', (_mode, name) => {
  1070. if (name === 'session/disposed') throw new Error('disposed dispatch instrumentation')
  1071. })
  1072. ctx.on('session/disposed', (session) => { heard.push(session) })
  1073. const session = ctx.sessions.prepare(SessionId('disposed-dispatch'))
  1074. const detach = ctx.sessions.enter(session)
  1075. ctx.sessions.announce(session)
  1076. expect(() => { detach() }).not.toThrow()
  1077. expect(ctx.sessions.get(session.id)).toBeUndefined()
  1078. expect(heard).toEqual([])
  1079. expect(warnings).toEqual([
  1080. 'session "disposed-dispatch": session/disposed dispatch threw: Error: disposed dispatch instrumentation',
  1081. ])
  1082. })
  1083. it('does not let internal dispatch replace the disposed callback tuple', async () => {
  1084. const ctx = new Context()
  1085. await ctx.plugin(SessionStore)
  1086. const replacement = new Session(SessionId('replacement-disposed'))
  1087. const heard: Session[] = []
  1088. ctx.on('internal/dispatch', (_mode, name, args) => {
  1089. if (name === 'session/disposed') args[0] = replacement
  1090. })
  1091. ctx.on('session/disposed', (session) => { heard.push(session) })
  1092. const session = ctx.sessions.prepare(SessionId('fixed-disposed-tuple'))
  1093. const detach = ctx.sessions.enter(session)
  1094. ctx.sessions.announce(session)
  1095. detach()
  1096. expect(heard).toEqual([session])
  1097. })
  1098. })
  1099. describe('todo/write event', () => {
  1100. it('appends the whole-list snapshot and isolates the log from later mutation', () => {
  1101. const session = new Session(SessionId('t1'))
  1102. const todos: TodoItem[] = [
  1103. { content: 'plan the work', status: 'in_progress' },
  1104. { content: 'write the code', status: 'pending' },
  1105. ]
  1106. session.append('todo/write', { todos })
  1107. const event = session.events.findLast(e => e.type === 'todo/write')!
  1108. expect(event.type).toBe('todo/write')
  1109. expect(event.data.todos).toEqual(todos)
  1110. // The append snapshots its input: mutating the caller's array afterward must
  1111. // not change what the log holds (the durable-source-of-truth contract).
  1112. todos.push({ content: 'sneak in', status: 'pending' })
  1113. todos[0]!.status = 'completed'
  1114. expect(event.data.todos).toEqual([
  1115. { content: 'plan the work', status: 'in_progress' },
  1116. { content: 'write the code', status: 'pending' },
  1117. ])
  1118. })
  1119. it('is last-write-wins: the current list is the most recent todo/write', () => {
  1120. const session = new Session(SessionId('t2'))
  1121. session.append('todo/write', { todos: [{ content: 'first', status: 'pending' }] })
  1122. session.append('todo/write', { todos: [
  1123. { content: 'first', status: 'completed' },
  1124. { content: 'second', status: 'in_progress' },
  1125. ] })
  1126. const current = session.events.findLast(e => e.type === 'todo/write')!.data.todos
  1127. expect(current).toEqual([
  1128. { content: 'first', status: 'completed' },
  1129. { content: 'second', status: 'in_progress' },
  1130. ])
  1131. })
  1132. it('is NOT a surface event: it produces no derived message and joins no surface node', () => {
  1133. const session = new Session(SessionId('t3'))
  1134. session.append('user/message', { content: [{ type: 'text', text: 'q' }], source: { kind: 'user' } }, { surfaceOp: 'append' })
  1135. const before = session.deriveMessages().length
  1136. session.append('todo/write', { todos: [{ content: 'a task', status: 'pending' }] })
  1137. // The todo event must not add a message to the derived history…
  1138. expect(session.deriveMessages()).toHaveLength(before)
  1139. // …and must not appear on the ordered surface.
  1140. expect(session.surface.nodes).not.toContain(session.seq - 1)
  1141. })
  1142. it('round-trips through a seeded replay identically (durable, no surfaceOp needed)', () => {
  1143. const original = new Session(SessionId('t4'))
  1144. original.append('turn/start', { turn: 1, trigger: { kind: 'message', source: { kind: 'user' } } })
  1145. original.append('todo/write', { todos: [{ content: 'only', status: 'completed' }] })
  1146. original.append('turn/end', { turn: 1, reason: { kind: 'completed' } })
  1147. // Seeding a non-surface event with no surfaceOp must not throw.
  1148. const replayed = new Session(SessionId('t4-replay'), [...original.events])
  1149. expect(replayed.events.findLast(e => e.type === 'todo/write')!.data.todos)
  1150. .toEqual([{ content: 'only', status: 'completed' }])
  1151. expect(replayed.seq).toBe(original.seq)
  1152. })
  1153. })