provider-cloudflare-workers-ai.test.ts 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. import { describe, expect } from "bun:test"
  2. import { Effect, Layer } from "effect"
  3. import { AccountV2 } from "@opencode-ai/core/account"
  4. import { Catalog } from "@opencode-ai/core/catalog"
  5. import { Location } from "@opencode-ai/core/location"
  6. import { EventV2 } from "@opencode-ai/core/event"
  7. import { ModelV2 } from "@opencode-ai/core/model"
  8. import { PluginV2 } from "@opencode-ai/core/plugin"
  9. import { Policy } from "@opencode-ai/core/policy"
  10. import { AccountPlugin } from "@opencode-ai/core/plugin/account"
  11. import { CloudflareWorkersAIPlugin } from "@opencode-ai/core/plugin/provider/cloudflare-workers-ai"
  12. import { ProviderV2 } from "@opencode-ai/core/provider"
  13. import { AbsolutePath } from "@opencode-ai/core/schema"
  14. import { location } from "../fixture/location"
  15. import { testEffect } from "../lib/effect"
  16. import { fakeSelectorSdk, it, model, npmLayer, withEnv } from "./provider-helper"
  17. const itWithAccount = testEffect(
  18. Catalog.layer.pipe(
  19. Layer.provideMerge(PluginV2.defaultLayer),
  20. Layer.provideMerge(AccountV2.defaultLayer),
  21. Layer.provideMerge(EventV2.defaultLayer),
  22. Layer.provide(Policy.defaultLayer),
  23. Layer.provideMerge(
  24. Layer.succeed(Location.Service, Location.Service.of(location({ directory: AbsolutePath.make("test") }))),
  25. ),
  26. Layer.provideMerge(npmLayer),
  27. ),
  28. )
  29. function cloudflareLanguage(sdk: unknown, modelID = "@cf/model") {
  30. return (sdk as { languageModel: (id: string) => { config: CloudflareConfig; provider: string } }).languageModel(
  31. modelID,
  32. )
  33. }
  34. type CloudflareConfig = {
  35. url: (input: { path: string; modelId: string }) => string
  36. headers: () => Record<string, string> | Promise<Record<string, string>>
  37. }
  38. function cloudflareURL(sdk: unknown, modelID = "@cf/model") {
  39. return cloudflareLanguage(sdk, modelID).config.url({ path: "/chat/completions", modelId: modelID })
  40. }
  41. function cloudflareHeaders(sdk: unknown, modelID = "@cf/model") {
  42. return cloudflareLanguage(sdk, modelID).config.headers()
  43. }
  44. describe("CloudflareWorkersAIPlugin", () => {
  45. it.effect("maps account ID to endpoint URL and creates an OpenAI-compatible SDK", () =>
  46. withEnv({ CLOUDFLARE_ACCOUNT_ID: "acct", CLOUDFLARE_API_KEY: "key" }, () =>
  47. Effect.gen(function* () {
  48. const plugin = yield* PluginV2.Service
  49. const catalog = yield* Catalog.Service
  50. yield* plugin.add(CloudflareWorkersAIPlugin)
  51. const transform = yield* catalog.transform()
  52. yield* transform((catalog) =>
  53. catalog.provider.update(ProviderV2.ID.make("cloudflare-workers-ai"), (provider) => {
  54. provider.endpoint = { type: "aisdk", package: "test-provider" }
  55. }),
  56. )
  57. const provider = yield* catalog.provider.get(ProviderV2.ID.make("cloudflare-workers-ai"))
  58. const sdk = yield* plugin.trigger(
  59. "aisdk.sdk",
  60. {
  61. model: model("cloudflare-workers-ai", "@cf/model", { endpoint: provider.endpoint }),
  62. package: "@ai-sdk/openai-compatible",
  63. options: { name: "cloudflare-workers-ai", headers: { custom: "header" } },
  64. },
  65. {},
  66. )
  67. expect(provider.endpoint).toEqual({
  68. type: "aisdk",
  69. package: "test-provider",
  70. url: "https://api.cloudflare.com/client/v4/accounts/acct/ai/v1",
  71. })
  72. expect(sdk.sdk).toBeDefined()
  73. }),
  74. ),
  75. )
  76. it.effect("preserves a configured endpoint URL instead of deriving one from account ID", () =>
  77. withEnv({ CLOUDFLARE_ACCOUNT_ID: "acct" }, () =>
  78. Effect.gen(function* () {
  79. const plugin = yield* PluginV2.Service
  80. const catalog = yield* Catalog.Service
  81. yield* plugin.add(CloudflareWorkersAIPlugin)
  82. const transform = yield* catalog.transform()
  83. yield* transform((catalog) =>
  84. catalog.provider.update(ProviderV2.ID.make("cloudflare-workers-ai"), (provider) => {
  85. provider.endpoint = { type: "aisdk", package: "test-provider", url: "https://proxy.example/v1" }
  86. }),
  87. )
  88. expect((yield* catalog.provider.get(ProviderV2.ID.make("cloudflare-workers-ai"))).endpoint).toEqual({
  89. type: "aisdk",
  90. package: "test-provider",
  91. url: "https://proxy.example/v1",
  92. })
  93. }),
  94. ),
  95. )
  96. it.effect("allows a configured baseURL without account ID", () =>
  97. withEnv({ CLOUDFLARE_ACCOUNT_ID: undefined, CLOUDFLARE_API_KEY: "key" }, () =>
  98. Effect.gen(function* () {
  99. const plugin = yield* PluginV2.Service
  100. yield* plugin.add(CloudflareWorkersAIPlugin)
  101. const result = yield* plugin.trigger(
  102. "aisdk.sdk",
  103. {
  104. model: model("cloudflare-workers-ai", "@cf/model", {
  105. endpoint: { type: "aisdk", package: "@ai-sdk/openai-compatible", url: "https://proxy.example/v1" },
  106. }),
  107. package: "@ai-sdk/openai-compatible",
  108. options: { name: "cloudflare-workers-ai", baseURL: "https://proxy.example/v1" },
  109. },
  110. {},
  111. )
  112. expect(cloudflareURL(result.sdk)).toBe("https://proxy.example/v1/chat/completions")
  113. }),
  114. ),
  115. )
  116. itWithAccount.effect("falls back to account metadata when account env is absent", () =>
  117. withEnv(
  118. {
  119. CLOUDFLARE_ACCOUNT_ID: undefined,
  120. CLOUDFLARE_API_KEY: undefined,
  121. },
  122. () =>
  123. Effect.gen(function* () {
  124. const plugin = yield* PluginV2.Service
  125. const accounts = yield* AccountV2.Service
  126. const catalog = yield* Catalog.Service
  127. const events = yield* EventV2.Service
  128. yield* accounts.create({
  129. serviceID: AccountV2.ServiceID.make("cloudflare-workers-ai"),
  130. credential: new AccountV2.ApiKeyCredential({
  131. type: "api",
  132. key: "account-key",
  133. metadata: { accountId: "account-acct" },
  134. }),
  135. })
  136. yield* plugin.add({
  137. ...AccountPlugin,
  138. effect: AccountPlugin.effect.pipe(
  139. Effect.provideService(AccountV2.Service, accounts),
  140. Effect.provideService(Catalog.Service, catalog),
  141. Effect.provideService(EventV2.Service, events),
  142. Effect.provideService(PluginV2.Service, plugin),
  143. ),
  144. })
  145. yield* plugin.add(CloudflareWorkersAIPlugin)
  146. const transform = yield* catalog.transform()
  147. yield* transform((catalog) =>
  148. catalog.provider.update(ProviderV2.ID.make("cloudflare-workers-ai"), (provider) => {
  149. provider.endpoint = { type: "aisdk", package: "test-provider" }
  150. }),
  151. )
  152. expect((yield* catalog.provider.get(ProviderV2.ID.make("cloudflare-workers-ai"))).endpoint).toEqual({
  153. type: "aisdk",
  154. package: "test-provider",
  155. url: "https://api.cloudflare.com/client/v4/accounts/account-acct/ai/v1",
  156. })
  157. }),
  158. ),
  159. )
  160. it.effect("uses env account ID over configured account ID", () =>
  161. withEnv({ CLOUDFLARE_ACCOUNT_ID: "env-acct" }, () =>
  162. Effect.gen(function* () {
  163. const plugin = yield* PluginV2.Service
  164. const catalog = yield* Catalog.Service
  165. yield* plugin.add(CloudflareWorkersAIPlugin)
  166. const transform = yield* catalog.transform()
  167. yield* transform((catalog) =>
  168. catalog.provider.update(ProviderV2.ID.make("cloudflare-workers-ai"), (provider) => {
  169. provider.endpoint = { type: "aisdk", package: "test-provider" }
  170. provider.options.aisdk.provider.accountId = "configured-acct"
  171. }),
  172. )
  173. expect((yield* catalog.provider.get(ProviderV2.ID.make("cloudflare-workers-ai"))).endpoint).toEqual({
  174. type: "aisdk",
  175. package: "test-provider",
  176. url: "https://api.cloudflare.com/client/v4/accounts/env-acct/ai/v1",
  177. })
  178. }),
  179. ),
  180. )
  181. it.effect("uses env API key over auth or configured API key and keeps the Cloudflare User-Agent", () =>
  182. withEnv({ CLOUDFLARE_ACCOUNT_ID: "acct", CLOUDFLARE_API_KEY: "env-key" }, () =>
  183. Effect.gen(function* () {
  184. const plugin = yield* PluginV2.Service
  185. yield* plugin.add(CloudflareWorkersAIPlugin)
  186. const result = yield* plugin.trigger(
  187. "aisdk.sdk",
  188. {
  189. model: model("cloudflare-workers-ai", "@cf/model", {
  190. endpoint: { type: "aisdk", package: "@ai-sdk/openai-compatible", url: "https://proxy.example/v1" },
  191. }),
  192. package: "@ai-sdk/openai-compatible",
  193. options: {
  194. name: "cloudflare-workers-ai",
  195. apiKey: "auth-key",
  196. baseURL: "https://proxy.example/v1",
  197. headers: { custom: "header" },
  198. },
  199. },
  200. {},
  201. )
  202. const headers = yield* Effect.promise(() => Promise.resolve(cloudflareHeaders(result.sdk)))
  203. expect(headers.authorization).toBe("Bearer env-key")
  204. expect(headers.custom).toBe("header")
  205. expect(headers["user-agent"]).toMatch(/^opencode\/.* cloudflare-workers-ai \(.+\) ai-sdk\/openai-compatible\//)
  206. }),
  207. ),
  208. )
  209. it.effect("expands account ID vars in endpoint URLs", () =>
  210. withEnv({ CLOUDFLARE_ACCOUNT_ID: "acct", CLOUDFLARE_API_KEY: "key" }, () =>
  211. Effect.gen(function* () {
  212. const plugin = yield* PluginV2.Service
  213. yield* plugin.add(CloudflareWorkersAIPlugin)
  214. const result = yield* plugin.trigger(
  215. "aisdk.sdk",
  216. {
  217. model: model("cloudflare-workers-ai", "@cf/model", {
  218. endpoint: {
  219. type: "aisdk",
  220. package: "@ai-sdk/openai-compatible",
  221. url: "https://api.cloudflare.com/client/v4/accounts/${CLOUDFLARE_ACCOUNT_ID}/ai/v1",
  222. },
  223. }),
  224. package: "@ai-sdk/openai-compatible",
  225. options: {
  226. name: "cloudflare-workers-ai",
  227. baseURL: "https://api.cloudflare.com/client/v4/accounts/${CLOUDFLARE_ACCOUNT_ID}/ai/v1",
  228. },
  229. },
  230. {},
  231. )
  232. expect(cloudflareURL(result.sdk)).toBe(
  233. "https://api.cloudflare.com/client/v4/accounts/acct/ai/v1/chat/completions",
  234. )
  235. }),
  236. ),
  237. )
  238. it.effect("selects languageModel with the API model ID", () =>
  239. Effect.gen(function* () {
  240. const plugin = yield* PluginV2.Service
  241. const calls: string[] = []
  242. yield* plugin.add(CloudflareWorkersAIPlugin)
  243. const result = yield* plugin.trigger(
  244. "aisdk.language",
  245. {
  246. model: model("cloudflare-workers-ai", "alias", { apiID: ModelV2.ID.make("@cf/api-model") }),
  247. sdk: fakeSelectorSdk(calls),
  248. options: {},
  249. },
  250. {},
  251. )
  252. expect(result.language).toBeDefined()
  253. expect(calls).toEqual(["languageModel:@cf/api-model"])
  254. }),
  255. )
  256. it.effect("does not create an SDK for non OpenAI-compatible packages", () =>
  257. withEnv({ CLOUDFLARE_ACCOUNT_ID: "acct", CLOUDFLARE_API_KEY: "key" }, () =>
  258. Effect.gen(function* () {
  259. const plugin = yield* PluginV2.Service
  260. yield* plugin.add(CloudflareWorkersAIPlugin)
  261. const result = yield* plugin.trigger(
  262. "aisdk.sdk",
  263. {
  264. model: model("cloudflare-workers-ai", "@cf/model", {
  265. endpoint: { type: "aisdk", package: "@ai-sdk/anthropic", url: "https://proxy.example/v1" },
  266. }),
  267. package: "@ai-sdk/anthropic",
  268. options: { name: "cloudflare-workers-ai" },
  269. },
  270. {},
  271. )
  272. expect(result.sdk).toBeUndefined()
  273. }),
  274. ),
  275. )
  276. })