mirror of
https://github.com/DayuanJiang/next-ai-draw-io.git
synced 2026-10-13 04:59:51 +08:00
Five reviewers (Fable 5.1, Opus 5.5, Sonnet 5.5, Codex GPT-6 Astra, Codex GPT-6.1 Sol) found no behavior or security regression; this commit applies what they asked for. Settings dialog: the automatic model list fetch only fills the list, which waits behind 'Browse models'; it no longer opens the picker (the modal picker took the focus from whatever the user was typing) and shows no error of its own. One list request per provider at a time, so a click during the automatic fetch sends nothing twice; the baseline that detects freshly entered credentials is taken on every visit of a provider page; SGLang's prefilled local example URL triggers no fetch. Entries saved with Azure's old placeholder URL still count as having no URL. The base URL field of Azure and of the custom preset is labelled required (new dictionary key baseUrlRequired). Smaller code: the PROVIDER_INFO alias is gone (three files and the tests import PROVIDERS), as are three logo values no code read, two unused type re-exports, three unused exports and SINGLE_SYSTEM_PROVIDERS (the chat route reads the record). Renamed for clarity: REQUIRED_KEY_VARS, requiredKeyEnv, configuredUrl, LocalizedText. Seven stale comments rewritten; the custom preset's note shortened. Tests: the matrix gains six override shapes (a Vertex key alone, AWS keys with a session token, headers with a URL, a trusted URL with a key, a key with a server model's URL variable, '/' alone), 5843 rows; the new rows were regenerated on the pre-refactor code and match it. The matrix and the server credential tests clear every variable they read; the admin variable table covers every provider; a test that derived its expectation from the function under test is gone; the singleSystem, listNeedsNoKey, sdkKnowsEndpoint and auto-detection sets are spelled out. Docs: the READMEs say 25 providers and name the OpenAI-compatible preset; the AI_PROVIDER lists are complete; the Azure example URL has its /openai suffix; 'Adding a Provider' names the tests to update.
529 lines
18 KiB
TypeScript
529 lines
18 KiB
TypeScript
import fs from "fs"
|
|
import os from "os"
|
|
import path from "path"
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"
|
|
import {
|
|
ADMIN_PROVIDERS_KEY,
|
|
adminProvidersToConfig,
|
|
credEnvNames,
|
|
deriveEnvUpdates,
|
|
loadAdminProviders,
|
|
maskAdminProviders,
|
|
mergeSecrets,
|
|
type StoredAdminProvider,
|
|
validateAdminProviders,
|
|
} from "@/lib/admin/providers"
|
|
import { _resetForTests, saveSettings } from "@/lib/admin/settings"
|
|
import { PROVIDER_NAMES } from "@/lib/providers"
|
|
import { loadRawServerModelsConfig } from "@/lib/server-model-config"
|
|
|
|
let tmpDir: string
|
|
|
|
beforeEach(() => {
|
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "admin-providers-"))
|
|
vi.stubEnv("SETTINGS_FILE", path.join(tmpDir, "settings.json"))
|
|
_resetForTests()
|
|
})
|
|
|
|
afterEach(() => {
|
|
_resetForTests()
|
|
fs.rmSync(tmpDir, { recursive: true, force: true })
|
|
})
|
|
|
|
function provider(
|
|
overrides: Partial<StoredAdminProvider> = {},
|
|
): StoredAdminProvider {
|
|
return {
|
|
id: "p1",
|
|
provider: "openai",
|
|
apiKey: "sk-test",
|
|
models: ["gpt-5.2"],
|
|
...overrides,
|
|
}
|
|
}
|
|
|
|
describe("deriveEnvUpdates", () => {
|
|
it("writes credentials to ADMIN_-prefixed env vars (never shadows standard vars)", () => {
|
|
const updates = deriveEnvUpdates([provider()], [])
|
|
expect(updates.ADMIN_OPENAI_API_KEY).toBe("sk-test")
|
|
expect(updates.OPENAI_API_KEY).toBeUndefined()
|
|
expect(JSON.parse(updates.ADMIN_PROVIDERS as string)).toHaveLength(1)
|
|
})
|
|
|
|
it("suffixes env vars for a second instance of the same provider", () => {
|
|
const updates = deriveEnvUpdates(
|
|
[
|
|
provider({ id: "p1", name: "First" }),
|
|
provider({
|
|
id: "p2",
|
|
name: "Second",
|
|
apiKey: "sk-second",
|
|
models: ["gpt-5-mini"],
|
|
}),
|
|
],
|
|
[],
|
|
)
|
|
expect(updates.ADMIN_OPENAI_API_KEY).toBe("sk-test")
|
|
expect(updates.ADMIN_OPENAI_API_KEY_2).toBe("sk-second")
|
|
})
|
|
|
|
it("writes an Ollama URL only when the entry has one", () => {
|
|
// Without one, the operator's own OLLAMA_BASE_URL (or local Ollama)
|
|
// stays, also for the AI_PROVIDER=ollama default model
|
|
const keyOnly = deriveEnvUpdates(
|
|
[provider({ provider: "ollama", apiKey: "ollama-key" })],
|
|
[],
|
|
)
|
|
expect(keyOnly.OLLAMA_API_KEY).toBe("ollama-key")
|
|
expect(keyOnly.OLLAMA_BASE_URL ?? null).toBeNull()
|
|
const own = deriveEnvUpdates(
|
|
[
|
|
provider({
|
|
provider: "ollama",
|
|
apiKey: "k",
|
|
baseUrl: "https://ollama.internal/api",
|
|
}),
|
|
],
|
|
[],
|
|
)
|
|
expect(own.OLLAMA_BASE_URL).toBe("https://ollama.internal/api")
|
|
// No key: local Ollama, nothing to write
|
|
const local = deriveEnvUpdates(
|
|
[provider({ provider: "ollama", apiKey: undefined })],
|
|
[],
|
|
)
|
|
expect(local.OLLAMA_BASE_URL ?? null).toBeNull()
|
|
})
|
|
|
|
it("maps bedrock credentials to ADMIN_AWS_* env vars", () => {
|
|
const updates = deriveEnvUpdates(
|
|
[
|
|
provider({
|
|
provider: "bedrock",
|
|
apiKey: undefined,
|
|
awsAccessKeyId: "AKIA123",
|
|
awsSecretAccessKey: "secret",
|
|
awsRegion: "us-west-2",
|
|
models: ["claude-x"],
|
|
}),
|
|
],
|
|
[],
|
|
)
|
|
expect(updates.ADMIN_AWS_ACCESS_KEY_ID).toBe("AKIA123")
|
|
expect(updates.ADMIN_AWS_SECRET_ACCESS_KEY).toBe("secret")
|
|
expect(updates.ADMIN_AWS_REGION).toBe("us-west-2")
|
|
// Standard AWS vars are left to the environment
|
|
expect(updates.AWS_ACCESS_KEY_ID).toBeUndefined()
|
|
})
|
|
|
|
it("clears AWS_* bedrock keys written by older versions", () => {
|
|
const bedrock = provider({
|
|
provider: "bedrock",
|
|
apiKey: undefined,
|
|
awsAccessKeyId: "AKIA123",
|
|
awsSecretAccessKey: "secret",
|
|
models: ["claude-x"],
|
|
})
|
|
const updates = deriveEnvUpdates([bedrock], [bedrock])
|
|
expect(updates.AWS_ACCESS_KEY_ID).toBeNull()
|
|
expect(updates.AWS_SECRET_ACCESS_KEY).toBeNull()
|
|
expect(updates.AWS_REGION).toBeNull()
|
|
expect(updates.ADMIN_AWS_ACCESS_KEY_ID).toBe("AKIA123")
|
|
})
|
|
|
|
it("clears keys owned by the previous list when providers are removed", () => {
|
|
const prev = [provider()]
|
|
const updates = deriveEnvUpdates([], prev)
|
|
expect(updates.ADMIN_OPENAI_API_KEY).toBeNull()
|
|
expect(updates.ADMIN_PROVIDERS).toBeNull()
|
|
})
|
|
|
|
it("sets AI_PROVIDER/AI_MODEL only when a default is flagged", () => {
|
|
const noDefault = deriveEnvUpdates([provider()], [])
|
|
expect(noDefault.AI_PROVIDER).toBeNull()
|
|
expect(noDefault.AI_MODEL).toBeNull()
|
|
|
|
const updates = deriveEnvUpdates(
|
|
[
|
|
provider({ id: "p1" }),
|
|
provider({
|
|
id: "p2",
|
|
provider: "deepseek",
|
|
models: ["deepseek-chat"],
|
|
isDefault: true,
|
|
}),
|
|
],
|
|
[],
|
|
)
|
|
expect(updates.AI_PROVIDER).toBe("deepseek")
|
|
expect(updates.AI_MODEL).toBe("deepseek-chat")
|
|
})
|
|
})
|
|
|
|
describe("adminProvidersToConfig", () => {
|
|
it("builds a config with ADMIN_-prefixed apiKeyEnv wiring", () => {
|
|
const config = adminProvidersToConfig([provider()])
|
|
expect(config.providers).toHaveLength(1)
|
|
expect(config.providers[0].models).toEqual(["gpt-5.2"])
|
|
expect(config.providers[0].apiKeyEnv).toBe("ADMIN_OPENAI_API_KEY")
|
|
})
|
|
|
|
it("wires suffixed env vars for a second instance", () => {
|
|
const config = adminProvidersToConfig([
|
|
provider({ id: "p1", name: "First" }),
|
|
provider({
|
|
id: "p2",
|
|
name: "Second",
|
|
apiKey: "sk-second",
|
|
models: ["gpt-5-mini"],
|
|
}),
|
|
])
|
|
expect(config.providers[1].apiKeyEnv).toBe("ADMIN_OPENAI_API_KEY_2")
|
|
})
|
|
|
|
it("skips providers without models and carries the default flag", () => {
|
|
const config = adminProvidersToConfig([
|
|
provider({ id: "p1", models: [] }),
|
|
provider({ id: "p2", name: "D", isDefault: true }),
|
|
])
|
|
expect(config.providers).toHaveLength(1)
|
|
expect(config.providers[0].default).toBe(true)
|
|
})
|
|
})
|
|
|
|
describe("mergeSecrets", () => {
|
|
it("keeps stored secret when client sends an isSet marker", () => {
|
|
const stored = [provider({ apiKey: "sk-original" })]
|
|
const merged = mergeSecrets(
|
|
[
|
|
{
|
|
...provider(),
|
|
apiKey: { isSet: true, hint: "…test" },
|
|
},
|
|
],
|
|
stored,
|
|
)
|
|
expect(merged[0].apiKey).toBe("sk-original")
|
|
})
|
|
|
|
it("replaces secret when client sends a plaintext string", () => {
|
|
const stored = [provider({ apiKey: "sk-original" })]
|
|
const merged = mergeSecrets(
|
|
[{ ...provider(), apiKey: "sk-new" }],
|
|
stored,
|
|
)
|
|
expect(merged[0].apiKey).toBe("sk-new")
|
|
})
|
|
|
|
it("clears secret when client sends undefined", () => {
|
|
const stored = [provider({ apiKey: "sk-original" })]
|
|
const merged = mergeSecrets(
|
|
[{ ...provider(), apiKey: undefined }],
|
|
stored,
|
|
)
|
|
expect(merged[0].apiKey).toBeUndefined()
|
|
})
|
|
})
|
|
|
|
describe("loadRawServerModelsConfig merge", () => {
|
|
it("combines env AI_MODELS_CONFIG with panel providers", async () => {
|
|
vi.stubEnv(
|
|
"AI_MODELS_CONFIG",
|
|
JSON.stringify({
|
|
providers: [
|
|
{
|
|
name: "Env OpenAI",
|
|
provider: "openai",
|
|
models: ["gpt-from-env"],
|
|
default: true,
|
|
},
|
|
],
|
|
}),
|
|
)
|
|
saveSettings(deriveEnvUpdates([provider({ name: "Panel" })], []))
|
|
|
|
const merged = await loadRawServerModelsConfig()
|
|
expect(merged?.providers.map((p) => p.name)).toEqual([
|
|
"Env OpenAI",
|
|
"Panel",
|
|
])
|
|
// Env default kept because panel set none
|
|
expect(merged?.providers[0].default).toBe(true)
|
|
})
|
|
|
|
it("panel default overrides the env default", async () => {
|
|
vi.stubEnv(
|
|
"AI_MODELS_CONFIG",
|
|
JSON.stringify({
|
|
providers: [
|
|
{
|
|
name: "Env OpenAI",
|
|
provider: "openai",
|
|
models: ["gpt-from-env"],
|
|
default: true,
|
|
},
|
|
],
|
|
}),
|
|
)
|
|
saveSettings(
|
|
deriveEnvUpdates(
|
|
[provider({ name: "Panel", isDefault: true })],
|
|
[],
|
|
),
|
|
)
|
|
|
|
const merged = await loadRawServerModelsConfig()
|
|
expect(merged?.providers[0].default).toBeFalsy()
|
|
expect(merged?.providers[1].default).toBe(true)
|
|
})
|
|
|
|
it("returns only env config when the panel has no providers", async () => {
|
|
vi.stubEnv(
|
|
"AI_MODELS_CONFIG",
|
|
JSON.stringify({
|
|
providers: [
|
|
{
|
|
name: "Env Only",
|
|
provider: "openai",
|
|
models: ["gpt-from-env"],
|
|
},
|
|
],
|
|
}),
|
|
)
|
|
const merged = await loadRawServerModelsConfig()
|
|
expect(merged?.providers.map((p) => p.name)).toEqual(["Env Only"])
|
|
})
|
|
})
|
|
|
|
describe("validateAdminProviders", () => {
|
|
it("rejects names clashing with env-configured providers", () => {
|
|
expect(
|
|
validateAdminProviders([provider({ name: "Env OpenAI" })], {
|
|
providers: [
|
|
{
|
|
name: "Env OpenAI",
|
|
provider: "openai",
|
|
models: ["gpt-x"],
|
|
},
|
|
],
|
|
}),
|
|
).toMatch(/already defined/)
|
|
})
|
|
|
|
it("rejects a global-credential provider already in the env config", () => {
|
|
expect(
|
|
validateAdminProviders(
|
|
[
|
|
provider({
|
|
provider: "bedrock",
|
|
apiKey: undefined,
|
|
awsAccessKeyId: "AKIA-panel",
|
|
awsSecretAccessKey: "panel-secret",
|
|
awsRegion: "us-east-1",
|
|
models: ["claude-x"],
|
|
}),
|
|
],
|
|
{
|
|
providers: [
|
|
{
|
|
name: "Env Bedrock",
|
|
provider: "bedrock",
|
|
models: ["claude-env"],
|
|
},
|
|
],
|
|
},
|
|
),
|
|
).toMatch(/shares global credentials/)
|
|
})
|
|
|
|
it("allows a normal provider type alongside the same env type", () => {
|
|
expect(
|
|
validateAdminProviders([provider({ name: "Panel OpenAI" })], {
|
|
providers: [
|
|
{
|
|
name: "Env OpenAI",
|
|
provider: "openai",
|
|
models: ["gpt-x"],
|
|
},
|
|
],
|
|
}),
|
|
).toBeNull()
|
|
})
|
|
|
|
it("rejects two bedrock instances", () => {
|
|
const list = [
|
|
provider({ id: "p1", provider: "bedrock" }),
|
|
provider({ id: "p2", provider: "bedrock" }),
|
|
]
|
|
expect(validateAdminProviders(list)).toMatch(/Only one/)
|
|
})
|
|
|
|
it("rejects duplicate display names", () => {
|
|
const list = [
|
|
provider({ id: "p1", name: "Same" }),
|
|
provider({ id: "p2", name: "Same" }),
|
|
]
|
|
expect(validateAdminProviders(list)).toMatch(/unique/)
|
|
})
|
|
|
|
it("rejects names that differ only in case or punctuation", () => {
|
|
const list = [
|
|
provider({ id: "p1", name: "Open AI" }),
|
|
provider({ id: "p2", name: "open-ai" }),
|
|
]
|
|
expect(validateAdminProviders(list)).toMatch(/unique/)
|
|
})
|
|
|
|
it("rejects a case-only clash with an env-configured name", () => {
|
|
expect(
|
|
validateAdminProviders([provider({ name: "openai" })], {
|
|
providers: [
|
|
{ name: "OpenAI", provider: "openai", models: ["gpt-x"] },
|
|
],
|
|
}),
|
|
).toMatch(/already defined/)
|
|
})
|
|
|
|
it("accepts distinct CJK names", () => {
|
|
const list = [
|
|
provider({ id: "p1", provider: "deepseek", name: "主力" }),
|
|
provider({ id: "p2", provider: "deepseek", name: "备用" }),
|
|
]
|
|
expect(validateAdminProviders(list)).toBeNull()
|
|
})
|
|
|
|
it("rejects multiple defaults", () => {
|
|
const list = [
|
|
provider({ id: "p1", isDefault: true }),
|
|
provider({ id: "p2", name: "Other", isDefault: true }),
|
|
]
|
|
expect(validateAdminProviders(list)).toMatch(/default/)
|
|
})
|
|
|
|
it("accepts a valid list", () => {
|
|
const list = [
|
|
provider({ id: "p1", isDefault: true }),
|
|
provider({ id: "p2", name: "Backup" }),
|
|
]
|
|
expect(validateAdminProviders(list)).toBeNull()
|
|
})
|
|
})
|
|
|
|
describe("loadAdminProviders", () => {
|
|
it("returns [] when nothing is stored", () => {
|
|
expect(loadAdminProviders()).toEqual([])
|
|
})
|
|
|
|
it("loads valid stored providers", () => {
|
|
saveSettings({ [ADMIN_PROVIDERS_KEY]: JSON.stringify([provider()]) })
|
|
expect(loadAdminProviders()).toHaveLength(1)
|
|
})
|
|
|
|
it("round-trips a bedrock provider with multiple string secrets", () => {
|
|
const bedrock = provider({
|
|
provider: "bedrock",
|
|
apiKey: undefined,
|
|
awsAccessKeyId: "AKIA123",
|
|
awsSecretAccessKey: "secret",
|
|
awsRegion: "us-west-2",
|
|
models: ["claude-x"],
|
|
})
|
|
saveSettings({ [ADMIN_PROVIDERS_KEY]: JSON.stringify([bedrock]) })
|
|
const loaded = loadAdminProviders()
|
|
expect(loaded).toHaveLength(1)
|
|
expect(loaded[0].awsAccessKeyId).toBe("AKIA123")
|
|
expect(loaded[0].awsSecretAccessKey).toBe("secret")
|
|
})
|
|
|
|
it("drops malformed entries and keeps valid ones", () => {
|
|
saveSettings({
|
|
[ADMIN_PROVIDERS_KEY]: JSON.stringify([
|
|
provider({ id: "good" }),
|
|
{ id: "missing-fields" }, // no provider/models
|
|
{ provider: "openai", models: ["x"] }, // no id
|
|
"not-an-object",
|
|
]),
|
|
})
|
|
const loaded = loadAdminProviders()
|
|
expect(loaded).toHaveLength(1)
|
|
expect(loaded[0].id).toBe("good")
|
|
})
|
|
|
|
it("returns [] when the stored value is not an array", () => {
|
|
saveSettings({ [ADMIN_PROVIDERS_KEY]: JSON.stringify({ nope: true }) })
|
|
expect(loadAdminProviders()).toEqual([])
|
|
})
|
|
|
|
it("returns [] on invalid JSON", () => {
|
|
saveSettings({ [ADMIN_PROVIDERS_KEY]: "{ broken" })
|
|
expect(loadAdminProviders()).toEqual([])
|
|
})
|
|
|
|
it("drops entries whose secret is an {isSet} marker, not a string", () => {
|
|
// A hand-edited file could hold a transit-only marker object; if it
|
|
// slipped through, maskSecret() would throw on a non-string value.
|
|
saveSettings({
|
|
[ADMIN_PROVIDERS_KEY]: JSON.stringify([
|
|
{ ...provider(), apiKey: { isSet: true, hint: "…1234" } },
|
|
]),
|
|
})
|
|
const loaded = loadAdminProviders()
|
|
expect(loaded).toEqual([])
|
|
// Masking the loaded list must not throw
|
|
expect(() => maskAdminProviders(loaded)).not.toThrow()
|
|
})
|
|
})
|
|
|
|
describe("credEnvNames", () => {
|
|
it("names the panel's variables for every provider", () => {
|
|
// bedrock, vertexai and ollama write fixed variables; EdgeOne has none
|
|
const expected: Record<string, string | null> = {
|
|
openai: "OPENAI",
|
|
anthropic: "ANTHROPIC",
|
|
google: "GOOGLE",
|
|
deepseek: "DEEPSEEK",
|
|
qwen: "QWEN",
|
|
doubao: "DOUBAO",
|
|
glm: "GLM",
|
|
kimi: "KIMI",
|
|
minimax: "MINIMAX",
|
|
mimo: "MIMO",
|
|
openrouter: "OPENROUTER",
|
|
aihubmix: "AIHUBMIX",
|
|
siliconflow: "SILICONFLOW",
|
|
modelscope: "MODELSCOPE",
|
|
novita: "NOVITA",
|
|
atlascloud: "ATLASCLOUD",
|
|
qiniu: "QINIU",
|
|
gateway: "AI_GATEWAY",
|
|
bedrock: null,
|
|
vertexai: null,
|
|
azure: "AZURE",
|
|
edgeone: null,
|
|
ollama: null,
|
|
sglang: "SGLANG",
|
|
custom: "CUSTOM",
|
|
}
|
|
expect(Object.keys(expected).sort()).toEqual([...PROVIDER_NAMES].sort())
|
|
for (const [p, prefix] of Object.entries(expected)) {
|
|
const first = credEnvNames(p as StoredAdminProvider["provider"], 0)
|
|
const third = credEnvNames(p as StoredAdminProvider["provider"], 2)
|
|
expect([p, first, third]).toEqual([
|
|
p,
|
|
prefix
|
|
? {
|
|
key: `ADMIN_${prefix}_API_KEY`,
|
|
url: `ADMIN_${prefix}_BASE_URL`,
|
|
}
|
|
: {},
|
|
prefix
|
|
? {
|
|
key: `ADMIN_${prefix}_API_KEY_3`,
|
|
url: `ADMIN_${prefix}_BASE_URL_3`,
|
|
}
|
|
: {},
|
|
])
|
|
}
|
|
})
|
|
})
|