browser-plugin.client.spec.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. /**
  2. * Web reference source coverage: Remote-backed file/session discovery,
  3. * deterministic ordering and labels, quoted-path suppression, pick projections, codec
  4. * round-trip, and registration lifecycle.
  5. */
  6. import { Context, Service } from '@deepseek-ai/cordis'
  7. import { describe, expect, it, vi } from 'vitest'
  8. import { LocaleRuntime } from '@deepseek-ai/dsh-client-locale/client'
  9. import type { SessionId } from '@deepseek-ai/dsh-session/types'
  10. import type {
  11. CandidateRequest, ClientSessionContext, InputTriggerCandidate, InputTriggerSource,
  12. } from '@deepseek-ai/dsh-client-ui-input-trigger/client'
  13. import type { FileReferenceCandidate } from '@deepseek-ai/dsh-file-reference/types'
  14. import type { SessionReferenceMentionCandidate } from '@deepseek-ai/dsh-session-reference/types'
  15. import { apply, inject } from '../src/client/index.ts'
  16. import { apply as nodeApply } from '../src/index.ts'
  17. const sid = (value: string): SessionId => value as SessionId
  18. const session: ClientSessionContext = { sessionId: sid('target') }
  19. type RemoteEnvelope<T> =
  20. | { ok: true; value: T }
  21. | { ok: false; error: { code: string; message: string; details: object } }
  22. type RemoteLookup<T> = (
  23. agentId: SessionId,
  24. query: string,
  25. signal?: AbortSignal,
  26. ) => Promise<RemoteEnvelope<T[]>>
  27. function request(
  28. query: string,
  29. options: { quoted?: boolean; signal?: AbortSignal } = {},
  30. ): CandidateRequest {
  31. return {
  32. query,
  33. quoted: options.quoted ?? false,
  34. position: 'inline',
  35. signal: options.signal ?? new AbortController().signal,
  36. }
  37. }
  38. async function bench(
  39. files: RemoteLookup<FileReferenceCandidate> = vi.fn(() => Promise.resolve({
  40. ok: true as const,
  41. value: [
  42. { path: 'src', kind: 'directory' as const },
  43. { path: 'docs/a b.md', kind: 'file' as const },
  44. ],
  45. })),
  46. sessions: RemoteLookup<SessionReferenceMentionCandidate> = vi.fn(() => Promise.resolve({
  47. ok: true as const,
  48. value: [{
  49. sessionId: sid('source'),
  50. label: 'Research',
  51. cwd: '/project',
  52. createdAt: 1_700_000_000_000,
  53. mention: '@[Research](dsh-session:InNvdXJjZSI)',
  54. }],
  55. })),
  56. ): Promise<{ ctx: Context; fiber: ReturnType<Context['plugin']>; source: InputTriggerSource }> {
  57. const ctx = new Context()
  58. let source: InputTriggerSource | undefined
  59. ctx.provide('inputTriggers', {
  60. registerSource(candidate: InputTriggerSource) {
  61. source = candidate
  62. return () => { source = undefined }
  63. },
  64. })
  65. class RemoteService extends Service {
  66. constructor(serviceCtx: Context) {
  67. super(serviceCtx, 'remote')
  68. }
  69. }
  70. new RemoteService(ctx)
  71. ctx.provide('remote.fileReferences', { list: files })
  72. ctx.provide('remote.sessionReferenceResolver', { candidates: sessions })
  73. ctx.provide('locale', new LocaleRuntime(ctx))
  74. const fiber = ctx.plugin({ inject: [...inject], apply })
  75. await fiber.await()
  76. if (source === undefined) throw new Error('reference source was not registered')
  77. return { ctx, fiber, source }
  78. }
  79. describe('apply', () => {
  80. it('declares its services and releases the @ reference registration on disposal', async () => {
  81. expect(inject).toEqual([
  82. 'inputTriggers', 'locale', 'remote', 'remote.fileReferences', 'remote.sessionReferenceResolver',
  83. ])
  84. const { fiber } = await bench()
  85. let registered: InputTriggerSource | undefined
  86. const ctx = new Context()
  87. ctx.provide('inputTriggers', {
  88. registerSource(source: InputTriggerSource) {
  89. registered = source
  90. return () => { registered = undefined }
  91. },
  92. })
  93. class RemoteService extends Service {
  94. constructor(serviceCtx: Context) {
  95. super(serviceCtx, 'remote')
  96. }
  97. }
  98. new RemoteService(ctx)
  99. ctx.provide('remote.fileReferences', { list: () => Promise.resolve({ ok: true, value: [] }) })
  100. ctx.provide('remote.sessionReferenceResolver', { candidates: () => Promise.resolve({ ok: true, value: [] }) })
  101. ctx.provide('locale', new LocaleRuntime(ctx))
  102. const ownFiber = ctx.plugin({ inject: [...inject], apply })
  103. await ownFiber.await()
  104. expect(registered).toMatchObject({ trigger: '@', name: 'reference', showGroupTitle: false })
  105. await ownFiber.dispose()
  106. expect(registered).toBeUndefined()
  107. await fiber.dispose()
  108. })
  109. it('the node half applies without host-side behavior', () => {
  110. expect(() => { nodeApply() }).not.toThrow()
  111. })
  112. })
  113. describe('candidates', () => {
  114. it('starts both Remote lookups together and renders files before sessions with stable labels', async () => {
  115. let releaseFiles!: () => void
  116. let releaseSessions!: () => void
  117. const files = vi.fn(() => new Promise<{
  118. ok: true
  119. value: { path: string; kind: 'file' | 'directory' }[]
  120. }>((resolve) => {
  121. releaseFiles = () => {
  122. resolve({
  123. ok: true,
  124. value: [
  125. { path: 'src', kind: 'directory' },
  126. { path: 'docs/a b.md', kind: 'file' },
  127. ],
  128. })
  129. }
  130. }))
  131. const sessions = vi.fn(() => new Promise<{
  132. ok: true
  133. value: {
  134. sessionId: SessionId
  135. label: string
  136. cwd: string
  137. createdAt: number
  138. mention: string
  139. }[]
  140. }>((resolve) => {
  141. releaseSessions = () => {
  142. resolve({
  143. ok: true,
  144. value: [{
  145. sessionId: sid('source'),
  146. label: 'Research',
  147. cwd: '/project',
  148. createdAt: 1_700_000_000_000,
  149. mention: '@[Research](dsh-session:InNvdXJjZSI)',
  150. }],
  151. })
  152. }
  153. }))
  154. const { source } = await bench(files, sessions)
  155. const pending = source.candidates(session, request('re'))
  156. expect(files).toHaveBeenCalledTimes(1)
  157. expect(sessions).toHaveBeenCalledTimes(1)
  158. releaseSessions()
  159. releaseFiles()
  160. await expect(pending).resolves.toEqual([
  161. expect.objectContaining({
  162. name: 'src/',
  163. description: 'src',
  164. icon: 'folder',
  165. section: 'Files & folders',
  166. }),
  167. expect.objectContaining({
  168. name: 'a b.md',
  169. description: 'docs/a b.md',
  170. icon: 'file',
  171. section: 'Files & folders',
  172. }),
  173. expect.objectContaining({
  174. name: 'Research',
  175. description: 'source · /project · 2023-11-14T22:13:20.000Z',
  176. icon: 'session',
  177. section: 'Sessions',
  178. }),
  179. ])
  180. })
  181. it('suppresses sessions for an open quoted path and degrades each failed domain independently', async () => {
  182. const files = vi.fn()
  183. .mockResolvedValueOnce({
  184. ok: true as const,
  185. value: [{ path: 'README.md', kind: 'file' as const }],
  186. })
  187. .mockRejectedValueOnce(new Error('file scan failed'))
  188. const sessions = vi.fn(() => Promise.resolve({
  189. ok: true as const,
  190. value: [{
  191. sessionId: sid('source'),
  192. label: 'Research',
  193. cwd: '/project',
  194. createdAt: 0,
  195. mention: '@[Research](dsh-session:InNvdXJjZSI)',
  196. }],
  197. }))
  198. const { source } = await bench(files, sessions)
  199. const quoted = await source.candidates(session, request('READ', { quoted: true }))
  200. expect(quoted).toEqual([expect.objectContaining({ name: 'README.md', icon: 'file' })])
  201. expect(source.onPick({
  202. candidate: quoted[0]!,
  203. session,
  204. position: 'inline',
  205. via: 'menu',
  206. action: 'pick',
  207. span: { start: 0, end: 6, draftRev: 1 },
  208. })).toEqual({
  209. insert: {
  210. source: 'reference',
  211. ref: '@"README.md"',
  212. label: 'README.md',
  213. appearance: 'file',
  214. clipboardText: '@"README.md"',
  215. },
  216. })
  217. expect(sessions).not.toHaveBeenCalled()
  218. await expect(source.candidates(session, request('research'))).resolves.toEqual([
  219. expect.objectContaining({ name: 'Research', icon: 'session' }),
  220. ])
  221. })
  222. it('drops a completed result when the query signal was superseded', async () => {
  223. const controller = new AbortController()
  224. const { source } = await bench()
  225. const pending = source.candidates(session, request('', { signal: controller.signal }))
  226. controller.abort()
  227. await expect(pending).resolves.toEqual([])
  228. })
  229. it('treats Remote failures as empty domains and filters paths that cannot be mentioned', async () => {
  230. const files = vi.fn(() => Promise.resolve({
  231. ok: true as const,
  232. value: [{ path: 'bad\nname', kind: 'file' as const }],
  233. }))
  234. const sessions = vi.fn()
  235. .mockRejectedValueOnce(new Error('session lookup failed'))
  236. .mockResolvedValueOnce({
  237. ok: false as const,
  238. error: { code: 'internal', message: 'session lookup failed', details: {} },
  239. })
  240. const { source } = await bench(files, sessions)
  241. await expect(source.candidates(session, request('bad'))).resolves.toEqual([])
  242. files.mockResolvedValueOnce({
  243. ok: false as const,
  244. error: { code: 'internal', message: 'file lookup failed', details: {} },
  245. } as never)
  246. await expect(source.candidates(session, request('bad'))).resolves.toEqual([])
  247. })
  248. it('omits redundant session ids and labels sessions without a cwd', async () => {
  249. const files = vi.fn(() => Promise.resolve({ ok: true as const, value: [] }))
  250. const sessions = vi.fn(() => Promise.resolve({
  251. ok: true as const,
  252. value: [{
  253. sessionId: sid('same'),
  254. label: 'same',
  255. createdAt: 0,
  256. mention: '@[same](dsh-session:InNhbWUi)',
  257. }],
  258. }))
  259. const { source } = await bench(files, sessions)
  260. await expect(source.candidates(session, request('same'))).resolves.toEqual([
  261. expect.objectContaining({
  262. name: 'same',
  263. description: '(no cwd) · 1970-01-01T00:00:00.000Z',
  264. }),
  265. ])
  266. })
  267. })
  268. describe('pick and codec', () => {
  269. const pickAs = (action: 'pick' | 'drill') =>
  270. (source: InputTriggerSource, candidate: InputTriggerCandidate) => source.onPick({
  271. candidate,
  272. session,
  273. position: 'inline',
  274. via: 'menu',
  275. action,
  276. span: { start: 0, end: 1, draftRev: 1 },
  277. })
  278. const pick = pickAs('pick')
  279. const drill = pickAs('drill')
  280. it('settles files and directories as atomic icon labels; drill keeps directory completion open', async () => {
  281. const { source } = await bench()
  282. const [directory, file] = await source.candidates(session, request(''))
  283. expect(directory?.drill).toBe(true)
  284. expect(file?.drill).toBeUndefined()
  285. expect(pick(source, directory!)).toEqual({
  286. insert: {
  287. source: 'reference',
  288. ref: '@src/',
  289. label: 'src/',
  290. appearance: 'folder',
  291. clipboardText: '@src/',
  292. },
  293. })
  294. expect(drill(source, directory!)).toEqual({ text: '@src/', continue: true })
  295. expect(pick(source, file!)).toEqual({
  296. insert: {
  297. source: 'reference',
  298. ref: '@"docs/a b.md"',
  299. label: 'a b.md',
  300. appearance: 'file',
  301. clipboardText: '@"docs/a b.md"',
  302. },
  303. })
  304. const [quotedDirectory] = await source.candidates(session, request('', { quoted: true }))
  305. expect(drill(source, quotedDirectory!)).toEqual({ text: '@"src/', continue: true })
  306. })
  307. it('inserts sessions as atomic chips whose clipboard and model forms are canonical mentions', async () => {
  308. const { source } = await bench()
  309. const candidates = await source.candidates(session, request(''))
  310. const candidate = candidates.find(item => item.name === 'Research')!
  311. const mention = '@[Research](dsh-session:InNvdXJjZSI)'
  312. expect(pick(source, candidate)).toEqual({
  313. insert: {
  314. source: 'reference',
  315. ref: mention,
  316. label: 'Research',
  317. appearance: 'session',
  318. clipboardText: mention,
  319. },
  320. })
  321. expect(source.codec?.clipboardText(mention)).toBe(mention)
  322. await expect(source.codec?.serialize(mention, new AbortController().signal)).resolves.toBe(mention)
  323. })
  324. it('ignores candidates that do not carry a source-owned value', async () => {
  325. const { source } = await bench()
  326. expect(pick(source, { name: 'foreign candidate' })).toBeUndefined()
  327. })
  328. })