session.spec.ts 60 KB

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