session.spec.ts 66 KB

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