fake-api.client.ts 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
  1. // Test-local programmable IApiClient fake (NOT the fixture: fixture is a demo
  2. // data source on a real clock; behavior tests need per-case responses and
  3. // deferred-controlled timing). Streams are hand pumps: pushMux/pushHost.
  4. import type {
  5. ClientResponse, HostFrame, IApiClient, ModelSelection, MuxFrame,
  6. RpcError, RpcReceipt, RpcRequest, RpcResponse, SessionId, SessionModels, SessionSearchItem, SkillEntry,
  7. WorkspaceId, WorkspaceView,
  8. } from '@deepseek-ai/dsh-api-remotes/client'
  9. import { RpcId } from '@deepseek-ai/dsh-client-connection/client'
  10. import type { SessionRemotes } from '../src/client/sessions/remotes.ts'
  11. /** Programmable-default workspace row (branded id, ISO-ish times). */
  12. function fakeWorkspace(id: string, over: Partial<WorkspaceView> = {}): WorkspaceView {
  13. return {
  14. workspaceId: id as WorkspaceId,
  15. path: '/f/ws',
  16. title: 'ws',
  17. sessionIds: [],
  18. createdAt: '2026-01-01T00:00:00.000Z',
  19. updatedAt: '2026-01-01T00:00:00.000Z',
  20. ...over,
  21. }
  22. }
  23. export interface Deferred<T> {
  24. promise: Promise<T>
  25. resolve(value: T): void
  26. reject(error: unknown): void
  27. }
  28. /** Test-held settlement: the case decides when an RPC lands (history-pending injections etc.). */
  29. export function deferred<T>(): Deferred<T> {
  30. let resolve!: (value: T) => void
  31. let reject!: (error: unknown) => void
  32. const promise = new Promise<T>((res, rej) => {
  33. resolve = res
  34. reject = rej
  35. })
  36. return { promise, resolve, reject }
  37. }
  38. let nextRpc = 0
  39. export function ok<T>(value: T): RpcResponse<T> {
  40. return { rpcId: RpcId(`fake-${nextRpc++}`), result: { ok: true, value } }
  41. }
  42. export function err<T>(error: RpcError): RpcResponse<T> {
  43. return { rpcId: RpcId(`fake-${nextRpc++}`), result: { ok: false, error } }
  44. }
  45. type StreamItem<F> = { kind: 'frame'; envelope: RpcRequest<F> } | { kind: 'end' } | { kind: 'fail'; error: unknown }
  46. interface StreamConn<F> {
  47. feed(item: StreamItem<F>): void
  48. }
  49. /**
  50. * Commands Remote double: the generated face delivers the carrier's outcome, so
  51. * a test that programs nothing sees an empty catalog and an unmatched line.
  52. * @returns the Remote namespaces the session cluster calls.
  53. */
  54. export function fakeRemote(): SessionRemotes {
  55. return {
  56. commands: {
  57. list: () => Promise.resolve({ ok: true, value: [] }),
  58. execute: () => Promise.resolve({ ok: true, value: undefined }),
  59. },
  60. }
  61. }
  62. export class FakeApiClient implements IApiClient {
  63. /** Chronological call record: [method, payload]. */
  64. readonly calls: { method: string; payload: unknown }[] = []
  65. // Programmable slots (defaults answer OK-empty); reassign per case.
  66. onList: (payload: unknown) => Promise<RpcResponse<{ items: never[] }>> = () => Promise.resolve(ok({ items: [] }))
  67. onSearch: (payload: unknown) => Promise<RpcResponse<{ items: SessionSearchItem[]; hasMore: boolean }>> =
  68. () => Promise.resolve(ok({ items: [], hasMore: false }))
  69. onCreate: (payload: unknown) => Promise<RpcResponse<{ sessionId: SessionId }>> = () => Promise.resolve(ok({ sessionId: 'fk-new' as SessionId }))
  70. readonly defaultModel: ModelSelection = { provider: 'deepseek-official', model: 'deepseek-v4-flash' }
  71. onRename: (payload: unknown) => Promise<RpcResponse<{ title: string; seq: number }>> = () => Promise.resolve(ok({ title: 'fk-renamed', seq: 0 }))
  72. onFork: (payload: unknown) => Promise<RpcResponse<{ sessionId: SessionId }>> = () => Promise.resolve(ok({ sessionId: 'fk-fork' as SessionId }))
  73. onHistory: (payload: { sessionId: SessionId; beforeSeq?: number; maxMessages?: number })
  74. => Promise<RpcResponse<{ events: never[]; hasMore: boolean }>> =
  75. () => Promise.resolve(ok({ events: [], hasMore: false }))
  76. onModels: (payload: unknown) => Promise<RpcResponse<SessionModels>> = () => Promise.resolve(ok({
  77. current: this.defaultModel,
  78. routable: true,
  79. groups: [{
  80. id: 'deepseek-official',
  81. name: 'DeepSeek',
  82. models: [{ id: 'deepseek-v4-flash', name: 'DeepSeek V4 Flash' }],
  83. }],
  84. failures: [],
  85. }))
  86. onSelectModel: (payload: { provider: string; model: string }) =>
  87. Promise<RpcResponse<{ selected: ModelSelection }>> =
  88. payload => Promise.resolve(ok({ selected: { provider: payload.provider, model: payload.model } }))
  89. onPrompt: (payload: unknown) => Promise<RpcResponse<{ accepted: true }>> = () => Promise.resolve(ok({ accepted: true as const }))
  90. onAttachment: (payload: unknown) => Promise<RpcResponse<{ attachment: { attachmentId: never; mediaType: 'image/png'; bytes: number; width: number; height: number }; data: string }>> =
  91. () => Promise.resolve(ok({ attachment: { attachmentId: 'a' as never, mediaType: 'image/png', bytes: 1, width: 1, height: 1 }, data: 'AA==' }))
  92. onUpdateQueue: (payload: unknown) => Promise<RpcResponse<{ accepted: true }>> = () => Promise.resolve(ok({ accepted: true as const }))
  93. onCancel: (payload: unknown) => Promise<RpcResponse<{ accepted: true }>> = () => Promise.resolve(ok({ accepted: true as const }))
  94. onDescribe: (payload: unknown) => Promise<RpcResponse<{
  95. version: string
  96. cwd: string
  97. attachedSessions: number
  98. canOpenPath: boolean
  99. }>> =
  100. () => Promise.resolve(ok({
  101. version: '0-fake', cwd: '/f', attachedSessions: 0, canOpenPath: true,
  102. }))
  103. onPickDirectory: (payload: unknown) => Promise<RpcResponse<{ path: string | null }>> =
  104. () => Promise.resolve(ok({ path: null }))
  105. onOpenPath: (payload: unknown) => Promise<RpcResponse<{ opened: true }>> =
  106. () => Promise.resolve(ok({ opened: true as const }))
  107. onListDirectory: (payload: unknown) => Promise<RpcResponse<{
  108. path: string
  109. home: string
  110. crumbs: { name: string; path: string; hidden: boolean }[]
  111. entries: { name: string; path: string; hidden: boolean }[]
  112. truncated: boolean
  113. }>> =
  114. () => Promise.resolve(ok({ path: '/home/fake', home: '/home/fake', crumbs: [{ name: '/', path: '/', hidden: false }], entries: [], truncated: false }))
  115. onCreateDirectory: (payload: unknown) => Promise<RpcResponse<{ path: string }>> =
  116. () => Promise.resolve(ok({ path: '/home/fake/new' }))
  117. private readonly muxConns: StreamConn<MuxFrame>[] = []
  118. private readonly hostConns: StreamConn<HostFrame>[] = []
  119. lastSearchSignal: AbortSignal | undefined
  120. // Parameters carry local structural annotations: the CI lint lane runs
  121. // without built lib/, so IApiClient's indexed-access types collapse to any
  122. // and inferred parameters would trip no-unsafe-argument.
  123. readonly sessions: IApiClient['sessions'] = {
  124. list: (payload: unknown) => this.record('session.list', payload, this.onList(payload)),
  125. search: (payload: unknown, signal?: AbortSignal) => {
  126. this.lastSearchSignal = signal
  127. return this.record('session.search', payload, this.onSearch(payload))
  128. },
  129. create: (payload: unknown) => this.record('session.create', payload, this.onCreate(payload)),
  130. history: (payload: { sessionId: SessionId; beforeSeq?: number; maxMessages?: number }) =>
  131. this.record('session.history', payload, this.onHistory(payload)),
  132. models: (payload: unknown) => this.record('session.models', payload, this.onModels(payload)),
  133. selectModel: (payload: { provider: string; model: string }) =>
  134. this.record('session.selectModel', payload, this.onSelectModel(payload)),
  135. rename: (payload: unknown) => this.record('session.rename', payload, this.onRename(payload)),
  136. fork: (payload: unknown) => this.record('session.fork', payload, this.onFork(payload)),
  137. prompt: (payload: unknown) => this.record('session.prompt', payload, this.onPrompt(payload)),
  138. attachment: (payload: unknown) => this.record('session.attachment', payload, this.onAttachment(payload)),
  139. updateQueue: (payload: unknown) => this.record('session.updateQueue', payload, this.onUpdateQueue(payload)),
  140. cancel: (payload: unknown) => this.record('session.cancel', payload, this.onCancel(payload)),
  141. }
  142. onSubagentList: (payload: unknown) => Promise<RpcResponse<{ entries: never[]; parentAvailable: boolean }>>
  143. = () => Promise.resolve(ok({ entries: [], parentAvailable: true }))
  144. onSubagentHistory: (payload: unknown) => Promise<RpcResponse<{ events: never[]; hasMore: boolean }>>
  145. = () => Promise.resolve(ok({ events: [], hasMore: false }))
  146. onSubagentPrompt: (payload: unknown) => Promise<RpcResponse<{ messageId: never }>>
  147. = () => Promise.resolve(ok({ messageId: 'fake-message' as never }))
  148. onSubagentInterrupt: (payload: unknown) => Promise<RpcResponse<{ accepted: true }>>
  149. = () => Promise.resolve(ok({ accepted: true as const }))
  150. readonly subagents: IApiClient['subagents'] = {
  151. list: (payload: unknown) => this.record('subagent.list', payload, this.onSubagentList(payload)),
  152. history: (payload: unknown) => this.record('subagent.history', payload, this.onSubagentHistory(payload)),
  153. prompt: (payload: unknown) => this.record('subagent.prompt', payload, this.onSubagentPrompt(payload)),
  154. interrupt: (payload: unknown) => this.record('subagent.interrupt', payload, this.onSubagentInterrupt(payload)),
  155. }
  156. readonly host: IApiClient['host'] = {
  157. describe: (payload: unknown) => this.record('host.describe', payload, this.onDescribe(payload)),
  158. pickDirectory: (payload: unknown) => this.record('host.pickDirectory', payload, this.onPickDirectory(payload)),
  159. listDirectory: (payload: unknown) => this.record('host.listDirectory', payload, this.onListDirectory(payload)),
  160. createDirectory: (payload: unknown) => this.record('host.createDirectory', payload, this.onCreateDirectory(payload)),
  161. openPath: (payload: unknown) => this.record('host.openPath', payload, this.onOpenPath(payload)),
  162. }
  163. // The archive-set field defaults at the binding below so list stubs keep
  164. // the pre-archive `{ items }` shape; a stub carrying the field wins.
  165. onWorkspaceList: (payload: unknown) => Promise<RpcResponse<{ items: never[]; archivedSessionIds?: never[] }>> =
  166. () => Promise.resolve(ok({ items: [] }))
  167. onWorkspaceCreate: (payload: unknown) => Promise<RpcResponse<{ workspace: WorkspaceView; created: boolean }>> =
  168. () => Promise.resolve(ok({ workspace: fakeWorkspace('fk-ws'), created: true }))
  169. onWorkspaceRename: (payload: unknown) => Promise<RpcResponse<{ workspace: WorkspaceView }>> =
  170. () => Promise.resolve(ok({ workspace: fakeWorkspace('fk-ws') }))
  171. onWorkspaceDelete: (payload: unknown) => Promise<RpcResponse<{ deleted: true }>> =
  172. () => Promise.resolve(ok({ deleted: true }))
  173. onWorkspaceInsertBefore: (payload: unknown) => Promise<RpcResponse<{ workspaceIds: WorkspaceId[] }>> =
  174. () => Promise.resolve(ok({ workspaceIds: [] }))
  175. onWorkspaceInsertSessionBefore: (payload: unknown) => Promise<RpcResponse<{ workspace: WorkspaceView }>> =
  176. () => Promise.resolve(ok({ workspace: fakeWorkspace('fk-ws') }))
  177. onWorkspaceArchiveSession: (payload: unknown) => Promise<RpcResponse<{ archivedSessionIds: SessionId[] }>> =
  178. payload => Promise.resolve(ok({ archivedSessionIds: [(payload as { sessionId: SessionId }).sessionId] }))
  179. readonly workspace: IApiClient['workspace'] = {
  180. list: (payload: unknown) => this.record('workspace.list', payload, this.onWorkspaceList(payload).then(response => (
  181. response.result.ok
  182. ? { ...response, result: { ok: true as const, value: { archivedSessionIds: [] as never[], ...response.result.value } } }
  183. : response
  184. )) as ReturnType<IApiClient['workspace']['list']>),
  185. create: (payload: unknown) => this.record('workspace.create', payload, this.onWorkspaceCreate(payload)),
  186. rename: (payload: unknown) => this.record('workspace.rename', payload, this.onWorkspaceRename(payload)),
  187. delete: (payload: unknown) => this.record('workspace.delete', payload, this.onWorkspaceDelete(payload)),
  188. insertBefore: (payload: unknown) =>
  189. this.record('workspace.insertBefore', payload, this.onWorkspaceInsertBefore(payload)),
  190. insertSessionBefore: (payload: unknown) =>
  191. this.record('workspace.insertSessionBefore', payload, this.onWorkspaceInsertSessionBefore(payload)),
  192. archiveSession: (payload: unknown) =>
  193. this.record('workspace.archiveSession', payload, this.onWorkspaceArchiveSession(payload)),
  194. }
  195. // Payloads stay `unknown` (lint-lane note above); response rows are the real
  196. // wire shapes so cases can program requires-bearing catalogs and dual-address
  197. // skill lists without casts.
  198. onSkillList: (payload: unknown) => Promise<RpcResponse<{ skills: SkillEntry[] }>>
  199. = () => Promise.resolve(ok({ skills: [] }))
  200. readonly agentPresets: IApiClient['agentPresets'] = {
  201. list: (payload: unknown) => this.record('agentPreset.list', payload, Promise.resolve(ok({ presets: [], authorable: false, hasDocument: false }))),
  202. select: (payload: { agentPreset: string }) =>
  203. this.record('agentPreset.select', payload, Promise.resolve(ok({ agentPreset: payload.agentPreset }))),
  204. read: (payload: { agentPreset: string }) =>
  205. this.record('agentPreset.read', payload, Promise.resolve(ok({
  206. agentPreset: payload.agentPreset, trust: 'user' as const, content: '',
  207. }))),
  208. copy: (payload: { agentPreset: string }) =>
  209. this.record('agentPreset.copy', payload, Promise.resolve(ok({ agentPreset: payload.agentPreset }))),
  210. openDocument: (payload: { agentPreset: string }) =>
  211. this.record('agentPreset.openDocument', payload, Promise.resolve(ok({ opened: true as const }))),
  212. remove: (payload: { agentPreset: string }) =>
  213. this.record('agentPreset.remove', payload, Promise.resolve(ok({}))),
  214. }
  215. readonly skills: IApiClient['skills'] = {
  216. list: (payload: unknown) => this.record('skill.list', payload, this.onSkillList(payload)),
  217. }
  218. readonly goals: IApiClient['goals'] = {
  219. create: payload => this.record('goal.create', payload, Promise.resolve(ok({ ref: { id: 'fake-goal' as never, revision: 1 } }))),
  220. edit: payload => this.record('goal.edit', payload, Promise.resolve(ok({ ref: { id: 'fake-goal' as never, revision: 1 } }))),
  221. pause: payload => this.record('goal.pause', payload, Promise.resolve(ok({ ref: { id: 'fake-goal' as never, revision: 1 } }))),
  222. resume: payload => this.record('goal.resume', payload, Promise.resolve(ok({ ref: { id: 'fake-goal' as never, revision: 1 } }))),
  223. complete: payload => this.record('goal.complete', payload, Promise.resolve(ok({ ref: { id: 'fake-goal' as never, revision: 1 } }))),
  224. clear: payload => this.record('goal.clear', payload, Promise.resolve(ok({ cleared: true as const }))),
  225. }
  226. readonly settings: IApiClient['settings'] = {
  227. describe: payload => this.record('settings.describe', payload, Promise.resolve(ok({ writable: true, hasDocument: false, namespaces: [] }))),
  228. openDocument: payload => this.record('settings.openDocument', payload, Promise.resolve(ok({ opened: true as const }))),
  229. update: payload => this.record('settings.update', payload, Promise.resolve(ok({ ns: 'fake', schema: {}, value: {}, applies: 'live' as const, secrets: [], revision: 0 }))),
  230. replace: payload => this.record('settings.replace', payload, Promise.resolve(ok({ ns: 'fake', schema: {}, value: {}, applies: 'live' as const, secrets: [], revision: 0 }))),
  231. mutate: payload => this.record('settings.mutate', payload, Promise.resolve(ok({ ns: 'fake', schema: {}, value: {}, applies: 'live' as const, secrets: [], revision: 0 }))),
  232. }
  233. readonly credentials: IApiClient['credentials'] = {
  234. describe: payload => this.record('credentials.describe', payload, Promise.resolve(ok({ credentials: {} }))),
  235. set: payload => this.record('credentials.set', payload, Promise.resolve(ok({}))),
  236. unset: payload => this.record('credentials.unset', payload, Promise.resolve(ok({}))),
  237. }
  238. readonly llm: IApiClient['llm'] = {
  239. providers: payload => this.record('llm.providers', payload, Promise.resolve(ok({ providers: [] }))),
  240. models: payload => this.record('llm.models', payload, Promise.resolve(ok({ groups: [], failures: [] }))),
  241. discoverModels: payload => this.record('llm.discoverModels', payload, Promise.resolve(ok({ models: [] }))),
  242. }
  243. /** When true, streams never fire onOpen (misbehaving-carrier material for the handshake timeout guard). */
  244. suppressStreamOpen = false
  245. /** When true, onOpen callbacks are parked instead of fired; releaseStreamOpens() fires them.
  246. * Lets a case hold the readiness handshake open (describe done, streams not yet "established"). */
  247. holdStreamOpen = false
  248. private heldOpens: (() => void)[] = []
  249. releaseStreamOpens(): void {
  250. const held = this.heldOpens
  251. this.heldOpens = []
  252. for (const fire of held) fire()
  253. }
  254. readonly events: IApiClient['events'] = {
  255. mux: (_payload: unknown, signal: AbortSignal, onOpen?: () => void) => this.openStream(this.muxConns, signal, onOpen),
  256. host: (_payload: unknown, signal: AbortSignal, onOpen?: () => void) => this.openStream(this.hostConns, signal, onOpen),
  257. }
  258. onRespond: (message: ClientResponse) => Promise<RpcReceipt> = () => Promise.resolve({ accepted: true })
  259. respond(message: ClientResponse): Promise<RpcReceipt> {
  260. return this.record('respond', message, this.onRespond(message))
  261. }
  262. /** Push one mux frame to every open mux stream (rpcId minted unless pinned by the case). */
  263. pushMux(frame: MuxFrame, rpcId?: string): void {
  264. for (const conn of [...this.muxConns]) conn.feed({ kind: 'frame', envelope: { rpcId: RpcId(rpcId ?? `push-${nextRpc++}`), payload: frame } })
  265. }
  266. pushHost(frame: HostFrame, rpcId?: string): void {
  267. for (const conn of [...this.hostConns]) conn.feed({ kind: 'frame', envelope: { rpcId: RpcId(rpcId ?? `push-${nextRpc++}`), payload: frame } })
  268. }
  269. /** End (clean close) or fail (throw) every open stream — reconnect-path material. */
  270. endStreams(): void {
  271. for (const conn of [...this.muxConns, ...this.hostConns]) conn.feed({ kind: 'end' })
  272. }
  273. failStreams(error: unknown): void {
  274. for (const conn of [...this.muxConns, ...this.hostConns]) conn.feed({ kind: 'fail', error })
  275. }
  276. get openMuxCount(): number {
  277. return this.muxConns.length
  278. }
  279. callsOf(method: string): unknown[] {
  280. return this.calls.filter(c => c.method === method).map(c => c.payload)
  281. }
  282. private record<T>(method: string, payload: unknown, response: Promise<T>): Promise<T> {
  283. this.calls.push({ method, payload })
  284. return response
  285. }
  286. private async *openStream<F>(registry: StreamConn<F>[], signal: AbortSignal, onOpen?: () => void): AsyncGenerator<RpcRequest<F>> {
  287. const inbox: StreamItem<F>[] = []
  288. let wake: (() => void) | null = null
  289. const conn: StreamConn<F> = {
  290. feed: (item) => {
  291. inbox.push(item)
  292. wake?.()
  293. },
  294. }
  295. registry.push(conn)
  296. if (this.holdStreamOpen && onOpen !== undefined) this.heldOpens.push(onOpen)
  297. else if (!this.suppressStreamOpen) onOpen?.()
  298. try {
  299. while (!signal.aborted) {
  300. while (inbox.length > 0) {
  301. const item = inbox.shift() as StreamItem<F>
  302. if (item.kind === 'end') return
  303. if (item.kind === 'fail') throw item.error
  304. yield item.envelope
  305. }
  306. await new Promise<void>((resolve) => {
  307. wake = resolve
  308. signal.addEventListener('abort', () => { resolve() }, { once: true })
  309. })
  310. wake = null
  311. }
  312. } finally {
  313. registry.splice(registry.indexOf(conn), 1)
  314. }
  315. }
  316. }