plugin-apply.spec.ts 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375
  1. import { createServer } from 'node:http'
  2. import type { IncomingMessage, Server, ServerResponse } from 'node:http'
  3. import { mkdtemp, rm } from 'node:fs/promises'
  4. import { join } from 'node:path'
  5. import { tmpdir } from 'node:os'
  6. import { PassThrough, Writable } from 'node:stream'
  7. import { afterEach, describe, expect, it, vi } from 'vitest'
  8. import { Context } from '@deepseek-ai/cordis'
  9. import Loader from '@deepseek-ai/cordis-plugin-loader'
  10. import * as agentCore from '@deepseek-ai/dsh-agent-spine-demo'
  11. import { LlmAdapter } from '@deepseek-ai/dsh-llm'
  12. import type { GenerateOptions, StreamChunk } from '@deepseek-ai/dsh-llm'
  13. import JsonlSessionPersistence from '@deepseek-ai/dsh-session-persistence-jsonl'
  14. import * as jsonrpc from '../src/index.ts'
  15. /**
  16. * Mount the real namespace plugin with in-memory stdio and exit hooks. Covers
  17. * the full transport/server path, response-before-exit shutdown exactly once,
  18. * and bare-fiber disposal without process exit.
  19. */
  20. /** One ordered frame, write completion, or exit observation. */
  21. type WireEvent =
  22. | { kind: 'frame'; frame: Record<string, unknown> }
  23. | { kind: 'write-complete'; ids: (string | number)[] }
  24. | { kind: 'root-disposed' }
  25. | { kind: 'exit'; code: number }
  26. interface ApplyHarness {
  27. ctx: Context
  28. /** The plugin fiber used by the bare-dispose case. */
  29. fiber: Awaited<ReturnType<Context['plugin']>>
  30. /** Frames, write completions, and exits in observation order. */
  31. events: WireEvent[]
  32. outputErrors: Error[]
  33. send(frame: Record<string, unknown>): void
  34. sendRaw(text: string): void
  35. frames(): Record<string, unknown>[]
  36. exits(): number[]
  37. waitForFrame(predicate: (frame: Record<string, unknown>) => boolean, description: string): Promise<Record<string, unknown>>
  38. dispose(): Promise<void>
  39. }
  40. /** Adapter whose route registration is the delayed Loader entry's readiness fact. */
  41. class DelayedAdapter extends LlmAdapter {
  42. async * stream(_options: GenerateOptions): AsyncIterable<StreamChunk> {
  43. throw new Error('not exercised')
  44. }
  45. }
  46. /** Poll asynchronous output for up to five seconds. */
  47. async function waitFor<T>(get: () => T | undefined, description: string): Promise<T> {
  48. const deadline = Date.now() + 5000
  49. for (;;) {
  50. const value = get()
  51. if (value !== undefined) return value
  52. if (Date.now() > deadline) throw new Error(`timed out waiting for ${description}`)
  53. await new Promise(resolve => setTimeout(resolve, 5))
  54. }
  55. }
  56. /** Drain asynchronous work before a negative assertion. */
  57. async function settle(): Promise<void> {
  58. await new Promise(resolve => setTimeout(resolve, 25))
  59. }
  60. /** Mount the real plugin on a minimal harness with in-memory stdio and exit. */
  61. async function mountPlugin(
  62. storageDir: string,
  63. options: {
  64. writeDelayMs?: number
  65. failFlush?: boolean
  66. beforeServer?: (ctx: Context) => Promise<void> | void
  67. } = {},
  68. ): Promise<ApplyHarness> {
  69. const ctx = new Context()
  70. await ctx.plugin(agentCore, { workspaceContext: false })
  71. await ctx.plugin(JsonlSessionPersistence, { root: storageDir })
  72. await new Promise(resolve => setTimeout(resolve, 50))
  73. await options.beforeServer?.(ctx)
  74. const input = new PassThrough()
  75. const events: WireEvent[] = []
  76. const outputErrors: Error[] = []
  77. let pendingOutput = ''
  78. // Record frame admission separately from write completion so delayed output
  79. // tests the flush barrier.
  80. const output = new Writable({
  81. write(chunk: Buffer, _encoding, callback) {
  82. const ids: (string | number)[] = []
  83. pendingOutput += chunk.toString('utf8')
  84. for (;;) {
  85. const newline = pendingOutput.indexOf('\n')
  86. if (newline < 0) break
  87. const line = pendingOutput.slice(0, newline).trim()
  88. pendingOutput = pendingOutput.slice(newline + 1)
  89. if (line) {
  90. const frame = JSON.parse(line) as Record<string, unknown>
  91. events.push({ kind: 'frame', frame })
  92. if (typeof frame.id === 'string' || typeof frame.id === 'number') ids.push(frame.id)
  93. }
  94. }
  95. const complete = (): void => {
  96. if (options.failFlush === true && chunk.length === 0) {
  97. callback(new Error('flush callback failed'))
  98. return
  99. }
  100. events.push({ kind: 'write-complete', ids })
  101. callback()
  102. }
  103. if ((options.writeDelayMs ?? 0) > 0) setTimeout(complete, options.writeDelayMs)
  104. else complete()
  105. },
  106. })
  107. output.on('error', (error: Error) => { outputErrors.push(error) })
  108. const exit = (code: number): void => { events.push({ kind: 'exit', code }) }
  109. ctx.effect(() => () => { events.push({ kind: 'root-disposed' }) }, 'jsonrpc test root-disposal witness')
  110. const fiber = await ctx.plugin(jsonrpc, { input, output, exit })
  111. const frames = (): Record<string, unknown>[] =>
  112. events.flatMap(event => event.kind === 'frame' ? [event.frame] : [])
  113. return {
  114. ctx,
  115. fiber,
  116. events,
  117. outputErrors,
  118. send: (frame) => { input.write(`${JSON.stringify(frame)}\n`) },
  119. sendRaw: (text) => { input.write(text) },
  120. frames,
  121. exits: () => events.flatMap(event => event.kind === 'exit' ? [event.code] : []),
  122. waitForFrame: (predicate, description) => waitFor(() => frames().find(predicate), description),
  123. dispose: async () => { await ctx.fiber.dispose() },
  124. }
  125. }
  126. const servers: Server[] = []
  127. afterEach(async () => {
  128. await Promise.all(servers.splice(0).map(server => new Promise(resolve => server.close(resolve))))
  129. vi.unstubAllEnvs()
  130. })
  131. /** Keyless SSE endpoint for completing a prompt turn. */
  132. async function mockCompletionServer(): Promise<{ url: string; requests: unknown[] }> {
  133. const requests: unknown[] = []
  134. const server = createServer((request: IncomingMessage, response: ServerResponse) => {
  135. let body = ''
  136. request.on('data', (chunk: Buffer) => { body += chunk.toString('utf8') })
  137. request.on('end', () => {
  138. requests.push(JSON.parse(body))
  139. response.writeHead(200, { 'content-type': 'text/event-stream' })
  140. response.write('data: {"choices":[{"delta":{"role":"assistant","content":null,"reasoning_content":""}}]}\n\n')
  141. response.write('data: {"choices":[{"delta":{"content":"done"}}]}\n\n')
  142. response.write('data: {"choices":[{"delta":{"content":""},"finish_reason":"stop"}],"usage":{"prompt_tokens":3,"completion_tokens":1}}\n\n')
  143. response.write('data: [DONE]\n\n')
  144. response.end()
  145. })
  146. })
  147. servers.push(server)
  148. await new Promise<void>(resolve => server.listen(0, '127.0.0.1', resolve))
  149. const address = server.address()
  150. if (address === null || typeof address === 'string') throw new Error('no port')
  151. return { url: `http://127.0.0.1:${address.port}`, requests }
  152. }
  153. describe('dsh-sdk-jsonrpc-server plugin apply', () => {
  154. it('serves initialize over the injected stdio pair', async () => {
  155. const storageDir = await mkdtemp(join(tmpdir(), 'dsh-jsonrpc-apply-init-'))
  156. vi.stubEnv('DEEPSEEK_API_KEY', 'test-key')
  157. const harness = await mountPlugin(storageDir)
  158. try {
  159. harness.send({ jsonrpc: '2.0', id: 'init-1', method: 'initialize', params: { cwd: storageDir, provider: 'deepseek-official', model: 'apply-model' } })
  160. const response = await harness.waitForFrame(frame => frame.id === 'init-1', 'initialize response')
  161. expect(response).toEqual({
  162. jsonrpc: '2.0',
  163. id: 'init-1',
  164. result: { serverInfo: { name: 'deepseek-harness-sdk-runtime', version: '0.0.1' } },
  165. })
  166. expect(harness.exits()).toEqual([])
  167. } finally {
  168. await harness.dispose()
  169. await rm(storageDir, { recursive: true, force: true })
  170. }
  171. })
  172. it('waits for Loader-owned adapter registration before initialize', async () => {
  173. const storageDir = await mkdtemp(join(tmpdir(), 'dsh-jsonrpc-apply-readiness-'))
  174. vi.stubEnv('DEEPSEEK_API_KEY', 'test-key')
  175. let markStarted!: () => void
  176. let release!: () => void
  177. const started = new Promise<void>((resolve) => { markStarted = resolve })
  178. const ready = new Promise<void>((resolve) => { release = resolve })
  179. let delayedEntry: Promise<string> | undefined
  180. const harness = await mountPlugin(storageDir, {
  181. beforeServer: async (ctx) => {
  182. await ctx.plugin(Loader)
  183. ctx.loader.builtins['delayed-readiness'] = {
  184. inject: ['llm'],
  185. async apply(entryCtx: Context) {
  186. markStarted()
  187. await ready
  188. entryCtx.llm.registerAdapter(['delayed-private'], new DelayedAdapter())
  189. },
  190. }
  191. delayedEntry = ctx.loader.create({ name: 'cordis:delayed-readiness' })
  192. await started
  193. },
  194. })
  195. try {
  196. const initialize = {
  197. jsonrpc: '2.0',
  198. id: 'init-delayed',
  199. method: 'initialize',
  200. params: { cwd: storageDir, provider: 'delayed-private', model: 'apply-model' },
  201. }
  202. const probe = { jsonrpc: '2.0', id: 'probe-during-delay', method: 'nope/unknown' }
  203. harness.sendRaw(`${JSON.stringify(initialize)}\n${JSON.stringify(probe)}\n`)
  204. // The transport processes independent requests concurrently. Receiving
  205. // this later probe proves the preceding initialize handler has reached
  206. // its Loader wait, without relying on a scheduler delay.
  207. await harness.waitForFrame(frame => frame.id === 'probe-during-delay', 'probe while initialize waits')
  208. expect(harness.frames().some(frame => frame.id === 'init-delayed')).toBe(false)
  209. release()
  210. await delayedEntry
  211. const response = await harness.waitForFrame(frame => frame.id === 'init-delayed', 'initialize response after Loader settlement')
  212. expect(response).toMatchObject({
  213. id: 'init-delayed',
  214. result: { serverInfo: { name: 'deepseek-harness-sdk-runtime' } },
  215. })
  216. expect(harness.ctx.llm.listProviders()).toContainEqual({ id: 'delayed-private', name: 'delayed-private' })
  217. } finally {
  218. release()
  219. await Promise.allSettled(delayedEntry === undefined ? [] : [delayedEntry])
  220. await harness.dispose()
  221. await rm(storageDir, { recursive: true, force: true })
  222. }
  223. })
  224. it('drives a session/prompt turn end-to-end and forwards session notifications as output frames', async () => {
  225. const storageDir = await mkdtemp(join(tmpdir(), 'dsh-jsonrpc-apply-prompt-'))
  226. const llmServer = await mockCompletionServer()
  227. vi.stubEnv('DEEPSEEK_API_KEY', 'test-key')
  228. vi.stubEnv('DEEPSEEK_BASE_URL', llmServer.url)
  229. const harness = await mountPlugin(storageDir)
  230. try {
  231. harness.send({ jsonrpc: '2.0', id: 1, method: 'initialize', params: { cwd: storageDir, provider: 'deepseek-official', model: 'dsagent-model' } })
  232. await harness.waitForFrame(frame => frame.id === 1, 'initialize response')
  233. harness.send({
  234. jsonrpc: '2.0',
  235. id: 2,
  236. method: 'session/prompt',
  237. params: { sessionId: 'main', contentBlocks: [{ type: 'text', text: 'fix it' }] },
  238. })
  239. const response = await harness.waitForFrame(frame => frame.id === 2, 'prompt response')
  240. expect((response.result as { messageId?: unknown }).messageId).toBeTypeOf('string')
  241. await harness.waitForFrame(
  242. frame => frame.method === 'session.status'
  243. && (frame.params as { status?: string } | undefined)?.status === 'idle',
  244. 'idle session status',
  245. )
  246. expect(llmServer.requests).toHaveLength(1)
  247. const body = llmServer.requests[0] as { model: string; messages: { role: string }[] }
  248. expect(body.model).toBe('dsagent-model')
  249. expect(body.messages.at(-1)?.role).toBe('user')
  250. // Notifications use the same transport and arrive as id-less frames.
  251. const notifications = harness.frames().filter(frame => frame.id === undefined)
  252. expect(notifications.some(frame => frame.method === 'session.event')).toBe(true)
  253. expect(notifications.findLast(frame => frame.method === 'session.status')).toMatchObject({
  254. jsonrpc: '2.0',
  255. params: { sessionId: 'main', status: 'idle' },
  256. })
  257. } finally {
  258. await harness.dispose()
  259. await rm(storageDir, { recursive: true, force: true })
  260. }
  261. })
  262. it('answers shutdown before exiting 0 exactly once, even against a racing second shutdown', async () => {
  263. const storageDir = await mkdtemp(join(tmpdir(), 'dsh-jsonrpc-apply-shutdown-'))
  264. const harness = await mountPlugin(storageDir, { writeDelayMs: 10 })
  265. try {
  266. // One chunk makes the two deferred exit callbacks race.
  267. const first = { jsonrpc: '2.0', id: 'sd-1', method: 'shutdown' }
  268. const second = { jsonrpc: '2.0', id: 'sd-2', method: 'shutdown' }
  269. harness.sendRaw(`${JSON.stringify(first)}\n${JSON.stringify(second)}\n`)
  270. await waitFor(() => harness.exits().length > 0 ? true : undefined, 'exit recorder call')
  271. expect(harness.exits()).toEqual([0])
  272. // Both response writes and the flush barrier complete before exit.
  273. const exitIndex = harness.events.findIndex(event => event.kind === 'exit')
  274. const firstResponse = harness.events.findIndex(event => event.kind === 'frame' && event.frame.id === 'sd-1')
  275. const secondResponse = harness.events.findIndex(event => event.kind === 'frame' && event.frame.id === 'sd-2')
  276. const firstComplete = harness.events.findIndex(event => event.kind === 'write-complete' && event.ids.includes('sd-1'))
  277. const secondComplete = harness.events.findIndex(event => event.kind === 'write-complete' && event.ids.includes('sd-2'))
  278. const flushComplete = harness.events.findIndex(event => event.kind === 'write-complete' && event.ids.length === 0)
  279. const rootDisposed = harness.events.findIndex(event => event.kind === 'root-disposed')
  280. expect(firstResponse).toBeGreaterThanOrEqual(0)
  281. expect(secondResponse).toBeGreaterThanOrEqual(0)
  282. expect(firstComplete).toBeGreaterThan(firstResponse)
  283. expect(secondComplete).toBeGreaterThan(secondResponse)
  284. expect(flushComplete).toBeGreaterThan(firstComplete)
  285. expect(flushComplete).toBeGreaterThan(secondComplete)
  286. expect(rootDisposed).toBeGreaterThan(flushComplete)
  287. expect(exitIndex).toBeGreaterThan(rootDisposed)
  288. await settle()
  289. expect(harness.exits()).toEqual([0])
  290. expect(harness.events.filter(event => event.kind === 'root-disposed')).toHaveLength(1)
  291. const before = harness.frames().length
  292. harness.send({ jsonrpc: '2.0', id: 'after-exit', method: 'initialize', params: { cwd: storageDir, provider: 'deepseek-official', model: 'x' } })
  293. await settle()
  294. expect(harness.frames().length).toBe(before)
  295. } finally {
  296. await harness.dispose()
  297. await rm(storageDir, { recursive: true, force: true })
  298. }
  299. })
  300. it('still disposes and exits once when the flush callback fails', async () => {
  301. const storageDir = await mkdtemp(join(tmpdir(), 'dsh-jsonrpc-apply-flush-failure-'))
  302. const harness = await mountPlugin(storageDir, { failFlush: true })
  303. try {
  304. harness.send({ jsonrpc: '2.0', id: 'sd-fail', method: 'shutdown' })
  305. await waitFor(() => harness.exits().length > 0 ? true : undefined, 'exit after flush failure')
  306. await settle()
  307. expect(harness.exits()).toEqual([0])
  308. expect(harness.events.filter(event => event.kind === 'root-disposed')).toHaveLength(1)
  309. expect(harness.outputErrors.map(error => error.message)).toEqual(['flush callback failed'])
  310. const before = harness.frames().length
  311. harness.send({ jsonrpc: '2.0', id: 'after-flush-failure', method: 'initialize', params: { cwd: storageDir, provider: 'deepseek-official', model: 'x' } })
  312. await settle()
  313. expect(harness.frames().length).toBe(before)
  314. } finally {
  315. await harness.dispose()
  316. await rm(storageDir, { recursive: true, force: true })
  317. }
  318. })
  319. it('stops serving on a bare fiber dispose (HMR-style unload) without calling exit', async () => {
  320. const storageDir = await mkdtemp(join(tmpdir(), 'dsh-jsonrpc-apply-dispose-'))
  321. const harness = await mountPlugin(storageDir)
  322. try {
  323. // Prove the handler-rejection path is live before disposal.
  324. harness.send({ jsonrpc: '2.0', id: 'probe-1', method: 'nope/unknown' })
  325. const error = await harness.waitForFrame(frame => frame.id === 'probe-1', 'error response for unknown method')
  326. expect(error.error).toMatchObject({
  327. code: -32603,
  328. message: 'unknown DeepSeek Harness SDK runtime method: nope/unknown',
  329. })
  330. await harness.fiber.dispose()
  331. expect(harness.events.some(event => event.kind === 'root-disposed')).toBe(false)
  332. const before = harness.frames().length
  333. harness.send({ jsonrpc: '2.0', id: 'probe-2', method: 'initialize', params: { cwd: storageDir, provider: 'deepseek-official', model: 'x' } })
  334. await settle()
  335. expect(harness.frames().length).toBe(before)
  336. expect(harness.exits()).toEqual([])
  337. } finally {
  338. await harness.dispose()
  339. await rm(storageDir, { recursive: true, force: true })
  340. }
  341. })
  342. })