session.spec.ts 69 KB

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