openAgent

1import { describe, expect, beforeAll, afterAll } from "bun:test"
2import { LayerNode } from "@opencode-ai/core/effect/layer-node"
3import { FSUtil } from "@opencode-ai/core/fs-util"
4import { Effect } from "effect"
5import { Discovery } from "../../src/skill/discovery"
6import { Global } from "@opencode-ai/core/global"
7import { Filesystem } from "@/util/filesystem"
8import { rm } from "fs/promises"
9import path from "path"
10import { testEffect } from "../lib/effect"
11 
12let CLOUDFLARE_SKILLS_URL: string
13let server: ReturnType<typeof Bun.serve>
14let downloadCount = 0
15let mutableVersion = "1"
16let mutableContent = "# Old"
17let mutableDownloadCount = 0
18let mutableFiles = ["SKILL.md"]
19 
20const fixturePath = path.join(import.meta.dir, "../fixture/skills")
21const cacheDir = path.join(Global.Path.cache, "skills")
22const it = testEffect(LayerNode.compile(LayerNode.group([Discovery.node, FSUtil.node])))
23 
24beforeAll(async () => {
25  await rm(cacheDir, { recursive: true, force: true })
26 
27  server = Bun.serve({
28    port: 0,
29    async fetch(req) {
30      const url = new URL(req.url)
31 
32      if (url.pathname === "/mutable/index.json") {
33        return Response.json({ skills: [{ name: "mutable", version: mutableVersion, files: mutableFiles }] })
34      }
35      if (url.pathname === "/mutable/mutable/SKILL.md") {
36        mutableDownloadCount++
37        return new Response(mutableContent)
38      }
39      if (url.pathname === "/mutable/mutable/old.md") return new Response("old reference")
40 
41      // route /.well-known/skills/* to the fixture directory
42      if (url.pathname.startsWith("/.well-known/skills/")) {
43        const filePath = url.pathname.replace("/.well-known/skills/", "")
44        const fullPath = path.join(fixturePath, filePath)
45 
46        if (await Filesystem.exists(fullPath)) {
47          if (!fullPath.endsWith("index.json")) {
48            downloadCount++
49          }
50          return new Response(Bun.file(fullPath))
51        }
52      }
53 
54      return new Response("Not Found", { status: 404 })
55    },
56  })
57 
58  CLOUDFLARE_SKILLS_URL = `http://localhost:${server.port}/.well-known/skills/`
59})
60 
61afterAll(async () => {
62  void server?.stop()
63  await rm(cacheDir, { recursive: true, force: true })
64})
65 
66describe("Discovery.pull", () => {
67  it.live("downloads skills from cloudflare url", () =>
68    Effect.gen(function* () {
69      const fsys = yield* FSUtil.Service
70      const discovery = yield* Discovery.Service
71      const dirs = yield* discovery.pull(CLOUDFLARE_SKILLS_URL)
72      expect(dirs.length).toBeGreaterThan(0)
73      for (const dir of dirs) {
74        expect(dir).toStartWith(cacheDir)
75        const md = path.join(dir, "SKILL.md")
76        expect(yield* fsys.existsSafe(md)).toBe(true)
77      }
78    }),
79  )
80 
81  it.live("url without trailing slash works", () =>
82    Effect.gen(function* () {
83      const fsys = yield* FSUtil.Service
84      const discovery = yield* Discovery.Service
85      const dirs = yield* discovery.pull(CLOUDFLARE_SKILLS_URL.replace(/\/$/, ""))
86      expect(dirs.length).toBeGreaterThan(0)
87      for (const dir of dirs) {
88        const md = path.join(dir, "SKILL.md")
89        expect(yield* fsys.existsSafe(md)).toBe(true)
90      }
91    }),
92  )
93 
94  it.live("returns empty array for invalid url", () =>
95    Effect.gen(function* () {
96      const discovery = yield* Discovery.Service
97      const dirs = yield* discovery.pull(`http://localhost:${server.port}/invalid-url/`)
98      expect(dirs).toEqual([])
99    }),
100  )
101 
102  it.live("returns empty array for non-json response", () =>
103    Effect.gen(function* () {
104      // any url not explicitly handled in server returns 404 text "Not Found"
105      const discovery = yield* Discovery.Service
106      const dirs = yield* discovery.pull(`http://localhost:${server.port}/some-other-path/`)
107      expect(dirs).toEqual([])
108    }),
109  )
110 
111  it.live("downloads reference files alongside SKILL.md", () =>
112    Effect.gen(function* () {
113      const fsys = yield* FSUtil.Service
114      const discovery = yield* Discovery.Service
115      const dirs = yield* discovery.pull(CLOUDFLARE_SKILLS_URL)
116      // find a skill dir that should have reference files (e.g. agents-sdk)
117      const agentsSdk = dirs.find((d) => d.endsWith(path.sep + "agents-sdk"))
118      expect(agentsSdk).toBeDefined()
119      if (agentsSdk) {
120        const refs = path.join(agentsSdk, "references")
121        expect(yield* fsys.existsSafe(path.join(agentsSdk, "SKILL.md"))).toBe(true)
122        // agents-sdk has reference files per the index
123        const refDir = yield* Effect.promise(() =>
124          Array.fromAsync(new Bun.Glob("**/*.md").scan({ cwd: refs, onlyFiles: true })),
125        )
126        expect(refDir.length).toBeGreaterThan(0)
127      }
128    }),
129  )
130 
131  it.live("caches downloaded files on second pull", () =>
132    Effect.gen(function* () {
133      // clear dir and downloadCount
134      yield* Effect.promise(() => rm(cacheDir, { recursive: true, force: true }))
135      downloadCount = 0
136      const discovery = yield* Discovery.Service
137 
138      // first pull to populate cache
139      const first = yield* discovery.pull(CLOUDFLARE_SKILLS_URL)
140      expect(first.length).toBeGreaterThan(0)
141      const firstCount = downloadCount
142      expect(firstCount).toBeGreaterThan(0)
143 
144      // second pull should return same results from cache
145      const second = yield* discovery.pull(CLOUDFLARE_SKILLS_URL)
146      expect(second.length).toBe(first.length)
147      expect(second.sort()).toEqual(first.sort())
148 
149      // second pull should NOT increment download count
150      expect(downloadCount).toBe(firstCount)
151    }),
152  )
153 
154  it.live("refreshes a remote skill when its version changes", () =>
155    Effect.gen(function* () {
156      yield* Effect.promise(() => rm(cacheDir, { recursive: true, force: true }))
157      mutableVersion = "1"
158      mutableContent = "# Old"
159      mutableDownloadCount = 0
160      mutableFiles = ["SKILL.md", "old.md"]
161      const discovery = yield* Discovery.Service
162      const url = `http://localhost:${server.port}/mutable/`
163 
164      const first = yield* discovery.pull(url)
165      expect(yield* Effect.promise(() => Bun.file(path.join(first[0], "SKILL.md")).text())).toBe("# Old")
166 
167      mutableVersion = "2"
168      mutableContent = "# Partial"
169      mutableFiles = ["SKILL.md", "missing.md"]
170      const second = yield* discovery.pull(url)
171      expect(yield* Effect.promise(() => Bun.file(path.join(second[0], "SKILL.md")).text())).toBe("# Old")
172      expect(yield* Effect.promise(() => Bun.file(path.join(second[0], "old.md")).text())).toBe("old reference")
173 
174      mutableVersion = "3"
175      mutableContent = "# New"
176      mutableFiles = ["SKILL.md"]
177      yield* discovery.pull(url)
178      expect(yield* Effect.promise(() => Bun.file(path.join(second[0], "SKILL.md")).text())).toBe("# New")
179      expect(yield* Effect.promise(() => Bun.file(path.join(second[0], "old.md")).exists())).toBe(false)
180      expect(mutableDownloadCount).toBe(3)
181 
182      yield* discovery.pull(url)
183      expect(mutableDownloadCount).toBe(3)
184    }),
185  )
186})
187