test-remote.ts 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  1. /** Test-only direct Remote face over the Session Controller's internal controllers. */
  2. import { SessionLogOffset } from '@deepseek-ai/dsh-session'
  3. import type { Context } from '@deepseek-ai/cordis'
  4. import type { ModelSelection as AgentModelSelection } from '@deepseek-ai/dsh-agent'
  5. import type { SessionEvent, SessionHeader, SessionId } from '@deepseek-ai/dsh-session'
  6. import {
  7. SessionPersistenceNotFoundError,
  8. SessionPersistenceRevision,
  9. SessionReadOnlyError,
  10. type SessionAccess,
  11. type SessionHandle,
  12. type SessionHandleReadOptions,
  13. type SessionPersistenceListOptions,
  14. type SessionPersistenceOpenOptions,
  15. type SessionPersistenceSnapshot,
  16. type SessionPersistenceStatOptions,
  17. } from '@deepseek-ai/dsh-session-persistence'
  18. import SessionProjectionRegistry from '@deepseek-ai/dsh-session-projection'
  19. import SessionQueryEngine from '@deepseek-ai/dsh-session-query'
  20. import { vi } from 'vitest'
  21. import {
  22. RemoteError,
  23. remoteErrorOf,
  24. type RemoteResult,
  25. } from '@deepseek-ai/dsh-typert-protocol'
  26. import SessionController from '../src/index.ts'
  27. import type {
  28. ModelCatalog,
  29. SessionAttachmentRequest,
  30. SessionAttachmentValue,
  31. SessionCancelRequest,
  32. SessionCancelValue,
  33. SessionControlFrame,
  34. SessionCreateRequest,
  35. SessionCreateValue,
  36. SessionEditRequest,
  37. SessionEditValue,
  38. SessionForkRequest,
  39. SessionForkValue,
  40. SessionFollowFrame,
  41. SessionFollowRequest,
  42. SessionListRequest,
  43. SessionListValue,
  44. SessionOpenWorkspacePathRequest,
  45. SessionOpenWorkspacePathValue,
  46. SessionPage,
  47. SessionPageRequest,
  48. SessionPromptRequest,
  49. SessionPromptValue,
  50. SessionRenameRequest,
  51. SessionRenameValue,
  52. SessionSearchRequest,
  53. SessionSearchValue,
  54. SessionSelectModelRequest,
  55. SessionSelectModelValue,
  56. SessionUpdateQueueRequest,
  57. SessionUpdateQueueValue,
  58. } from '../src/types.ts'
  59. /** Direct test face matching the generated `ctx.remote.session` unary methods. */
  60. export interface TestSessionRemote {
  61. canOpenWorkspacePath(): Promise<RemoteResult<boolean>>
  62. list(request: SessionListRequest, signal?: AbortSignal): Promise<RemoteResult<SessionListValue>>
  63. search(request: SessionSearchRequest, signal?: AbortSignal): Promise<RemoteResult<SessionSearchValue>>
  64. create(request: SessionCreateRequest): Promise<RemoteResult<SessionCreateValue>>
  65. selectModel(request: SessionSelectModelRequest): Promise<RemoteResult<SessionSelectModelValue>>
  66. modelCatalog(): Promise<RemoteResult<ModelCatalog>>
  67. rename(request: SessionRenameRequest): Promise<RemoteResult<SessionRenameValue>>
  68. fork(request: SessionForkRequest): Promise<RemoteResult<SessionForkValue>>
  69. prompt(request: SessionPromptRequest, signal?: AbortSignal): Promise<RemoteResult<SessionPromptValue>>
  70. edit(request: SessionEditRequest, signal?: AbortSignal): Promise<RemoteResult<SessionEditValue>>
  71. attachment(request: SessionAttachmentRequest): Promise<RemoteResult<SessionAttachmentValue>>
  72. updateQueue(request: SessionUpdateQueueRequest): Promise<RemoteResult<SessionUpdateQueueValue>>
  73. cancel(request: SessionCancelRequest): Promise<RemoteResult<SessionCancelValue>>
  74. openWorkspacePath(
  75. request: SessionOpenWorkspacePathRequest,
  76. signal?: AbortSignal,
  77. ): Promise<RemoteResult<SessionOpenWorkspacePathValue>>
  78. page(request: SessionPageRequest, signal?: AbortSignal): Promise<RemoteResult<SessionPage>>
  79. follow(request: SessionFollowRequest, signal?: AbortSignal): AsyncIterable<SessionFollowFrame>
  80. control(signal?: AbortSignal): AsyncIterable<SessionControlFrame>
  81. }
  82. /** Dependencies and policy supplied by a Session Controller unit harness. */
  83. export interface TestSessionRemoteDefaults {
  84. readonly defaultModelSelection: () => AgentModelSelection
  85. readonly cwd: string
  86. readonly coldBlankProbeMaxEvents?: number
  87. readonly coldBlankProbeMaxBytes?: number
  88. readonly nativeOpen?: boolean
  89. readonly saveDefaultModelSelection?: (selection: AgentModelSelection) => void | Promise<void>
  90. readonly openPath?: (path: string, signal: AbortSignal) => Promise<void>
  91. readonly canOpenPath?: () => boolean
  92. }
  93. const installed = new WeakMap<Context, SessionController>()
  94. /** Compact header-and-events point read a persistence double declares per session. */
  95. interface TestSessionInspection {
  96. readonly meta: SessionHeader
  97. readonly events: readonly SessionEvent[]
  98. }
  99. type LegacyTestPersistence = Record<string, unknown> & {
  100. readonly list?: (signal?: AbortSignal) => Promise<readonly SessionHeader[]>
  101. readonly inspect?: (
  102. sessionId: SessionId,
  103. signal?: AbortSignal,
  104. ) => Promise<TestSessionInspection | undefined>
  105. readonly stat?: (
  106. sessionId: SessionId,
  107. options?: SessionPersistenceStatOptions,
  108. ) => Promise<SessionPersistenceSnapshot | undefined>
  109. readonly open?: (
  110. sessionId: SessionId,
  111. access: SessionAccess,
  112. options?: SessionPersistenceOpenOptions,
  113. ) => Promise<SessionHandle>
  114. }
  115. /** One immutable read handle over a double's inspected header and events. */
  116. function testReadHandle(
  117. sessionId: SessionId,
  118. inspection: TestSessionInspection,
  119. ): SessionHandle {
  120. const events = Object.freeze([...inspection.events])
  121. return {
  122. id: sessionId,
  123. header: inspection.meta,
  124. inheritedEventCount: SessionLogOffset(0),
  125. access: 'read',
  126. read: (offset = 0, length?: number, options?: SessionHandleReadOptions) => {
  127. options?.signal?.throwIfAborted()
  128. return Promise.resolve(events.slice(offset, length === undefined ? undefined : offset + length))
  129. },
  130. append: () => Promise.reject(new SessionReadOnlyError(sessionId, 'append')),
  131. flush: () => Promise.reject(new SessionReadOnlyError(sessionId, 'flush')),
  132. close: () => Promise.resolve(),
  133. [Symbol.asyncDispose]: () => Promise.resolve(),
  134. }
  135. }
  136. /**
  137. * Adapt a compact header/inspect persistence double onto the handle-based
  138. * abstract the production readers consume: `list` snapshots wrap the double's
  139. * headers, `stat` derives a metadata-less snapshot from the listing (so the
  140. * cold-blank probe skips unless the double declares its own `stat`), and
  141. * `open` serves immutable read handles over the double's `inspect` result.
  142. */
  143. export function testSessionPersistence(
  144. _ctx: Context,
  145. persistence: LegacyTestPersistence,
  146. ): Record<string, unknown> {
  147. const listHeaders = async (signal?: AbortSignal): Promise<readonly SessionHeader[]> =>
  148. await persistence.list?.(signal) ?? []
  149. const adapted: Record<string, unknown> = {
  150. ...persistence,
  151. list: async (options?: SessionPersistenceListOptions) =>
  152. (await listHeaders(options?.signal)).map(header => ({
  153. header,
  154. revision: SessionPersistenceRevision(`test:${header.id}:list`),
  155. })),
  156. }
  157. if (persistence.stat === undefined) {
  158. adapted.stat = async (
  159. sessionId: SessionId,
  160. options?: SessionPersistenceStatOptions,
  161. ): Promise<SessionPersistenceSnapshot | undefined> => {
  162. options?.signal?.throwIfAborted()
  163. const header = (await listHeaders(options?.signal)).find(listed => listed.id === sessionId)
  164. return header === undefined
  165. ? undefined
  166. : { header, revision: SessionPersistenceRevision(`test:${sessionId}:stat`) }
  167. }
  168. }
  169. if (persistence.open === undefined) {
  170. adapted.open = async (
  171. sessionId: SessionId,
  172. access: SessionAccess,
  173. options?: SessionPersistenceOpenOptions,
  174. ): Promise<SessionHandle> => {
  175. options?.signal?.throwIfAborted()
  176. if (access !== 'read') {
  177. throw new Error(`test persistence double only serves read handles (requested "${access}")`)
  178. }
  179. const inspection = await persistence.inspect?.(sessionId, options?.signal)
  180. if (inspection === undefined) throw new SessionPersistenceNotFoundError(sessionId)
  181. return testReadHandle(sessionId, inspection)
  182. }
  183. }
  184. return adapted
  185. }
  186. /** Concrete point-read query used by Session Controller tests that do not exercise search. */
  187. class TestSessionQuery extends SessionQueryEngine {
  188. override searchSessions(): Promise<never> {
  189. return Promise.reject(new Error('session search is not configured in this test'))
  190. }
  191. override searchEvents(): Promise<never> {
  192. return Promise.reject(new Error('event search is not configured in this test'))
  193. }
  194. }
  195. /** Install the required projection and point-query services for direct controller tests. */
  196. export function installSessionReadTestServices(ctx: Context): void {
  197. if (ctx.get('sessionProjections') === undefined) new SessionProjectionRegistry(ctx)
  198. if (ctx.get('sessionQuery') === undefined) new TestSessionQuery(ctx)
  199. }
  200. function installControllers(
  201. ctx: Context,
  202. defaults: TestSessionRemoteDefaults,
  203. ): SessionController {
  204. const found = installed.get(ctx)
  205. if (found !== undefined) return found
  206. if (ctx.get('typert') === undefined) {
  207. const dispose = (): void => {}
  208. ctx.provide('typert', {
  209. lookups: { configure: () => dispose },
  210. contexts: { configureHost: () => dispose },
  211. } as never)
  212. }
  213. if (ctx.get('agentDefaultModel') === undefined) {
  214. ctx.provide('agentDefaultModel', {
  215. currentSelection: defaults.defaultModelSelection,
  216. saveSelection: async (selection: AgentModelSelection) => {
  217. await defaults.saveDefaultModelSelection?.(selection)
  218. },
  219. } as never)
  220. }
  221. if (ctx.get('llm') === undefined) {
  222. ctx.provide('llm', {
  223. listProviders: () => {
  224. const selection = defaults.defaultModelSelection()
  225. return [{ id: selection.provider, name: selection.provider }]
  226. },
  227. } as never)
  228. }
  229. installSessionReadTestServices(ctx)
  230. const cwd = vi.spyOn(process, 'cwd').mockReturnValue(defaults.cwd)
  231. let controller: SessionController
  232. try {
  233. controller = new SessionController(
  234. ctx,
  235. {
  236. ...defaults.coldBlankProbeMaxEvents === undefined
  237. ? {}
  238. : { coldBlankProbeMaxEvents: defaults.coldBlankProbeMaxEvents },
  239. ...defaults.coldBlankProbeMaxBytes === undefined
  240. ? {}
  241. : { coldBlankProbeMaxBytes: defaults.coldBlankProbeMaxBytes },
  242. ...defaults.nativeOpen === undefined ? {} : { nativeOpen: defaults.nativeOpen },
  243. },
  244. {
  245. ...defaults.openPath === undefined ? {} : { openPath: defaults.openPath },
  246. ...defaults.canOpenPath === undefined ? {} : { canOpenPath: defaults.canOpenPath },
  247. },
  248. )
  249. } finally {
  250. cwd.mockRestore()
  251. }
  252. installed.set(ctx, controller)
  253. return controller
  254. }
  255. /** Build or return the production Session Controller for a direct unit harness. */
  256. export function createSessionTestController(
  257. ctx: Context,
  258. defaults: TestSessionRemoteDefaults,
  259. ): SessionController {
  260. return installControllers(ctx, defaults)
  261. }
  262. function remoteResult<T>(
  263. operation: () => T | Promise<T>,
  264. signal?: AbortSignal,
  265. ): Promise<RemoteResult<T>> {
  266. return Promise.resolve()
  267. .then(operation)
  268. .then(value => ({ ok: true as const, value }))
  269. .catch((error: unknown) => ({
  270. ok: false as const,
  271. error: signal?.aborted === true
  272. ? new RemoteError('gateway/cancelled', 'request was aborted', {})
  273. : remoteErrorOf(error)
  274. ?? new RemoteError(
  275. 'gateway/internal',
  276. error instanceof Error ? error.message : String(error),
  277. {},
  278. ),
  279. }))
  280. }
  281. /** Build the generated Session Remote's unary result semantics without a carrier. */
  282. export function createSessionTestRemote(
  283. ctx: Context,
  284. defaults: TestSessionRemoteDefaults,
  285. ): TestSessionRemote {
  286. const direct = createSessionTestController(ctx, defaults)
  287. return {
  288. canOpenWorkspacePath: () => remoteResult(() => direct.canOpenWorkspacePath()),
  289. list: (request, signal = new AbortController().signal) => remoteResult(
  290. () => direct.list(request, signal),
  291. signal,
  292. ),
  293. search: (request, signal = new AbortController().signal) => remoteResult(
  294. () => direct.search(request, signal),
  295. signal,
  296. ),
  297. create: request => remoteResult(() => direct.create(request)),
  298. selectModel: request => remoteResult(() => direct.selectModel(request)),
  299. modelCatalog: () => remoteResult(() => direct.modelCatalog()),
  300. rename: request => remoteResult(() => direct.rename(request)),
  301. fork: request => remoteResult(() => direct.fork(request)),
  302. prompt: (request, signal = new AbortController().signal) => remoteResult(
  303. () => direct.prompt(request, signal),
  304. signal,
  305. ),
  306. edit: (request, signal = new AbortController().signal) => remoteResult(
  307. () => direct.edit(request, signal),
  308. signal,
  309. ),
  310. attachment: request => remoteResult(() => direct.attachment(request)),
  311. updateQueue: request => remoteResult(() => direct.updateQueue(request)),
  312. cancel: request => remoteResult(() => direct.cancel(request)),
  313. openWorkspacePath: (request, signal = new AbortController().signal) => remoteResult(
  314. () => direct.openWorkspacePath(request, signal),
  315. signal,
  316. ),
  317. page: (request, signal = new AbortController().signal) => remoteResult(
  318. () => direct.page(request, signal),
  319. signal,
  320. ),
  321. follow: (request, signal = new AbortController().signal) => direct.follow(request, signal),
  322. control: (signal = new AbortController().signal) => direct.control(signal),
  323. }
  324. }