session.spec.ts 70 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799
  1. import { describe, expect, expectTypeOf, it, vi } from 'vitest'
  2. import { Context } from '@deepseek-ai/cordis'
  3. import { createSystemMessage, createUserMessage, ToolCallId, createMessage, createToolResultMessage, MessageId, ReasoningEffortId } from '@deepseek-ai/dsh-llm'
  4. import SessionStore, {
  5. adoptSessionEvent,
  6. SESSION_FORMAT_VERSION,
  7. Session,
  8. SessionEvent,
  9. SessionId,
  10. SessionLogOffset,
  11. SessionSeq,
  12. snapshotSessionEvent,
  13. } from '@deepseek-ai/dsh-session'
  14. import type { CreateSessionOptions, SessionEventType, SessionHeader, SessionSurface } from '@deepseek-ai/dsh-session'
  15. describe('Session', () => {
  16. it('exposes one stable readonly surface view', () => {
  17. const session = Session.create(SessionId('surface-view'))
  18. const surface = session.surface
  19. expectTypeOf(surface).toEqualTypeOf<SessionSurface>()
  20. expect(surface).toBe(session.surface)
  21. })
  22. it('derives message history from the event log', () => {
  23. const session = Session.create(SessionId('s1'))
  24. session.append('turn/start', { turn: 1 })
  25. session.append('user/message', createUserMessage({
  26. content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' },
  27. }), { surfaceOp: 'append' })
  28. session.append('assistant/attempt', {
  29. turn: 1, step: 1,
  30. stream: [{ type: 'text-chunks', time0: 1, index: 0, dt: [], texts: ['hi'] }],
  31. })
  32. session.append('assistant/message', {
  33. stream: [],
  34. turn: 1, step: 1,
  35. message: createMessage({
  36. role: 'assistant',
  37. content: [
  38. { type: 'text', text: 'let me check' },
  39. { type: 'tool-call', id: ToolCallId('c1'), name: 'echo', arguments: '{}' },
  40. ],
  41. source: {
  42. kind: 'model',
  43. ...{ provider: 'mock', model: 'mock' },
  44. },
  45. }),
  46. }, { surfaceOp: 'append' })
  47. session.append('tool/result', {
  48. turn: 1, step: 1,
  49. message: createToolResultMessage({
  50. callId: ToolCallId('c1'),
  51. content: [{ type: 'text', text: 'ok' }],
  52. isError: false,
  53. }),
  54. }, { surfaceOp: 'append' })
  55. session.append('turn/end', { turn: 1, reason: { kind: 'completed' } })
  56. const messages = session.deriveMessages()
  57. expect(messages.map(m => m.role)).toEqual(['user', 'assistant', 'user'])
  58. // raw chunks must NOT appear in derived history
  59. expect(messages[1]!.content).toHaveLength(2)
  60. expect(messages[2]!.content[0]).toMatchObject({ type: 'tool-result', toolCallId: ToolCallId('c1') })
  61. })
  62. it('accepts and round-trips a max-tokens turn/end reason', () => {
  63. // The max-tokens TurnEndReason variant carries no extra data, so it must
  64. // append and persist like any other reason (JSON-serializable, no fields).
  65. const session = Session.create(SessionId('s1'))
  66. session.append('turn/start', { turn: 1 })
  67. session.append('turn/end', { turn: 1, reason: { kind: 'max-tokens' } })
  68. const turnEnd = session.snapshotEvents().findLast(e => e.type === 'turn/end')!
  69. expect(turnEnd.data.reason).toEqual({ kind: 'max-tokens' })
  70. // survives a structuredClone (the persistence-serialization boundary)
  71. expect(structuredClone(turnEnd.data.reason)).toEqual({ kind: 'max-tokens' })
  72. })
  73. it('round-trips an aborted turn with its cancellation cause', () => {
  74. const session = Session.create(SessionId('aborted'))
  75. session.append('turn/start', { turn: 1 })
  76. session.append('turn/end', { turn: 1, reason: { kind: 'aborted', reason: { kind: 'user' } } })
  77. const replayed = Session.create(SessionId('aborted-replay'), structuredClone(session.snapshotEvents()))
  78. expect(replayed.snapshotEvents().slice(0, -1)).toEqual(session.snapshotEvents())
  79. const turnEnd = replayed.snapshotEvents().findLast(event => event.type === 'turn/end')
  80. expect(turnEnd?.type === 'turn/end' && turnEnd.data.reason)
  81. .toEqual({ kind: 'aborted', reason: { kind: 'user' } })
  82. })
  83. it('renders injected-context and user messages as plain user content', () => {
  84. const session = Session.create(SessionId('s2'))
  85. session.append('user/message', createUserMessage({
  86. content: [{ type: 'text', text: 'file changed: a.ts' }],
  87. source: { kind: 'plugin', plugin: 'watcher' },
  88. }), { surfaceOp: 'append' })
  89. session.append('user/message', createUserMessage({
  90. content: [{ type: 'text', text: 'focus on tests' }],
  91. source: { kind: 'user' },
  92. }), { surfaceOp: 'append' })
  93. const [contextMessage, steeringMessage] = session.deriveMessages()
  94. expect(contextMessage!.role).toBe('user')
  95. expect(contextMessage!.content).toEqual([{ type: 'text', text: 'file changed: a.ts' }])
  96. expect(steeringMessage!.role).toBe('user')
  97. expect(steeringMessage!.content).toEqual([{ type: 'text', text: 'focus on tests' }])
  98. })
  99. it('keeps the exact identified context message in durable history and projection', () => {
  100. const session = Session.create(SessionId('s2-raw'))
  101. const message = createUserMessage({
  102. content: [{ type: 'text', text: '<system-reminder>Additional instructions from: pkg/AGENTS.md</system-reminder>' }],
  103. source: { kind: 'plugin', plugin: 'agent-instructions' },
  104. })
  105. session.append('user/message', message, { surfaceOp: 'append' })
  106. expect(session.deriveMessages()).toEqual([message])
  107. const event = session.snapshotEvents()[0]
  108. expect(event?.type === 'user/message' && event.data.source).toEqual({ kind: 'plugin', plugin: 'agent-instructions' })
  109. })
  110. it('replays identically from a seeded event log', () => {
  111. const original = Session.create(SessionId('s3'))
  112. original.append('turn/start', { turn: 1 })
  113. original.append('user/message', createUserMessage({
  114. content: [{ type: 'text', text: 'q' }], source: { kind: 'user' },
  115. }), { surfaceOp: 'append' })
  116. original.append('assistant/message', {
  117. stream: [],
  118. turn: 1, step: 1,
  119. message: createMessage({
  120. role: 'assistant',
  121. content: [{ type: 'text', text: 'a' }],
  122. source: {
  123. kind: 'model',
  124. ...{ provider: 'mock', model: 'mock' },
  125. },
  126. }),
  127. }, { surfaceOp: 'append' })
  128. original.append('turn/end', { turn: 1, reason: { kind: 'completed' } })
  129. const replayed = Session.create(SessionId('s3-replay'), original.snapshotEvents())
  130. expect(replayed.deriveMessages()).toEqual(original.deriveMessages())
  131. // The seed verbatim, plus the end-seed event the constructor appends.
  132. expect(replayed.snapshotEvents().slice(0, original.seq)).toEqual(original.snapshotEvents())
  133. expect(replayed.seq).toBe(original.seq + 1)
  134. expect(replayed.firstLiveSeq).toBe(original.seq)
  135. })
  136. it('marks an explicitly empty seed without marking a fresh session', () => {
  137. const fresh = Session.create(SessionId('fresh-empty'))
  138. expect(fresh.snapshotEvents()).toEqual([])
  139. const resumed = Session.create(SessionId('resumed-empty'), [])
  140. expect(resumed.firstLiveSeq).toBe(0)
  141. expect(resumed.snapshotEvents()).toMatchObject([
  142. { type: 'session/end-seed', seq: 0, data: {} },
  143. ])
  144. const reopened = Session.create(SessionId('reopened-empty'), resumed.snapshotEvents())
  145. expect(reopened.firstLiveSeq).toBe(1)
  146. expect(reopened.snapshotEvents()).toEqual(resumed.snapshotEvents())
  147. })
  148. it('rejects pre-provider request headers and assistant messages on seed/load', () => {
  149. const requestHeader = {
  150. type: 'request/header', seq: 0, time: 1,
  151. data: { header: { config: { model: 'old-model' } }, reason: 'initial' },
  152. } as unknown as SessionEvent
  153. expect(() => Session.create(SessionId('old-header'), [requestHeader]))
  154. .toThrow('seed request/header at index 0 lacks provider/model')
  155. const assistantMessage = {
  156. type: 'assistant/message', seq: 0, time: 1,
  157. data: { turn: 1, step: 1, content: [{ type: 'text', text: 'old' }] },
  158. surfaceOp: 'append',
  159. } as unknown as SessionEvent
  160. expect(() => Session.create(SessionId('old-assistant'), [assistantMessage]))
  161. .toThrow('seed assistant/message at index 0 lacks an identified message')
  162. const malformedHeader = {
  163. type: 'request/header', seq: 0, time: 1,
  164. data: { header: 'old-header' },
  165. } as unknown as SessionEvent
  166. expect(() => Session.create(SessionId('malformed-header'), [malformedHeader]))
  167. .toThrow('seed request/header at index 0 lacks provider/model')
  168. const unrelatedPrimitiveData = {
  169. type: 'plugin/event', seq: 0, time: 1, data: null,
  170. } as unknown as SessionEvent
  171. expect(Session.create(SessionId('primitive-plugin-data'), [unrelatedPrimitiveData]).snapshotEvents().slice(0, 1))
  172. .toEqual([unrelatedPrimitiveData])
  173. })
  174. it('validates Assistant settlement fields without replaying embedded streams', () => {
  175. const id = SessionId('invalid-restored-assistant-stream')
  176. const header = {
  177. version: SESSION_FORMAT_VERSION,
  178. id,
  179. createdAt: 1,
  180. isSeeded: false,
  181. delegationDepth: 0,
  182. } as const
  183. for (const data of [
  184. null,
  185. { turn: '1', step: 1, stream: [] },
  186. { turn: -1, step: 1, stream: [] },
  187. { turn: -0, step: 1, stream: [] },
  188. { turn: 1.5, step: 1, stream: [] },
  189. { turn: 1, step: '1', stream: [] },
  190. { turn: 1, step: -1, stream: [] },
  191. { turn: 1, step: -0, stream: [] },
  192. { turn: 1, step: 1.5, stream: [] },
  193. { turn: 1, step: 1, stream: null },
  194. ]) {
  195. const invalidAttempt = {
  196. type: 'assistant/attempt', seq: 0, time: 1, data,
  197. } as unknown as SessionEvent
  198. expect(() => Session.fromRestore(
  199. id,
  200. [invalidAttempt],
  201. header,
  202. SessionLogOffset(0),
  203. 'detached',
  204. ))
  205. .toThrow(/invalid settlement fields/)
  206. }
  207. const mismatchedMessage = {
  208. type: 'assistant/message',
  209. seq: 0,
  210. time: 1,
  211. data: {
  212. turn: 1,
  213. step: 1,
  214. message: {
  215. id: 'message',
  216. role: 'assistant',
  217. content: [{ type: 'text', text: 'different' }],
  218. source: { kind: 'model', provider: 'mock', model: 'mock' },
  219. },
  220. stream: [{ type: 'text-chunks', time0: 1, index: 0, dt: [], texts: ['streamed'] }],
  221. },
  222. surfaceOp: 'append',
  223. } as unknown as SessionEvent
  224. const restored = Session.fromRestore(
  225. id,
  226. [mismatchedMessage],
  227. header,
  228. SessionLogOffset(0),
  229. 'detached',
  230. )
  231. expect(restored.eventAt(SessionSeq(0))).toBe(mismatchedMessage)
  232. expect(Object.isFrozen(mismatchedMessage)).toBe(false)
  233. })
  234. it('rejects historical or malformed request-header lifecycle markers on seed/load', () => {
  235. const base = {
  236. type: 'request/header', seq: SessionSeq(0), time: 1,
  237. data: { header: { config: { provider: 'mock', model: 'model' } }, reason: 'initial' },
  238. } as const
  239. for (const reason of ['fallback', 'unknown', null]) {
  240. const invalid = structuredClone(base) as unknown as SessionEvent
  241. if (invalid.type !== 'request/header') throw new Error('test fixture must be a request header')
  242. invalid.data.reason = reason as never
  243. expect(() => Session.create(SessionId('invalid-header-reason'), [invalid]))
  244. .toThrow('seed request/header at index 0 has an invalid reason')
  245. }
  246. for (const startsSeries of [false, 1, 'true']) {
  247. const invalid = structuredClone(base) as unknown as SessionEvent
  248. if (invalid.type !== 'request/header') throw new Error('test fixture must be a request header')
  249. invalid.data.startsSeries = startsSeries as never
  250. expect(() => Session.create(SessionId('invalid-series-marker'), [invalid]))
  251. .toThrow('seed request/header at index 0 has an invalid startsSeries marker')
  252. }
  253. })
  254. it('rejects event-specific malformed message shapes on seed/load', () => {
  255. const user = {
  256. id: 'user',
  257. role: 'user',
  258. content: [{ type: 'text', text: 'content' }],
  259. source: { kind: 'user' },
  260. }
  261. const assistant = {
  262. id: 'assistant',
  263. role: 'assistant',
  264. content: [{ type: 'text', text: 'content' }],
  265. source: { kind: 'model', provider: 'mock', model: 'mock' },
  266. }
  267. const tool = {
  268. id: 'tool',
  269. role: 'user',
  270. content: [{
  271. type: 'tool-result',
  272. toolCallId: 'call',
  273. content: [{ type: 'text', text: 'result' }],
  274. }],
  275. source: { kind: 'tool', callId: 'call' },
  276. }
  277. const invalid = [
  278. {
  279. name: 'message record',
  280. event: {
  281. type: 'user/message', seq: 0, time: 1, surfaceOp: 'append',
  282. data: null,
  283. },
  284. message: 'lacks an identified message',
  285. },
  286. {
  287. name: 'user role',
  288. event: {
  289. type: 'user/message', seq: 0, time: 1, surfaceOp: 'append',
  290. data: { ...user, role: 'assistant' },
  291. },
  292. message: 'message must have role "user"',
  293. },
  294. {
  295. name: 'source',
  296. event: {
  297. type: 'user/message', seq: 0, time: 1, surfaceOp: 'append',
  298. data: { ...user, source: null },
  299. },
  300. message: 'message has invalid source',
  301. },
  302. {
  303. name: 'content shape',
  304. event: {
  305. type: 'user/message', seq: 0, time: 1, surfaceOp: 'append',
  306. data: { ...user, content: 'not-an-array' },
  307. },
  308. message: 'message has invalid content',
  309. },
  310. {
  311. name: 'assistant source',
  312. event: {
  313. type: 'assistant/message', seq: 0, time: 1, surfaceOp: 'append',
  314. data: {
  315. turn: 1,
  316. step: 1,
  317. message: { ...assistant, source: { kind: 'user' } },
  318. },
  319. },
  320. message: 'message must have model source',
  321. },
  322. {
  323. name: 'tool source',
  324. event: {
  325. type: 'tool/result', seq: 0, time: 1, surfaceOp: 'append',
  326. data: {
  327. turn: 1,
  328. step: 1,
  329. message: { ...tool, source: { kind: 'user' } },
  330. },
  331. },
  332. message: 'message must have tool source',
  333. },
  334. {
  335. name: 'system role',
  336. event: {
  337. type: 'system/message', seq: 0, time: 1, surfaceOp: 'append',
  338. data: {
  339. turn: 1,
  340. step: 1,
  341. message: { ...user, id: 'system', source: { kind: 'plugin', plugin: 'prompt' } },
  342. },
  343. },
  344. message: 'message must have role "system"',
  345. },
  346. {
  347. name: 'system source',
  348. event: {
  349. type: 'system/message', seq: 0, time: 1, surfaceOp: 'append',
  350. data: {
  351. turn: 1,
  352. step: 1,
  353. message: { ...user, id: 'system', role: 'system', source: { kind: 'plugin', plugin: '' } },
  354. },
  355. },
  356. message: 'message must have plugin source',
  357. },
  358. {
  359. name: 'tool tuple',
  360. event: {
  361. type: 'tool/result', seq: 0, time: 1, surfaceOp: 'append',
  362. data: {
  363. turn: 1,
  364. step: 1,
  365. message: { ...tool, content: [{ type: 'text', text: 'not a result' }] },
  366. },
  367. },
  368. message: 'message must contain one tool-result block',
  369. },
  370. {
  371. name: 'tool correlation',
  372. event: {
  373. type: 'tool/result', seq: 0, time: 1, surfaceOp: 'append',
  374. data: {
  375. turn: 1,
  376. step: 1,
  377. message: {
  378. ...tool,
  379. source: { kind: 'tool', callId: 'other-call' },
  380. },
  381. },
  382. },
  383. message: 'message has mismatched tool call ids',
  384. },
  385. ] as const
  386. for (const { name, event, message } of invalid) {
  387. expect(
  388. () => Session.create(SessionId(`invalid-${name}`), [event as unknown as SessionEvent]),
  389. name,
  390. ).toThrow(message)
  391. }
  392. })
  393. it('snapshots message events without validating plugin-owned block details', () => {
  394. const boundary = snapshotSessionEvent({
  395. type: 'turn/start',
  396. seq: SessionSeq(0),
  397. time: 1,
  398. data: { turn: 1 },
  399. })
  400. expect(boundary).toEqual({
  401. type: 'turn/start',
  402. seq: SessionSeq(0),
  403. time: 1,
  404. data: { turn: 1 },
  405. })
  406. const extended = snapshotSessionEvent({
  407. type: 'user/message',
  408. seq: SessionSeq(0),
  409. time: 1,
  410. surfaceOp: 'append',
  411. data: {
  412. id: 'extended-message',
  413. role: 'user',
  414. content: [{ type: 'plugin-block', value: 1 }],
  415. source: { kind: 'plugin-source', value: 1 },
  416. },
  417. } as unknown as SessionEvent)
  418. expect(extended.type === 'user/message' && extended.data.content)
  419. .toEqual([{ type: 'plugin-block', value: 1 }])
  420. })
  421. it('adopts exclusively owned messages in place and keeps snapshots detached', () => {
  422. const owned = {
  423. type: 'user/message',
  424. seq: 0,
  425. time: 1,
  426. surfaceOp: 'append',
  427. data: {
  428. id: 'owned-message',
  429. role: 'user',
  430. content: [{ type: 'text', text: 'owned' }],
  431. source: { kind: 'user' },
  432. },
  433. } as SessionEvent<'user/message'>
  434. expect(adoptSessionEvent(owned)).toBe(owned)
  435. expect(Object.isFrozen(owned.data)).toBe(true)
  436. expect(Object.isFrozen(owned.data.content)).toBe(true)
  437. const source = structuredClone(owned)
  438. const snapshot = snapshotSessionEvent(source)
  439. expect(snapshot).not.toBe(source)
  440. expect(snapshot.data).not.toBe(source.data)
  441. expect(snapshot.data.content).not.toBe(source.data.content)
  442. })
  443. it('adopts a system/message by freezing its message', () => {
  444. const event = {
  445. type: 'system/message',
  446. seq: SessionSeq(0),
  447. time: 1,
  448. surfaceOp: 'append',
  449. data: {
  450. turn: 1,
  451. step: 1,
  452. message: createSystemMessage('You are terse.', '@deepseek-ai/dsh-system-prompt'),
  453. },
  454. } as unknown as SessionEvent
  455. const adopted = adoptSessionEvent(event)
  456. expect(adopted.type === 'system/message' && Object.isFrozen(adopted.data.message)).toBe(true)
  457. expect(adopted.type === 'system/message' && Object.isFrozen(adopted.data.message.content[0])).toBe(true)
  458. })
  459. it('validates message shape before adopting ownership', () => {
  460. const malformed = {
  461. type: 'user/message',
  462. seq: 0,
  463. time: 1,
  464. data: {
  465. id: 'wrong-role',
  466. role: 'assistant',
  467. content: [],
  468. source: { kind: 'user' },
  469. },
  470. } as unknown as SessionEvent
  471. expect(() => adoptSessionEvent(malformed)).toThrow('message must have role "user"')
  472. })
  473. it('round-trips a non-empty reasoning effort and rejects invalid durable values', () => {
  474. const valid = {
  475. type: 'request/header',
  476. seq: SessionSeq(0),
  477. time: 1,
  478. data: {
  479. header: {
  480. config: {
  481. provider: 'mock',
  482. model: 'model',
  483. reasoningEffort: ReasoningEffortId('adapter-owned'),
  484. },
  485. },
  486. reason: 'initial',
  487. },
  488. } as const
  489. expect(Session.create(SessionId('reasoning-effort'), [valid]).snapshotEvents()[0])
  490. .toEqual(valid)
  491. for (const reasoningEffort of ['', 1]) {
  492. const invalid = structuredClone(valid) as unknown as SessionEvent
  493. if (invalid.type !== 'request/header') throw new Error('test fixture must be a request header')
  494. const config = invalid.data.header.config as unknown as Record<string, unknown>
  495. config.reasoningEffort = reasoningEffort
  496. expect(() => Session.create(SessionId('invalid-reasoning-effort'), [invalid]))
  497. .toThrow('seed request/header at index 0 has an invalid reasoningEffort')
  498. }
  499. })
  500. it('round-trips adapter-default markers and rejects invalid durable values', () => {
  501. const valid = {
  502. type: 'request/header',
  503. seq: SessionSeq(0),
  504. time: 1,
  505. data: {
  506. header: {
  507. config: {
  508. provider: 'mock',
  509. model: 'model',
  510. maxTokens: 256_000,
  511. },
  512. adapterDefaults: { maxTokens: true },
  513. },
  514. reason: 'initial',
  515. },
  516. } as const
  517. expect(Session.create(SessionId('adapter-defaults'), [valid]).snapshotEvents()[0]).toEqual(valid)
  518. for (const adapterDefaults of [
  519. null,
  520. [],
  521. { unknown: true },
  522. { maxTokens: false },
  523. { reasoningEffort: true },
  524. ]) {
  525. const invalid = structuredClone(valid) as unknown as SessionEvent
  526. if (invalid.type !== 'request/header') throw new Error('test fixture must be a request header')
  527. invalid.data.header.adapterDefaults = adapterDefaults as never
  528. expect(() => Session.create(SessionId('invalid-adapter-defaults'), [invalid]))
  529. .toThrow('seed request/header at index 0 has invalid adapterDefaults')
  530. }
  531. })
  532. it('isolates the log from mutation through a derived message (append-only contract)', () => {
  533. const session = Session.create(SessionId('s4'))
  534. session.append('user/message', createUserMessage({
  535. content: [{ type: 'text', text: 'original' }], source: { kind: 'user' },
  536. }), { surfaceOp: 'append' })
  537. session.append('tool/result', {
  538. turn: 1, step: 1,
  539. message: createToolResultMessage({
  540. callId: ToolCallId('c1'),
  541. content: [{ type: 'text', text: 'tool out' }],
  542. isError: false,
  543. }),
  544. }, { surfaceOp: 'append' })
  545. const before = structuredClone(session.snapshotEvents())
  546. // A misbehaving consumer tries to mutate the messages it was handed.
  547. const messages = session.deriveMessages()
  548. const userBlock = messages[0]!.content[0]!
  549. expect(() => { if (userBlock.type === 'text') userBlock.text = 'HACKED' }).toThrow(TypeError)
  550. const toolBlock = messages[1]!.content[0]!
  551. expect(() => {
  552. if (toolBlock.type === 'tool-result') toolBlock.content.push({ type: 'text', text: 'injected' })
  553. }).toThrow(TypeError)
  554. expect(() => { messages[0]!.content.push({ type: 'text', text: 'extra' }) }).toThrow(TypeError)
  555. // The returned ARRAY is the caller's own snapshot, though — reordering it
  556. // is the caller's business and never reaches the cache or the log.
  557. messages.reverse()
  558. // The log is unchanged: deep-equal to the snapshot taken before mutation.
  559. expect(session.snapshotEvents()).toEqual(before)
  560. // And a fresh derivation still reflects the original content and order.
  561. expect(session.deriveMessages()[0]!.content).toEqual([{ type: 'text', text: 'original' }])
  562. })
  563. it('rejects non-JSON-serializable event data at the source (incl. sparse arrays)', () => {
  564. const session = Session.create(SessionId('s5'))
  565. const bad = (extra: unknown) => () => session.append('user/message', { content: [{ type: 'text', text: 'x' }], source: { kind: 'user' }, extra } as never, { surfaceOp: 'append' })
  566. expect(bad(1n)).toThrow(/non-JSON-serializable/)
  567. expect(bad(() => 0)).toThrow(/non-JSON-serializable/)
  568. expect(bad(Symbol('s'))).toThrow(/non-JSON-serializable/)
  569. expect(bad(new Map())).toThrow(/non-JSON-serializable/)
  570. expect(bad(undefined)).toThrow(/non-JSON-serializable/)
  571. expect(bad(Infinity)).toThrow(/non-JSON-serializable/)
  572. // A sparse array: `every` skips the hole but JSON.stringify writes it null.
  573. // Build the hole without a sparse literal or `delete` (both linted).
  574. const sparse: unknown[] = Array(3)
  575. sparse[0] = 1
  576. sparse[2] = 3 // index 1 stays a hole
  577. expect(bad(sparse)).toThrow(/non-JSON-serializable/)
  578. // A DENSE array carrying a non-serializable element is rejected too.
  579. expect(bad([1, 2n, 3])).toThrow(/non-JSON-serializable/)
  580. // A nested non-serializable value (inside a plain object) is rejected.
  581. expect(bad({ nested: { deep: () => 0 } })).toThrow(/non-JSON-serializable/)
  582. // A circular reference is rejected (the seen-set guard, not a stack blow-up).
  583. const cyclic: Record<string, unknown> = { a: 1 }
  584. cyclic['self'] = cyclic
  585. expect(bad(cyclic)).toThrow(/non-JSON-serializable/)
  586. // The rejected appends never entered the log.
  587. expect(session.snapshotEvents()).toHaveLength(0)
  588. })
  589. it('rejects a surface-eligible append with no surfaceOp marker (runtime guard for the union-widening loophole)', () => {
  590. const session = Session.create(SessionId('s5b'))
  591. session.append('turn/start', { turn: 1 })
  592. // A widened SessionEventType bypasses the overload's conditional requirement,
  593. // so the runtime guard must still reject the missing surface marker.
  594. const widenedType = 'user/message' as SessionEventType
  595. expect(() => session.append(widenedType, createUserMessage({
  596. content: [{ type: 'text', text: 'hi' }], source: { kind: 'user' },
  597. })))
  598. .toThrow(/surface-eligible and requires a surfaceOp marker/)
  599. // The rejected append never entered the log (only turn/start is present).
  600. expect(session.snapshotEvents()).toHaveLength(1)
  601. })
  602. it('accepts dense arrays and nested plain objects', () => {
  603. const session = Session.create(SessionId('s6'))
  604. 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()
  605. expect(session.snapshotEvents()).toHaveLength(1)
  606. })
  607. it('validates seed events: rejects a non-JSON-serializable seed', () => {
  608. // A replay/fork seed must satisfy the SAME invariant as Session.append, or
  609. // it builds a live log no backend can persist.
  610. const badSeed = [
  611. { type: 'user/message' as const, seq: 0, time: 1, data: { content: [{ type: 'text' as const, text: 'x' }], source: { kind: 'user' as const }, bad: 1n } },
  612. ] as unknown as SessionEvent[]
  613. expect(() => Session.create(SessionId('seed-bad'), badSeed)).toThrow(/losslessly JSON-serializable/)
  614. })
  615. it('validates seed events: rejects a non-contiguous seq', () => {
  616. const gapSeed = [
  617. { type: 'turn/start' as const, seq: 0, time: 1, data: { turn: 1 } },
  618. { type: 'turn/end' as const, seq: 5, time: 2, data: { turn: 1, reason: { kind: 'completed' as const } } }, // gap: expected seq 1
  619. ] as SessionEvent[]
  620. expect(() => Session.create(SessionId('seed-gap'), gapSeed)).toThrow(/contiguous|seq/)
  621. })
  622. it('validates seed events: rejects a surface-eligible event missing its surfaceOp marker', () => {
  623. // A surface-eligible event (user/message) with no surfaceOp would load fine
  624. // but vanish from deriveMessages() (the surface is the sole derivation path),
  625. // so a resume/fork would silently lose history. append() forbids this at
  626. // compile time; a raw seed must be rejected at runtime to match.
  627. const markerlessSeed = [
  628. { type: 'turn/start' as const, seq: 0, time: 1, data: { turn: 1 } },
  629. { type: 'user/message' as const, seq: 1, time: 2, data: createUserMessage({
  630. content: [{ type: 'text' as const, text: 'hi' }], source: { kind: 'user' as const },
  631. }) },
  632. { type: 'turn/end' as const, seq: 2, time: 3, data: { turn: 1, reason: { kind: 'completed' as const } } },
  633. ] as SessionEvent[]
  634. expect(() => Session.create(SessionId('seed-no-marker'), markerlessSeed)).toThrow(/requires a surfaceOp marker/)
  635. })
  636. it('accepts a well-formed contiguous serializable seed', () => {
  637. const goodSeed = [
  638. { type: 'turn/start' as const, seq: 0, time: 1, data: { turn: 1 } },
  639. { type: 'user/message' as const, seq: 1, time: 2, data: createUserMessage({
  640. content: [{ type: 'text' as const, text: 'hi' }], source: { kind: 'user' as const },
  641. }), surfaceOp: 'append' as const },
  642. { type: 'turn/end' as const, seq: 2, time: 3, data: { turn: 1, reason: { kind: 'completed' as const } } },
  643. ] as SessionEvent[]
  644. const session = Session.create(SessionId('seed-ok'), goodSeed)
  645. expect(session.snapshotEvents().slice(0, 3)).toEqual(goodSeed)
  646. expect(session.firstLiveSeq).toBe(3)
  647. })
  648. it('reads each seed array entry once so validation and storage use the same event', () => {
  649. const accepted = {
  650. type: 'turn/start' as const,
  651. seq: 0,
  652. time: 1,
  653. data: { turn: 1 },
  654. }
  655. const drifted = { ...accepted, seq: 99, data: { invalid: 1n } }
  656. let reads = 0
  657. const seed = new Array<SessionEvent>(1)
  658. Object.defineProperty(seed, 0, {
  659. enumerable: true,
  660. get: () => {
  661. reads += 1
  662. return reads === 1 ? accepted : drifted
  663. },
  664. })
  665. const session = Session.create(SessionId('seed-entry-snapshot'), seed)
  666. expect(reads).toBe(1)
  667. expect(session.snapshotEvents().slice(0, 1)).toEqual([accepted])
  668. })
  669. it('reads a nested seed-data getter once and stores its first JSON value', () => {
  670. let reads = 0
  671. const data = Object.defineProperty({}, 'value', {
  672. enumerable: true,
  673. get: () => {
  674. reads += 1
  675. return reads === 1 ? 'accepted' : 1n
  676. },
  677. })
  678. const seed = [{ type: 'test/unstable', seq: 0, time: 1, data }] as unknown as SessionEvent[]
  679. const session = Session.create(SessionId('seed-nested-drift'), seed)
  680. expect(reads).toBe(1)
  681. expect(session.snapshotEvents()[0]!.data).toEqual({ value: 'accepted' })
  682. })
  683. it('rejects non-JSON surface metadata in a seed event', () => {
  684. const seed = [{
  685. type: 'user/message',
  686. seq: 0,
  687. time: 1,
  688. data: createUserMessage({
  689. content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' },
  690. }),
  691. surfaceOp: { op: 'replace', start: 1n, end: 2 },
  692. }] as unknown as SessionEvent[]
  693. expect(() => Session.create(SessionId('seed-bad-metadata'), seed))
  694. .toThrow(/losslessly JSON-serializable/)
  695. })
  696. it('rejects exotic seed metadata before cloning can erase its prototype', () => {
  697. class ReplaceOp {
  698. readonly op = 'replace' as const
  699. readonly start = 0
  700. readonly end = 0
  701. }
  702. const seed = [{
  703. type: 'user/message',
  704. seq: 0,
  705. time: 1,
  706. data: createUserMessage({
  707. content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' },
  708. }),
  709. surfaceOp: new ReplaceOp(),
  710. }] as unknown as SessionEvent[]
  711. expect(() => Session.create(SessionId('seed-exotic-metadata'), seed))
  712. .toThrow(/losslessly JSON-serializable/)
  713. })
  714. it('rejects an exotic seed event shell before spreading erases its prototype', () => {
  715. class SeedEvent {
  716. readonly type = 'turn/start' as const
  717. readonly seq = SessionSeq(0)
  718. readonly time = 1
  719. readonly data = { turn: 1 }
  720. }
  721. const seed: SessionEvent[] = [new SeedEvent()]
  722. expect(() => Session.create(SessionId('seed-exotic-shell'), seed))
  723. .toThrow(/not losslessly JSON-serializable/)
  724. })
  725. it('accepts a null-prototype seed event shell as a plain JSON record', () => {
  726. const event = Object.assign(Object.create(null) as Record<string, unknown>, {
  727. type: 'turn/start' as const,
  728. seq: 0,
  729. time: 1,
  730. data: { turn: 1 },
  731. }) as unknown as SessionEvent
  732. const session = Session.create(SessionId('seed-null-prototype'), [event])
  733. expect(session.snapshotEvents().slice(0, 1)).toEqual([{ ...event }])
  734. })
  735. it('reads a nested seed-metadata getter once and stores its first JSON value', () => {
  736. let reads = 0
  737. const surfaceOp = Object.defineProperty({ op: 'replace', end: 0 }, 'start', {
  738. enumerable: true,
  739. get: () => {
  740. reads += 1
  741. return reads === 1 ? 0 : 1n
  742. },
  743. })
  744. const seed = [{
  745. type: 'user/message',
  746. seq: 0,
  747. time: 1,
  748. data: createUserMessage({
  749. content: [{ type: 'text', text: 'source' }], source: { kind: 'user' },
  750. }),
  751. surfaceOp: 'append',
  752. }, {
  753. type: 'user/message',
  754. seq: 1,
  755. time: 2,
  756. data: createUserMessage({
  757. content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' },
  758. }),
  759. surfaceOp,
  760. sourceEventSeqs: [0],
  761. }] as unknown as SessionEvent[]
  762. const session = Session.create(SessionId('seed-unstable-metadata'), seed)
  763. const event = session.snapshotEvents()[1]!
  764. if (event.type !== 'user/message') throw new Error('test fixture must remain a user/message')
  765. expect(reads).toBe(1)
  766. expect(event.surfaceOp).toEqual({ op: 'replace', start: 0, end: 0 })
  767. })
  768. it.each([
  769. ['an Error', new Error('validator failed'), 'validator failed'],
  770. ['a non-Error value', 'validator failed', 'invalid surface metadata'],
  771. ] as const)('adds seed context when surface validation throws %s', (_name, failure, expected) => {
  772. const originalHasOwn = Object.hasOwn
  773. const hasOwn = vi.spyOn(Object, 'hasOwn').mockImplementation((object: object, property: PropertyKey): boolean => {
  774. if ((object as Record<string, unknown>)['op'] === 'replace') throw failure
  775. return originalHasOwn(object, property)
  776. })
  777. const seed = [{
  778. type: 'user/message',
  779. seq: 0,
  780. time: 1,
  781. data: createUserMessage({
  782. content: [{ type: 'text', text: 'source' }], source: { kind: 'user' },
  783. }),
  784. surfaceOp: 'append',
  785. }, {
  786. type: 'user/message',
  787. seq: 1,
  788. time: 2,
  789. data: createUserMessage({
  790. content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' },
  791. }),
  792. surfaceOp: { op: 'replace', start: 0, end: 0 },
  793. sourceEventSeqs: [0],
  794. }] as unknown as SessionEvent[]
  795. try {
  796. expect(() => Session.create(SessionId('seed-non-error-metadata-failure'), seed))
  797. .toThrow(`invalid seed event at index 1: ${expected}`)
  798. } finally {
  799. hasOwn.mockRestore()
  800. }
  801. })
  802. it('snapshots the seed: mutating the original after construction does not affect session.snapshotEvents()', () => {
  803. const seed = [
  804. { type: 'turn/start' as const, seq: 0, time: 1, data: { turn: 1 } },
  805. { type: 'user/message' as const, seq: 1, time: 2, data: {
  806. id: MessageId('seed-input'),
  807. role: 'user' as const,
  808. content: [{ type: 'text' as const, text: 'original' }], source: { kind: 'user' as const },
  809. }, surfaceOp: 'append' as const },
  810. { type: 'turn/end' as const, seq: 2, time: 3, data: { turn: 1, reason: { kind: 'completed' as const } } },
  811. ] as SessionEvent[]
  812. const session = Session.create(SessionId('seed-snapshot'), seed)
  813. // Mutate the ORIGINAL seed objects after construction: a shared reference
  814. // would let this rewrite the forked log (or reintroduce non-serializable
  815. // data past validation). The snapshot must shield session.snapshotEvents().
  816. const um = seed[1]!
  817. ;(um.data as { content: { type: 'text'; text: string }[] }).content[0]!.text = 'HACKED'
  818. ;(um.data as Record<string, unknown>)['injected'] = 1n // would have failed validation
  819. const logged = session.snapshotEvents()[1]!
  820. expect(logged.type === 'user/message' && (logged.data.content[0] as { text: string }).text).toBe('original')
  821. expect((logged.data as Record<string, unknown>)['injected']).toBeUndefined()
  822. })
  823. it('snapshots append data: mutating the passed object after append does not affect session.snapshotEvents()', () => {
  824. const session = Session.create(SessionId('append-snapshot'))
  825. const data = {
  826. id: MessageId('append-input'),
  827. role: 'user' as const,
  828. content: [{ type: 'text' as const, text: 'original' }],
  829. source: { kind: 'user' as const },
  830. }
  831. const event = session.append('user/message', data, { surfaceOp: 'append' })
  832. // Mutate the caller's object after append returns. A shared reference would
  833. // make session.snapshotEvents() diverge from the value that passed validation.
  834. data.content[0]!.text = 'HACKED'
  835. ;(data as Record<string, unknown>)['injected'] = 1n
  836. const logged = session.snapshotEvents()[0]!
  837. expect(logged.type === 'user/message' && (logged.data.content[0] as { text: string }).text).toBe('original')
  838. expect((logged.data as Record<string, unknown>)['injected']).toBeUndefined()
  839. // The returned event carries the same snapshot, not the caller's input.
  840. expect((event.data.content[0] as { text: string }).text).toBe('original')
  841. })
  842. it('reads a nested append-data getter once and stores its first JSON value', () => {
  843. const session = Session.create(SessionId('append-nested-drift'))
  844. let reads = 0
  845. const data = Object.defineProperty({}, 'value', {
  846. enumerable: true,
  847. get: () => {
  848. reads += 1
  849. return reads === 1 ? 'accepted' : 1n
  850. },
  851. })
  852. const event = session.append('request/context', data as never)
  853. expect(reads).toBe(1)
  854. expect(event.data).toEqual({ value: 'accepted' })
  855. expect(session.snapshotEvents()).toEqual([event])
  856. })
  857. it('rejects non-JSON surface metadata before appending the event', () => {
  858. const session = Session.create(SessionId('append-bad-metadata'))
  859. expect(() => session.append(
  860. 'user/message',
  861. createUserMessage({
  862. content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' },
  863. }),
  864. { surfaceOp: { op: 'replace', start: 1n, end: 2 } } as never,
  865. )).toThrow(/non-JSON-serializable surface metadata/)
  866. expect(session.snapshotEvents()).toEqual([])
  867. })
  868. it('rejects exotic surface metadata before cloning can erase its prototype', () => {
  869. class ReplaceOp {
  870. readonly op = 'replace' as const
  871. readonly start = SessionSeq(0)
  872. readonly end = SessionSeq(0)
  873. }
  874. const session = Session.create(SessionId('append-exotic-metadata'))
  875. expect(() => session.append(
  876. 'user/message',
  877. createUserMessage({
  878. content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' },
  879. }),
  880. { surfaceOp: new ReplaceOp() },
  881. )).toThrow(/non-JSON-serializable surface metadata/)
  882. expect(session.snapshotEvents()).toEqual([])
  883. })
  884. it('reads a nested append-metadata getter once and stores its first JSON value', () => {
  885. const session = Session.create(SessionId('append-unstable-metadata'))
  886. const source = session.append(
  887. 'user/message',
  888. createUserMessage({
  889. content: [{ type: 'text', text: 'source' }], source: { kind: 'user' },
  890. }),
  891. { surfaceOp: 'append' },
  892. )
  893. let reads = 0
  894. const surfaceOp = Object.defineProperty({ op: 'replace', end: 0 }, 'start', {
  895. enumerable: true,
  896. get: () => {
  897. reads += 1
  898. return reads === 1 ? 0 : 1n
  899. },
  900. })
  901. const event = session.append(
  902. 'user/message',
  903. createUserMessage({
  904. content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' },
  905. }),
  906. { surfaceOp, sourceEventSeqs: [0] } as never,
  907. )
  908. expect(reads).toBe(1)
  909. expect(event.surfaceOp).toEqual({ op: 'replace', start: 0, end: 0 })
  910. expect(session.snapshotEvents()).toEqual([source, event])
  911. })
  912. it('rejects invalid plain surface metadata shapes at append', () => {
  913. const session = Session.create(SessionId('append-invalid-surface-shape'))
  914. const appendRaw = session.append.bind(session) as unknown as (
  915. type: SessionEventType,
  916. data: unknown,
  917. opts?: unknown,
  918. ) => SessionEvent
  919. const data = { content: [{ type: 'text', text: 'hello' }], source: { kind: 'user' } }
  920. expect(() => appendRaw('user/message', data, { surfaceOp: 'invalid' }))
  921. .toThrow(/invalid surfaceOp/)
  922. expect(() => appendRaw('user/message', data, {
  923. surfaceOp: { op: 'replace', start: -1, end: 0 },
  924. })).toThrow(/invalid replace surfaceOp/)
  925. expect(() => appendRaw('user/message', data, {
  926. surfaceOp: 'append',
  927. sourceEventSeqs: [0, -1],
  928. })).toThrow(/non-negative safe integers/)
  929. expect(session.snapshotEvents()).toEqual([])
  930. })
  931. it('rejects surface metadata on non-surface append and seed events', () => {
  932. const session = Session.create(SessionId('non-surface-metadata'))
  933. const appendRaw = session.append.bind(session) as unknown as (
  934. type: SessionEventType,
  935. data: unknown,
  936. opts?: unknown,
  937. ) => SessionEvent
  938. expect(() => appendRaw(
  939. 'turn/start',
  940. { turn: 1 },
  941. { surfaceOp: 'append' },
  942. )).toThrow(/not surface-eligible and cannot carry surfaceOp/)
  943. expect(() => Session.create(SessionId('non-surface-metadata-seed'), [{
  944. type: 'turn/start',
  945. seq: SessionSeq(0),
  946. time: 1,
  947. data: { turn: 1 },
  948. surfaceOp: 'append',
  949. } as unknown as SessionEvent])).toThrow(/invalid seed event.*not surface-eligible/)
  950. expect(session.snapshotEvents()).toEqual([])
  951. })
  952. it('deep-freezes seeded and appended event snapshots', () => {
  953. const seeded = Session.create(SessionId('seed-frozen'), [{
  954. type: 'turn/start',
  955. seq: SessionSeq(0),
  956. time: 1,
  957. data: { turn: 1 },
  958. }])
  959. const seededEvent = seeded.snapshotEvents()[0]!
  960. if (seededEvent.type !== 'turn/start') throw new Error('test fixture must remain a turn/start')
  961. expect(Object.isFrozen(seededEvent)).toBe(true)
  962. expect(Object.isFrozen(seededEvent.data)).toBe(true)
  963. expect(() => { seededEvent.data.turn = 99 }).toThrow(TypeError)
  964. const appended = Session.create(SessionId('append-frozen'))
  965. const appendedEvent = appended.append('user/message', createUserMessage({
  966. content: [{ type: 'text', text: 'first' }], source: { kind: 'user' },
  967. }), { surfaceOp: 'append' })
  968. expect(Object.isFrozen(appendedEvent)).toBe(true)
  969. expect(Object.isFrozen(appendedEvent.data)).toBe(true)
  970. expect(Object.isFrozen(appendedEvent.data.content)).toBe(true)
  971. expect(Object.isFrozen(appendedEvent.data.content[0])).toBe(true)
  972. expect(() => { (appendedEvent.data.content[0] as { text: string }).text = 'mutated' }).toThrow(TypeError)
  973. })
  974. it('returns cached frozen event-array snapshots that do not grow after append', () => {
  975. const session = Session.create(SessionId('events-snapshot'))
  976. session.append('turn/start', { turn: 1 })
  977. const before = session.snapshotEvents()
  978. const beforeEvent = before[0]!
  979. if (beforeEvent.type !== 'turn/start') throw new Error('test fixture must remain a turn/start')
  980. expect(session.snapshotEvents()).toBe(before)
  981. expect(Object.isFrozen(before)).toBe(true)
  982. expect(() => { (before as SessionEvent[]).push(beforeEvent) }).toThrow(TypeError)
  983. expect(() => { beforeEvent.data.turn = 99 }).toThrow(TypeError)
  984. session.append('turn/end', { turn: 1, reason: { kind: 'completed' } })
  985. const after = session.snapshotEvents()
  986. expect(before).toHaveLength(1)
  987. expect(after).toHaveLength(2)
  988. expect(after).not.toBe(before)
  989. expect(session.snapshotEvents()).toBe(after)
  990. })
  991. it('reads one event without materializing an array and snapshots half-open ranges', () => {
  992. const session = Session.create(SessionId('event-reads'))
  993. const start = session.append('turn/start', { turn: 1 })
  994. const end = session.append('turn/end', { turn: 1, reason: { kind: 'completed' } })
  995. expect(session.eventAt(SessionSeq(0))).toBe(start)
  996. expect(session.eventAt(SessionSeq(1))).toBe(end)
  997. expect(session.eventAt(SessionSeq(2))).toBeUndefined()
  998. const range = session.snapshotEvents(SessionLogOffset(1), SessionLogOffset(2))
  999. expect(range).toEqual([end])
  1000. expect(Object.isFrozen(range)).toBe(true)
  1001. session.append('turn/start', { turn: 2 })
  1002. expect(range).toEqual([end])
  1003. })
  1004. it('detaches and freezes an explicitly supplied session header', () => {
  1005. const input = {
  1006. version: SESSION_FORMAT_VERSION,
  1007. id: SessionId('header-owned'),
  1008. createdAt: 123,
  1009. cwd: '/accepted',
  1010. parentSession: SessionId('parent'),
  1011. isSeeded: true,
  1012. } satisfies SessionHeader
  1013. const session = Session.create(SessionId('header-owned'), [], input, SessionLogOffset(0))
  1014. input.cwd = '/caller-mutated'
  1015. expect(session.header).toEqual({
  1016. version: SESSION_FORMAT_VERSION,
  1017. id: 'header-owned',
  1018. createdAt: 123,
  1019. cwd: '/accepted',
  1020. parentSession: 'parent',
  1021. isSeeded: true,
  1022. })
  1023. expect(session.header).not.toBe(input)
  1024. expect(Object.isFrozen(session.header)).toBe(true)
  1025. expect(Reflect.set(session.header, 'cwd', '/published-mutated')).toBe(false)
  1026. expect(session.id).toBe('header-owned')
  1027. expect(session.header.cwd).toBe('/accepted')
  1028. })
  1029. it('rejects an exotic, non-JSON, or mismatched supplied header', () => {
  1030. class ExoticHeader implements SessionHeader {
  1031. readonly version = SESSION_FORMAT_VERSION
  1032. readonly id = SessionId('header-invalid')
  1033. readonly createdAt = 123
  1034. readonly isSeeded = false
  1035. }
  1036. expect(() => Session.create(SessionId('header-invalid'), undefined, new ExoticHeader()))
  1037. .toThrow(/not losslessly JSON-serializable/)
  1038. expect(() => Session.fromRestore(
  1039. SessionId('header-invalid'),
  1040. [],
  1041. new ExoticHeader(),
  1042. SessionLogOffset(0),
  1043. 'detached',
  1044. ))
  1045. .toThrow(/not a plain JSON record/)
  1046. for (const header of [null, 1, []]) {
  1047. expect(() => Session.fromRestore(
  1048. SessionId('header-invalid'),
  1049. [],
  1050. header as unknown as SessionHeader,
  1051. SessionLogOffset(0),
  1052. 'detached',
  1053. )).toThrow(/not a plain JSON record/)
  1054. }
  1055. expect(() => Session.create(SessionId('header-invalid'), undefined, {
  1056. version: SESSION_FORMAT_VERSION,
  1057. id: SessionId('header-invalid'),
  1058. createdAt: 123,
  1059. isSeeded: false,
  1060. parentSession: 1n,
  1061. } as unknown as SessionHeader)).toThrow(/not losslessly JSON-serializable/)
  1062. expect(() => Session.create(SessionId('header-invalid'), undefined, {
  1063. version: SESSION_FORMAT_VERSION,
  1064. id: SessionId('other'),
  1065. createdAt: 123,
  1066. isSeeded: false,
  1067. })).toThrow(/does not match session id/)
  1068. })
  1069. it('rejects invalid scalar fields in an explicitly supplied header', () => {
  1070. const base = {
  1071. version: SESSION_FORMAT_VERSION,
  1072. id: SessionId('header-shape'),
  1073. createdAt: 123,
  1074. isSeeded: false,
  1075. }
  1076. const cases: Array<{ header: unknown; error: RegExp }> = [
  1077. { header: 1, error: /not a plain JSON record/ },
  1078. { header: null, error: /not a plain JSON record/ },
  1079. { header: { ...base, version: SESSION_FORMAT_VERSION + 1 }, error: /header version/ },
  1080. { header: { ...base, createdAt: '123' }, error: /createdAt must be a non-negative safe integer/ },
  1081. { header: { ...base, cwd: 1 }, error: /header cwd must be a string/ },
  1082. { header: { ...base, cwd: 'relative' }, error: /header cwd must be an absolute path/ },
  1083. { header: { ...base, parentSession: 1 }, error: /header parentSession must be a string/ },
  1084. { header: { ...base, isSeeded: 'yes' }, error: /isSeeded must be a boolean/ },
  1085. { header: { ...base, seedLength: 1 }, error: /invalid field "seedLength"/ },
  1086. ]
  1087. for (const { header, error } of cases) {
  1088. expect(() => Session.create(SessionId('header-shape'), undefined, header as SessionHeader)).toThrow(error)
  1089. }
  1090. })
  1091. it('retains opaque logical header metadata except the physical v0 seed field', () => {
  1092. const id = SessionId('header-extension')
  1093. const session = Session.create(id, undefined, {
  1094. version: SESSION_FORMAT_VERSION,
  1095. id,
  1096. createdAt: 123,
  1097. isSeeded: false,
  1098. extension: { value: 'kept' },
  1099. } as SessionHeader)
  1100. expect((session.header as SessionHeader & { extension: { value: string } }).extension)
  1101. .toEqual({ value: 'kept' })
  1102. })
  1103. it('rejects seed records with invalid fixed-envelope fields', () => {
  1104. const base = {
  1105. type: 'turn/start',
  1106. seq: 0,
  1107. time: 1,
  1108. data: { turn: 1 },
  1109. }
  1110. const cases: unknown[] = [
  1111. { ...base, extra: true },
  1112. { ...base, type: 1 },
  1113. { ...base, seq: '0' },
  1114. { ...base, seq: 0.5 },
  1115. { ...base, seq: -1 },
  1116. { ...base, time: '1' },
  1117. { ...base, time: 0.5 },
  1118. { type: base.type, seq: base.seq, time: base.time },
  1119. { ...base, ignorable: false },
  1120. { ...base, ignorable: 'yes' },
  1121. ]
  1122. for (const [index, event] of cases.entries()) {
  1123. expect(() => Session.create(SessionId(`bad-envelope-${index}`), [event as SessionEvent]))
  1124. .toThrow(/invalid event envelope/)
  1125. }
  1126. // `ignorable: true` is the one accepted marker value (unknown-type skip contract).
  1127. const marked = Session.create(SessionId('ignorable-envelope'), [
  1128. { ...base, ignorable: true } as SessionEvent,
  1129. ])
  1130. expect(marked.snapshotEvents()[0]?.ignorable).toBe(true)
  1131. })
  1132. })
  1133. describe('SessionStore', () => {
  1134. it('creates sessions, emits session/created and session/event', async () => {
  1135. const ctx = new Context()
  1136. await ctx.plugin(SessionStore)
  1137. const created: Session[] = []
  1138. const events: [Session, SessionEvent][] = []
  1139. ctx.on('session/created', session => void created.push(session))
  1140. ctx.on('session/event', (session, event) => void events.push([session, event]))
  1141. const session = ctx.sessions.create()
  1142. expect(created).toEqual([session])
  1143. // The store-owned append publication hooks are module-private. A JavaScript caller
  1144. // may create an unrelated property with the old implementation's name,
  1145. // but cannot suppress the durable event feed.
  1146. expect(Reflect.set(session, 'onAppend', undefined)).toBe(true)
  1147. session.append('turn/start', { turn: 1 })
  1148. session.append('user/message', createUserMessage({
  1149. content: [{ type: 'text', text: 'x' }], source: { kind: 'user' },
  1150. }), { surfaceOp: 'append' })
  1151. expect(events).toHaveLength(2)
  1152. expect(events[1]![0]).toBe(session)
  1153. expect(events[1]![1].type).toBe('user/message')
  1154. expect(ctx.sessions.get(session.id)).toBe(session)
  1155. expect(ctx.sessions.list()).toEqual([session])
  1156. })
  1157. it('rejects duplicate ids and supports seeding', async () => {
  1158. const ctx = new Context()
  1159. await ctx.plugin(SessionStore)
  1160. const a = ctx.sessions.create(SessionId('fixed'))
  1161. expect(() => ctx.sessions.create(SessionId('fixed'))).toThrow('already exists')
  1162. a.append('turn/start', { turn: 1 })
  1163. a.append('user/message', createUserMessage({
  1164. content: [{ type: 'text', text: 'q' }], source: { kind: 'user' },
  1165. }), { surfaceOp: 'append' })
  1166. const forked = ctx.sessions.create(SessionId('fork'), { seed: a.snapshotEvents() })
  1167. expect(forked.deriveMessages()).toEqual(a.deriveMessages())
  1168. })
  1169. it('enter() rejects a stale prepared session whose id is already live (no overwrite)', async () => {
  1170. // A stale prepared object must not replace the live same-id entry; its later
  1171. // detach would otherwise remove the wrong session.
  1172. const ctx = new Context()
  1173. await ctx.plugin(SessionStore)
  1174. const stale = ctx.sessions.prepare(SessionId('racy'))
  1175. const live = ctx.sessions.create(SessionId('racy'))
  1176. expect(() => ctx.sessions.enter(stale)).toThrow(/already exists/)
  1177. // The live session is intact and still the store entry.
  1178. expect(ctx.sessions.get(SessionId('racy'))).toBe(live)
  1179. })
  1180. it('prepare() + enter() + announce() register a session and emit session/created', async () => {
  1181. const ctx = new Context()
  1182. await ctx.plugin(SessionStore)
  1183. const created: Session[] = []
  1184. ctx.on('session/created', session => void created.push(session))
  1185. const session = ctx.sessions.prepare(SessionId('lifecycle'))
  1186. // prepare alone does NOT enter the store.
  1187. expect(ctx.sessions.get(SessionId('lifecycle'))).toBeUndefined()
  1188. const detach = ctx.sessions.enter(session)
  1189. expect(ctx.sessions.get(SessionId('lifecycle'))).toBe(session)
  1190. // enter does NOT announce.
  1191. expect(created).toEqual([])
  1192. ctx.sessions.announce(session)
  1193. expect(created).toEqual([session])
  1194. // The detach disposer removes the entry + stops notification.
  1195. detach()
  1196. detach() // idempotent: cannot disturb a later same-id lifecycle
  1197. expect(ctx.sessions.get(SessionId('lifecycle'))).toBeUndefined()
  1198. })
  1199. it('prevents simultaneous attachment of one session object to two stores', async () => {
  1200. const firstCtx = new Context()
  1201. const secondCtx = new Context()
  1202. await firstCtx.plugin(SessionStore)
  1203. await secondCtx.plugin(SessionStore)
  1204. const session = Session.create(SessionId('owned-key'))
  1205. const detachFirst = firstCtx.sessions.enter(session)
  1206. expect(() => secondCtx.sessions.enter(session)).toThrow(/already attached to a store/)
  1207. expect(firstCtx.sessions.get(SessionId('owned-key'))).toBe(session)
  1208. detachFirst()
  1209. expect(firstCtx.sessions.get(SessionId('owned-key'))).toBeUndefined()
  1210. const detachSecond = secondCtx.sessions.enter(session)
  1211. expect(secondCtx.sessions.get(SessionId('owned-key'))).toBe(session)
  1212. detachSecond()
  1213. })
  1214. it('rejects direct and reentrant repeat announcements to preserve one lifecycle pair', async () => {
  1215. const ctx = new Context()
  1216. await ctx.plugin(SessionStore)
  1217. let created = 0
  1218. let disposed = 0
  1219. let reentrantError = ''
  1220. ctx.on('session/created', (session) => {
  1221. created += 1
  1222. try {
  1223. ctx.sessions.announce(session)
  1224. } catch (error: unknown) {
  1225. reentrantError = String(error)
  1226. }
  1227. })
  1228. ctx.on('session/disposed', () => { disposed += 1 })
  1229. const session = ctx.sessions.prepare(SessionId('once'))
  1230. const detach = ctx.sessions.enter(session)
  1231. ctx.sessions.announce(session)
  1232. expect(reentrantError).toMatch(/already announced/)
  1233. expect(() => { ctx.sessions.announce(session) }).toThrow(/already announced/)
  1234. detach()
  1235. expect({ created, disposed }).toEqual({ created: 1, disposed: 1 })
  1236. })
  1237. it('defers a reentrant detach until the creation dispatch unwinds', async () => {
  1238. const ctx = new Context()
  1239. await ctx.plugin(SessionStore)
  1240. const order: string[] = []
  1241. const session = ctx.sessions.prepare(SessionId('reentrant-detach'))
  1242. const detach = ctx.sessions.enter(session)
  1243. ctx.on('session/created', (created) => {
  1244. order.push('created:first')
  1245. detach()
  1246. expect(ctx.sessions.get(created.id)).toBe(created)
  1247. })
  1248. ctx.on('session/created', (created) => {
  1249. order.push('created:second')
  1250. expect(ctx.sessions.get(created.id)).toBe(created)
  1251. })
  1252. ctx.on('session/disposed', (disposed) => {
  1253. order.push('disposed')
  1254. expect(ctx.sessions.get(disposed.id)).toBeUndefined()
  1255. })
  1256. ctx.sessions.announce(session)
  1257. expect(order).toEqual(['created:first', 'created:second', 'disposed'])
  1258. expect(ctx.sessions.get(session.id)).toBeUndefined()
  1259. detach()
  1260. })
  1261. it('rolls back create when its owner unloads from session/created', async () => {
  1262. const ctx = new Context()
  1263. await ctx.plugin(SessionStore)
  1264. let ownerCtx!: Context
  1265. const owner = await ctx.plugin(Object.assign((inner: Context) => { ownerCtx = inner }, { inject: ['sessions'] }))
  1266. const id = SessionId('create-unload-race')
  1267. ctx.on('session/created', (session) => {
  1268. if (session.id === id) void owner.dispose()
  1269. })
  1270. ownerCtx.sessions.create(id)
  1271. await owner.dispose()
  1272. expect(ctx.sessions.get(id)).toBeUndefined()
  1273. })
  1274. it('synthesizes a minimal current-version header for a bare-created session', async () => {
  1275. const ctx = new Context()
  1276. await ctx.plugin(SessionStore)
  1277. const session = ctx.sessions.create(SessionId('plain'))
  1278. expect(session.header).toMatchObject({ version: SESSION_FORMAT_VERSION, id: 'plain', isSeeded: false })
  1279. expect(Number.isSafeInteger(session.header.createdAt)).toBe(true)
  1280. expect(session.header.cwd).toBeUndefined()
  1281. expect(session.header.parentSession).toBeUndefined()
  1282. })
  1283. it('attaches cwd and parentSession from meta to the header', async () => {
  1284. const ctx = new Context()
  1285. await ctx.plugin(SessionStore)
  1286. const session = ctx.sessions.create(SessionId('child'), {
  1287. meta: { cwd: '/work/project', parentSession: SessionId('parent') },
  1288. })
  1289. expect(session.header).toMatchObject({
  1290. version: SESSION_FORMAT_VERSION,
  1291. id: 'child',
  1292. cwd: '/work/project',
  1293. parentSession: 'parent',
  1294. isSeeded: false,
  1295. })
  1296. })
  1297. it('attaches subagent origin and delegationDepth from meta to the header', async () => {
  1298. const ctx = new Context()
  1299. await ctx.plugin(SessionStore)
  1300. const session = ctx.sessions.create(SessionId('delegated-child'), {
  1301. meta: { parentSession: SessionId('parent'), origin: 'subagent', delegationDepth: 2 },
  1302. })
  1303. expect(session.header).toMatchObject({
  1304. id: 'delegated-child',
  1305. parentSession: 'parent',
  1306. origin: 'subagent',
  1307. delegationDepth: 2,
  1308. })
  1309. })
  1310. it('rejects non-JSON and invalid scalar session metadata', async () => {
  1311. const ctx = new Context()
  1312. await ctx.plugin(SessionStore)
  1313. const cases: Array<{ meta: unknown; error: RegExp }> = [
  1314. { meta: { parentSession: 1n }, error: /header is not losslessly JSON-serializable/ },
  1315. { meta: { cwd: 1 }, error: /header cwd must be a string/ },
  1316. { meta: { parentSession: 1 }, error: /header parentSession must be a string/ },
  1317. { meta: { createdAt: '123' }, error: /header createdAt must be a non-negative safe integer/ },
  1318. { meta: { createdAt: 1.5 }, error: /header createdAt must be a non-negative safe integer/ },
  1319. { meta: { createdAt: -1 }, error: /header createdAt must be a non-negative safe integer/ },
  1320. { meta: { createdAt: Number.MAX_SAFE_INTEGER + 1 }, error: /header createdAt must be a non-negative safe integer/ },
  1321. { meta: { isSeeded: 'yes' }, error: /isSeeded must be a boolean/ },
  1322. { meta: { origin: 'fork' }, error: /origin must be "subagent"/ },
  1323. { meta: { delegationDepth: '1' }, error: /delegationDepth must be a non-negative safe integer/ },
  1324. { meta: { delegationDepth: 0.5 }, error: /delegationDepth must be a non-negative safe integer/ },
  1325. { meta: { delegationDepth: -1 }, error: /delegationDepth must be a non-negative safe integer/ },
  1326. { meta: { agentPreset: 1 }, error: /agentPreset must be a string/ },
  1327. ]
  1328. for (const [index, { meta, error }] of cases.entries()) {
  1329. expect(() => ctx.sessions.prepare(SessionId(`bad-meta-${index}`), {
  1330. meta: meta as NonNullable<CreateSessionOptions['meta']>,
  1331. })).toThrow(error)
  1332. }
  1333. })
  1334. it('rejects a non-absolute meta.cwd', async () => {
  1335. const ctx = new Context()
  1336. await ctx.plugin(SessionStore)
  1337. expect(() => ctx.sessions.create(SessionId('rel'), { meta: { cwd: 'relative/path' } }))
  1338. .toThrow(/cwd must be an absolute path/)
  1339. // the rejected session was not registered
  1340. expect(ctx.sessions.get(SessionId('rel'))).toBeUndefined()
  1341. })
  1342. it('a bare Session() constructed without the store still exposes a current-version header', () => {
  1343. const session = Session.create(SessionId('bare'))
  1344. expect(session.header).toMatchObject({ version: SESSION_FORMAT_VERSION, id: 'bare', isSeeded: false })
  1345. expect(typeof session.header.createdAt).toBe('number')
  1346. })
  1347. it('detaches sessions when the creating fiber is disposed (HMR safety)', async () => {
  1348. const ctx = new Context()
  1349. await ctx.plugin(SessionStore)
  1350. let session!: Session
  1351. const fiber = await ctx.plugin(Object.assign((inner: Context) => {
  1352. session = inner.sessions.create(SessionId('scoped'))
  1353. }, { inject: ['sessions'] }))
  1354. expect(ctx.sessions.get(SessionId('scoped'))).toBe(session)
  1355. let observed = 0
  1356. ctx.on('session/event', () => void observed++)
  1357. await fiber.dispose()
  1358. expect(ctx.sessions.get(SessionId('scoped'))).toBeUndefined()
  1359. session.append('user/message', createUserMessage({
  1360. content: [{ type: 'text', text: 'late' }], source: { kind: 'user' },
  1361. }), { surfaceOp: 'append' })
  1362. expect(observed).toBe(0)
  1363. })
  1364. it('pairs a partial session/created announcement with disposal during rollback', async () => {
  1365. const ctx = new Context()
  1366. await ctx.plugin(SessionStore)
  1367. let threw = false
  1368. const disposed: Session[] = []
  1369. ctx.on('session/disposed', (session) => { disposed.push(session) })
  1370. ctx.on('session/created', () => {
  1371. if (!threw) { threw = true; throw new Error('boom created listener') }
  1372. })
  1373. // The throwing emit must roll the store entry back, not leak it.
  1374. expect(() => ctx.sessions.create(SessionId('fixed'))).toThrow('boom created listener')
  1375. expect(ctx.sessions.get(SessionId('fixed'))).toBeUndefined() // rolled back, not leaked
  1376. expect(disposed.map(session => session.id)).toEqual(['fixed'])
  1377. // A subsequent create of the SAME id succeeds (the already-exists check is
  1378. // not wedged) and its store-owned publication hooks are correctly wired.
  1379. const events: SessionEvent[] = []
  1380. ctx.on('session/event', (_session, event) => void events.push(event))
  1381. const session = ctx.sessions.create(SessionId('fixed'))
  1382. expect(ctx.sessions.get(SessionId('fixed'))).toBe(session)
  1383. session.append('turn/start', { turn: 1 })
  1384. session.append('user/message', createUserMessage({
  1385. content: [{ type: 'text', text: 'hi' }], source: { kind: 'user' },
  1386. }), { surfaceOp: 'append' })
  1387. expect(events.at(-1)?.type).toBe('user/message')
  1388. })
  1389. it('contains session/event observer failures after the append commit point', async () => {
  1390. const ctx = new Context()
  1391. await ctx.plugin(SessionStore)
  1392. const warnings: string[] = []
  1393. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  1394. const session = ctx.sessions.create(SessionId('contained-event'))
  1395. const heard: SessionEvent[] = []
  1396. let committedBeforeNotify = false
  1397. ctx.on('session/event', (observedSession, event) => {
  1398. committedBeforeNotify = observedSession.snapshotEvents().at(-1) === event
  1399. throw new Error('sync event observer')
  1400. })
  1401. ctx.on('session/event', () => Promise.reject(new Error('async event observer')) as never)
  1402. ctx.on('session/event', (_observedSession, event) => { heard.push(event) })
  1403. let appended!: SessionEvent
  1404. expect(() => {
  1405. appended = session.append('turn/start', {
  1406. turn: 1,
  1407. })
  1408. }).not.toThrow()
  1409. expect(committedBeforeNotify).toBe(true)
  1410. expect(session.snapshotEvents()).toEqual([appended])
  1411. expect(heard).toEqual([appended])
  1412. await Promise.resolve()
  1413. await Promise.resolve()
  1414. expect(warnings).toEqual([
  1415. 'session "contained-event": session/event listener threw: Error: sync event observer',
  1416. 'session "contained-event": session/event listener rejected: Error: async event observer',
  1417. ])
  1418. })
  1419. it('runs internal dispatch validation on one frozen candidate before commit and resets after a veto', async () => {
  1420. const ctx = new Context()
  1421. await ctx.plugin(SessionStore)
  1422. const session = ctx.sessions.create(SessionId('dispatch-veto'))
  1423. const validations: Array<{ event: SessionEvent; logLength: number; frozen: boolean }> = []
  1424. const observed: SessionEvent[] = []
  1425. let reject = true
  1426. ctx.on('internal/dispatch', (_mode, name, args) => {
  1427. if (name !== 'session/event') return
  1428. const [observedSession, event] = args as [Session, SessionEvent]
  1429. validations.push({
  1430. event,
  1431. logLength: observedSession.snapshotEvents().length,
  1432. frozen: Object.isFrozen(event) && Object.isFrozen(event.data),
  1433. })
  1434. if (reject) {
  1435. reject = false
  1436. throw new Error('reject first candidate')
  1437. }
  1438. })
  1439. ctx.on('session/event', (_observedSession, event) => { observed.push(event) })
  1440. expect(() => session.append('turn/start', {
  1441. turn: 1,
  1442. })).toThrow('reject first candidate')
  1443. expect(session.snapshotEvents()).toEqual([])
  1444. expect(observed).toEqual([])
  1445. const appended = session.append('turn/start', {
  1446. turn: 1,
  1447. })
  1448. expect(validations.map(({ logLength, frozen }) => ({ logLength, frozen }))).toEqual([
  1449. { logLength: 0, frozen: true },
  1450. { logLength: 0, frozen: true },
  1451. ])
  1452. expect(validations.map(({ event }) => event.seq)).toEqual([0, 0])
  1453. expect(validations[1]!.event).toBe(appended)
  1454. expect(session.snapshotEvents()).toEqual([appended])
  1455. expect(observed).toEqual([appended])
  1456. })
  1457. it('does not publish a surface transition rejected by internal dispatch', async () => {
  1458. const ctx = new Context()
  1459. await ctx.plugin(SessionStore)
  1460. const session = ctx.sessions.create(SessionId('surface-dispatch-veto'))
  1461. session.append('turn/start', { turn: 1 })
  1462. session.append('step/start', { turn: 1, step: 1 })
  1463. session.append('user/message', createUserMessage({
  1464. content: [{ type: 'text', text: 'source' }],
  1465. source: { kind: 'user' },
  1466. }), { surfaceOp: 'append' })
  1467. const surface = session.surface
  1468. let reject = true
  1469. ctx.on('internal/dispatch', (_mode, name) => {
  1470. if (name === 'session/event' && reject) {
  1471. reject = false
  1472. throw new Error('reject surface candidate')
  1473. }
  1474. })
  1475. expect(() => session.append('user/message', createUserMessage({
  1476. content: [{ type: 'text', text: 'replacement' }],
  1477. source: { kind: 'plugin', plugin: 'test' },
  1478. }), {
  1479. surfaceOp: { op: 'replace', start: SessionSeq(2), end: SessionSeq(2) },
  1480. sourceEventSeqs: [SessionSeq(2)],
  1481. })).toThrow('reject surface candidate')
  1482. expect(session.snapshotEvents()).toHaveLength(3)
  1483. expect(surface.nodes).toEqual([2])
  1484. expect(surface.replaceGeneration).toBe(0)
  1485. session.append('user/message', createUserMessage({
  1486. content: [{ type: 'text', text: 'next' }],
  1487. source: { kind: 'user' },
  1488. }), { surfaceOp: 'append' })
  1489. expect(surface.nodes).toEqual([2, 3])
  1490. expect(surface.replaceGeneration).toBe(0)
  1491. })
  1492. it('resolves session/event dispatch before commit so instrumentation failure cannot hide a logged event', async () => {
  1493. const ctx = new Context()
  1494. await ctx.plugin(SessionStore)
  1495. const session = ctx.sessions.create(SessionId('dispatch-check'))
  1496. const observed: SessionEvent[] = []
  1497. ctx.on('internal/dispatch', (_mode, name) => {
  1498. if (name === 'session/event') throw new Error('dispatch instrumentation rejected the carrier')
  1499. })
  1500. ctx.on('session/event', (_observedSession, event) => { observed.push(event) })
  1501. expect(() => session.append('turn/start', {
  1502. turn: 1,
  1503. })).toThrow('dispatch instrumentation rejected the carrier')
  1504. expect(session.snapshotEvents()).toEqual([])
  1505. expect(observed).toEqual([])
  1506. })
  1507. it('contains a reentrant observer append without reordering later observers', async () => {
  1508. const ctx = new Context()
  1509. await ctx.plugin(SessionStore)
  1510. const warnings: string[] = []
  1511. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  1512. const session = ctx.sessions.create(SessionId('reentrant-observer'))
  1513. const heard: SessionEvent[] = []
  1514. ctx.on('session/event', (observedSession) => {
  1515. observedSession.append('request/context', { provider: 'mock', model: 'mock' })
  1516. })
  1517. ctx.on('session/event', (_observedSession, event) => { heard.push(event) })
  1518. const appended = session.append('turn/start', {
  1519. turn: 1,
  1520. })
  1521. expect(session.snapshotEvents()).toEqual([appended])
  1522. expect(heard).toEqual([appended])
  1523. expect(warnings).toEqual([
  1524. 'session "reentrant-observer": session/event listener threw: Error: session append cannot reenter while another append is being published',
  1525. ])
  1526. })
  1527. it('defers detach through dispatch resolution, commit, and observer publication', async () => {
  1528. const ctx = new Context()
  1529. await ctx.plugin(SessionStore)
  1530. const order: string[] = []
  1531. const session = ctx.sessions.prepare(SessionId('detach-during-append'))
  1532. const detach = ctx.sessions.enter(session)
  1533. ctx.on('internal/dispatch', (_mode, name, args) => {
  1534. if (name !== 'session/event') return
  1535. const session = args[0] as Session
  1536. order.push(`resolve:${ctx.sessions.get(session.id) === session ? 'live' : 'detached'}`)
  1537. detach()
  1538. })
  1539. ctx.on('session/event', (session) => {
  1540. order.push(`observe:${ctx.sessions.get(session.id) === session ? 'live' : 'detached'}`)
  1541. })
  1542. ctx.on('session/disposed', (session) => {
  1543. order.push(`dispose:${ctx.sessions.get(session.id) === session ? 'live' : 'detached'}`)
  1544. })
  1545. ctx.sessions.announce(session)
  1546. const appended = session.append('turn/start', {
  1547. turn: 1,
  1548. })
  1549. expect(session.snapshotEvents()).toEqual([appended])
  1550. expect(order).toEqual(['resolve:live', 'observe:live', 'dispose:detached'])
  1551. expect(ctx.sessions.get(session.id)).toBeUndefined()
  1552. })
  1553. it('observes async session/created rejection without rolling back or starving peers', async () => {
  1554. const ctx = new Context()
  1555. await ctx.plugin(SessionStore)
  1556. const warnings: string[] = []
  1557. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  1558. const heard: string[] = []
  1559. ctx.on('session/created', () => Promise.reject(new Error('late creation failure')) as never)
  1560. ctx.on('session/created', (session) => { heard.push(session.id) })
  1561. const session = ctx.sessions.create(SessionId('async-created'))
  1562. await Promise.resolve()
  1563. await Promise.resolve()
  1564. expect(ctx.sessions.get(session.id)).toBe(session)
  1565. expect(heard).toEqual(['async-created'])
  1566. expect(warnings).toEqual([
  1567. 'session "async-created": session/created listener rejected: Error: late creation failure',
  1568. ])
  1569. })
  1570. it('contains synchronous and async session/disposed listener failures per observer', async () => {
  1571. const ctx = new Context()
  1572. await ctx.plugin(SessionStore)
  1573. const warnings: string[] = []
  1574. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  1575. const heard: string[] = []
  1576. ctx.on('session/disposed', () => { throw new Error('sync disposed') })
  1577. ctx.on('session/disposed', () => Promise.reject(new Error('async disposed')) as never)
  1578. ctx.on('session/disposed', (session) => { heard.push(session.id) })
  1579. const unannounced = ctx.sessions.prepare(SessionId('never-announced'))
  1580. const detachUnannounced = ctx.sessions.enter(unannounced)
  1581. detachUnannounced()
  1582. expect(heard).toEqual([])
  1583. const announced = ctx.sessions.prepare(SessionId('contained-disposal'))
  1584. const detach = ctx.sessions.enter(announced)
  1585. ctx.sessions.announce(announced)
  1586. expect(() => { detach() }).not.toThrow()
  1587. await Promise.resolve()
  1588. await Promise.resolve()
  1589. expect(heard).toEqual(['contained-disposal'])
  1590. expect(warnings).toEqual([
  1591. 'session "contained-disposal": session/disposed listener threw: Error: sync disposed',
  1592. 'session "contained-disposal": session/disposed listener rejected: Error: async disposed',
  1593. ])
  1594. })
  1595. it('contains internal dispatch failure after session detachment', async () => {
  1596. const ctx = new Context()
  1597. await ctx.plugin(SessionStore)
  1598. const warnings: string[] = []
  1599. ctx.logger.warn = ((message: unknown) => { warnings.push(String(message)) }) as typeof ctx.logger.warn
  1600. const heard: Session[] = []
  1601. ctx.on('internal/dispatch', (_mode, name) => {
  1602. if (name === 'session/disposed') throw new Error('disposed dispatch instrumentation')
  1603. })
  1604. ctx.on('session/disposed', (session) => { heard.push(session) })
  1605. const session = ctx.sessions.prepare(SessionId('disposed-dispatch'))
  1606. const detach = ctx.sessions.enter(session)
  1607. ctx.sessions.announce(session)
  1608. expect(() => { detach() }).not.toThrow()
  1609. expect(ctx.sessions.get(session.id)).toBeUndefined()
  1610. expect(heard).toEqual([])
  1611. expect(warnings).toEqual([
  1612. 'session "disposed-dispatch": session/disposed dispatch threw: Error: disposed dispatch instrumentation',
  1613. ])
  1614. })
  1615. it('does not let internal dispatch replace the disposed callback tuple', async () => {
  1616. const ctx = new Context()
  1617. await ctx.plugin(SessionStore)
  1618. const replacement = Session.create(SessionId('replacement-disposed'))
  1619. const heard: Session[] = []
  1620. ctx.on('internal/dispatch', (_mode, name, args) => {
  1621. if (name === 'session/disposed') args[0] = replacement
  1622. })
  1623. ctx.on('session/disposed', (session) => { heard.push(session) })
  1624. const session = ctx.sessions.prepare(SessionId('fixed-disposed-tuple'))
  1625. const detach = ctx.sessions.enter(session)
  1626. ctx.sessions.announce(session)
  1627. detach()
  1628. expect(heard).toEqual([session])
  1629. })
  1630. })