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

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