session.spec.ts 60 KB

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