client-handler.spec.ts 38 KB

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