knowledge.test.ts 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  1. // 资料库类型与资料集合(docs/design/21-knowledge-sources.md)
  2. import fs from 'node:fs'
  3. import http from 'node:http'
  4. import type { AddressInfo } from 'node:net'
  5. import path from 'node:path'
  6. import pino from 'pino'
  7. import { afterAll, beforeAll, describe, expect, it } from 'vitest'
  8. import type { KnowledgeBrowseDto, KnowledgeLocalCheckDto, ProfileInput } from '@agent-server/shared'
  9. import { createApp, type App } from '../src/app'
  10. import { knowledgeFilesDir, knowledgeMountDir } from '../src/config'
  11. import { describeKnowledge, linkOrigins } from '../src/knowledge/describe'
  12. import { MounterRejected, MounterUnavailable, type MounterApi, type MountSpec, type MountStatusRow, type RemoteSpec } from '../src/knowledge/mounter'
  13. /** 模拟挂载服务:/home/u 下在系统盘,/media/u/Data 下在外接盘(UUID aaaa) */
  14. class FakeMounter implements MounterApi {
  15. up = true
  16. synced: MountSpec[][] = []
  17. checks: string[] = []
  18. tests: RemoteSpec[] = []
  19. states = new Map<string, Omit<MountStatusRow, 'id'>>()
  20. private guard() {
  21. if (!this.up) throw new MounterUnavailable('挂载服务没有运行')
  22. }
  23. async list(p: string): Promise<KnowledgeBrowseDto> {
  24. this.guard()
  25. return { path: p, parent: '', entries: [{ name: 'docs', path: `${p}/docs`, selectable: true }] }
  26. }
  27. async check(p: string): Promise<KnowledgeLocalCheckDto> {
  28. this.guard()
  29. this.checks.push(p)
  30. if (p.startsWith('/media/u/Data/')) return { path: p, uuid: 'aaaa', relPath: p.slice('/media/u/Data'.length), systemDisk: false, mountPoint: '/media/u/Data', fsType: 'ext4', device: '/dev/sda1' }
  31. if (p.startsWith('/home/u/')) return { path: p, uuid: null, relPath: null, systemDisk: true, mountPoint: '/', fsType: 'ext4', device: '/dev/dm-0' }
  32. throw new MounterRejected('只能选择 /home、/mnt、/media 下的目录', 'not_allowed')
  33. }
  34. async test(remote: RemoteSpec) {
  35. this.guard()
  36. this.tests.push(remote)
  37. return remote.secrets.secretAccessKey === 'sk-secret'
  38. ? { state: 'ok' as const, message: '', entries: ['产品手册/'] }
  39. : { state: 'auth_failed' as const, message: '认证失败或没有权限:SignatureDoesNotMatch', entries: null }
  40. }
  41. private rows(): MountStatusRow[] {
  42. return (this.synced.at(-1) ?? []).map(m => ({ id: m.id, ...(this.states.get(m.id) ?? { state: 'ok', message: null, since: '2026-11-06T00:00:00Z' }) }))
  43. }
  44. async sync(mounts: MountSpec[]) {
  45. this.guard()
  46. this.synced.push(mounts)
  47. return this.rows()
  48. }
  49. async status() {
  50. this.guard()
  51. return { version: 'test', mounts: this.rows() }
  52. }
  53. }
  54. const mounter = new FakeMounter()
  55. let app: App
  56. let site: http.Server
  57. let siteOrigin: string
  58. beforeAll(async () => {
  59. app = createApp(pino({ level: 'silent' }), { providers: {}, mounter })
  60. site = http.createServer((req, res) => {
  61. if (req.url === '/missing') return res.writeHead(404).end()
  62. res.setHeader('content-type', 'text/html; charset=utf-8')
  63. res.end('<html><head><title> 产品 手册 </title></head><body>x</body></html>')
  64. })
  65. await new Promise<void>(r => site.listen(0, '127.0.0.1', r))
  66. siteOrigin = `http://127.0.0.1:${(site.address() as AddressInfo).port}`
  67. })
  68. afterAll(() => {
  69. site.close()
  70. })
  71. const profile = (over: Partial<ProfileInput> = {}): ProfileInput => ({
  72. name: '资料测试', description: '', provider: 'claude', model: 'haiku', systemPrompt: '', permissionMode: 'ask',
  73. allowedTools: [], disallowedTools: [], skills: 'all', fileAccess: { mode: 'restricted', read: [], write: [], deny: [] },
  74. knowledgeRootIds: [], isDefault: false, ...over,
  75. })
  76. describe('资料库类型', () => {
  77. it('托管目录:平台在 files/<id> 下创建目录,可以设为 Agent 可写;删除时连同文件一起删除', async () => {
  78. const k = await app.knowledge.create({ kind: 'managed', name: '产品资料', description: '产品手册', access: 'write' })
  79. expect(k.path).toBe(path.join(knowledgeFilesDir(), k.id))
  80. expect(fs.statSync(k.path).isDirectory()).toBe(true)
  81. expect(k).toMatchObject({ kind: 'managed', access: 'write', url: null, status: { state: 'ok' } })
  82. fs.writeFileSync(path.join(k.path, 'a.md'), 'x')
  83. expect((await app.knowledge.update(k.id, { kind: 'managed', name: '产品资料', access: 'read' })).access).toBe('read')
  84. app.knowledge.delete(k.id)
  85. expect(fs.existsSync(k.path)).toBe(false)
  86. })
  87. it('网络链接:只接受 http/https,不能带用户名密码;没有目录、只读', async () => {
  88. const k = await app.knowledge.create({ kind: 'link', name: '内部文档', url: 'http://wiki.local/docs/', access: 'write' })
  89. expect(k).toMatchObject({ path: '', url: 'http://wiki.local/docs/', access: 'read', status: { state: 'ok' } })
  90. await expect(app.knowledge.create({ kind: 'link', name: 'ftp', url: 'ftp://a.com/x' })).rejects.toThrow(/http/)
  91. await expect(app.knowledge.create({ kind: 'link', name: '坏链接', url: 'not a url' })).rejects.toThrow(/格式不正确/)
  92. await expect(app.knowledge.create({ kind: 'link', name: '带密码', url: 'http://u:p@a.com/' })).rejects.toThrow(/用户名或密码/)
  93. })
  94. it('名称不能重复;类型不能修改;远程存储必须填写连接参数', async () => {
  95. const k = app.knowledge.list().find(x => x.name === '内部文档')!
  96. await expect(app.knowledge.create({ kind: 'managed', name: '内部文档' })).rejects.toThrow(/已被使用/)
  97. await expect(app.knowledge.update(k.id, { kind: 'managed', name: '内部文档' })).rejects.toThrow(/类型不能修改/)
  98. await expect(app.knowledge.create({ kind: 'remote', name: '远程' })).rejects.toThrow(/连接参数/)
  99. })
  100. it('测试访问:返回状态码、标题;失败时给出原因', async () => {
  101. expect(await app.knowledge.testLink(`${siteOrigin}/docs`)).toMatchObject({ ok: true, status: 200, contentType: 'text/html', title: '产品 手册' })
  102. expect(await app.knowledge.testLink(`${siteOrigin}/missing`)).toMatchObject({ ok: false, status: 404, error: 'HTTP 404' })
  103. expect((await app.knowledge.testLink('http://127.0.0.1:1/')).ok).toBe(false)
  104. })
  105. it('提示词清单:标出类型、读写、链接的放行站点与不可用原因', () => {
  106. const roots = [
  107. ...app.knowledge.list(),
  108. { ...app.knowledge.list()[0]!, id: 'kb_x', name: '移动硬盘', kind: 'local' as const, path: '/srv/agent-server/knowledge/mnt/kb_x', status: { state: 'device_missing' as const, message: '设备未连接', since: null } },
  109. ]
  110. const text = describeKnowledge(roots)
  111. expect(text).toContain('- 内部文档(网络链接,只读):http://wiki.local/docs/')
  112. expect(text).toContain('同一站点(http://wiki.local)下的地址都可以访问')
  113. expect(text).toContain('- 移动硬盘(本机目录,只读,暂不可用:设备未连接):/srv/agent-server/knowledge/mnt/kb_x')
  114. expect(linkOrigins(roots)).toEqual(['http://wiki.local'])
  115. })
  116. })
  117. describe('资料集合', () => {
  118. it('Profile 生效的资料库 = 单独勾选的 ∪ 集合成员,去掉停用的;集合成员变化立即生效', async () => {
  119. const a = await app.knowledge.create({ kind: 'managed', name: '合同' })
  120. const b = await app.knowledge.create({ kind: 'managed', name: '发票' })
  121. const c = await app.knowledge.create({ kind: 'link', name: '报价单', url: 'https://erp.example.com/quotes' })
  122. const col = app.knowledge.createCollection({ name: '财务', description: '财务相关', rootIds: [a.id, b.id, a.id] })
  123. expect(col.rootIds).toEqual([a.id, b.id])
  124. expect(app.knowledge.get(a.id).collectionIds).toEqual([col.id])
  125. const p = app.profiles.create(profile({ knowledgeRootIds: [c.id], knowledgeCollectionIds: [col.id] }))
  126. expect(p.knowledgeCollectionIds).toEqual([col.id])
  127. const names = () => app.knowledge.effective(app.profiles.get(p.id)).map(k => k.name).sort()
  128. expect(names()).toEqual(['发票', '合同', '报价单'])
  129. await app.knowledge.update(b.id, { kind: 'managed', name: '发票', enabled: false })
  130. expect(names()).toEqual(['合同', '报价单'])
  131. app.knowledge.updateCollection(col.id, { name: '财务', rootIds: [a.id] })
  132. await app.knowledge.update(b.id, { kind: 'managed', name: '发票', enabled: true })
  133. expect(names()).toEqual(['合同', '报价单'])
  134. // 被 Profile 使用的集合不能删除;删除资料库时从集合中移除
  135. expect(app.knowledge.collection(col.id).usedBy).toEqual([{ id: p.id, name: '资料测试' }])
  136. expect(() => app.knowledge.deleteCollection(col.id)).toThrow(/正被 Profile 使用/)
  137. app.knowledge.delete(a.id)
  138. expect(app.knowledge.collection(col.id).rootIds).toEqual([])
  139. expect(names()).toEqual(['报价单'])
  140. })
  141. it('校验:名称不能重复,成员必须存在;Profile 只能引用已有的集合,恢复旧版本时忽略已删除的集合', () => {
  142. const col = app.knowledge.collections().find(x => x.name === '财务')!
  143. expect(() => app.knowledge.createCollection({ name: '财务', rootIds: [] })).toThrow(/已被使用/)
  144. expect(() => app.knowledge.createCollection({ name: '空', rootIds: ['kb_nope'] })).toThrow(/不存在/)
  145. expect(() => app.profiles.create(profile({ name: '坏引用', knowledgeCollectionIds: ['kbc_nope'] }))).toThrow(/资料集合不存在/)
  146. const temp = app.knowledge.createCollection({ name: '临时', rootIds: [] })
  147. const p = app.profiles.create(profile({ name: '版本测试', knowledgeCollectionIds: [temp.id, col.id] }))
  148. const v2 = app.profiles.update(p.id, profile({ name: '版本测试', knowledgeCollectionIds: [col.id] }))
  149. expect(app.profiles.versions(p.id)[0]!.changed).toEqual(['knowledgeCollectionIds'])
  150. app.knowledge.deleteCollection(temp.id)
  151. expect(app.profiles.restore(p.id, 1).knowledgeCollectionIds).toEqual([col.id])
  152. expect(v2.version).toBe(2)
  153. })
  154. })
  155. describe('本机目录(挂载服务)', () => {
  156. const settle = () => new Promise(r => setTimeout(r, 20))
  157. it('新建时由挂载服务检查并识别设备;登记列表同步给挂载服务,状态来自挂载服务', async () => {
  158. const home = await app.knowledge.create({ kind: 'local', name: '项目文档', localPath: '/home/u/docs' })
  159. expect(home).toMatchObject({ kind: 'local', access: 'read', path: path.join(knowledgeMountDir(), home.id), local: { path: '/home/u/docs', uuid: null, relPath: null } })
  160. const disk = await app.knowledge.create({ kind: 'local', name: '移动硬盘资料', localPath: '/media/u/Data/资料', access: 'write' })
  161. expect(disk).toMatchObject({ access: 'read', local: { path: '/media/u/Data/资料', uuid: 'aaaa', relPath: '/资料' } })
  162. await settle()
  163. expect(mounter.synced.at(-1)).toEqual(expect.arrayContaining([
  164. { id: home.id, kind: 'local', local: { path: '/home/u/docs', uuid: null, relPath: null } },
  165. { id: disk.id, kind: 'local', local: { path: '/media/u/Data/资料', uuid: 'aaaa', relPath: '/资料' } },
  166. ]))
  167. expect(app.knowledge.get(home.id).status.state).toBe('ok')
  168. // 设备拔出:状态与原因来自挂载服务,提示词中标注暂不可用
  169. mounter.states.set(disk.id, { state: 'device_missing', message: '设备未连接(文件系统 UUID aaaa)', since: '2026-11-06T01:00:00Z' })
  170. await app.knowledge.refreshMounts()
  171. expect(app.knowledge.get(disk.id).status).toEqual({ state: 'device_missing', message: '设备未连接(文件系统 UUID aaaa)', since: '2026-11-06T01:00:00Z' })
  172. expect(describeKnowledge([app.knowledge.get(disk.id)])).toContain('(本机目录,只读,暂不可用:设备未连接(文件系统 UUID aaaa))')
  173. mounter.states.delete(disk.id)
  174. // 停用后不再挂载;删除后从登记列表中移除
  175. await app.knowledge.update(home.id, { kind: 'local', name: '项目文档', localPath: '/home/u/docs', enabled: false })
  176. await settle()
  177. expect(mounter.synced.at(-1)!.map(m => m.id)).not.toContain(home.id)
  178. app.knowledge.delete(home.id)
  179. await settle()
  180. expect(app.knowledge.list().some(k => k.id === home.id)).toBe(false)
  181. })
  182. it('挂载服务拒绝的目录不能登记;路径不变时修改名称不重新检查', async () => {
  183. await expect(app.knowledge.create({ kind: 'local', name: '系统目录', localPath: '/etc' })).rejects.toThrow(/只能选择/)
  184. await expect(app.knowledge.create({ kind: 'local', name: '空路径' })).rejects.toThrow(/请选择本机目录/)
  185. const k = app.knowledge.list().find(x => x.name === '移动硬盘资料')!
  186. mounter.checks = []
  187. await app.knowledge.update(k.id, { kind: 'local', name: '移动硬盘', localPath: '/media/u/Data/资料' })
  188. expect(mounter.checks).toEqual([])
  189. expect(app.knowledge.get(k.id).local).toEqual({ path: '/media/u/Data/资料', uuid: 'aaaa', relPath: '/资料' })
  190. })
  191. it('挂载服务不可用:本机目录状态为 mounter_down,不能新建;恢复后重新同步', async () => {
  192. mounter.up = false
  193. await app.knowledge.refreshMounts()
  194. const k = app.knowledge.list().find(x => x.name === '移动硬盘')!
  195. expect(k.status).toMatchObject({ state: 'mounter_down', message: '挂载服务没有运行' })
  196. expect(app.knowledge.mounterInfo()).toEqual({ available: false, version: null, error: '挂载服务没有运行' })
  197. await expect(app.knowledge.create({ kind: 'local', name: '新目录', localPath: '/home/u/new' })).rejects.toMatchObject({ status: 503 })
  198. await expect(app.knowledge.browse('/home')).rejects.toThrow(/agent-mounter/)
  199. // 挂载服务不可用时仍可修改名称、说明,也可以停用
  200. await app.knowledge.update(k.id, { kind: 'local', name: '移动硬盘', description: '合同扫描件', localPath: '/media/u/Data/资料', enabled: false })
  201. // 恢复后:挂载服务的登记与平台不一致,重新同步
  202. mounter.up = true
  203. await app.knowledge.refreshMounts()
  204. expect(app.knowledge.mounterInfo()).toEqual({ available: true, version: 'test', error: null })
  205. await settle()
  206. expect(mounter.synced.at(-1)!.map(m => m.id)).not.toContain(k.id)
  207. await app.knowledge.update(k.id, { kind: 'local', name: '移动硬盘', localPath: '/media/u/Data/资料', enabled: true })
  208. await settle()
  209. expect(mounter.synced.at(-1)!.map(m => m.id)).toContain(k.id)
  210. expect(app.knowledge.get(k.id).status.state).toBe('ok')
  211. })
  212. })
  213. describe('远程存储', () => {
  214. const settle = () => new Promise(r => setTimeout(r, 20))
  215. const s3 = (secrets: { name: string; value: string | null }[], params: Record<string, string> = {}) => ({
  216. type: 's3' as const,
  217. params: { provider: 'Minio', endpoint: 'http://127.0.0.1:9198', bucket: 'agentserver-kb', prefix: 'docs', unknown: 'x', ...params },
  218. secrets,
  219. })
  220. it('凭据只写不读:DTO 只显示是否已设置;留空沿用原值;随登记列表发给挂载服务', async () => {
  221. await expect(app.knowledge.create({ kind: 'remote', name: '对象存储', remote: s3([{ name: 'accessKeyId', value: 'agentserver' }]) })).rejects.toThrow(/Secret Key/)
  222. await expect(app.knowledge.create({ kind: 'remote', name: '对象存储', remote: s3([], { bucket: '' }) })).rejects.toThrow(/存储桶/)
  223. await expect(app.knowledge.create({ kind: 'remote', name: '对象存储', remote: s3([], { endpoint: 'http://u:p@x/' }) })).rejects.toThrow(/用户名或密码/)
  224. await expect(app.knowledge.create({ kind: 'remote', name: '对象存储', remote: s3([], { provider: 'Evil' }) })).rejects.toThrow(/服务商不正确/)
  225. const k = await app.knowledge.create({ kind: 'remote', name: '对象存储', access: 'write', remote: s3([{ name: 'accessKeyId', value: 'agentserver' }, { name: 'secretAccessKey', value: 'sk-secret' }]) })
  226. expect(k).toMatchObject({
  227. kind: 'remote', access: 'read', path: path.join(knowledgeMountDir(), k.id),
  228. remote: { type: 's3', params: { provider: 'Minio', endpoint: 'http://127.0.0.1:9198', bucket: 'agentserver-kb', prefix: 'docs' }, secrets: [{ name: 'accessKeyId', isSet: true }, { name: 'secretAccessKey', isSet: true }] },
  229. })
  230. expect(k.remote!.params).not.toHaveProperty('unknown')
  231. expect(JSON.stringify(app.knowledge.list())).not.toContain('sk-secret')
  232. await settle()
  233. expect(mounter.synced.at(-1)).toContainEqual({ id: k.id, kind: 'remote', remote: { type: 's3', params: k.remote!.params, secrets: { accessKeyId: 'agentserver', secretAccessKey: 'sk-secret' } } })
  234. // 修改时凭据留空:沿用原值
  235. await app.knowledge.update(k.id, { kind: 'remote', name: '对象存储', remote: s3([{ name: 'accessKeyId', value: null }, { name: 'secretAccessKey', value: '' }], { prefix: '' }) })
  236. await settle()
  237. const spec = mounter.synced.at(-1)!.find(m => m.id === k.id)!
  238. expect(spec).toMatchObject({ remote: { secrets: { accessKeyId: 'agentserver', secretAccessKey: 'sk-secret' } } })
  239. expect(spec.kind === 'remote' && spec.remote.params).not.toHaveProperty('prefix')
  240. // 提示词中标注远程资料
  241. expect(describeKnowledge([app.knowledge.get(k.id)])).toContain('远程资料:先按文件名和目录结构查找')
  242. })
  243. it('测试连接:新建时用填写的凭据;编辑时没有重新填写的凭据沿用原值', async () => {
  244. const k = app.knowledge.list().find(x => x.name === '对象存储')!
  245. expect(await app.knowledge.testRemote(s3([{ name: 'accessKeyId', value: 'a' }, { name: 'secretAccessKey', value: 'wrong' }]))).toEqual({ ok: false, state: 'auth_failed', message: '认证失败或没有权限:SignatureDoesNotMatch', entries: [] })
  246. expect(await app.knowledge.testRemote(s3([]), k.id)).toEqual({ ok: true, state: 'ok', message: null, entries: ['产品手册/'] })
  247. expect(mounter.tests.at(-1)!.secrets).toEqual({ accessKeyId: 'agentserver', secretAccessKey: 'sk-secret' })
  248. // 换了存储类型:不沿用原来的凭据
  249. await expect(app.knowledge.testRemote({ type: 'webdav', params: { url: 'http://dav.local/' }, secrets: [] }, k.id)).resolves.toMatchObject({ ok: false })
  250. expect(mounter.tests.at(-1)!.secrets).toEqual({})
  251. await expect(app.knowledge.testRemote({ type: 'webdav', params: {}, secrets: [] })).rejects.toThrow(/请填写地址/)
  252. })
  253. it('停用后不再挂载', async () => {
  254. const k = app.knowledge.list().find(x => x.name === '对象存储')!
  255. await app.knowledge.update(k.id, { kind: 'remote', name: '对象存储', enabled: false, remote: s3([]) })
  256. await settle()
  257. expect(mounter.synced.at(-1)!.map(m => m.id)).not.toContain(k.id)
  258. })
  259. })