mirror of
https://github.com/DayuanJiang/next-ai-draw-io.git
synced 2026-10-13 04:59:51 +08:00
refactor(providers): one record per provider, one place for the key-and-URL decision (#988)
Every fact about a provider lives in one record in lib/providers.ts (SDK kind, credential kind, env var prefix, default URL, picker group, four-language notes, and a short model list for the six providers that cannot list models). The thirteen tables keyed by provider name are gone. resolveEndpoint decides whose key a call uses and where it goes; usesServerCredentials reads its answer instead of mirroring getAIModel's branches; serverCredentialError holds the server credential check once. The UI, the connection test and the routes read the record's credential and sdk fields instead of comparing provider names (44 such checks before, 6 after, in the admin panel's fixed-variable branches). Intended behavior changes: providers that can list their models have no hand-written list; the settings dialog fetches the live list in the background once credentials are entered for a provider without models and offers it behind "Browse models". Azure has no placeholder default URL (old entries that hold it still count as unset); the base URL field of Azure and of the new "custom" OpenAI-compatible preset (CUSTOM_API_KEY, CUSTOM_BASE_URL) is labelled required. The connection test answers 400 for an unknown provider name; prototype names are refused everywhere. Provider lists in error messages and the admin "add provider" dropdown follow the picker's order. Also fixed, from before the refactor: the redirect guard drops x-access-code on cross-origin redirects, and edgeOneEndpoint accepts the Origin header only when it matches Host or X-Forwarded-Host. Verification: a behavior snapshot of getAIModel's SDK factory calls and the quota functions over 25 providers, 22 client override shapes and 9 server environments (5843 rows), recorded on the old code and unchanged apart from the intended changes; 752 unit tests, 65 provider e2e tests, tsc, biome, next build. Reviewed by five models from one brief; their findings and the resulting fixes are recorded in docs/plans/2026-10-provider-refactor.md.
This commit is contained in:
@@ -0,0 +1,218 @@
|
||||
/**
|
||||
* The rules the provider record (lib/providers.ts) must keep, and the parts
|
||||
* of the UI that follow its order. The record replaced thirteen tables keyed
|
||||
* by provider name; while they were being replaced, a fixture of their old
|
||||
* values checked the derived ones, and the behavior snapshot
|
||||
* (provider-matrix.test.ts) still holds every scenario's answer.
|
||||
*/
|
||||
import { readFileSync } from "node:fs"
|
||||
import path from "node:path"
|
||||
import { describe, expect, it, vi } from "vitest"
|
||||
import { envVarsOf } from "@/lib/ai-providers"
|
||||
import { i18n } from "@/lib/i18n/config"
|
||||
import { POPULAR_PROVIDERS, PROVIDER_GROUPS } from "@/lib/provider-setup"
|
||||
import { PROVIDER_NAMES, PROVIDERS, publicDefaultUrl } from "@/lib/providers"
|
||||
|
||||
vi.mock("@/lib/admin/settings", () => ({
|
||||
loadSettings: () => ({}),
|
||||
getEnvFallback: (key: string) => process.env[key] ?? null,
|
||||
}))
|
||||
|
||||
const sorted = (list: Iterable<string>) => [...list].sort()
|
||||
|
||||
describe("the provider record", () => {
|
||||
// The fields that change what the server does are spelled out here, so
|
||||
// a slip in one record fails a test instead of changing a request
|
||||
const withField = (
|
||||
field: "singleSystem" | "listNeedsNoKey" | "sdkKnowsEndpoint",
|
||||
) => sorted(PROVIDER_NAMES.filter((p) => PROVIDERS[p][field]))
|
||||
|
||||
it("lets the server auto-detect exactly the providers that need a key", () => {
|
||||
// credential apiKey or vertexKey: the providers whose <P>_API_KEY the
|
||||
// server must have; aws, optionalKey and none need no key
|
||||
const detected = PROVIDER_NAMES.filter((p) =>
|
||||
["apiKey", "vertexKey"].includes(PROVIDERS[p].credential),
|
||||
)
|
||||
expect(sorted(detected)).toEqual(
|
||||
sorted([
|
||||
"openai",
|
||||
"anthropic",
|
||||
"google",
|
||||
"deepseek",
|
||||
"qwen",
|
||||
"doubao",
|
||||
"glm",
|
||||
"kimi",
|
||||
"minimax",
|
||||
"mimo",
|
||||
"openrouter",
|
||||
"aihubmix",
|
||||
"siliconflow",
|
||||
"modelscope",
|
||||
"novita",
|
||||
"atlascloud",
|
||||
"qiniu",
|
||||
"gateway",
|
||||
"vertexai",
|
||||
"azure",
|
||||
"sglang",
|
||||
"custom",
|
||||
]),
|
||||
)
|
||||
// Ollama has a key variable too, an optional one
|
||||
const withKeyVar = PROVIDER_NAMES.filter((p) => !!envVarsOf(p).apiKey)
|
||||
expect(sorted(detected)).toEqual(
|
||||
sorted(withKeyVar.filter((p) => p !== "ollama")),
|
||||
)
|
||||
})
|
||||
|
||||
it("merges system messages for the providers that reject several", () => {
|
||||
expect(withField("singleSystem")).toEqual(
|
||||
sorted([
|
||||
"minimax",
|
||||
"glm",
|
||||
"qwen",
|
||||
"kimi",
|
||||
"qiniu",
|
||||
"novita",
|
||||
"mimo",
|
||||
"custom",
|
||||
]),
|
||||
)
|
||||
})
|
||||
|
||||
it("lists models without a key for the providers with a public or local list", () => {
|
||||
expect(withField("listNeedsNoKey")).toEqual(
|
||||
sorted(["ollama", "openrouter", "aihubmix"]),
|
||||
)
|
||||
})
|
||||
|
||||
it("leaves the base URL to the SDKs that know their endpoint", () => {
|
||||
expect(withField("sdkKnowsEndpoint")).toEqual(
|
||||
sorted([
|
||||
"openai",
|
||||
"google",
|
||||
"azure",
|
||||
"openrouter",
|
||||
"gateway",
|
||||
"deepseek",
|
||||
]),
|
||||
)
|
||||
})
|
||||
|
||||
it("writes every note and hint in every UI language", () => {
|
||||
for (const p of PROVIDER_NAMES) {
|
||||
for (const copy of [PROVIDERS[p].note, PROVIDERS[p].baseUrlHint]) {
|
||||
if (!copy) continue
|
||||
expect(sorted(Object.keys(copy))).toEqual(sorted(i18n.locales))
|
||||
for (const text of Object.values(copy)) {
|
||||
expect(text.trim()).not.toBe("")
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
it("only calls https defaults on its own", () => {
|
||||
expect(publicDefaultUrl("sglang")).toBeUndefined()
|
||||
expect(publicDefaultUrl("openai")).toBe("https://api.openai.com/v1")
|
||||
expect(publicDefaultUrl("bedrock")).toBeUndefined()
|
||||
})
|
||||
|
||||
it("gives the no-key providers no env prefix and limits fixed credentials to non-key kinds", () => {
|
||||
for (const p of PROVIDER_NAMES) {
|
||||
const { credential, envPrefix, fixedCredentials } = PROVIDERS[p]
|
||||
if (credential === "none") expect([p, envPrefix]).toEqual([p, null])
|
||||
if (credential === "aws") expect([p, envPrefix]).toEqual([p, null])
|
||||
if (fixedCredentials) {
|
||||
expect(["aws", "vertexKey", "optionalKey"]).toContain(
|
||||
credential,
|
||||
)
|
||||
}
|
||||
}
|
||||
const fixed = PROVIDER_NAMES.filter(
|
||||
(p) => PROVIDERS[p].fixedCredentials,
|
||||
)
|
||||
expect(fixed).toEqual(["bedrock", "vertexai", "ollama"])
|
||||
})
|
||||
|
||||
it("keeps a short model list exactly for the providers that cannot list models", () => {
|
||||
for (const p of PROVIDER_NAMES) {
|
||||
const { modelList, models } = PROVIDERS[p]
|
||||
if (modelList) {
|
||||
expect([p, models]).toEqual([p, undefined])
|
||||
} else {
|
||||
expect([p, models?.length ?? 0]).not.toEqual([p, 0])
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
it("names every server variable in env.example", () => {
|
||||
// env.example is written by hand; a new provider adds its two lines
|
||||
const example = readFileSync(
|
||||
path.join(process.cwd(), "env.example"),
|
||||
"utf8",
|
||||
)
|
||||
for (const p of PROVIDER_NAMES) {
|
||||
const { apiKey, baseUrl } = envVarsOf(p)
|
||||
for (const name of [apiKey, baseUrl]) {
|
||||
if (!name) continue
|
||||
expect([p, name, example.includes(name)]).toEqual([
|
||||
p,
|
||||
name,
|
||||
true,
|
||||
])
|
||||
}
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
describe("the picker's order", () => {
|
||||
it("groups every provider once, in record order", () => {
|
||||
expect(PROVIDER_GROUPS).toEqual([
|
||||
{
|
||||
id: "vendors",
|
||||
providers: [
|
||||
"openai",
|
||||
"anthropic",
|
||||
"google",
|
||||
"deepseek",
|
||||
"qwen",
|
||||
"doubao",
|
||||
"glm",
|
||||
"kimi",
|
||||
"minimax",
|
||||
"mimo",
|
||||
],
|
||||
},
|
||||
{
|
||||
id: "aggregators",
|
||||
providers: [
|
||||
"openrouter",
|
||||
"aihubmix",
|
||||
"siliconflow",
|
||||
"modelscope",
|
||||
"novita",
|
||||
"atlascloud",
|
||||
"qiniu",
|
||||
"gateway",
|
||||
],
|
||||
},
|
||||
{
|
||||
id: "cloud",
|
||||
providers: ["bedrock", "vertexai", "azure", "edgeone"],
|
||||
},
|
||||
{ id: "selfHosted", providers: ["ollama", "sglang", "custom"] },
|
||||
])
|
||||
})
|
||||
|
||||
it("offers the same popular providers", () => {
|
||||
expect(POPULAR_PROVIDERS).toEqual([
|
||||
"openai",
|
||||
"anthropic",
|
||||
"google",
|
||||
"deepseek",
|
||||
"openrouter",
|
||||
"qwen",
|
||||
])
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user