codec.spec.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. import { describe, expect, it } from 'vitest'
  2. import { SessionFormatEventCollector } from '@deepseek-ai/dsh-session-format'
  3. import type {
  4. SessionFormatArtifact,
  5. SessionFormatArtifactDecoder,
  6. SessionFormatEvent,
  7. SessionFormatEventRun,
  8. SessionFormatJsonValue,
  9. SessionFormatMigrationContext,
  10. SessionFormatRecovery,
  11. } from '@deepseek-ai/dsh-session-format'
  12. import {
  13. releasedV0SessionFormatCodec,
  14. releasedV1SessionFormatCodec,
  15. } from '../src/index.ts'
  16. const fullHeader = {
  17. type: 'session', version: 1, id: 'codec', createdAt: 1, cwd: '/work', parentSession: 'parent',
  18. seedLength: 0, origin: 'subagent', delegationDepth: 1, agentPreset: 'default',
  19. } as const
  20. const textBlock = { type: 'text', text: 'text' } as const
  21. class DecodedItemCollector implements SessionFormatMigrationContext {
  22. readonly values: Array<SessionFormatEvent | SessionFormatEventRun> = []
  23. emitEvent(event: SessionFormatEvent): void {
  24. this.values.push(event)
  25. }
  26. emitRun(run: SessionFormatEventRun): void {
  27. this.values.push(run)
  28. }
  29. }
  30. function decodeRow(
  31. decoder: SessionFormatArtifactDecoder,
  32. row: SessionFormatJsonValue,
  33. ): Array<SessionFormatEvent | SessionFormatEventRun> {
  34. const output = new DecodedItemCollector()
  35. decoder.decodeRow(row, output)
  36. return output.values
  37. }
  38. function decodeArtifact(
  39. codec: typeof releasedV0SessionFormatCodec,
  40. header: unknown,
  41. rows: readonly unknown[],
  42. recovery: SessionFormatRecovery = 'strict',
  43. ): SessionFormatArtifact {
  44. const decoder = codec.createDecoder(header, recovery)
  45. const context = new SessionFormatEventCollector()
  46. for (const row of rows) decoder.decodeRow(row, context)
  47. return { header: decoder.header, inheritedEventCount: decoder.finish(context), events: context.values }
  48. }
  49. describe('released v0/v1 physical codecs', () => {
  50. it('decodes every physical header field and seeded zero cut', () => {
  51. const decoded = decodeArtifact(releasedV1SessionFormatCodec, fullHeader, [])
  52. expect(decoded).toEqual({
  53. header: {
  54. version: 1, id: 'codec', createdAt: 1, cwd: '/work', parentSession: 'parent',
  55. isSeeded: true, origin: 'subagent', delegationDepth: 1, agentPreset: 'default',
  56. },
  57. inheritedEventCount: 0,
  58. events: [],
  59. })
  60. expect(releasedV0SessionFormatCodec.decodeHeader({ ...fullHeader, version: 0 }))
  61. .toEqual({ ...decoded.header, version: 0 })
  62. })
  63. it.each([
  64. ['non-object', null],
  65. ['extra member', { ...fullHeader, extra: true }],
  66. ['wrong type', { ...fullHeader, type: 'other' }],
  67. ['wrong version', { ...fullHeader, version: 0 }],
  68. ['non-string id', { ...fullHeader, id: 1 }],
  69. ['negative creation', { ...fullHeader, createdAt: -1 }],
  70. ['negative depth', { ...fullHeader, delegationDepth: -1 }],
  71. ['bad cwd', { ...fullHeader, cwd: 1 }],
  72. ['bad parent', { ...fullHeader, parentSession: 1 }],
  73. ['bad preset', { ...fullHeader, agentPreset: 1 }],
  74. ['bad origin', { ...fullHeader, origin: 'other' }],
  75. ])('refuses malformed physical header: %s', (_name, header) => {
  76. expect(() => releasedV1SessionFormatCodec.decodeHeader(header)).toThrow()
  77. })
  78. it('expands valid text, reasoning, and named or unnamed tool-call rows exactly', () => {
  79. const cases = [
  80. [{
  81. type: 'text-chunks', seq0: 0, time0: 1,
  82. data: { turn: 1, step: 2, index: 3, dt: [2], texts: ['a', 'b'] },
  83. }, [
  84. { type: 'assistant/chunk', seq: 0, time: 1, data: {
  85. turn: 1, step: 2, chunk: { type: 'text-delta', index: 3, text: 'a' },
  86. } },
  87. { type: 'assistant/chunk', seq: 1, time: 3, data: {
  88. turn: 1, step: 2, chunk: { type: 'text-delta', index: 3, text: 'b' },
  89. } },
  90. ]],
  91. [{
  92. type: 'reasoning-chunks', seq0: 0, time0: 4,
  93. data: { turn: 2, step: 3, index: 1, dt: [1], texts: ['c', 'd'] },
  94. }, [
  95. { type: 'assistant/chunk', seq: 0, time: 4, data: {
  96. turn: 2, step: 3, chunk: { type: 'reasoning-delta', index: 1, text: 'c' },
  97. } },
  98. { type: 'assistant/chunk', seq: 1, time: 5, data: {
  99. turn: 2, step: 3, chunk: { type: 'reasoning-delta', index: 1, text: 'd' },
  100. } },
  101. ]],
  102. [{
  103. type: 'tool-call-chunks', seq0: 0, time0: 6,
  104. data: { turn: 3, step: 4, index: 2, id: 'call', name: 'read', dt: [1], args: ['{', '}'] },
  105. }, [
  106. { type: 'assistant/chunk', seq: 0, time: 6, data: {
  107. turn: 3, step: 4,
  108. chunk: { type: 'tool-call-delta', index: 2, id: 'call', name: 'read', argumentsDelta: '{' },
  109. } },
  110. { type: 'assistant/chunk', seq: 1, time: 7, data: {
  111. turn: 3, step: 4,
  112. chunk: { type: 'tool-call-delta', index: 2, id: 'call', name: 'read', argumentsDelta: '}' },
  113. } },
  114. ]],
  115. [{
  116. type: 'tool-call-chunks', seq0: 0, time0: 8,
  117. data: { turn: 4, step: 5, index: 0, id: 'call', dt: [], args: ['x'] },
  118. }, [
  119. { type: 'assistant/chunk', seq: 0, time: 8, data: {
  120. turn: 4, step: 5,
  121. chunk: { type: 'tool-call-delta', index: 0, id: 'call', argumentsDelta: 'x' },
  122. } },
  123. ]],
  124. ] as const
  125. for (const [row, expected] of cases) {
  126. const decoder = releasedV1SessionFormatCodec.createDecoder(fullHeader, 'strict')
  127. const item = decodeRow(decoder, row)[0]
  128. if (item === undefined || !('runType' in item)) throw new Error('expected a packed Assistant run')
  129. expect([...(item as SessionFormatEventRun).expand()]).toEqual(expected)
  130. }
  131. })
  132. it.each([
  133. ['row envelope', { type: 'text-chunks', seq0: 0, time0: 1, data: {}, extra: true }],
  134. ['empty payload', { type: 'text-chunks', seq0: 0, time0: 1, data: { turn: 1, step: 0, index: 0, dt: [], texts: [] } }],
  135. ['non-string payload', { type: 'text-chunks', seq0: 0, time0: 1, data: { turn: 1, step: 0, index: 0, dt: [], texts: [1] } }],
  136. ['gap arity', { type: 'reasoning-chunks', seq0: 0, time0: 1, data: { turn: 1, step: 0, index: 0, dt: [], texts: ['a', 'b'] } }],
  137. ['coordinates', { type: 'text-chunks', seq0: 0, time0: 1, data: { turn: '1', step: 0, index: 0, dt: [], texts: ['a'] } }],
  138. ['tool id', { type: 'tool-call-chunks', seq0: 0, time0: 1, data: { turn: 1, step: 0, index: 0, id: 1, dt: [], args: ['a'] } }],
  139. ['tool name', { type: 'tool-call-chunks', seq0: 0, time0: 1, data: { turn: 1, step: 0, index: 0, id: 'id', name: 1, dt: [], args: ['a'] } }],
  140. ['unsafe time sum', { type: 'text-chunks', seq0: 0, time0: Number.MAX_SAFE_INTEGER, data: { turn: 1, step: 0, index: 0, dt: [1], texts: ['a', 'b'] } }],
  141. ])('refuses malformed packed row: %s', (_name, row) => {
  142. expect(() => decodeArtifact(releasedV1SessionFormatCodec, fullHeader, [row])).toThrow()
  143. })
  144. it.each([
  145. ['not array', 'bad'],
  146. ['too many scalar entries', [0, 0]],
  147. ['malformed range', [[0]]],
  148. ['reversed range', [[2, 1]]],
  149. ['range past event', [[0, 3]]],
  150. ['overlapping ranges', [[0, 1], [1, 2]]],
  151. ])('refuses malformed stored source-event ranges: %s', (_name, sourceEventSeqs) => {
  152. const rows = [
  153. { type: 'turn/start', seq: 0, time: 1, data: { turn: 1 } },
  154. { type: 'user/message', seq: 1, time: 2, data: {
  155. id: 'u', role: 'user', content: [{ type: 'text', text: 'x' }], source: { kind: 'user' },
  156. }, sourceEventSeqs, surfaceOp: 'append' },
  157. ]
  158. expect(() => decodeArtifact(releasedV1SessionFormatCodec,
  159. { type: 'session', version: 1, id: 'codec', createdAt: 1, delegationDepth: 0 },
  160. rows,
  161. )).toThrow()
  162. })
  163. it('contains non-SessionFormatError row failures during recoverable scans', () => {
  164. const bad = new Proxy({}, { get: () => { throw new Error('proxy failure') } })
  165. const decoder = releasedV1SessionFormatCodec.createDecoder(
  166. { type: 'session', version: 1, id: 'codec', createdAt: 1, delegationDepth: 0 },
  167. 'recoverable',
  168. )
  169. expect(decodeRow(decoder, bad)).toEqual([])
  170. expect(() => decodeRow(decoder, {
  171. type: 'turn/end', seq: 0, time: 2, data: { turn: 1, reason: { kind: 'completed' } },
  172. })).toThrow('released Session row 0 is malformed')
  173. })
  174. it('streams the same row-atomic recoverable prefix', () => {
  175. const create = (header: unknown) => releasedV1SessionFormatCodec.createDecoder(header, 'recoverable')
  176. const header = { type: 'session', version: 1, id: 'codec', createdAt: 1, delegationDepth: 0 }
  177. const malformed = create(header)
  178. expect(decodeRow(malformed, null)).toEqual([])
  179. const malformedProxy = create(header)
  180. const proxy = new Proxy({}, { get: () => { throw new Error('proxy failure') } })
  181. expect(decodeRow(malformedProxy, proxy)).toEqual([])
  182. expect(decodeRow(malformedProxy, { type: 'step/start', seq: 0, time: 1, data: { turn: 1, step: 1 } })).toEqual([])
  183. expect(() => decodeRow(malformedProxy, {
  184. type: 'turn/end', seq: 0, time: 2, data: { turn: 1, reason: { kind: 'completed' } },
  185. })).toThrow('released Session row 0 is malformed')
  186. const gap = create(header)
  187. expect(decodeRow(gap, { type: 'step/start', seq: 1, time: 1, data: { turn: 1, step: 1 } })).toEqual([])
  188. const terminalGap = create(header)
  189. expect(() => decodeRow(terminalGap, {
  190. type: 'turn/end', seq: 1, time: 2, data: { turn: 1, reason: { kind: 'completed' } },
  191. })).toThrow(/seq gap/)
  192. const seeded = create({ ...header, seedLength: 1 })
  193. expect(() => seeded.finish(new DecodedItemCollector())).toThrow(/inheritedEventCount exceeds/)
  194. const packed = create(header)
  195. const runs = decodeRow(packed, {
  196. type: 'text-chunks', seq0: 0, time0: 1,
  197. data: { turn: 1, step: 1, index: 0, dt: [1], texts: ['a', 'b'] },
  198. })
  199. expect(runs).toHaveLength(1)
  200. expect([...((runs[0] as SessionFormatEventRun).expand())]).toHaveLength(2)
  201. const codec = create(header)
  202. decodeRow(codec, { type: 'turn/start', seq: 0, time: 1, data: { turn: 1 } })
  203. const item = decodeRow(codec, {
  204. type: 'user/message', seq: 1, time: 2,
  205. data: { id: 'm', role: 'user', content: [], source: { kind: 'user' } },
  206. sourceEventSeqs: [0], surfaceOp: 'append',
  207. })[0]
  208. expect(item !== undefined && !('runType' in item) ? item.sourceEventSeqs : undefined).toEqual([0])
  209. })
  210. it('ignores decodable non-terminal rows after the first recoverable issue', () => {
  211. const header = { type: 'session', version: 1, id: 'codec', createdAt: 1, delegationDepth: 0 }
  212. const recovered = decodeArtifact(releasedV1SessionFormatCodec, header, [
  213. { type: 'turn/start', seq: 0, time: 1, data: { turn: 1 } },
  214. { type: 'turn/start', seq: 4, time: 2, data: { turn: 2 } },
  215. { type: 'step/start', seq: 1, time: 3, data: { turn: 1, step: 0 } },
  216. ], 'recoverable')
  217. expect(recovered).toMatchObject({ events: [{ seq: 0 }] })
  218. })
  219. it('rejects strict gaps and a recoverable gap row that itself closes a turn', () => {
  220. const currentHeader = { type: 'session', version: 1, id: 'codec', createdAt: 1, delegationDepth: 0 }
  221. expect(() => decodeArtifact(releasedV1SessionFormatCodec, currentHeader, [
  222. { type: 'turn/start', seq: 1, time: 1, data: { turn: 1 } },
  223. ])).toThrow(/seq gap/)
  224. expect(() => decodeArtifact(releasedV1SessionFormatCodec, currentHeader, [
  225. { type: 'turn/end', seq: 1, time: 1, data: { turn: 1, reason: { kind: 'completed' } } },
  226. ], 'recoverable')).toThrow(/seq gap/)
  227. })
  228. it('refuses overlapping ranges after a valid first range', () => {
  229. const header = { type: 'session', version: 1, id: 'codec', createdAt: 1, delegationDepth: 0 }
  230. const rows = [
  231. { type: 'turn/start', seq: 0, time: 1, data: { turn: 1 } },
  232. { type: 'step/start', seq: 1, time: 2, data: { turn: 1, step: 1 } },
  233. { type: 'step/end', seq: 2, time: 3, data: { turn: 1, step: 1 } },
  234. { type: 'turn/end', seq: 3, time: 4, data: { turn: 1, reason: { kind: 'completed' } } },
  235. {
  236. type: 'user/message', seq: 4, time: 5, surfaceOp: 'append', sourceEventSeqs: [[0, 1], [1, 2]],
  237. data: { id: 'u', role: 'user', content: [textBlock], source: { kind: 'user' } },
  238. },
  239. ]
  240. expect(() => decodeArtifact(releasedV1SessionFormatCodec, header, rows)).toThrow(/strictly increasing/)
  241. })
  242. })