chatCrossClientSync.test.ts 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
  2. import { createPinia, setActivePinia } from 'pinia'
  3. import type { TranscriptSnapshot } from '@shared/chatTranscript'
  4. import type { RpcEventFrame, RealtimeConnectionState } from '@shared/types'
  5. const wire = vi.hoisted(() => ({
  6. event: undefined as ((e: RpcEventFrame['params']) => void) | undefined,
  7. state: undefined as ((s: RealtimeConnectionState) => void) | undefined,
  8. request: vi.fn(),
  9. clients: [] as any[],
  10. owner: 0,
  11. supported: true,
  12. }))
  13. const api = vi.hoisted(() => ({ messages: vi.fn(), sessions: vi.fn() }))
  14. vi.mock('@/api/realtime', () => ({
  15. RpcError: class extends Error {},
  16. ChatRpcSocket: class {
  17. get transcriptSupported() {
  18. return wire.supported
  19. }
  20. onEvent(f: typeof wire.event) {
  21. wire.event = f
  22. }
  23. onState(f: typeof wire.state) {
  24. wire.state = f
  25. }
  26. async connect() {
  27. wire.state?.('ready')
  28. }
  29. close() {}
  30. async request(...args: unknown[]) {
  31. return wire.request(...args)
  32. }
  33. },
  34. }))
  35. vi.mock('@/api/chatTranscript', () => ({
  36. ChatTranscriptClient: class {
  37. close = vi.fn()
  38. loadOlder = vi.fn()
  39. restore = vi.fn()
  40. run = vi.fn()
  41. constructor(
  42. readonly profile: string,
  43. readonly id: string,
  44. readonly changed: (value: TranscriptSnapshot) => Promise<void>,
  45. readonly failed: (error: Error) => void,
  46. ) {
  47. wire.clients.push(this)
  48. }
  49. },
  50. }))
  51. vi.mock('@/api/sessions', () => ({
  52. getMessages: api.messages,
  53. getSessions: api.sessions,
  54. getSession: vi.fn(),
  55. deleteSession: vi.fn(),
  56. getSessionUnread: vi.fn(),
  57. markSessionRead: vi.fn(),
  58. updateSession: vi.fn(),
  59. requestHistorySync: vi.fn(),
  60. }))
  61. vi.mock('@/api/profiles', () => ({ getModels: vi.fn() }))
  62. vi.mock('@/stores/auth', () => ({
  63. useAuthStore: () => ({
  64. user: { id: `v2-viewer-${wire.owner}` },
  65. activeProfile: { name: 'p' },
  66. status: 'authenticated',
  67. isAuthenticated: true,
  68. }),
  69. }))
  70. import { useChatStore } from '@/stores/chat'
  71. import { ScopedCache } from '@/utils/cache'
  72. function session(id = 's', owned = true) {
  73. return {
  74. id,
  75. profile: 'p',
  76. owned,
  77. source: 'web',
  78. title: id,
  79. messageCount: 0,
  80. toolCallCount: 0,
  81. startedAt: 1,
  82. updatedAt: 1,
  83. }
  84. }
  85. function snapshot(messages: any[], id = 's', extra: Partial<TranscriptSnapshot> = {}): TranscriptSnapshot {
  86. return {
  87. protocol: 'ordinary-chat-transcript-v2',
  88. epoch: 'test',
  89. cursor: 1,
  90. profile: 'p',
  91. sessionId: id,
  92. messages,
  93. session: {},
  94. hasOlder: false,
  95. total: messages.length,
  96. state: 'current',
  97. running: false,
  98. queued: false,
  99. ...extra,
  100. }
  101. }
  102. const answer = (content = '规范正文', extra = {}) => ({
  103. id: 'canonical-answer',
  104. seq: 2,
  105. revision: 1,
  106. source_message_id: 'upstream',
  107. turn_id: 'turn',
  108. role: 'assistant',
  109. content,
  110. status: 'complete',
  111. ...extra,
  112. })
  113. function emit(type: string, payload: any = {}) {
  114. wire.event?.({ type, session_id: 'runtime', profile: 'p', payload })
  115. }
  116. describe('ordinary v2 cross-client store', () => {
  117. let chat: ReturnType<typeof useChatStore>
  118. beforeEach(() => {
  119. setActivePinia(createPinia())
  120. wire.owner++
  121. wire.clients = []
  122. wire.supported = true
  123. wire.request
  124. .mockReset()
  125. .mockResolvedValue({ session_id: 'runtime', stored_session_id: 's', running: false })
  126. api.messages.mockReset().mockResolvedValue({ messages: [], total: 0, returned: 0, hasMore: false })
  127. api.sessions.mockReset().mockResolvedValue({ items: [session()] })
  128. chat = useChatStore()
  129. chat.sessions = [session()]
  130. })
  131. afterEach(() => {
  132. chat.disconnect()
  133. vi.useRealTimers()
  134. })
  135. async function open(id = 's') {
  136. await chat.selectSession(id, 'p')
  137. await vi.waitFor(() => expect(wire.clients.some((c) => c.id === id)).toBe(true))
  138. return wire.clients.filter((c) => c.id === id).at(-1)!
  139. }
  140. it.each(['image_path', 'path', 'ref_path'])('preserves uploaded image %s in pending and canonical messages', async field => {
  141. const client = await open()
  142. const paths = ['/home/user/.hermes/images/照片 one.png', '/tmp/photo-two.png']
  143. let uploaded = 0
  144. wire.request.mockImplementation((method: string) => Promise.resolve(
  145. method === 'image.attach_bytes' ? { [field]: paths[uploaded++] } : {},
  146. ))
  147. await chat.send('查看图片', paths.map((_, index) => new File(['image'], `photo-${index}.png`, { type: 'image/png' })))
  148. const submission = wire.request.mock.calls.find(([method]) => method === 'prompt.submit')![1]
  149. expect(submission.text).toBe([
  150. '查看图片',
  151. `[用户附加图片:photo-0.png]\n@image:${paths[0]}\n[screenshot]`,
  152. `[用户附加图片:photo-1.png]\n@image:${paths[1]}\n[screenshot]`,
  153. ].join('\n\n'))
  154. const pending = chat.messages.find(message => message.role === 'user')!
  155. expect(pending.attachments?.map(file => file.path)).toEqual(paths)
  156. const checkDownloads = () => chat.messages[0]!.attachments?.forEach((file, index) => {
  157. const url = new URL(file.url!, 'https://yaoyao.test')
  158. expect(url.pathname).toBe('/api/files/download')
  159. expect(url.searchParams.get('path')).toBe(paths[index])
  160. expect(url.searchParams.get('profile')).toBe('p')
  161. })
  162. checkDownloads()
  163. await client.changed(snapshot([{
  164. id: 'canonical-image', seq: 1, revision: 1, role: 'user', status: 'complete',
  165. client_message_id: pending.clientMessageId, content: submission.text,
  166. }]))
  167. expect(chat.messages).toHaveLength(1)
  168. expect(chat.messages[0]!.content).toBe('查看图片')
  169. expect(chat.messages[0]!.attachments?.map(file => file.path)).toEqual(paths)
  170. checkDownloads()
  171. })
  172. it('does not fabricate an image path when an older upload response omits it', async () => {
  173. await open()
  174. wire.request.mockResolvedValue({})
  175. await chat.send('', [new File(['image'], 'photo.png', { type: 'image/png' })])
  176. const submission = wire.request.mock.calls.find(([method]) => method === 'prompt.submit')![1]
  177. expect(submission.text).toBe('[用户附加图片:photo.png]\n[screenshot]')
  178. expect(chat.messages[0]!.attachments?.[0]?.url).toBeUndefined()
  179. })
  180. it('keeps a model-switch confirmation through transcript updates and sends after confirmation', async () => {
  181. const client = await open()
  182. const model = { id: 'model-b', name: 'Model B', provider: 'provider-b' }
  183. chat.models = [model]
  184. wire.request.mockImplementation(async (method, params) => {
  185. if (method === 'session.resume') return { session_id: 'runtime', stored_session_id: 's', running: false }
  186. if (method === 'config.set' && params.key === 'model') return params.confirm_expensive_model
  187. ? { value: model.id, scope: 'session' }
  188. : { confirm_required: true, confirm_message: 'Switching this long conversation loses its cached input.' }
  189. return {}
  190. })
  191. await chat.setModel(model)
  192. await expect(chat.send('待发送')).rejects.toThrow('请先确认模型切换')
  193. const confirmation = chat.pendingApproval
  194. expect(confirmation?.message).toContain('cached input')
  195. await client.changed(snapshot([answer()], 's', { pendingApproval: null }))
  196. expect(chat.pendingApproval).toEqual(confirmation)
  197. await chat.respondToApproval(confirmation!.id, 'once')
  198. expect(wire.request).toHaveBeenCalledWith('config.set', expect.objectContaining({
  199. key: 'model', confirm_expensive_model: true,
  200. }))
  201. expect(chat.pendingApproval).toBeUndefined()
  202. wire.request.mockClear()
  203. await chat.send('确认后继续')
  204. expect(wire.request).toHaveBeenCalledWith('prompt.submit', expect.objectContaining({ text: '确认后继续' }), expect.anything(), expect.anything())
  205. expect(wire.request.mock.calls.some(([method, params]) => method === 'config.set' && params.key === 'model')).toBe(false)
  206. })
  207. it('keeps native approvals separate and dismisses a superseded model confirmation', async () => {
  208. const client = await open()
  209. const first = { id: 'model-b', provider: 'provider', name: 'B' }
  210. const second = { id: 'model-c', provider: 'provider', name: 'C' }
  211. wire.request.mockImplementation(async (method, params) => method === 'config.set' && params.key === 'model'
  212. ? { confirm_required: true, confirm_message: `Confirm ${params.value}` } : {})
  213. await chat.setModel(first)
  214. const staleId = chat.pendingApproval!.id
  215. await chat.setModel(second)
  216. const confirmation = chat.pendingApproval!
  217. expect(confirmation.id).not.toBe(staleId)
  218. await client.changed(snapshot([], 's', { pendingApproval: { request_id: 'tool-approval', message: '允许工具' } }))
  219. expect(chat.pendingApproval?.id).toBe(confirmation.id)
  220. wire.request.mockClear()
  221. await chat.respondToApproval(staleId, 'once')
  222. expect(wire.request).not.toHaveBeenCalled()
  223. await chat.respondToApproval(confirmation.id, 'deny')
  224. expect(chat.pendingApproval?.id).toBe('tool-approval')
  225. await chat.respondToApproval('tool-approval', 'once')
  226. expect(wire.request).toHaveBeenCalledWith('approval.respond', expect.objectContaining({ choice: 'once' }))
  227. })
  228. it('renders only canonical messages and ignores raw upstream bodies and completions', async () => {
  229. const client = await open()
  230. await client.changed(snapshot([answer('前半', { status: 'streaming' })], 's', { running: true }))
  231. emit('message.delta', { text: '不应追加' })
  232. emit('message.interim', { text: '不应重复' })
  233. emit('message.complete', { text: '不应替换' })
  234. expect(chat.messages.map((m) => m.content)).toEqual(['前半'])
  235. expect(chat.isStreaming).toBe(true)
  236. await client.changed(snapshot([answer('完整正文', { revision: 2 })], 's', { cursor: 2 }))
  237. expect(chat.messages.map((m) => m.content)).toEqual(['完整正文'])
  238. expect(chat.isStreaming).toBe(false)
  239. expect(api.messages).not.toHaveBeenCalled()
  240. })
  241. it('keeps checkpoint state when a usage update replaces the route during outbox persistence', async () => {
  242. const client = await open()
  243. const original = ScopedCache.prototype.set
  244. let entered!: () => void, release!: () => void
  245. const started = new Promise<void>(resolve => { entered = resolve })
  246. const gate = new Promise<void>(resolve => { release = resolve })
  247. const spy = vi.spyOn(ScopedCache.prototype, 'set').mockImplementation(async function(this: ScopedCache<unknown>, scope, key, value, durable) {
  248. if ((this as unknown as { namespace: string }).namespace === 'ordinary-outbox-v2') {
  249. entered()
  250. await gate
  251. }
  252. await original.call(this, scope, key, value, durable)
  253. })
  254. const saving = client.changed(snapshot([answer('正在处理', { status: 'streaming' })], 's', {
  255. running: true, liveStatus: '正在思考', pendingApproval: { request_id: 'approval-1', message: '请确认' },
  256. }))
  257. try {
  258. await started
  259. wire.event?.({ type: 'session.usage', session_id: 's', profile: 'p', payload: { input_tokens: 7 } })
  260. release()
  261. await saving
  262. expect(chat.messages.map(m => m.content)).toEqual(['正在处理'])
  263. expect(chat.isStreaming).toBe(true)
  264. expect(chat.pendingApproval?.id).toBe('approval-1')
  265. expect(chat.contextUsage?.inputTokens).toBe(7)
  266. } finally {
  267. release()
  268. await saving.catch(() => {})
  269. spy.mockRestore()
  270. }
  271. })
  272. it('does not materialize a resume snapshot beside the canonical reply', async () => {
  273. wire.request.mockResolvedValue({
  274. session_id: 'runtime',
  275. stored_session_id: 's',
  276. running: true,
  277. inflight: { assistant: '旧恢复快照' },
  278. })
  279. const client = await open()
  280. await client.changed(snapshot([answer('当前正文')]))
  281. expect(chat.messages.map((m) => m.content)).toEqual(['当前正文'])
  282. expect(chat.messages[0]!.id).toBe('canonical-answer')
  283. })
  284. it('restores tools and pending interactions from the canonical snapshot', async () => {
  285. const client = await open()
  286. await client.changed(
  287. snapshot(
  288. [
  289. answer('', {
  290. status: 'streaming',
  291. tool_calls: [{ id: 'tool', name: 'terminal', status: 'running' }],
  292. }),
  293. ],
  294. 's',
  295. {
  296. running: true,
  297. pendingApproval: { request_id: 'approval', message: '允许执行' },
  298. pendingClarification: { request_id: 'clarify', question: '请选择' },
  299. },
  300. ),
  301. )
  302. expect(chat.messages[0]!.toolCalls?.[0]?.id).toBe('tool')
  303. expect(chat.pendingApproval?.id).toBe('approval')
  304. expect(chat.pendingClarification?.id).toBe('clarify')
  305. await client.changed(
  306. snapshot([answer()], 's', { cursor: 2, pendingApproval: null, pendingClarification: null }),
  307. )
  308. expect(chat.pendingApproval).toBeUndefined()
  309. expect(chat.pendingClarification).toBeUndefined()
  310. })
  311. it('rejects a closed session callback after switching to another conversation', async () => {
  312. const first = await open()
  313. chat.sessions.push(session('second'))
  314. wire.request.mockResolvedValue({ session_id: 'runtime-2', stored_session_id: 'second' })
  315. const second = await open('second')
  316. await second.changed(snapshot([answer('第二个会话')], 'second'))
  317. await first.changed(snapshot([answer('旧回调')]))
  318. expect(chat.activeSessionId).toBe('second')
  319. expect(chat.messages[0]!.content).toBe('第二个会话')
  320. })
  321. it('does not let a late submit receipt re-open a completed turn or duplicate the user', async () => {
  322. const client = await open()
  323. let accept!: (value: any) => void
  324. wire.request.mockImplementation((method: string) =>
  325. method === 'prompt.submit'
  326. ? new Promise((resolve) => {
  327. accept = resolve
  328. })
  329. : Promise.resolve({}),
  330. )
  331. const sending = chat.send('问题')
  332. await vi.waitFor(() => expect(accept).toBeTypeOf('function'))
  333. const local = chat.messages.find((m) => m.role === 'user')!
  334. await client.changed(
  335. snapshot(
  336. [
  337. {
  338. id: 'canonical-user',
  339. seq: 1,
  340. revision: 2,
  341. source_message_id: 'persisted-user',
  342. client_message_id: local.clientMessageId,
  343. role: 'user',
  344. content: '问题',
  345. status: 'complete',
  346. },
  347. answer(),
  348. ],
  349. 's',
  350. { cursor: 3, running: false },
  351. ),
  352. )
  353. accept({ status: 'streaming' })
  354. await sending
  355. expect(chat.messages.filter((m) => m.role === 'user')).toHaveLength(1)
  356. expect(chat.messages[0]!.stage).toBe('settled')
  357. expect(chat.isStreaming).toBe(false)
  358. })
  359. it('keeps a pending local input during a new generation replacement', async () => {
  360. const client = await open()
  361. let reject!: (error: Error) => void
  362. wire.request.mockImplementation((method: string) =>
  363. method === 'prompt.submit'
  364. ? new Promise((_resolve, r) => {
  365. reject = r
  366. })
  367. : Promise.resolve({}),
  368. )
  369. const sending = chat.send('待确认').catch(() => {})
  370. await vi.waitFor(() => expect(reject).toBeTypeOf('function'))
  371. const local = chat.messages[0]!.id
  372. await client.changed(snapshot([answer('历史重建')], 's', { epoch: 'rebuilt' }))
  373. expect(chat.messages.some((m) => m.id === local)).toBe(true)
  374. reject(new Error('connection lost'))
  375. await sending
  376. })
  377. it('uses transcript pagination without requesting legacy message pages', async () => {
  378. const client = await open()
  379. await client.changed(snapshot([answer()], 's', { hasOlder: true }))
  380. await chat.loadOlder()
  381. expect(client.loadOlder).toHaveBeenCalledOnce()
  382. expect(api.messages).not.toHaveBeenCalled()
  383. })
  384. it('requires v2 and never falls back to legacy history for owned chat', async () => {
  385. wire.supported = false
  386. await expect(chat.selectSession('s', 'p')).rejects.toThrow('升级服务端')
  387. expect(api.messages).not.toHaveBeenCalled()
  388. })
  389. it('keeps read-only native history outside the ordinary transcript', async () => {
  390. chat.sessions = [session('s', false)]
  391. await chat.selectSession('s', 'p')
  392. expect(api.messages).toHaveBeenCalledOnce()
  393. expect(wire.request).not.toHaveBeenCalled()
  394. })
  395. })