client-handler.spec.ts 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767
  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, GoalRef, 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. subagents?: Partial<ApiProxy['subagents']>
  19. host?: Partial<ApiProxy['host']>
  20. commands?: Partial<ApiProxy['commands']>
  21. skills?: Partial<ApiProxy['skills']>
  22. agentPresets?: Partial<ApiProxy['agentPresets']>
  23. events?: Partial<ApiProxy['events']>
  24. goals?: Partial<ApiProxy['goals']>
  25. settings?: Partial<ApiProxy['settings']>
  26. credentials?: Partial<ApiProxy['credentials']>
  27. llm?: Partial<ApiProxy['llm']>
  28. respond?: ApiProxy['respond']
  29. } = {}): ApiProxy {
  30. async function *empty<F>(): AsyncGenerator<RpcRequest<F>> { /* no frames */ }
  31. const err = <T>(r: RpcRequest<unknown>): Promise<RpcResponse<T>> =>
  32. Promise.resolve({ rpcId: r.rpcId, result: { ok: false, error: { code: 'internal' as const, message: 'stub', details: {} } } })
  33. return {
  34. sessions: {
  35. list: r => ok(r, { items: [] }),
  36. search: r => ok(r, { items: [], hasMore: false }),
  37. create: r => ok(r, { sessionId: sid('s-new') }),
  38. history: r => ok(r, {
  39. events: [],
  40. hasMore: false,
  41. modelTarget: { provider: 'deepseek-official', model: 'deepseek-v4-flash' },
  42. }),
  43. models: r => ok(r, {
  44. current: { provider: 'deepseek-official', model: 'deepseek-v4-flash' },
  45. groups: [],
  46. failures: [],
  47. }),
  48. selectModel: r => ok(r, {
  49. selected: { provider: r.payload.provider, model: r.payload.model },
  50. }),
  51. rename: r => ok(r, { title: 'renamed', seq: 0 }),
  52. fork: r => ok(r, { sessionId: sid('s-fork') }),
  53. prompt: r => ok(r, { accepted: true as const }),
  54. updateQueue: r => ok(r, { accepted: true as const }),
  55. cancel: r => ok(r, { accepted: true as const }),
  56. ...overrides.sessions,
  57. },
  58. subagents: {
  59. list: r => ok(r, { entries: [], parentAvailable: false }),
  60. history: r => ok(r, { events: [], hasMore: false }),
  61. prompt: r => ok(r, { messageId: 'message-1' as never }),
  62. ...overrides.subagents,
  63. },
  64. host: {
  65. describe: r => ok(r, { version: '0-test', cwd: '/t', attachedSessions: 0 }),
  66. pickDirectory: r => ok(r, { path: null }),
  67. listDirectory: r => ok(r, { path: '/t', home: '/t', crumbs: [], entries: [], truncated: false }),
  68. createDirectory: r => ok(r, { path: '/t/new' }),
  69. openPath: r => ok(r, { opened: true as const }),
  70. ...overrides.host,
  71. },
  72. workspace: {
  73. list: r => ok(r, { items: [], archivedSessionIds: [] }),
  74. create: r => ok(r, { workspace: { workspaceId: 'w1' as never, path: '/t', title: 't', sessionIds: [], createdAt: '0', updatedAt: '0' }, created: true }),
  75. rename: r => ok(r, { workspace: { workspaceId: 'w1' as never, path: '/t', title: 't', sessionIds: [], createdAt: '0', updatedAt: '0' } }),
  76. delete: r => ok(r, { deleted: true as const }),
  77. insertSessionBefore: r => ok(r, { workspace: { workspaceId: 'w1' as never, path: '/t', title: 't', sessionIds: [], createdAt: '0', updatedAt: '0' } }),
  78. archiveSession: r => ok(r, { archivedSessionIds: [r.payload.sessionId] }),
  79. },
  80. commands: {
  81. list: r => ok(r, { commands: [] }),
  82. execute: r => ok(r, { matched: false }),
  83. ...overrides.commands,
  84. },
  85. skills: { list: r => ok(r, { skills: [] }), ...overrides.skills },
  86. agentPresets: {
  87. list: r => ok(r, { presets: [], authorable: false }),
  88. select: r => ok(r, { agentPreset: r.payload.agentPreset }),
  89. read: r => ok(r, { agentPreset: r.payload.agentPreset, trust: 'user' as const, content: '', writable: true }),
  90. write: r => ok(r, { agentPreset: r.payload.agentPreset }),
  91. remove: r => ok(r, {}),
  92. ...overrides.agentPresets,
  93. },
  94. goals: {
  95. create: err,
  96. edit: err,
  97. pause: err,
  98. resume: err,
  99. complete: err,
  100. clear: err,
  101. ...overrides.goals,
  102. },
  103. settings: {
  104. describe: r => ok(r, { writable: true, hasDocument: false, namespaces: [] }),
  105. openDocument: r => ok(r, { opened: true as const }),
  106. update: err,
  107. replace: err,
  108. mutate: err,
  109. ...overrides.settings,
  110. },
  111. credentials: {
  112. describe: r => ok(r, { credentials: {} }),
  113. set: err,
  114. unset: err,
  115. ...overrides.credentials,
  116. },
  117. llm: {
  118. providers: r => ok(r, { providers: [] }),
  119. models: r => ok(r, { groups: [], failures: [] }),
  120. discoverModels: err,
  121. ...overrides.llm,
  122. },
  123. events: { mux: () => empty<MuxFrame>(), host: () => empty<HostFrame>(), ...overrides.events },
  124. respond: overrides.respond ?? (() => Promise.resolve({ accepted: false as const, reason: 'not-pending' as const })),
  125. }
  126. }
  127. function client(api: ApiProxy, timeoutMs?: number): InProcessApiClient {
  128. return new InProcessApiClient(toFetchHandler(api), timeoutMs)
  129. }
  130. /** Wrap one scripted method to record its invocation into `seen` before responding. */
  131. function recorderInto(seen: { method: string; payload: unknown }[]) {
  132. return <P, V>(method: string, respond: (r: RpcRequest<P>) => Promise<RpcResponse<V>>) =>
  133. (r: RpcRequest<P>): Promise<RpcResponse<V>> => {
  134. seen.push({ method, payload: r.payload })
  135. return respond(r)
  136. }
  137. }
  138. describe('unary round trip', () => {
  139. it('carries payload out and value back through the full wire form', async () => {
  140. let seen: RpcRequest<{ cursor?: string }> | undefined
  141. const api = scriptedApi({
  142. sessions: {
  143. list: (r) => {
  144. seen = r
  145. return ok(r, { items: [{ sessionId: sid('s1'), updatedAt: 7, running: false, blank: false }] })
  146. },
  147. },
  148. })
  149. const response = await client(api).sessions.list({ cursor: 'c1' })
  150. // Impl received the narrow form with a minted id; client returned the same id and value.
  151. expect(seen?.payload).toEqual({ cursor: 'c1' })
  152. expect(seen?.rpcId).toBeTruthy()
  153. expect(response.rpcId).toBe(seen?.rpcId)
  154. expect(response.result).toEqual({ ok: true, value: { items: [{ sessionId: 's1', updatedAt: 7, running: false, blank: false }] } })
  155. })
  156. it('round-trips a trimmed session search query and its bounded result metadata', async () => {
  157. let seen: RpcRequest<{ query: string }> | undefined
  158. const api = scriptedApi({
  159. sessions: {
  160. search: (request) => {
  161. seen = request
  162. return ok(request, {
  163. items: [{ sessionId: sid('s1'), snippet: 'matching message text' }],
  164. hasMore: true,
  165. })
  166. },
  167. },
  168. })
  169. const response = await client(api).sessions.search({ query: ' message text ' })
  170. expect(seen?.payload).toEqual({ query: 'message text' })
  171. expect(response.result).toEqual({
  172. ok: true,
  173. value: {
  174. items: [{ sessionId: 's1', snippet: 'matching message text' }],
  175. hasMore: true,
  176. },
  177. })
  178. })
  179. it('rejects an overlong session-search snippet at the client value boundary', async () => {
  180. const api = scriptedApi({
  181. sessions: {
  182. search: request => ok(request, {
  183. items: [{ sessionId: sid('s1'), snippet: '😀'.repeat(241) }],
  184. hasMore: false,
  185. }),
  186. },
  187. })
  188. await expect(client(api).sessions.search({ query: 'message' }))
  189. .rejects.toThrow(/240 Unicode code points/)
  190. })
  191. it('routes session fork with its optional cut anchor through the wire', async () => {
  192. let seen: RpcRequest<{ sessionId: SessionId; atSeq?: number }> | undefined
  193. const api = scriptedApi({
  194. sessions: {
  195. fork: (request) => {
  196. seen = request
  197. return ok(request, { sessionId: sid('s-child') })
  198. },
  199. },
  200. })
  201. const response = await client(api).sessions.fork({ sessionId: sid('s-parent'), atSeq: 7 })
  202. expect(seen?.payload).toEqual({ sessionId: 's-parent', atSeq: 7 })
  203. expect(response.result).toEqual({ ok: true, value: { sessionId: 's-child' } })
  204. })
  205. it('routes workspace rename, delete, and insertSessionBefore through the wire', async () => {
  206. const api = scriptedApi()
  207. const c = client(api)
  208. const renamed = await c.workspace.rename({ workspaceId: 'w1' as never, title: 'next' })
  209. expect(renamed.result.ok).toBe(true)
  210. const blankTitle = await c.workspace.rename({ workspaceId: 'w1' as never, title: ' ' })
  211. expect(blankTitle.result).toMatchObject({ ok: false, error: { code: 'bad-request' } })
  212. const deleted = await c.workspace.delete({ workspaceId: 'w1' as never })
  213. expect(deleted.result).toEqual({ ok: true, value: { deleted: true } })
  214. const anchored = await c.workspace.insertSessionBefore({ workspaceId: 'w1' as never, sessionId: sid('s1'), beforeSessionId: sid('s2') })
  215. expect(anchored.result.ok).toBe(true)
  216. const appended = await c.workspace.insertSessionBefore({ workspaceId: 'w1' as never, sessionId: sid('s1') })
  217. expect(appended.result.ok).toBe(true)
  218. })
  219. it('passes business errors through as 200 + err result, not a throw', async () => {
  220. const api = scriptedApi({
  221. sessions: {
  222. cancel: r => Promise.resolve({ rpcId: r.rpcId, result: { ok: false, error: { code: 'session-not-found', message: 'nope', details: { sessionId: sid('sx') } } } }),
  223. },
  224. })
  225. const response = await client(api).sessions.cancel({ sessionId: sid('sx') })
  226. expect(response.result).toEqual({ ok: false, error: { code: 'session-not-found', message: 'nope', details: { sessionId: 'sx' } } })
  227. })
  228. it('throws on rpcId echo mismatch', async () => {
  229. const api = scriptedApi({
  230. sessions: { list: () => Promise.resolve({ rpcId: RpcId('forged'), result: { ok: true, value: { items: [] } } }) },
  231. })
  232. await expect(client(api).sessions.list({})).rejects.toThrow(/rpcId mismatch/)
  233. })
  234. it('rejects an invalid payload at the handler as 200 + bad-request with issues', async () => {
  235. const api = scriptedApi()
  236. const response = await client(api).sessions.history({ sessionId: 123 as unknown as SessionId })
  237. expect(response.result.ok).toBe(false)
  238. if (!response.result.ok) {
  239. expect(response.result.error.code).toBe('bad-request')
  240. expect((response.result.error.details as { issues: unknown[] }).issues.length).toBeGreaterThan(0)
  241. }
  242. })
  243. it('rejects a method/path mismatch as bad-request', async () => {
  244. const handler = toFetchHandler(scriptedApi())
  245. const body = { type: 'client-request', rpcId: 'r1', method: 'session.create', payload: {} }
  246. const response = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', headers: { 'content-type': 'application/json' }, body: JSON.stringify(body) })
  247. expect(response.status).toBe(200)
  248. const parsed = await response.json() as { result: { ok: boolean; error?: { code: string; message: string } } }
  249. expect(parsed.result.ok).toBe(false)
  250. expect(parsed.result.error?.code).toBe('bad-request')
  251. expect(parsed.result.error?.message).toMatch(/does not match path/)
  252. })
  253. it('rejects a malformed envelope as bad-request, salvaging the rpcId or falling back to the sentinel', async () => {
  254. const handler = toFetchHandler(scriptedApi())
  255. // No salvageable rpcId → the fixed invalid-request sentinel keeps the response a valid ServerResponse.
  256. const noId = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', headers: { 'content-type': 'application/json' }, body: JSON.stringify({ nonsense: true }) })
  257. expect(noId.status).toBe(200)
  258. const noIdParsed = await noId.json() as { rpcId: string; result: { ok: boolean } }
  259. expect(noIdParsed.result.ok).toBe(false)
  260. expect(noIdParsed.rpcId).toBe('invalid-request')
  261. // A string rpcId in the otherwise-bad body is salvaged for correlation.
  262. const withId = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', headers: { 'content-type': 'application/json' }, body: JSON.stringify({ rpcId: 'salvage-me', nonsense: true }) })
  263. const withIdParsed = await withId.json() as { rpcId: string; result: { ok: boolean } }
  264. expect(withIdParsed.result.ok).toBe(false)
  265. expect(withIdParsed.rpcId).toBe('salvage-me')
  266. })
  267. it('maps carrier failures to HTTP statuses and the client throws transport failure', async () => {
  268. const handler = toFetchHandler(scriptedApi())
  269. // Unknown method → 404.
  270. const notFound = await handler.fetch('http://dsh.internal/api/no.such', { method: 'POST', headers: { 'content-type': 'application/json' }, body: '{}' })
  271. expect(notFound.status).toBe(404)
  272. // Non-JSON body → 400.
  273. const badBody = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', headers: { 'content-type': 'application/json' }, body: '{oops' })
  274. expect(badBody.status).toBe(400)
  275. // Impl crash → 500, and through the client that is a throw, not an err result.
  276. const crashing = scriptedApi({ sessions: { list: () => { throw new Error('impl exploded') } } })
  277. await expect(client(crashing).sessions.list({})).rejects.toThrow(/transport failure .*500/)
  278. })
  279. it('rejects non-JSON media types before executing anything (cross-site simple-request fence)', async () => {
  280. const list = vi.fn((r: RpcRequest<{}>) => ok(r, { items: [] }))
  281. const handler = toFetchHandler(scriptedApi({ sessions: { list } }))
  282. const body = JSON.stringify({ type: 'client-request', rpcId: 'r1', method: 'session.list', payload: {} })
  283. // A "simple" browser POST (text/plain — sent with no CORS preflight) is
  284. // refused at the carrier before the impl runs.
  285. const plain = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', headers: { 'content-type': 'text/plain' }, body })
  286. expect(plain.status).toBe(415)
  287. // A string body with no explicit header defaults to text/plain — same fence.
  288. const unlabelled = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', body })
  289. expect(unlabelled.status).toBe(415)
  290. expect(list).not.toHaveBeenCalled()
  291. // Media-type parameters pass: the fence checks the type, not the exact string.
  292. const charset = await handler.fetch('http://dsh.internal/api/session.list', { method: 'POST', headers: { 'content-type': 'application/json; charset=utf-8' }, body })
  293. expect(charset.status).toBe(200)
  294. expect(list).toHaveBeenCalledTimes(1)
  295. })
  296. it('rejects when the transport never resolves within timeoutMs', async () => {
  297. // AbortSignal.timeout is immune to fake timers; a short real timeout keeps this fast.
  298. const never = new InProcessApiClient({
  299. fetch: (_i: RequestInfo | URL, init?: RequestInit) => new Promise<Response>((_resolve, reject) => {
  300. init?.signal?.addEventListener('abort', () => { reject(new Error('aborted by timeout')) })
  301. }),
  302. }, 25)
  303. await expect(never.sessions.list({})).rejects.toThrow()
  304. })
  305. it('aborts a unary call through the caller-supplied external signal', async () => {
  306. // Real-fetch semantics: on abort the rejection is the signal's reason, and the abort
  307. // works even when the transport ignores the signal entirely (hung impl).
  308. const gate = new AbortController()
  309. const hung = new InProcessApiClient({ fetch: () => new Promise<Response>(() => {}) }, 60_000)
  310. const call = hung.sessions.list({}, gate.signal)
  311. gate.abort(new Error('externally aborted'))
  312. await expect(call).rejects.toThrow(/externally aborted/)
  313. })
  314. it('rejects an already-aborted signal before touching the transport, mapping a string reason to an Error', async () => {
  315. let touched = false
  316. const c = new InProcessApiClient({
  317. fetch: () => {
  318. touched = true
  319. return Promise.resolve(new Response('{}'))
  320. },
  321. }, 60_000)
  322. const gate = new AbortController()
  323. gate.abort('gone before start')
  324. await expect(c.sessions.list({}, gate.signal)).rejects.toThrow('gone before start')
  325. expect(touched).toBe(false)
  326. })
  327. it('maps a non-Error, non-string abort reason to the default AbortError message', async () => {
  328. const gate = new AbortController()
  329. const hung = new InProcessApiClient({ fetch: () => new Promise<Response>(() => {}) }, 60_000)
  330. const call = hung.sessions.list({}, gate.signal)
  331. gate.abort(42)
  332. await expect(call).rejects.toThrow('This operation was aborted')
  333. })
  334. it('passes a signal-less doFetch straight through to the handler', async () => {
  335. class Probe extends InProcessApiClient {
  336. direct(url: URL): Promise<Response> {
  337. return this.doFetch(url)
  338. }
  339. }
  340. const probe = new Probe({ fetch: () => Promise.resolve(new Response('raw')) })
  341. const response = await probe.direct(new URL('http://dsh.internal/probe'))
  342. expect(await response.text()).toBe('raw')
  343. })
  344. it('throws on an S→C ok value that fails the method value schema (second-level parse)', async () => {
  345. // Impl echoes rpcId but returns a wrong-shaped value: envelope parse passes, value parse must reject.
  346. const api = scriptedApi({
  347. sessions: { list: r => Promise.resolve({ rpcId: r.rpcId, result: { ok: true, value: { items: 'not-an-array' } } }) as never },
  348. })
  349. await expect(client(api).sessions.list({})).rejects.toThrow()
  350. })
  351. })
  352. describe('workspace domain round trip', () => {
  353. it('routes both workspace methods through their handler rows and value schemas', async () => {
  354. const c = client(scriptedApi())
  355. const list = await c.workspace.list({})
  356. expect(list.result).toEqual({ ok: true, value: { items: [], archivedSessionIds: [] } })
  357. const created = await c.workspace.create({ path: '/t' })
  358. expect(created.result.ok).toBe(true)
  359. if (created.result.ok) expect(created.result.value.created).toBe(true)
  360. const archivedResponse = await c.workspace.archiveSession({ sessionId: 's-arch' as never })
  361. expect(archivedResponse.result).toEqual({ ok: true, value: { archivedSessionIds: ['s-arch'] } })
  362. })
  363. it('rejects a create payload violating the exactly-one refine at the handler', async () => {
  364. const response = await client(scriptedApi()).workspace.create({})
  365. expect(response.result.ok).toBe(false)
  366. if (!response.result.ok) expect(response.result.error.code).toBe('bad-request')
  367. })
  368. })
  369. describe('SSE stream path', () => {
  370. it('yields frames in order and skips the comment preamble', async () => {
  371. const frames: MuxFrame[] = [
  372. { type: 'session/subscribed', sessionId: sid('s1'), lastSeq: 3 },
  373. { type: 'stream/error', error: { code: 'internal', message: 'x', details: {} } },
  374. ]
  375. const api = scriptedApi({
  376. events: {
  377. async *mux(request) {
  378. let n = 0
  379. for (const frame of frames) yield { rpcId: RpcId(`push-${n++}-${request.rpcId}`), payload: frame }
  380. },
  381. },
  382. })
  383. const seen: MuxFrame[] = []
  384. for await (const envelope of client(api).events.mux({}, new AbortController().signal)) {
  385. seen.push(envelope.payload)
  386. }
  387. expect(seen).toEqual(frames)
  388. })
  389. it('reassembles frames across arbitrary chunk boundaries', async () => {
  390. // Two SSE frames split so one frame spans chunks and one chunk carries parts of both.
  391. const f1 = { type: 'server-request', rpcId: 'a', method: 'session/subscribed', payload: { type: 'session/subscribed', sessionId: 's1', lastSeq: 1 } }
  392. const f2 = { type: 'server-request', rpcId: 'b', method: 'session/subscribed', payload: { type: 'session/subscribed', sessionId: 's2', lastSeq: 2 } }
  393. const wire = `: connected\n\ndata: ${JSON.stringify(f1)}\n\ndata: ${JSON.stringify(f2)}\n\n`
  394. const cuts = [5, 40, wire.indexOf('data: ', 40) + 3]
  395. const encoder = new TextEncoder()
  396. const doFetch = (): Promise<Response> => Promise.resolve(new Response(new ReadableStream<Uint8Array>({
  397. start(controller) {
  398. let prev = 0
  399. for (const cut of [...cuts, wire.length]) {
  400. controller.enqueue(encoder.encode(wire.slice(prev, cut)))
  401. prev = cut
  402. }
  403. controller.close()
  404. },
  405. }), { status: 200 }))
  406. const chopped = new InProcessApiClient({ fetch: doFetch })
  407. const seen: string[] = []
  408. for await (const envelope of chopped.events.mux({}, new AbortController().signal)) {
  409. seen.push((envelope.payload as { sessionId: string }).sessionId)
  410. expect(envelope.rpcId).toBe(seen.length === 1 ? 'a' : 'b')
  411. }
  412. expect(seen).toEqual(['s1', 's2'])
  413. })
  414. it('emits a stream/error frame then closes when the impl throws mid-stream', async () => {
  415. const api = scriptedApi({
  416. events: {
  417. async *host(request): AsyncGenerator<RpcRequest<HostFrame>> {
  418. yield { rpcId: RpcId(`p-${request.rpcId}`), payload: { type: 'host/session-added', sessionId: sid('s1'), blank: true } }
  419. throw new Error('impl died mid-stream')
  420. },
  421. },
  422. })
  423. const seen: HostFrame[] = []
  424. for await (const envelope of client(api).events.host({}, new AbortController().signal)) {
  425. seen.push(envelope.payload)
  426. }
  427. expect(seen.map(f => f.type)).toEqual(['host/session-added', 'stream/error'])
  428. const last = seen.at(-1)
  429. if (last?.type === 'stream/error') expect(last.error.message).toMatch(/impl died mid-stream/)
  430. })
  431. it('drops a malformed SSE frame and keeps the stream alive (S→C two-level parse)', async () => {
  432. const good = { type: 'server-request', rpcId: 'g1', method: 'session/subscribed', payload: { type: 'session/subscribed', sessionId: 's1', lastSeq: 1 } }
  433. const badEnvelope = { type: 'server-response', rpcId: 'x' } // wrong quadrant for a stream
  434. const badFrame = { type: 'server-request', rpcId: 'b1', method: 'nope', payload: { type: 'no/such-frame' } }
  435. const wire = [
  436. 'data: {oops', // not JSON
  437. `data: ${JSON.stringify(badEnvelope)}`,
  438. `data: ${JSON.stringify(badFrame)}`,
  439. `data: ${JSON.stringify(good)}`,
  440. ].map(l => `${l}\n\n`).join('')
  441. const doFetch = (): Promise<Response> => Promise.resolve(new Response(new ReadableStream<Uint8Array>({
  442. start(controller) {
  443. controller.enqueue(new TextEncoder().encode(wire))
  444. controller.close()
  445. },
  446. }), { status: 200 }))
  447. const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => undefined)
  448. try {
  449. const seen: MuxFrame[] = []
  450. for await (const envelope of new InProcessApiClient({ fetch: doFetch }).events.mux({}, new AbortController().signal)) {
  451. seen.push(envelope.payload)
  452. }
  453. // The three corrupt frames are reported and skipped; the good one still arrives.
  454. expect(seen).toEqual([{ type: 'session/subscribed', sessionId: 's1', lastSeq: 1 }])
  455. expect(errorSpy.mock.calls.length).toBe(3)
  456. } finally {
  457. errorSpy.mockRestore()
  458. }
  459. })
  460. it('fires onOpen once headers are in, before the first frame, and not on transport failure', async () => {
  461. const api = scriptedApi({
  462. events: {
  463. async *mux(request): AsyncGenerator<RpcRequest<MuxFrame>> {
  464. yield { rpcId: RpcId(`p-${request.rpcId}`), payload: { type: 'session/subscribed', sessionId: sid('s1'), lastSeq: 0 } }
  465. },
  466. },
  467. })
  468. const order: string[] = []
  469. const iterator = client(api).events.mux({}, new AbortController().signal, () => order.push('open'))
  470. expect(order).toEqual([]) // lazy generator: no fetch (and no onOpen) before iteration
  471. for await (const _ of iterator) order.push('frame')
  472. expect(order).toEqual(['open', 'frame'])
  473. // Transport failure path: onOpen must not fire.
  474. const failing = new InProcessApiClient({ fetch: () => Promise.resolve(new Response('down', { status: 503 })) })
  475. const failOrder: string[] = []
  476. await expect((async () => {
  477. for await (const _ of failing.events.mux({}, new AbortController().signal, () => failOrder.push('open'))) { /* unreachable */ }
  478. })()).rejects.toThrow(/transport failure/)
  479. expect(failOrder).toEqual([])
  480. })
  481. it('stops consuming when the caller aborts', async () => {
  482. let implSawAbort = false
  483. const api = scriptedApi({
  484. events: {
  485. async *mux(_request, signal): AsyncGenerator<RpcRequest<MuxFrame>> {
  486. try {
  487. let n = 0
  488. while (true) {
  489. yield { rpcId: RpcId(`p${n}`), payload: { type: 'session/subscribed', sessionId: sid('s1'), lastSeq: n++ } }
  490. await new Promise(resolve => setTimeout(resolve, 5))
  491. if (signal.aborted) return
  492. }
  493. } finally {
  494. implSawAbort = true
  495. }
  496. },
  497. },
  498. })
  499. const abort = new AbortController()
  500. let count = 0
  501. // In-process abort ends the stream (impl returns on signal.aborted); over a real
  502. // network fetch the same abort surfaces as a rejection — both stop the loop.
  503. await (async () => {
  504. for await (const _ of client(api).events.mux({}, abort.signal)) {
  505. if (++count === 2) abort.abort()
  506. }
  507. })().catch(() => undefined)
  508. expect(count).toBe(2)
  509. // Generator teardown may lag the abort by a microtask; poll briefly.
  510. await vi.waitFor(() => { expect(implSawAbort).toBe(true) })
  511. })
  512. })
  513. describe('goals unary surface', () => {
  514. const ref: GoalRef = { id: 'goal-1' as GoalRef['id'], revision: 1 }
  515. /** The `{ ref }` acknowledgement every non-clear mutation answers (state travels on the projection). */
  516. const ack = { ref: { id: 'goal-1' as GoalRef['id'], revision: 2 } }
  517. it('round-trips every goal method with its own payload and value shape', async () => {
  518. const seen: { method: string; payload: unknown }[] = []
  519. const record = recorderInto(seen)
  520. const api = scriptedApi({
  521. goals: {
  522. create: record('goal.create', r => ok(r, ack)),
  523. edit: record('goal.edit', r => ok(r, { ref: { ...ack.ref, revision: 3 } })),
  524. pause: record('goal.pause', r => ok(r, ack)),
  525. resume: record('goal.resume', r => ok(r, ack)),
  526. complete: record('goal.complete', r => ok(r, ack)),
  527. clear: record('goal.clear', r => ok(r, { cleared: true as const })),
  528. },
  529. })
  530. const c = client(api)
  531. const created = await c.goals.create({ sessionId: sid('s1'), objective: 'ship it', maxGoalRounds: 4 })
  532. expect(created.result).toEqual({ ok: true, value: ack })
  533. const edited = await c.goals.edit({ sessionId: sid('s1'), ref, objective: 'ship v2' })
  534. expect(edited.result).toEqual({ ok: true, value: { ref: { ...ack.ref, revision: 3 } } })
  535. expect((await c.goals.pause({ sessionId: sid('s1'), ref })).result).toEqual({ ok: true, value: ack })
  536. expect((await c.goals.resume({ sessionId: sid('s1'), ref })).result).toEqual({ ok: true, value: ack })
  537. expect((await c.goals.complete({ sessionId: sid('s1'), ref })).result).toEqual({ ok: true, value: ack })
  538. const cleared = await c.goals.clear({ sessionId: sid('s1'), ref })
  539. expect(cleared.result).toEqual({ ok: true, value: { cleared: true } })
  540. // The handler dispatched each call through its own route row: payload parsed per method.
  541. expect(seen.map(s => s.method)).toEqual(['goal.create', 'goal.edit', 'goal.pause', 'goal.resume', 'goal.complete', 'goal.clear'])
  542. expect(seen[0]?.payload).toEqual({ sessionId: 's1', objective: 'ship it', maxGoalRounds: 4 })
  543. expect(seen[1]?.payload).toEqual({ sessionId: 's1', ref, objective: 'ship v2' })
  544. })
  545. it('passes business errors through as results, not throws', async () => {
  546. // Default scripted goals impl answers an err result: it must arrive as a result, not a throw.
  547. const failed = await client(scriptedApi()).goals.pause({ sessionId: sid('s1'), ref })
  548. expect(failed.result.ok).toBe(false)
  549. if (!failed.result.ok) expect(failed.result.error.code).toBe('internal')
  550. })
  551. it('rejects an invalid goal payload at the handler as bad-request', async () => {
  552. const response = await client(scriptedApi()).goals.create({ sessionId: sid('s1'), objective: '' })
  553. expect(response.result.ok).toBe(false)
  554. if (!response.result.ok) expect(response.result.error.code).toBe('bad-request')
  555. let editCalls = 0
  556. const api = scriptedApi({ goals: { edit: (r) => { editCalls++; return ok(r, ack) } } })
  557. const emptyEdit = await client(api).goals.edit({ sessionId: sid('s1'), ref })
  558. expect(emptyEdit.result.ok).toBe(false)
  559. if (!emptyEdit.result.ok) expect(emptyEdit.result.error.code).toBe('bad-request')
  560. expect(editCalls).toBe(0)
  561. })
  562. })
  563. describe('respond path', () => {
  564. it('round-trips a client-response to a receipt', async () => {
  565. const seen: unknown[] = []
  566. const api = scriptedApi({
  567. respond: (message) => {
  568. seen.push(message)
  569. return Promise.resolve({ accepted: true as const })
  570. },
  571. })
  572. const receipt = await client(api).respond({ type: 'client-response', rpcId: RpcId('req-1'), result: { ok: true, value: { behavior: 'allow' } } })
  573. expect(receipt).toEqual({ accepted: true })
  574. expect(seen).toEqual([{ type: 'client-response', rpcId: 'req-1', result: { ok: true, value: { behavior: 'allow' } } }])
  575. })
  576. it('returns bad-response for a malformed client-response without reaching the impl', async () => {
  577. const respond = vi.fn()
  578. const handler = toFetchHandler(scriptedApi({ respond }))
  579. const response = await handler.fetch('http://dsh.internal/api/respond', { method: 'POST', headers: { 'content-type': 'application/json' }, body: JSON.stringify({ type: 'client-response' }) })
  580. expect(await response.json()).toEqual({ accepted: false, reason: 'bad-response' })
  581. expect(respond).not.toHaveBeenCalled()
  582. })
  583. })
  584. describe('envelope tap', () => {
  585. it('delivers one microtask batch of full forms per unary call', async () => {
  586. const api = scriptedApi()
  587. const tapped = client(api)
  588. const batches: (readonly RpcMessage[])[] = []
  589. tapped.subscribeEnvelopes(batch => batches.push(batch))
  590. await tapped.sessions.list({})
  591. await vi.waitFor(() => { expect(batches.length).toBeGreaterThan(0) })
  592. const all = batches.flat()
  593. expect(all.map(m => m.type)).toEqual(['client-request', 'server-response'])
  594. expect(all[0]?.rpcId).toBe(all[1]?.rpcId)
  595. })
  596. it('isolates a throwing listener and keeps serving the call', async () => {
  597. const api = scriptedApi()
  598. const tapped = client(api)
  599. const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => undefined)
  600. try {
  601. const good: string[] = []
  602. tapped.subscribeEnvelopes(() => { throw new Error('listener bug') })
  603. tapped.subscribeEnvelopes(batch => good.push(...batch.map(m => m.type)))
  604. const response = await tapped.sessions.list({})
  605. expect(response.result.ok).toBe(true)
  606. await vi.waitFor(() => { expect(good).toContain('server-response') })
  607. } finally {
  608. errorSpy.mockRestore()
  609. }
  610. })
  611. it('buffers nothing with zero subscribers and unsubscribes cleanly', async () => {
  612. const api = scriptedApi()
  613. const tapped = client(api)
  614. await tapped.sessions.list({}) // no subscribers: must not accumulate
  615. const batches: (readonly RpcMessage[])[] = []
  616. const unsubscribe = tapped.subscribeEnvelopes(batch => batches.push(batch))
  617. unsubscribe()
  618. await tapped.sessions.list({})
  619. await new Promise(resolve => setTimeout(resolve, 0))
  620. expect(batches).toEqual([])
  621. })
  622. })
  623. describe('config unary surface', () => {
  624. it('round-trips every settings/credentials/llm method with its own payload and value shape', async () => {
  625. const seen: { method: string; payload: unknown }[] = []
  626. const record = recorderInto(seen)
  627. const view = {
  628. ns: 'llm-deepseek',
  629. schema: { uid: 1, refs: { 1: { type: 'object' } } },
  630. value: { baseURL: 'https://next' },
  631. user: { baseURL: 'https://next' },
  632. applies: 'live' as const,
  633. secrets: [{ path: ['apiKey'], set: true }],
  634. revision: 0,
  635. }
  636. const providerRow = {
  637. provider: 'openai',
  638. displayName: 'openai',
  639. settingsNs: 'llm-pi-ai',
  640. settingsPath: ['providers', 'openai'],
  641. active: false,
  642. }
  643. const group = { id: 'deepseek-official', name: 'DeepSeek', models: [{ id: 'deepseek-v4-flash', name: 'Flash' }] }
  644. const api = scriptedApi({
  645. settings: {
  646. describe: record('settings.describe', r => ok(r, { writable: true, hasDocument: false, namespaces: [view] })),
  647. openDocument: record('settings.openDocument', r => ok(r, { opened: true as const })),
  648. update: record('settings.update', r => ok(r, view)),
  649. replace: record('settings.replace', r => ok(r, view)),
  650. mutate: record('settings.mutate', r => ok(r, view)),
  651. },
  652. credentials: {
  653. describe: record('credentials.describe', r => ok(r, { credentials: { OPENAI_API_KEY: { configured: true, source: 'file', writable: true } } })),
  654. set: record('credentials.set', r => ok(r, {})),
  655. unset: record('credentials.unset', r => ok(r, {})),
  656. },
  657. llm: {
  658. providers: record('llm.providers', r => ok(r, { providers: [providerRow] })),
  659. models: record('llm.models', r => ok(r, { groups: [group], failures: [] })),
  660. discoverModels: record('llm.discoverModels', r => ok(r, { models: [{ id: 'acme-large', contextWindow: 65536 }] })),
  661. },
  662. })
  663. const c = client(api)
  664. const described = await c.settings.describe({})
  665. expect(described.result).toEqual({ ok: true, value: { writable: true, hasDocument: false, namespaces: [view] } })
  666. expect((await c.settings.openDocument({})).result).toEqual({ ok: true, value: { opened: true } })
  667. const updated = await c.settings.update({ ns: 'llm-deepseek', patch: { baseURL: 'https://next' } })
  668. expect(updated.result).toEqual({ ok: true, value: view })
  669. const replaced = await c.settings.replace({ ns: 'llm-deepseek', section: {} })
  670. expect(replaced.result).toEqual({ ok: true, value: view })
  671. const mutated = await c.settings.mutate({
  672. ns: 'llm-deepseek',
  673. ops: [{ op: 'unset', path: ['baseURL'] }],
  674. expectedRevision: 0,
  675. })
  676. expect(mutated.result).toEqual({ ok: true, value: view })
  677. const creds = await c.credentials.describe({ refs: ['OPENAI_API_KEY'] })
  678. expect(creds.result).toEqual({ ok: true, value: { credentials: { OPENAI_API_KEY: { configured: true, source: 'file', writable: true } } } })
  679. expect((await c.credentials.set({ ref: 'OPENAI_API_KEY', value: 'sk-x' })).result).toEqual({ ok: true, value: {} })
  680. expect((await c.credentials.unset({ ref: 'OPENAI_API_KEY' })).result).toEqual({ ok: true, value: {} })
  681. const providers = await c.llm.providers({})
  682. expect(providers.result).toEqual({ ok: true, value: { providers: [providerRow] } })
  683. const models = await c.llm.models({})
  684. expect(models.result).toEqual({ ok: true, value: { groups: [group], failures: [] } })
  685. const discovered = await c.llm.discoverModels({
  686. settingsNs: 'llm-pi-ai',
  687. baseURL: 'https://gateway.acme.example/v1',
  688. api: 'openai-completions',
  689. apiKey: 'probe-key',
  690. })
  691. expect(discovered.result).toEqual({ ok: true, value: { models: [{ id: 'acme-large', contextWindow: 65536 }] } })
  692. expect(seen.map(call => call.method)).toEqual([
  693. 'settings.describe', 'settings.openDocument', 'settings.update', 'settings.replace', 'settings.mutate',
  694. 'credentials.describe', 'credentials.set', 'credentials.unset',
  695. 'llm.providers', 'llm.models', 'llm.discoverModels',
  696. ])
  697. expect(seen[2]?.payload).toEqual({ ns: 'llm-deepseek', patch: { baseURL: 'https://next' } })
  698. expect(seen[4]?.payload)
  699. .toEqual({ ns: 'llm-deepseek', ops: [{ op: 'unset', path: ['baseURL'] }], expectedRevision: 0 })
  700. expect(seen[6]?.payload).toEqual({ ref: 'OPENAI_API_KEY', value: 'sk-x' })
  701. // The draft crosses whole, credential included: the host needs it for this
  702. // one interrogation and stores none of it.
  703. expect(seen[10]?.payload).toEqual({
  704. settingsNs: 'llm-pi-ai',
  705. baseURL: 'https://gateway.acme.example/v1',
  706. api: 'openai-completions',
  707. apiKey: 'probe-key',
  708. })
  709. })
  710. it('rejects an invalid credential reference name at the carrier boundary', async () => {
  711. const api = scriptedApi()
  712. const response = await client(api).credentials.set({ ref: 'not a var', value: 'x' })
  713. expect(response.result.ok).toBe(false)
  714. if (response.result.ok) throw new Error('unreachable')
  715. expect(response.result.error.code).toBe('bad-request')
  716. })
  717. })