client-handler.spec.ts 34 KB

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