session.spec.ts 57 KB

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