client-handler.spec.ts 37 KB

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