312 lines
8.2 KiB
TypeScript
312 lines
8.2 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import { describe, expect, it } from "vitest";
|
|
import {
|
|
getConfigValueAtPath,
|
|
parseConfigPath,
|
|
setConfigValueAtPath,
|
|
unsetConfigValueAtPath,
|
|
} from "./config-paths.js";
|
|
import { readConfigFileSnapshot, validateConfigObject } from "./config.js";
|
|
import { buildWebSearchProviderConfig, withTempHome } from "./test-helpers.js";
|
|
import { OpenClawSchema } from "./zod-schema.js";
|
|
|
|
describe("$schema key in config (#14998)", () => {
|
|
it("accepts config with $schema string", () => {
|
|
const result = OpenClawSchema.safeParse({
|
|
$schema: "https://openclaw.ai/config.json",
|
|
});
|
|
expect(result.success).toBe(true);
|
|
if (result.success) {
|
|
expect(result.data.$schema).toBe("https://openclaw.ai/config.json");
|
|
}
|
|
});
|
|
|
|
it("accepts config without $schema", () => {
|
|
const result = OpenClawSchema.safeParse({});
|
|
expect(result.success).toBe(true);
|
|
});
|
|
|
|
it("rejects non-string $schema", () => {
|
|
const result = OpenClawSchema.safeParse({ $schema: 123 });
|
|
expect(result.success).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("ui.seamColor", () => {
|
|
it("accepts hex colors", () => {
|
|
const res = validateConfigObject({ ui: { seamColor: "#FF4500" } });
|
|
expect(res.ok).toBe(true);
|
|
});
|
|
|
|
it("rejects non-hex colors", () => {
|
|
const res = validateConfigObject({ ui: { seamColor: "lobster" } });
|
|
expect(res.ok).toBe(false);
|
|
});
|
|
|
|
it("rejects invalid hex length", () => {
|
|
const res = validateConfigObject({ ui: { seamColor: "#FF4500FF" } });
|
|
expect(res.ok).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("web search provider config", () => {
|
|
it("accepts kimi provider and config", () => {
|
|
const res = validateConfigObject(
|
|
buildWebSearchProviderConfig({
|
|
provider: "kimi",
|
|
providerConfig: {
|
|
apiKey: "test-key",
|
|
baseUrl: "https://api.moonshot.ai/v1",
|
|
model: "moonshot-v1-128k",
|
|
},
|
|
}),
|
|
);
|
|
|
|
expect(res.ok).toBe(true);
|
|
});
|
|
});
|
|
|
|
describe("talk.voiceAliases", () => {
|
|
it("accepts a string map of voice aliases", () => {
|
|
const res = validateConfigObject({
|
|
talk: {
|
|
voiceAliases: {
|
|
Clawd: "EXAVITQu4vr4xnSDxMaL",
|
|
Roger: "CwhRBWXzGAHq8TQ4Fs17",
|
|
},
|
|
},
|
|
});
|
|
expect(res.ok).toBe(true);
|
|
});
|
|
|
|
it("rejects non-string voice alias values", () => {
|
|
const res = validateConfigObject({
|
|
talk: {
|
|
voiceAliases: {
|
|
Clawd: 123,
|
|
},
|
|
},
|
|
});
|
|
expect(res.ok).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("gateway.remote.transport", () => {
|
|
it("accepts direct transport", () => {
|
|
const res = validateConfigObject({
|
|
gateway: {
|
|
remote: {
|
|
transport: "direct",
|
|
url: "wss://gateway.example.ts.net",
|
|
},
|
|
},
|
|
});
|
|
expect(res.ok).toBe(true);
|
|
});
|
|
|
|
it("rejects unknown transport", () => {
|
|
const res = validateConfigObject({
|
|
gateway: {
|
|
remote: {
|
|
transport: "udp",
|
|
},
|
|
},
|
|
});
|
|
expect(res.ok).toBe(false);
|
|
if (!res.ok) {
|
|
expect(res.issues[0]?.path).toBe("gateway.remote.transport");
|
|
}
|
|
});
|
|
});
|
|
|
|
describe("gateway.tools config", () => {
|
|
it("accepts gateway.tools allow and deny lists", () => {
|
|
const res = validateConfigObject({
|
|
gateway: {
|
|
tools: {
|
|
allow: ["gateway"],
|
|
deny: ["sessions_spawn", "sessions_send"],
|
|
},
|
|
},
|
|
});
|
|
expect(res.ok).toBe(true);
|
|
});
|
|
|
|
it("rejects invalid gateway.tools values", () => {
|
|
const res = validateConfigObject({
|
|
gateway: {
|
|
tools: {
|
|
allow: "gateway",
|
|
},
|
|
},
|
|
});
|
|
expect(res.ok).toBe(false);
|
|
if (!res.ok) {
|
|
expect(res.issues[0]?.path).toBe("gateway.tools.allow");
|
|
}
|
|
});
|
|
});
|
|
|
|
describe("gateway.channelHealthCheckMinutes", () => {
|
|
it("accepts zero to disable monitor", () => {
|
|
const res = validateConfigObject({
|
|
gateway: {
|
|
channelHealthCheckMinutes: 0,
|
|
},
|
|
});
|
|
expect(res.ok).toBe(true);
|
|
});
|
|
|
|
it("rejects negative intervals", () => {
|
|
const res = validateConfigObject({
|
|
gateway: {
|
|
channelHealthCheckMinutes: -1,
|
|
},
|
|
});
|
|
expect(res.ok).toBe(false);
|
|
if (!res.ok) {
|
|
expect(res.issues[0]?.path).toBe("gateway.channelHealthCheckMinutes");
|
|
}
|
|
});
|
|
});
|
|
|
|
describe("cron webhook schema", () => {
|
|
it("accepts cron.webhookToken and legacy cron.webhook", () => {
|
|
const res = OpenClawSchema.safeParse({
|
|
cron: {
|
|
enabled: true,
|
|
webhook: "https://example.invalid/legacy-cron-webhook",
|
|
webhookToken: "secret-token",
|
|
},
|
|
});
|
|
|
|
expect(res.success).toBe(true);
|
|
});
|
|
|
|
it("rejects non-http cron.webhook URLs", () => {
|
|
const res = OpenClawSchema.safeParse({
|
|
cron: {
|
|
webhook: "ftp://example.invalid/legacy-cron-webhook",
|
|
},
|
|
});
|
|
|
|
expect(res.success).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("broadcast", () => {
|
|
it("accepts a broadcast peer map with strategy", () => {
|
|
const res = validateConfigObject({
|
|
agents: {
|
|
list: [{ id: "alfred" }, { id: "baerbel" }],
|
|
},
|
|
broadcast: {
|
|
strategy: "parallel",
|
|
"120363403215116621@g.us": ["alfred", "baerbel"],
|
|
},
|
|
});
|
|
expect(res.ok).toBe(true);
|
|
});
|
|
|
|
it("rejects invalid broadcast strategy", () => {
|
|
const res = validateConfigObject({
|
|
broadcast: { strategy: "nope" },
|
|
});
|
|
expect(res.ok).toBe(false);
|
|
});
|
|
|
|
it("rejects non-array broadcast entries", () => {
|
|
const res = validateConfigObject({
|
|
broadcast: { "120363403215116621@g.us": 123 },
|
|
});
|
|
expect(res.ok).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("model compat config schema", () => {
|
|
it("accepts full openai-completions compat fields", () => {
|
|
const res = validateConfigObject({
|
|
models: {
|
|
providers: {
|
|
local: {
|
|
baseUrl: "http://127.0.0.1:1234/v1",
|
|
api: "openai-completions",
|
|
models: [
|
|
{
|
|
id: "qwen3-32b",
|
|
name: "Qwen3 32B",
|
|
compat: {
|
|
supportsUsageInStreaming: true,
|
|
supportsStrictMode: false,
|
|
thinkingFormat: "qwen",
|
|
requiresToolResultName: true,
|
|
requiresAssistantAfterToolResult: false,
|
|
requiresThinkingAsText: false,
|
|
requiresMistralToolIds: false,
|
|
},
|
|
},
|
|
],
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
expect(res.ok).toBe(true);
|
|
});
|
|
});
|
|
|
|
describe("config paths", () => {
|
|
it("rejects empty and blocked paths", () => {
|
|
expect(parseConfigPath("")).toEqual({
|
|
ok: false,
|
|
error: "Invalid path. Use dot notation (e.g. foo.bar).",
|
|
});
|
|
expect(parseConfigPath("__proto__.polluted").ok).toBe(false);
|
|
expect(parseConfigPath("constructor.polluted").ok).toBe(false);
|
|
expect(parseConfigPath("prototype.polluted").ok).toBe(false);
|
|
});
|
|
|
|
it("sets, gets, and unsets nested values", () => {
|
|
const root: Record<string, unknown> = {};
|
|
const parsed = parseConfigPath("foo.bar");
|
|
if (!parsed.ok || !parsed.path) {
|
|
throw new Error("path parse failed");
|
|
}
|
|
setConfigValueAtPath(root, parsed.path, 123);
|
|
expect(getConfigValueAtPath(root, parsed.path)).toBe(123);
|
|
expect(unsetConfigValueAtPath(root, parsed.path)).toBe(true);
|
|
expect(getConfigValueAtPath(root, parsed.path)).toBeUndefined();
|
|
});
|
|
});
|
|
|
|
describe("config strict validation", () => {
|
|
it("rejects unknown fields", async () => {
|
|
const res = validateConfigObject({
|
|
agents: { list: [{ id: "pi" }] },
|
|
customUnknownField: { nested: "value" },
|
|
});
|
|
expect(res.ok).toBe(false);
|
|
});
|
|
|
|
it("flags legacy config entries without auto-migrating", async () => {
|
|
await withTempHome(async (home) => {
|
|
const configDir = path.join(home, ".openclaw");
|
|
await fs.mkdir(configDir, { recursive: true });
|
|
await fs.writeFile(
|
|
path.join(configDir, "openclaw.json"),
|
|
JSON.stringify({
|
|
agents: { list: [{ id: "pi" }] },
|
|
routing: { allowFrom: ["+15555550123"] },
|
|
}),
|
|
"utf-8",
|
|
);
|
|
|
|
const snap = await readConfigFileSnapshot();
|
|
|
|
expect(snap.valid).toBe(false);
|
|
expect(snap.legacyIssues).not.toHaveLength(0);
|
|
});
|
|
});
|
|
});
|