client-handler.spec.ts 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443
  1. /**
  2. * Wire-protocol coverage over the isomorphic point: InProcessApiClient →
  3. * toFetchHandler(scripted impl) runs the real envelope wrap/unwrap, zod
  4. * two-level parse, rpcId discipline, and SSE framing with no network and no
  5. * browser. Each case scripts its own minimal ApiProxy.
  6. */
  7. import { describe, expect, it, vi } from 'vitest'
  8. import type { SessionId } from '@deepseek-ai/dsh-session'
  9. import type { ApiProxy, HostFrame, MuxFrame, RpcMessage, RpcRequest, RpcResponse } from '@deepseek-ai/dsh-host-apiproxy'
  10. import { InProcessApiClient, RpcId, toFetchHandler } from '@deepseek-ai/dsh-host-apiproxy'
  11. const sid = (id: string): SessionId => id as SessionId
  12. function ok<T>(request: RpcRequest<unknown>, value: T): Promise<RpcResponse<T>> {
  13. return Promise.resolve({ rpcId: request.rpcId, result: { ok: true, value } })
  14. }
  15. /** Scripted impl: every method resolves an empty-ish OK unless a case overrides it. */
  16. function scriptedApi(overrides: {
  17. sessions?: Partial<ApiProxy['sessions']>
  18. host?: Partial<ApiProxy['host']>
  19. events?: Partial<ApiProxy['events']>
  20. respond?: ApiProxy['respond']
  21. } = {}): ApiProxy {
  22. async function *empty<F>(): AsyncGenerator<RpcRequest<F>> { /* no frames */ }
  23. return {
  24. sessions: {
  25. list: r => ok(r, { items: [] }),
  26. create: r => ok(r, { sessionId: sid('s-new') }),
  27. history: r => ok(r, { events: [], hasMore: false }),
  28. prompt: r => ok(r, { accepted: true as const }),
  29. cancel: r => ok(r, { accepted: true as const }),
  30. ...overrides.sessions,
  31. },
  32. host: { describe: r => ok(r, { version: '0-test', cwd: '/t', attachedSessions: 0 }), ...overrides.host },
  33. workspace: {
  34. list: r => ok(r, { items: [] }),
  35. create: r => ok(r, { workspace: { workspaceId: 'w1' as never, path: '/t', title: 't', sessionIds: [], createdAt: '0', updatedAt: '0' }, created: true }),
  36. rename: r => ok(r, { workspace: { workspaceId: 'w1' as never, path: '/t', title: 't', sessionIds: [], createdAt: '0', updatedAt: '0' } }),
  37. insertSessionBefore: r => ok(r, { workspace: { workspaceId: 'w1' as never, path: '/t', title: 't', sessionIds: [], createdAt: '0', updatedAt: '0' } }),
  38. },
  39. events: { mux: () => empty<MuxFrame>(), host: () => empty<HostFrame>(), ...overrides.events },
  40. respond: overrides.respond ?? (() => Promise.resolve({ accepted: false as const, reason: 'not-pending' as const })),
  41. }
  42. }
  43. function client(api: ApiProxy, timeoutMs?: number): InProcessApiClient {
  44. return new InProcessApiClient(toFetchHandler(api), timeoutMs)
  45. }
  46. describe('unary round trip', () => {
  47. it('carries payload out and value back through the full wire form', async () => {
  48. let seen: RpcRequest<{ cursor?: string }> | undefined
  49. const api = scriptedApi({
  50. sessions: {
  51. list: (r) => {
  52. seen = r
  53. return ok(r, { items: [{ sessionId: sid('s1'), updatedAt: 7, running: false }] })
  54. },
  55. },
  56. })
  57. const response = await client(api).sessions.list({ cursor: 'c1' })
  58. // Impl received the narrow form with a minted id; client returned the same id and value.
  59. expect(seen?.payload).toEqual({ cursor: 'c1' })
  60. expect(seen?.rpcId).toBeTruthy()
  61. expect(response.rpcId).toBe(seen?.rpcId)
  62. expect(response.result).toEqual({ ok: true, value: { items: [{ sessionId: 's1', updatedAt: 7, running: false }] } })
  63. })
  64. it('routes workspace rename and insertSessionBefore through the wire', async () => {
  65. const api = scriptedApi()
  66. const c = client(api)
  67. const renamed = await c.workspace.rename({ workspaceId: 'w1' as never, title: 'next' })
  68. expect(renamed.result.ok).toBe(true)
  69. const blankTitle = await c.workspace.rename({ workspaceId: 'w1' as never, title: ' ' })
  70. expect(blankTitle.result).toMatchObject({ ok: false, error: { code: 'bad-request' } })
  71. const anchored = await c.workspace.insertSessionBefore({ workspaceId: 'w1' as never, sessionId: sid('s1'), beforeSessionId: sid('s2') })
  72. expect(anchored.result.ok).toBe(true)
  73. const appended = await c.workspace.insertSessionBefore({ workspaceId: 'w1' as never, sessionId: sid('s1') })
  74. expect(appended.result.ok).toBe(true)
  75. })
  76. it('passes business errors through as 200 + err result, not a throw', async () => {
  77. const api = scriptedApi({
  78. sessions: {
  79. cancel: r => Promise.resolve({ rpcId: r.rpcId, result: { ok: false, error: { code: 'session-not-found', message: 'nope', details: { sessionId: sid('sx') } } } }),
  80. },
  81. })
  82. const response = await client(api).sessions.cancel({ sessionId: sid('sx') })
  83. expect(response.result).toEqual({ ok: false, error: { code: 'session-not-found', message: 'nope', details: { sessionId: 'sx' } } })
  84. })
  85. it('throws on rpcId echo mismatch', async () => {
  86. const api = scriptedApi({
  87. sessions: { list: () => Promise.resolve({ rpcId: RpcId('forged'), result: { ok: true, value: { items: [] } } }) },
  88. })
  89. await expect(client(api).sessions.list({})).rejects.toThrow(/rpcId mismatch/)
  90. })
  91. it('rejects an invalid payload at the handler as 200 + bad-request with issues', async () => {
  92. const api = scriptedApi()
  93. const response = await client(api).sessions.history({ sessionId: 123 as unknown as SessionId })
  94. expect(response.result.ok).toBe(false)
  95. if (!response.result.ok) {
  96. expect(response.result.error.code).toBe('bad-request')
  97. expect((response.result.error.details as { issues: unknown[] }).issues.length).toBeGreaterThan(0)
  98. }
  99. })
  100. it('rejects a method/path mismatch as bad-request', async () => {
  101. const handler = toFetchHandler(scriptedApi())
  102. const body = { type: 'client-request', rpcId: 'r1', method: 'session.create', payload: {} }
  103. const response = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', body: JSON.stringify(body) })
  104. expect(response.status).toBe(200)
  105. const parsed = await response.json() as { result: { ok: boolean; error?: { code: string; message: string } } }
  106. expect(parsed.result.ok).toBe(false)
  107. expect(parsed.result.error?.code).toBe('bad-request')
  108. expect(parsed.result.error?.message).toMatch(/does not match path/)
  109. })
  110. it('rejects a malformed envelope as bad-request, salvaging the rpcId or falling back to the sentinel', async () => {
  111. const handler = toFetchHandler(scriptedApi())
  112. // No salvageable rpcId → the fixed invalid-request sentinel keeps the response a valid ServerResponse.
  113. const noId = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', body: JSON.stringify({ nonsense: true }) })
  114. expect(noId.status).toBe(200)
  115. const noIdParsed = await noId.json() as { rpcId: string; result: { ok: boolean } }
  116. expect(noIdParsed.result.ok).toBe(false)
  117. expect(noIdParsed.rpcId).toBe('invalid-request')
  118. // A string rpcId in the otherwise-bad body is salvaged for correlation.
  119. const withId = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', body: JSON.stringify({ rpcId: 'salvage-me', nonsense: true }) })
  120. const withIdParsed = await withId.json() as { rpcId: string; result: { ok: boolean } }
  121. expect(withIdParsed.result.ok).toBe(false)
  122. expect(withIdParsed.rpcId).toBe('salvage-me')
  123. })
  124. it('maps carrier failures to HTTP statuses and the client throws transport failure', async () => {
  125. const handler = toFetchHandler(scriptedApi())
  126. // Unknown method → 404.
  127. const notFound = await handler.fetch('http://dsh.internal/api/no.such', { method: 'POST', body: '{}' })
  128. expect(notFound.status).toBe(404)
  129. // Non-JSON body → 400.
  130. const badBody = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', body: '{oops' })
  131. expect(badBody.status).toBe(400)
  132. // Impl crash → 500, and through the client that is a throw, not an err result.
  133. const crashing = scriptedApi({ sessions: { list: () => { throw new Error('impl exploded') } } })
  134. await expect(client(crashing).sessions.list({})).rejects.toThrow(/transport failure .*500/)
  135. })
  136. it('rejects when the transport never resolves within timeoutMs', async () => {
  137. // AbortSignal.timeout is immune to fake timers; a short real timeout keeps this fast.
  138. const never = new InProcessApiClient({
  139. fetch: (_i: RequestInfo | URL, init?: RequestInit) => new Promise<Response>((_resolve, reject) => {
  140. init?.signal?.addEventListener('abort', () => { reject(new Error('aborted by timeout')) })
  141. }),
  142. }, 25)
  143. await expect(never.sessions.list({})).rejects.toThrow()
  144. })
  145. it('aborts a unary call through the caller-supplied external signal', async () => {
  146. // Real-fetch semantics: on abort the rejection is the signal's reason, and the abort
  147. // works even when the transport ignores the signal entirely (hung impl).
  148. const gate = new AbortController()
  149. const hung = new InProcessApiClient({ fetch: () => new Promise<Response>(() => {}) }, 60_000)
  150. const call = hung.sessions.list({}, gate.signal)
  151. gate.abort(new Error('externally aborted'))
  152. await expect(call).rejects.toThrow(/externally aborted/)
  153. })
  154. it('rejects an already-aborted signal before touching the transport, mapping a string reason to an Error', async () => {
  155. let touched = false
  156. const c = new InProcessApiClient({
  157. fetch: () => {
  158. touched = true
  159. return Promise.resolve(new Response('{}'))
  160. },
  161. }, 60_000)
  162. const gate = new AbortController()
  163. gate.abort('gone before start')
  164. await expect(c.sessions.list({}, gate.signal)).rejects.toThrow('gone before start')
  165. expect(touched).toBe(false)
  166. })
  167. it('maps a non-Error, non-string abort reason to the default AbortError message', async () => {
  168. const gate = new AbortController()
  169. const hung = new InProcessApiClient({ fetch: () => new Promise<Response>(() => {}) }, 60_000)
  170. const call = hung.sessions.list({}, gate.signal)
  171. gate.abort(42)
  172. await expect(call).rejects.toThrow('This operation was aborted')
  173. })
  174. it('passes a signal-less doFetch straight through to the handler', async () => {
  175. class Probe extends InProcessApiClient {
  176. direct(url: URL): Promise<Response> {
  177. return this.doFetch(url)
  178. }
  179. }
  180. const probe = new Probe({ fetch: () => Promise.resolve(new Response('raw')) })
  181. const response = await probe.direct(new URL('http://dsh.internal/probe'))
  182. expect(await response.text()).toBe('raw')
  183. })
  184. it('throws on an S→C ok value that fails the method value schema (second-level parse)', async () => {
  185. // Impl echoes rpcId but returns a wrong-shaped value: envelope parse passes, value parse must reject.
  186. const api = scriptedApi({
  187. sessions: { list: r => Promise.resolve({ rpcId: r.rpcId, result: { ok: true, value: { items: 'not-an-array' } } }) as never },
  188. })
  189. await expect(client(api).sessions.list({})).rejects.toThrow()
  190. })
  191. })
  192. describe('workspace domain round trip', () => {
  193. it('routes both workspace methods through their handler rows and value schemas', async () => {
  194. const c = client(scriptedApi())
  195. const list = await c.workspace.list({})
  196. expect(list.result).toEqual({ ok: true, value: { items: [] } })
  197. const created = await c.workspace.create({ path: '/t' })
  198. expect(created.result.ok).toBe(true)
  199. if (created.result.ok) expect(created.result.value.created).toBe(true)
  200. })
  201. it('rejects a create payload violating the exactly-one refine at the handler', async () => {
  202. const response = await client(scriptedApi()).workspace.create({})
  203. expect(response.result.ok).toBe(false)
  204. if (!response.result.ok) expect(response.result.error.code).toBe('bad-request')
  205. })
  206. })
  207. describe('SSE stream path', () => {
  208. it('yields frames in order and skips the comment preamble', async () => {
  209. const frames: MuxFrame[] = [
  210. { type: 'session/subscribed', sessionId: sid('s1'), lastSeq: 3 },
  211. { type: 'stream/error', error: { code: 'internal', message: 'x', details: {} } },
  212. ]
  213. const api = scriptedApi({
  214. events: {
  215. async *mux(request) {
  216. let n = 0
  217. for (const frame of frames) yield { rpcId: RpcId(`push-${n++}-${request.rpcId}`), payload: frame }
  218. },
  219. },
  220. })
  221. const seen: MuxFrame[] = []
  222. for await (const envelope of client(api).events.mux({}, new AbortController().signal)) {
  223. seen.push(envelope.payload)
  224. }
  225. expect(seen).toEqual(frames)
  226. })
  227. it('reassembles frames across arbitrary chunk boundaries', async () => {
  228. // Two SSE frames split so one frame spans chunks and one chunk carries parts of both.
  229. const f1 = { type: 'server-request', rpcId: 'a', method: 'session/subscribed', payload: { type: 'session/subscribed', sessionId: 's1', lastSeq: 1 } }
  230. const f2 = { type: 'server-request', rpcId: 'b', method: 'session/subscribed', payload: { type: 'session/subscribed', sessionId: 's2', lastSeq: 2 } }
  231. const wire = `: connected\n\ndata: ${JSON.stringify(f1)}\n\ndata: ${JSON.stringify(f2)}\n\n`
  232. const cuts = [5, 40, wire.indexOf('data: ', 40) + 3]
  233. const encoder = new TextEncoder()
  234. const doFetch = (): Promise<Response> => Promise.resolve(new Response(new ReadableStream<Uint8Array>({
  235. start(controller) {
  236. let prev = 0
  237. for (const cut of [...cuts, wire.length]) {
  238. controller.enqueue(encoder.encode(wire.slice(prev, cut)))
  239. prev = cut
  240. }
  241. controller.close()
  242. },
  243. }), { status: 200 }))
  244. const chopped = new InProcessApiClient({ fetch: doFetch })
  245. const seen: string[] = []
  246. for await (const envelope of chopped.events.mux({}, new AbortController().signal)) {
  247. seen.push((envelope.payload as { sessionId: string }).sessionId)
  248. expect(envelope.rpcId).toBe(seen.length === 1 ? 'a' : 'b')
  249. }
  250. expect(seen).toEqual(['s1', 's2'])
  251. })
  252. it('emits a stream/error frame then closes when the impl throws mid-stream', async () => {
  253. const api = scriptedApi({
  254. events: {
  255. async *host(request): AsyncGenerator<RpcRequest<HostFrame>> {
  256. yield { rpcId: RpcId(`p-${request.rpcId}`), payload: { type: 'host/session-added', sessionId: sid('s1') } }
  257. throw new Error('impl died mid-stream')
  258. },
  259. },
  260. })
  261. const seen: HostFrame[] = []
  262. for await (const envelope of client(api).events.host({}, new AbortController().signal)) {
  263. seen.push(envelope.payload)
  264. }
  265. expect(seen.map(f => f.type)).toEqual(['host/session-added', 'stream/error'])
  266. const last = seen.at(-1)
  267. if (last?.type === 'stream/error') expect(last.error.message).toMatch(/impl died mid-stream/)
  268. })
  269. it('drops a malformed SSE frame and keeps the stream alive (S→C two-level parse)', async () => {
  270. const good = { type: 'server-request', rpcId: 'g1', method: 'session/subscribed', payload: { type: 'session/subscribed', sessionId: 's1', lastSeq: 1 } }
  271. const badEnvelope = { type: 'server-response', rpcId: 'x' } // wrong quadrant for a stream
  272. const badFrame = { type: 'server-request', rpcId: 'b1', method: 'nope', payload: { type: 'no/such-frame' } }
  273. const wire = [
  274. 'data: {oops', // not JSON
  275. `data: ${JSON.stringify(badEnvelope)}`,
  276. `data: ${JSON.stringify(badFrame)}`,
  277. `data: ${JSON.stringify(good)}`,
  278. ].map(l => `${l}\n\n`).join('')
  279. const doFetch = (): Promise<Response> => Promise.resolve(new Response(new ReadableStream<Uint8Array>({
  280. start(controller) {
  281. controller.enqueue(new TextEncoder().encode(wire))
  282. controller.close()
  283. },
  284. }), { status: 200 }))
  285. const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => undefined)
  286. try {
  287. const seen: MuxFrame[] = []
  288. for await (const envelope of new InProcessApiClient({ fetch: doFetch }).events.mux({}, new AbortController().signal)) {
  289. seen.push(envelope.payload)
  290. }
  291. // The three corrupt frames are reported and skipped; the good one still arrives.
  292. expect(seen).toEqual([{ type: 'session/subscribed', sessionId: 's1', lastSeq: 1 }])
  293. expect(errorSpy.mock.calls.length).toBe(3)
  294. } finally {
  295. errorSpy.mockRestore()
  296. }
  297. })
  298. it('fires onOpen once headers are in, before the first frame, and not on transport failure', async () => {
  299. const api = scriptedApi({
  300. events: {
  301. async *mux(request): AsyncGenerator<RpcRequest<MuxFrame>> {
  302. yield { rpcId: RpcId(`p-${request.rpcId}`), payload: { type: 'session/subscribed', sessionId: sid('s1'), lastSeq: 0 } }
  303. },
  304. },
  305. })
  306. const order: string[] = []
  307. const iterator = client(api).events.mux({}, new AbortController().signal, () => order.push('open'))
  308. expect(order).toEqual([]) // lazy generator: no fetch (and no onOpen) before iteration
  309. for await (const _ of iterator) order.push('frame')
  310. expect(order).toEqual(['open', 'frame'])
  311. // Transport failure path: onOpen must not fire.
  312. const failing = new InProcessApiClient({ fetch: () => Promise.resolve(new Response('down', { status: 503 })) })
  313. const failOrder: string[] = []
  314. await expect((async () => {
  315. for await (const _ of failing.events.mux({}, new AbortController().signal, () => failOrder.push('open'))) { /* unreachable */ }
  316. })()).rejects.toThrow(/transport failure/)
  317. expect(failOrder).toEqual([])
  318. })
  319. it('stops consuming when the caller aborts', async () => {
  320. let implSawAbort = false
  321. const api = scriptedApi({
  322. events: {
  323. async *mux(_request, signal): AsyncGenerator<RpcRequest<MuxFrame>> {
  324. try {
  325. let n = 0
  326. while (true) {
  327. yield { rpcId: RpcId(`p${n}`), payload: { type: 'session/subscribed', sessionId: sid('s1'), lastSeq: n++ } }
  328. await new Promise(resolve => setTimeout(resolve, 5))
  329. if (signal.aborted) return
  330. }
  331. } finally {
  332. implSawAbort = true
  333. }
  334. },
  335. },
  336. })
  337. const abort = new AbortController()
  338. let count = 0
  339. // In-process abort ends the stream (impl returns on signal.aborted); over a real
  340. // network fetch the same abort surfaces as a rejection — both stop the loop.
  341. await (async () => {
  342. for await (const _ of client(api).events.mux({}, abort.signal)) {
  343. if (++count === 2) abort.abort()
  344. }
  345. })().catch(() => undefined)
  346. expect(count).toBe(2)
  347. // Generator teardown may lag the abort by a microtask; poll briefly.
  348. await vi.waitFor(() => { expect(implSawAbort).toBe(true) })
  349. })
  350. })
  351. describe('respond path', () => {
  352. it('round-trips a client-response to a receipt', async () => {
  353. const seen: unknown[] = []
  354. const api = scriptedApi({
  355. respond: (message) => {
  356. seen.push(message)
  357. return Promise.resolve({ accepted: true as const })
  358. },
  359. })
  360. const receipt = await client(api).respond({ type: 'client-response', rpcId: RpcId('req-1'), result: { ok: true, value: { behavior: 'allow' } } })
  361. expect(receipt).toEqual({ accepted: true })
  362. expect(seen).toEqual([{ type: 'client-response', rpcId: 'req-1', result: { ok: true, value: { behavior: 'allow' } } }])
  363. })
  364. it('returns bad-response for a malformed client-response without reaching the impl', async () => {
  365. const respond = vi.fn()
  366. const handler = toFetchHandler(scriptedApi({ respond }))
  367. const response = await handler.fetch('http://dsh.internal/api/respond', { method: 'POST', body: JSON.stringify({ type: 'client-response' }) })
  368. expect(await response.json()).toEqual({ accepted: false, reason: 'bad-response' })
  369. expect(respond).not.toHaveBeenCalled()
  370. })
  371. })
  372. describe('envelope tap', () => {
  373. it('delivers one microtask batch of full forms per unary call', async () => {
  374. const api = scriptedApi()
  375. const tapped = client(api)
  376. const batches: (readonly RpcMessage[])[] = []
  377. tapped.subscribeEnvelopes(batch => batches.push(batch))
  378. await tapped.sessions.list({})
  379. await vi.waitFor(() => { expect(batches.length).toBeGreaterThan(0) })
  380. const all = batches.flat()
  381. expect(all.map(m => m.type)).toEqual(['client-request', 'server-response'])
  382. expect(all[0]?.rpcId).toBe(all[1]?.rpcId)
  383. })
  384. it('isolates a throwing listener and keeps serving the call', async () => {
  385. const api = scriptedApi()
  386. const tapped = client(api)
  387. const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => undefined)
  388. try {
  389. const good: string[] = []
  390. tapped.subscribeEnvelopes(() => { throw new Error('listener bug') })
  391. tapped.subscribeEnvelopes(batch => good.push(...batch.map(m => m.type)))
  392. const response = await tapped.sessions.list({})
  393. expect(response.result.ok).toBe(true)
  394. await vi.waitFor(() => { expect(good).toContain('server-response') })
  395. } finally {
  396. errorSpy.mockRestore()
  397. }
  398. })
  399. it('buffers nothing with zero subscribers and unsubscribes cleanly', async () => {
  400. const api = scriptedApi()
  401. const tapped = client(api)
  402. await tapped.sessions.list({}) // no subscribers: must not accumulate
  403. const batches: (readonly RpcMessage[])[] = []
  404. const unsubscribe = tapped.subscribeEnvelopes(batch => batches.push(batch))
  405. unsubscribe()
  406. await tapped.sessions.list({})
  407. await new Promise(resolve => setTimeout(resolve, 0))
  408. expect(batches).toEqual([])
  409. })
  410. })