session.spec.ts 61 KB

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