Files
openclaw/src/plugins/manifest-registry.test.ts
T
2026-05-10 11:57:13 +01:00

2414 lines
70 KiB
TypeScript

import fs from "node:fs";
import path from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
import { collectChannelSchemaMetadata } from "../config/channel-config-metadata.js";
import { collectBundledChannelConfigs } from "./bundled-channel-config-metadata.js";
import type { PluginCandidate } from "./discovery.js";
import { loadPluginManifestRegistry } from "./manifest-registry.js";
import type { OpenClawPackageManifest } from "./manifest.js";
import { cleanupTrackedTempDirs, makeTrackedTempDir } from "./test-helpers/fs-fixtures.js";
vi.unmock("../version.js");
const tempDirs: string[] = [];
function chmodSafeDir(dir: string) {
if (process.platform === "win32") {
return;
}
fs.chmodSync(dir, 0o755);
}
function mkdirSafe(dir: string) {
fs.mkdirSync(dir, { recursive: true });
chmodSafeDir(dir);
}
function makeTempDir() {
return makeTrackedTempDir("openclaw-manifest-registry", tempDirs);
}
function writeManifest(dir: string, manifest: Record<string, unknown>) {
fs.writeFileSync(path.join(dir, "openclaw.plugin.json"), JSON.stringify(manifest), "utf-8");
}
function writeTextFile(rootDir: string, relativePath: string, value: string) {
mkdirSafe(path.dirname(path.join(rootDir, relativePath)));
fs.writeFileSync(path.join(rootDir, relativePath), value, "utf-8");
}
function setupBundleFixture(params: {
bundleDir: string;
dirs?: readonly string[];
textFiles?: Readonly<Record<string, string>>;
manifestRelativePath?: string;
manifest?: Record<string, unknown>;
}) {
for (const relativeDir of params.dirs ?? []) {
mkdirSafe(path.join(params.bundleDir, relativeDir));
}
for (const [relativePath, value] of Object.entries(params.textFiles ?? {})) {
writeTextFile(params.bundleDir, relativePath, value);
}
if (params.manifestRelativePath && params.manifest) {
writeTextFile(params.bundleDir, params.manifestRelativePath, JSON.stringify(params.manifest));
}
}
function createPluginCandidate(params: {
idHint: string;
rootDir: string;
sourceName?: string;
origin: "bundled" | "global" | "workspace" | "config";
format?: "openclaw" | "bundle";
bundleFormat?: "codex" | "claude" | "cursor";
packageName?: string;
packageVersion?: string;
packageManifest?: OpenClawPackageManifest;
packageDir?: string;
bundledManifest?: PluginCandidate["bundledManifest"];
bundledManifestPath?: string;
}): PluginCandidate {
return {
idHint: params.idHint,
source: path.join(params.rootDir, params.sourceName ?? "index.ts"),
rootDir: params.rootDir,
origin: params.origin,
format: params.format,
bundleFormat: params.bundleFormat,
packageName: params.packageName,
packageVersion: params.packageVersion,
packageManifest: params.packageManifest,
packageDir: params.packageDir,
bundledManifest: params.bundledManifest,
bundledManifestPath: params.bundledManifestPath,
};
}
function loadRegistry(candidates: PluginCandidate[]) {
return loadPluginManifestRegistry({
candidates,
});
}
function hermeticEnv(overrides: NodeJS.ProcessEnv = {}): NodeJS.ProcessEnv {
return {
OPENCLAW_BUNDLED_PLUGINS_DIR: undefined,
OPENCLAW_VERSION: undefined,
VITEST: "true",
...overrides,
};
}
function countDuplicateWarnings(registry: ReturnType<typeof loadPluginManifestRegistry>): number {
return registry.diagnostics.filter(
(diagnostic) =>
diagnostic.level === "warn" && diagnostic.message?.includes("duplicate plugin id"),
).length;
}
function hasPluginIdMismatchWarning(
registry: ReturnType<typeof loadPluginManifestRegistry>,
): boolean {
return registry.diagnostics.some((diagnostic) =>
diagnostic.message.includes("plugin id mismatch"),
);
}
function expectRegistryDiagnosticContains(
registry: ReturnType<typeof loadPluginManifestRegistry>,
fragment: string,
) {
expect(registry.diagnostics.some((diag) => diag.message.includes(fragment))).toBe(true);
}
function expectNoRegistryDiagnosticContains(
registry: ReturnType<typeof loadPluginManifestRegistry>,
fragment: string,
) {
expect(registry.diagnostics.some((diag) => diag.message.includes(fragment))).toBe(false);
}
function requireRecord(value: unknown, label: string): Record<string, unknown> {
expect(
typeof value === "object" && value !== null && !Array.isArray(value),
`${label} object`,
).toBe(true);
return value as Record<string, unknown>;
}
function expectRecordFields(
value: unknown,
label: string,
expected: Record<string, unknown>,
): Record<string, unknown> {
const record = requireRecord(value, label);
for (const [key, expectedValue] of Object.entries(expected)) {
expect(record[key], `${label}.${key}`).toEqual(expectedValue);
}
return record;
}
function expectArrayIncludesAll(value: unknown, expected: readonly unknown[], label: string) {
expect(Array.isArray(value), `${label} array`).toBe(true);
for (const item of expected) {
expect(value as unknown[], `${label} item ${String(item)}`).toContain(item);
}
}
function expectDiagnosticFields(
registry: ReturnType<typeof loadPluginManifestRegistry>,
expected: { level?: string; pluginId?: string; source?: string; messageIncludes?: string },
) {
const diagnostic = registry.diagnostics.find((entry) => {
if (expected.level && entry.level !== expected.level) {
return false;
}
if (expected.pluginId && entry.pluginId !== expected.pluginId) {
return false;
}
if (expected.source && entry.source !== expected.source) {
return false;
}
if (expected.messageIncludes && !entry.message.includes(expected.messageIncludes)) {
return false;
}
return true;
});
expect(diagnostic, `diagnostic ${expected.messageIncludes ?? ""}`).toBeDefined();
}
function prepareLinkedManifestFixture(params: { id: string; mode: "symlink" | "hardlink" }): {
rootDir: string;
linked: boolean;
} {
const rootDir = makeTempDir();
const outsideDir = makeTempDir();
const outsideManifest = path.join(outsideDir, "openclaw.plugin.json");
const linkedManifest = path.join(rootDir, "openclaw.plugin.json");
fs.writeFileSync(path.join(rootDir, "index.ts"), "export default function () {}", "utf-8");
fs.writeFileSync(
outsideManifest,
JSON.stringify({ id: params.id, configSchema: { type: "object" } }),
"utf-8",
);
try {
if (params.mode === "symlink") {
fs.symlinkSync(outsideManifest, linkedManifest);
} else {
fs.linkSync(outsideManifest, linkedManifest);
}
return { rootDir, linked: true };
} catch (err) {
if (params.mode === "symlink") {
return { rootDir, linked: false };
}
if ((err as NodeJS.ErrnoException).code === "EXDEV") {
return { rootDir, linked: false };
}
throw err;
}
}
function loadSingleCandidateRegistry(params: {
idHint: string;
rootDir: string;
origin: "bundled" | "global" | "workspace" | "config";
}) {
return loadRegistry([
createPluginCandidate({
idHint: params.idHint,
rootDir: params.rootDir,
origin: params.origin,
}),
]);
}
function loadRegistryForMinHostVersionCase(params: {
rootDir: string;
minHostVersion: string;
env?: NodeJS.ProcessEnv;
}) {
return loadPluginManifestRegistry({
...(params.env ? { env: params.env } : {}),
candidates: [
createPluginCandidate({
idHint: "synology-chat",
rootDir: params.rootDir,
packageDir: params.rootDir,
origin: "global",
packageManifest: {
install: {
npmSpec: "@openclaw/synology-chat",
minHostVersion: params.minHostVersion,
},
},
}),
],
});
}
function hasUnsafeManifestDiagnostic(registry: ReturnType<typeof loadPluginManifestRegistry>) {
return registry.diagnostics.some((diag) => diag.message.includes("unsafe plugin manifest path"));
}
function expectUnsafeWorkspaceManifestRejected(params: {
id: string;
mode: "symlink" | "hardlink";
}) {
const fixture = prepareLinkedManifestFixture({ id: params.id, mode: params.mode });
if (!fixture.linked) {
return;
}
const registry = loadSingleCandidateRegistry({
idHint: params.id,
rootDir: fixture.rootDir,
origin: "workspace",
});
expect(registry.plugins).toHaveLength(0);
expect(hasUnsafeManifestDiagnostic(registry)).toBe(true);
}
function createDuplicateCandidateRegistry(params: {
pluginId: string;
duplicateOrigin: "global" | "workspace";
}) {
const bundledDir = makeTempDir();
const duplicateDir = makeTempDir();
const manifest = { id: params.pluginId, configSchema: { type: "object" } };
writeManifest(bundledDir, manifest);
writeManifest(duplicateDir, manifest);
return loadPluginManifestRegistry({
candidates: [
createPluginCandidate({
idHint: params.pluginId,
rootDir: bundledDir,
origin: "bundled",
}),
createPluginCandidate({
idHint: params.pluginId,
rootDir: duplicateDir,
origin: params.duplicateOrigin,
}),
],
});
}
function createManifestPluginRoot(params: {
baseDir: string;
pluginId: string;
name: string;
relativePath?: string;
}) {
const pluginRoot = path.join(
params.baseDir,
...(params.relativePath ? [params.relativePath] : []),
);
mkdirSafe(pluginRoot);
writeManifest(pluginRoot, {
id: params.pluginId,
name: params.name,
configSchema: { type: "object" },
});
fs.writeFileSync(path.join(pluginRoot, "index.ts"), "export default {}", "utf-8");
return pluginRoot;
}
function loadBundleRegistry(params: {
idHint: string;
bundleFormat: "codex" | "claude" | "cursor";
setup: (bundleDir: string) => void;
}) {
const bundleDir = makeTempDir();
params.setup(bundleDir);
return loadRegistry([
createPluginCandidate({
idHint: params.idHint,
rootDir: bundleDir,
origin: "global",
format: "bundle",
bundleFormat: params.bundleFormat,
}),
]);
}
function expectPluginRoot(
registry: ReturnType<typeof loadPluginManifestRegistry>,
pluginId: string,
) {
const plugin = registry.plugins.find((entry) => entry.id === pluginId);
if (!plugin) {
throw new Error(`expected plugin ${pluginId} in manifest registry`);
}
return plugin.rootDir;
}
function expectCachedPluginRoot(params: {
first: ReturnType<typeof loadPluginManifestRegistry>;
second: ReturnType<typeof loadPluginManifestRegistry>;
pluginId: string;
firstRoot: string;
secondRoot: string;
}) {
expect(fs.realpathSync(expectPluginRoot(params.first, params.pluginId))).toBe(
fs.realpathSync(params.firstRoot),
);
expect(fs.realpathSync(expectPluginRoot(params.second, params.pluginId))).toBe(
fs.realpathSync(params.secondRoot),
);
}
afterEach(() => {
vi.restoreAllMocks();
cleanupTrackedTempDirs(tempDirs);
});
describe("loadPluginManifestRegistry", () => {
it("reflects plugin manifest changes on the next registry load", () => {
const stateDir = makeTempDir();
const pluginDir = path.join(stateDir, "extensions", "cached-manifest");
mkdirSafe(pluginDir);
fs.writeFileSync(path.join(pluginDir, "index.js"), "export default function () {}", "utf-8");
fs.writeFileSync(
path.join(pluginDir, "package.json"),
JSON.stringify({
name: "@openclaw/cached-manifest",
openclaw: { extensions: ["./index.js"] },
}),
"utf-8",
);
const manifestPath = path.join(pluginDir, "openclaw.plugin.json");
writeManifest(pluginDir, {
id: "cached-manifest",
name: "Before",
configSchema: { type: "object" },
});
const env = hermeticEnv({
OPENCLAW_STATE_DIR: stateDir,
});
const first = loadPluginManifestRegistry({ env });
expect(first.plugins.find((plugin) => plugin.id === "cached-manifest")?.name).toBe("Before");
writeManifest(pluginDir, {
id: "cached-manifest",
name: "After",
configSchema: { type: "object" },
});
const updatedAt = new Date(Date.now() + 5000);
fs.utimesSync(manifestPath, updatedAt, updatedAt);
const second = loadPluginManifestRegistry({ env });
expect(second.plugins.find((plugin) => plugin.id === "cached-manifest")?.name).toBe("After");
});
it("keeps only the higher-precedence plugin for truly distinct duplicates", () => {
const dirA = makeTempDir();
const dirB = makeTempDir();
const manifest = { id: "test-plugin", configSchema: { type: "object" } };
writeManifest(dirA, manifest);
writeManifest(dirB, manifest);
const candidates: PluginCandidate[] = [
createPluginCandidate({
idHint: "test-plugin",
rootDir: dirA,
origin: "bundled",
}),
createPluginCandidate({
idHint: "test-plugin",
rootDir: dirB,
origin: "global",
}),
];
const registry = loadRegistry(candidates);
expect(countDuplicateWarnings(registry)).toBe(1);
expect(registry.plugins).toHaveLength(1);
expect(registry.plugins[0]?.origin).toBe("bundled");
expectRegistryDiagnosticContains(
registry,
"global plugin will be overridden by bundled plugin",
);
});
it("lets config-loaded plugins replace bundled duplicates", () => {
const bundledDir = makeTempDir();
const configDir = makeTempDir();
const manifest = { id: "config-shadow", configSchema: { type: "object" } };
writeManifest(bundledDir, manifest);
writeManifest(configDir, manifest);
const registry = loadRegistry([
createPluginCandidate({
idHint: "config-shadow",
rootDir: bundledDir,
origin: "bundled",
}),
createPluginCandidate({
idHint: "config-shadow",
rootDir: configDir,
origin: "config",
}),
]);
expect(countDuplicateWarnings(registry)).toBe(1);
expect(registry.plugins).toHaveLength(1);
expect(registry.plugins[0]?.origin).toBe("config");
const warning = registry.diagnostics.find((diag) => diag.pluginId === "config-shadow");
expect(warning?.source).toBe(path.join(bundledDir, "index.ts"));
expect(warning?.message).toContain(path.join(configDir, "index.ts"));
});
it("deduplicates compatibility diagnostics when a config plugin replaces a global candidate", () => {
const globalDir = makeTempDir();
const configDir = makeTempDir();
const manifest = {
id: "external-chat",
channels: ["external-chat"],
configSchema: { type: "object" },
};
writeManifest(globalDir, manifest);
writeManifest(configDir, manifest);
const registry = loadRegistry([
createPluginCandidate({
idHint: "external-chat",
rootDir: globalDir,
origin: "global",
}),
createPluginCandidate({
idHint: "external-chat",
rootDir: configDir,
origin: "config",
}),
]);
const channelConfigWarnings = registry.diagnostics.filter((diagnostic) =>
diagnostic.message.includes("without channelConfigs metadata"),
);
expect(channelConfigWarnings).toHaveLength(1);
});
it("suppresses missing channel config diagnostics for inactive external channel plugins", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "external-chat",
channels: ["external-chat"],
configSchema: { type: "object" },
});
const candidate = createPluginCandidate({
idHint: "external-chat",
rootDir: dir,
origin: "global",
});
const disabledRegistry = loadPluginManifestRegistry({
config: { plugins: { entries: { "external-chat": { enabled: false } } } },
candidates: [candidate],
});
expectNoRegistryDiagnosticContains(disabledRegistry, "without channelConfigs metadata");
const allowlistRegistry = loadPluginManifestRegistry({
config: { plugins: { allow: ["other-plugin"] } },
candidates: [candidate],
});
expectNoRegistryDiagnosticContains(allowlistRegistry, "without channelConfigs metadata");
});
it("suppresses duplicate warnings for explicit installed globals overriding bundled plugins", () => {
const bundledDir = makeTempDir();
const globalDir = makeTempDir();
const manifest = { id: "zalouser", configSchema: { type: "object" } };
writeManifest(bundledDir, manifest);
writeManifest(globalDir, manifest);
const registry = loadPluginManifestRegistry({
installRecords: {
zalouser: {
source: "npm",
installPath: globalDir,
},
},
candidates: [
createPluginCandidate({
idHint: "zalouser",
rootDir: bundledDir,
origin: "bundled",
}),
createPluginCandidate({
idHint: "zalouser",
rootDir: globalDir,
origin: "global",
}),
],
});
expect(countDuplicateWarnings(registry)).toBe(0);
expect(registry.plugins).toHaveLength(1);
expect(registry.plugins[0]?.origin).toBe("global");
});
it("suppresses duplicate warnings when the installed global is discovered before bundled", () => {
const bundledDir = makeTempDir();
const globalDir = makeTempDir();
const manifest = { id: "zalouser", configSchema: { type: "object" } };
writeManifest(bundledDir, manifest);
writeManifest(globalDir, manifest);
const registry = loadPluginManifestRegistry({
installRecords: {
zalouser: {
source: "npm",
installPath: globalDir,
},
},
candidates: [
createPluginCandidate({
idHint: "zalouser",
rootDir: globalDir,
origin: "global",
}),
createPluginCandidate({
idHint: "zalouser",
rootDir: bundledDir,
origin: "bundled",
}),
],
});
expect(countDuplicateWarnings(registry)).toBe(0);
expect(registry.plugins).toHaveLength(1);
expect(registry.plugins[0]?.origin).toBe("global");
});
it("marks official installed npm globals as trusted official installs", () => {
const dir = makeTempDir();
writeManifest(dir, { id: "diagnostics-prometheus", configSchema: { type: "object" } });
const registry = loadPluginManifestRegistry({
installRecords: {
"diagnostics-prometheus": {
source: "npm",
installPath: dir,
resolvedName: "@openclaw/diagnostics-prometheus",
resolvedVersion: "2026.5.3",
},
},
candidates: [
createPluginCandidate({
idHint: "diagnostics-prometheus",
rootDir: dir,
packageName: "@openclaw/diagnostics-prometheus",
origin: "global",
}),
],
});
expect(registry.plugins[0]?.trustedOfficialInstall).toBe(true);
});
it("preserves trusted official installs when a config path selects the installed package", () => {
const dir = makeTempDir();
writeManifest(dir, { id: "diagnostics-prometheus", configSchema: { type: "object" } });
const registry = loadPluginManifestRegistry({
installRecords: {
"diagnostics-prometheus": {
source: "npm",
installPath: dir,
resolvedName: "@openclaw/diagnostics-prometheus",
resolvedVersion: "2026.5.3",
},
},
candidates: [
createPluginCandidate({
idHint: "diagnostics-prometheus",
rootDir: dir,
packageName: "@openclaw/diagnostics-prometheus",
origin: "global",
}),
createPluginCandidate({
idHint: "diagnostics-prometheus",
rootDir: dir,
packageName: "@openclaw/diagnostics-prometheus",
origin: "config",
}),
],
});
expect(registry.plugins).toHaveLength(1);
expectRecordFields(registry.plugins[0], "plugin", {
origin: "config",
trustedOfficialInstall: true,
});
});
it("does not trust unrecorded globals that spoof official ids", () => {
const dir = makeTempDir();
writeManifest(dir, { id: "diagnostics-prometheus", configSchema: { type: "object" } });
const registry = loadPluginManifestRegistry({
installRecords: {},
candidates: [
createPluginCandidate({
idHint: "diagnostics-prometheus",
rootDir: dir,
packageName: "@openclaw/diagnostics-prometheus",
origin: "global",
}),
],
});
expect(registry.plugins[0]?.trustedOfficialInstall).toBeUndefined();
});
it("preserves provider auth env metadata from plugin manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "openai",
enabledByDefault: true,
enabledByDefaultOnPlatforms: ["darwin", "not-a-platform"],
providers: ["openai", "openai-codex"],
providerAuthEnvVars: {
openai: ["OPENAI_API_KEY"],
},
providerEndpoints: [
{
endpointClass: "openai-public",
hosts: ["API.OPENAI.COM", ""],
hostSuffixes: [".openai.azure.com"],
baseUrls: ["https://api.openai.com/v1"],
googleVertexRegion: "global",
googleVertexRegionHostSuffix: "-aiplatform.googleapis.com",
},
],
modelIdNormalization: {
providers: {
openai: {
aliases: {
"gpt-latest": "gpt-5.4",
},
stripPrefixes: ["openai/"],
prefixWhenBare: "openai",
prefixWhenBareAfterAliasStartsWith: [
{
modelPrefix: "gpt-",
prefix: "openai",
},
{
modelPrefix: "",
prefix: "ignored",
},
],
},
ignored: {
prefixWhenBare: "ignored",
},
},
},
providerRequest: {
providers: {
openai: {
family: "openai-family",
compatibilityFamily: "moonshot",
openAICompletions: {
supportsStreamingUsage: true,
},
},
ignored: {
family: "ignored",
},
},
},
syntheticAuthRefs: ["openai-cli"],
nonSecretAuthMarkers: ["openai-cli"],
providerAuthAliases: {
"openai-codex": "openai",
},
providerAuthChoices: [
{
provider: "openai",
method: "api-key",
choiceId: "openai-api-key",
choiceLabel: "OpenAI API key",
assistantPriority: 10,
assistantVisibility: "visible",
},
],
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "openai",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.providerAuthEnvVars).toEqual({
openai: ["OPENAI_API_KEY"],
});
expect(registry.plugins[0]?.providerEndpoints).toEqual([
{
endpointClass: "openai-public",
hosts: ["api.openai.com"],
hostSuffixes: [".openai.azure.com"],
baseUrls: ["https://api.openai.com/v1"],
googleVertexRegion: "global",
googleVertexRegionHostSuffix: "-aiplatform.googleapis.com",
},
]);
expect(registry.plugins[0]?.modelIdNormalization).toEqual({
providers: {
openai: {
aliases: {
"gpt-latest": "gpt-5.4",
},
stripPrefixes: ["openai/"],
prefixWhenBare: "openai",
prefixWhenBareAfterAliasStartsWith: [
{
modelPrefix: "gpt-",
prefix: "openai",
},
],
},
},
});
expect(registry.plugins[0]?.providerRequest).toEqual({
providers: {
openai: {
family: "openai-family",
compatibilityFamily: "moonshot",
openAICompletions: {
supportsStreamingUsage: true,
},
},
},
});
expect(registry.plugins[0]?.syntheticAuthRefs).toEqual(["openai-cli"]);
expect(registry.plugins[0]?.nonSecretAuthMarkers).toEqual(["openai-cli"]);
expect(registry.plugins[0]?.providerAuthAliases).toEqual({
"openai-codex": "openai",
});
expect(registry.plugins[0]?.enabledByDefault).toBe(true);
expect(registry.plugins[0]?.enabledByDefaultOnPlatforms).toEqual(["darwin"]);
expect(registry.plugins[0]?.providerAuthChoices).toEqual([
{
provider: "openai",
method: "api-key",
choiceId: "openai-api-key",
choiceLabel: "OpenAI API key",
assistantPriority: 10,
assistantVisibility: "visible",
},
]);
});
it("preserves model catalog metadata from plugin manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "moonshot",
providers: ["moonshot"],
modelCatalog: {
providers: {
moonshot: {
baseUrl: "https://api.moonshot.ai/v1",
api: "openai-responses",
headers: {
"x-provider": "moonshot",
},
models: [
{
id: "kimi-k2.6",
name: "Kimi K2.6",
input: ["text", "image", "bogus"],
reasoning: true,
contextWindow: 256000,
contextTokens: 200000,
maxTokens: 128000,
cost: {
input: 0.6,
output: 2.5,
cacheRead: 0.15,
tieredPricing: [
{
input: 0.6,
output: 2.5,
cacheRead: 0.15,
cacheWrite: 0.6,
range: [0, "bad"],
},
{
input: 0.6,
output: 2.5,
cacheRead: 0.15,
cacheWrite: 0.6,
range: [0, -1],
},
{
input: 0.6,
output: 2.5,
cacheRead: 0.15,
cacheWrite: 0.6,
range: [0, 256000],
},
],
},
compat: {
supportsTools: true,
supportedReasoningEfforts: ["low", "medium"],
supportsStore: "yes",
unknownFlag: true,
},
status: "available",
tags: ["default"],
},
],
},
openai: {
models: [{ id: "gpt-5.4" }],
},
},
aliases: {
kimi: {
provider: "moonshot",
api: "openai-responses",
},
openai: {
provider: "openai",
},
},
suppressions: [
{
provider: "openai",
model: "legacy-kimi",
reason: "superseded by moonshot/kimi-k2.6",
},
],
discovery: {
moonshot: "static",
openai: "static",
ignored: "unknown",
},
},
modelPricing: {
providers: {
moonshot: {
openRouter: {
provider: "moonshotai",
modelIdTransforms: ["version-dots", "unknown"],
},
liteLLM: {
provider: "moonshot",
},
},
openai: {
external: false,
},
},
},
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "moonshot",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.modelCatalog).toEqual({
providers: {
moonshot: {
baseUrl: "https://api.moonshot.ai/v1",
api: "openai-responses",
headers: {
"x-provider": "moonshot",
},
models: [
{
id: "kimi-k2.6",
name: "Kimi K2.6",
input: ["text", "image"],
reasoning: true,
contextWindow: 256000,
contextTokens: 200000,
maxTokens: 128000,
cost: {
input: 0.6,
output: 2.5,
cacheRead: 0.15,
tieredPricing: [
{
input: 0.6,
output: 2.5,
cacheRead: 0.15,
cacheWrite: 0.6,
range: [0, 256000],
},
],
},
compat: {
supportsTools: true,
supportedReasoningEfforts: ["low", "medium"],
},
status: "available",
tags: ["default"],
},
],
},
},
aliases: {
kimi: {
provider: "moonshot",
api: "openai-responses",
},
},
suppressions: [
{
provider: "openai",
model: "legacy-kimi",
reason: "superseded by moonshot/kimi-k2.6",
},
],
discovery: {
moonshot: "static",
},
});
expect(registry.plugins[0]?.modelPricing).toEqual({
providers: {
moonshot: {
openRouter: {
provider: "moonshotai",
modelIdTransforms: ["version-dots"],
},
liteLLM: {
provider: "moonshot",
},
},
},
});
});
it("hydrates bundled channel config metadata from plugin-local config surfaces", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "alpha",
channels: ["alpha"],
configSchema: { type: "object" },
channelConfigs: {
alpha: {
schema: {
type: "object",
properties: {
manifestOnly: { type: "boolean" },
},
},
uiHints: {
manifestOnly: { help: "manifest hint" },
},
},
},
});
writeTextFile(dir, "index.ts", "export {};\n");
writeTextFile(
dir,
"src/config-schema.js",
[
"export const AlphaChannelConfigSchema = {",
" schema: {",
" type: 'object',",
" properties: {",
" generatedOnly: { type: 'string' },",
" },",
" additionalProperties: false,",
" },",
" uiHints: {",
" generatedOnly: { label: 'Generated only' },",
" },",
"};",
].join("\n"),
);
const candidate = createPluginCandidate({
idHint: "alpha",
rootDir: dir,
origin: "bundled",
packageDir: dir,
packageManifest: {
channel: {
id: "alpha",
label: "Alpha",
blurb: "Alpha channel",
},
},
});
expect(loadRegistry([candidate]).plugins[0]?.channelConfigs?.alpha?.schema).toEqual({
type: "object",
properties: {
manifestOnly: { type: "boolean" },
},
});
const registry = loadPluginManifestRegistry({
bundledChannelConfigCollector: collectBundledChannelConfigs,
candidates: [candidate],
});
expect(registry.plugins[0]?.channelConfigs?.alpha).toEqual({
schema: {
type: "object",
properties: {
generatedOnly: { type: "string" },
},
additionalProperties: false,
},
label: "Alpha",
description: "Alpha channel",
uiHints: {
generatedOnly: { label: "Generated only" },
manifestOnly: { help: "manifest hint" },
},
});
expect(collectChannelSchemaMetadata(registry)).toEqual([
{
id: "alpha",
label: "Alpha",
description: "Alpha channel",
configSchema: {
type: "object",
properties: {
generatedOnly: { type: "string" },
},
additionalProperties: false,
},
configUiHints: {
generatedOnly: { label: "Generated only" },
manifestOnly: { help: "manifest hint" },
},
},
]);
});
it("reports non-bundled providerAuthEnvVars as deprecated compat metadata", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "external-openai",
providers: ["openai"],
providerAuthEnvVars: {
openai: ["OPENAI_API_KEY"],
},
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "external-openai",
rootDir: dir,
origin: "global",
});
expect(registry.plugins[0]?.providerAuthEnvVars).toEqual({
openai: ["OPENAI_API_KEY"],
});
expectDiagnosticFields(registry, {
level: "warn",
pluginId: "external-openai",
source: path.join(dir, "openclaw.plugin.json"),
messageIncludes: "providerAuthEnvVars is deprecated compatibility metadata",
});
});
it("does not report deprecated providerAuthEnvVars when setup providers mirror env vars", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "external-openai",
providers: ["openai"],
setup: {
providers: [{ id: "openai", envVars: ["OPENAI_API_KEY"] }],
},
providerAuthEnvVars: {
openai: ["OPENAI_API_KEY"],
},
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "external-openai",
rootDir: dir,
origin: "global",
});
expectNoRegistryDiagnosticContains(
registry,
"providerAuthEnvVars is deprecated compatibility metadata",
);
});
it("sanitizes manifest-controlled fields in provider auth compatibility diagnostics", () => {
const dir = makeTempDir();
const lineBreak = String.fromCharCode(10);
const ansiRed = `${String.fromCharCode(27)}[31m`;
writeManifest(dir, {
id: `external${lineBreak}openai${ansiRed}`,
providers: ["openai"],
providerAuthEnvVars: {
[`openai${lineBreak}${ansiRed}`]: ["OPENAI_API_KEY"],
},
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "external-openai",
rootDir: dir,
origin: "global",
});
const diagnostic = registry.diagnostics.find((entry) =>
entry.message.includes("providerAuthEnvVars is deprecated compatibility metadata"),
);
expect(diagnostic?.pluginId).toBe("externalopenai");
expect(diagnostic?.message).toContain("openai");
expect(diagnostic?.message).not.toContain(lineBreak);
expect(diagnostic?.message).not.toContain(ansiRed);
});
it("reports non-bundled channel manifests without channel config descriptors", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "external-chat",
channels: ["external-chat"],
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "external-chat",
rootDir: dir,
origin: "global",
});
expect(registry.plugins[0]?.channels).toEqual(["external-chat"]);
expectDiagnosticFields(registry, {
level: "warn",
pluginId: "external-chat",
source: path.join(dir, "openclaw.plugin.json"),
messageIncludes: "without channelConfigs metadata",
});
});
it("sanitizes manifest-controlled fields in channel config descriptor diagnostics", () => {
const dir = makeTempDir();
const lineBreak = String.fromCharCode(10);
const ansiRed = `${String.fromCharCode(27)}[31m`;
writeManifest(dir, {
id: `external${lineBreak}chat${ansiRed}`,
channels: [`external${lineBreak}channel${ansiRed}`],
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "external-chat",
rootDir: dir,
origin: "global",
});
const diagnostic = registry.diagnostics.find((entry) =>
entry.message.includes("without channelConfigs metadata"),
);
expect(diagnostic?.pluginId).toBe("externalchat");
expect(diagnostic?.message).toContain("externalchannel");
expect(diagnostic?.message).not.toContain(lineBreak);
expect(diagnostic?.message).not.toContain(ansiRed);
});
it("accepts non-bundled channel manifests with channel config descriptors", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "external-chat",
channels: ["external-chat"],
configSchema: { type: "object" },
channelConfigs: {
"external-chat": {
schema: {
type: "object",
additionalProperties: false,
properties: {
token: { type: "string" },
},
},
},
},
});
const registry = loadSingleCandidateRegistry({
idHint: "external-chat",
rootDir: dir,
origin: "global",
});
expectRecordFields(registry.plugins[0]?.channelConfigs?.["external-chat"]?.schema, "schema", {
type: "object",
additionalProperties: false,
});
expectNoRegistryDiagnosticContains(registry, "without channelConfigs metadata");
});
it("hydrates supplemental official external catalog contracts for lagging npm manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "wecom-openclaw-plugin",
channels: ["wecom"],
configSchema: { type: "object" },
});
const registry = loadRegistry([
createPluginCandidate({
idHint: "wecom-openclaw-plugin",
rootDir: dir,
origin: "global",
packageName: "@wecom/wecom-openclaw-plugin",
}),
]);
expect(registry.plugins[0]?.contracts?.tools).toEqual(["wecom_mcp"]);
const wecomConfig = expectRecordFields(
registry.plugins[0]?.channelConfigs?.wecom,
"wecom config",
{
label: "WeCom",
},
);
expectRecordFields(wecomConfig.schema, "wecom schema", { type: "object" });
expectNoRegistryDiagnosticContains(registry, "without channelConfigs metadata");
});
it("fills missing official external catalog descriptors for partial npm channel configs", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "wecom-openclaw-plugin",
channels: ["wecom"],
configSchema: { type: "object" },
channelConfigs: {
wecom: {
schema: {
type: "object",
additionalProperties: false,
properties: {
corpId: { type: "string" },
},
},
},
},
});
const registry = loadRegistry([
createPluginCandidate({
idHint: "wecom-openclaw-plugin",
rootDir: dir,
origin: "global",
packageName: "@wecom/wecom-openclaw-plugin",
}),
]);
const wecomConfig = expectRecordFields(
registry.plugins[0]?.channelConfigs?.wecom,
"wecom config",
{
label: "WeCom",
description: "Enterprise WeChat conversation channel.",
},
);
expectRecordFields(wecomConfig.schema, "wecom schema", {
additionalProperties: false,
properties: {
corpId: { type: "string" },
},
});
});
it("drops prototype-polluting channel config keys from plugin manifests", () => {
const dir = makeTempDir();
writeTextFile(
dir,
"openclaw.plugin.json",
JSON.stringify({
id: "external-chat",
channels: ["safe-chat"],
configSchema: { type: "object" },
channelConfigs: {
["__proto__"]: {
schema: {
type: "object",
properties: {
polluted: { const: true },
},
},
},
constructor: {
schema: { type: "object" },
},
prototype: {
schema: { type: "object" },
},
"safe-chat": {
schema: {
type: "object",
additionalProperties: false,
},
},
},
}),
);
const registry = loadSingleCandidateRegistry({
idHint: "external-chat",
rootDir: dir,
origin: "global",
});
const channelConfigs = registry.plugins[0]?.channelConfigs;
if (!channelConfigs) {
throw new Error("expected external chat manifest channel config map");
}
expect(Object.getPrototypeOf(channelConfigs)).toBe(null);
expect(Object.prototype.hasOwnProperty.call(channelConfigs, "__proto__")).toBe(false);
expect(Object.prototype.hasOwnProperty.call(channelConfigs, "constructor")).toBe(false);
expect(Object.prototype.hasOwnProperty.call(channelConfigs, "prototype")).toBe(false);
expectRecordFields(channelConfigs["safe-chat"]?.schema, "safe-chat schema", {
type: "object",
additionalProperties: false,
});
});
it("falls back providerDiscoverySource from .ts to emitted .js files", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "anthropic-vertex",
providers: ["anthropic-vertex"],
providerDiscoveryEntry: "./provider-discovery.ts",
configSchema: { type: "object" },
});
fs.writeFileSync(path.join(dir, "provider-discovery.js"), "export default {};\n", "utf8");
const registry = loadSingleCandidateRegistry({
idHint: "anthropic-vertex",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.providerDiscoverySource).toBe(
path.join(dir, "provider-discovery.js"),
);
});
it("prefers providerCatalogEntry over legacy providerDiscoveryEntry", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "catalog-provider",
providers: ["catalog-provider"],
providerCatalogEntry: "./provider-catalog.ts",
providerDiscoveryEntry: "./provider-discovery.ts",
configSchema: { type: "object" },
});
fs.writeFileSync(path.join(dir, "provider-catalog.js"), "export default {};\n", "utf8");
fs.writeFileSync(path.join(dir, "provider-discovery.js"), "export default {};\n", "utf8");
const registry = loadSingleCandidateRegistry({
idHint: "catalog-provider",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.providerDiscoverySource).toBe(
path.join(dir, "provider-catalog.js"),
);
});
it("preserves activation and setup descriptors from plugin manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "openai",
providers: ["openai"],
activation: {
onProviders: ["openai"],
onCommands: ["models"],
onChannels: ["web"],
onRoutes: ["gateway-webhook"],
onConfigPaths: ["browser"],
onCapabilities: ["provider", "tool"],
},
setup: {
providers: [
{
id: "openai",
authMethods: ["api-key"],
envVars: ["OPENAI_API_KEY"],
authEvidence: [
{
type: "local-file-with-env",
fileEnvVar: "OPENAI_CREDENTIALS_FILE",
fallbackPaths: ["${HOME}/.config/openai/credentials.json"],
requiresAnyEnv: ["OPENAI_PROJECT", "OPENAI_ORG"],
requiresAllEnv: ["OPENAI_REGION"],
credentialMarker: "openai-local-credentials",
source: "openai local credentials",
},
],
},
],
cliBackends: ["openai-cli"],
configMigrations: ["legacy-openai-auth"],
requiresRuntime: false,
},
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "openai",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.activation).toEqual({
onProviders: ["openai"],
onCommands: ["models"],
onChannels: ["web"],
onRoutes: ["gateway-webhook"],
onConfigPaths: ["browser"],
onCapabilities: ["provider", "tool"],
});
expect(registry.plugins[0]?.setup).toEqual({
providers: [
{
id: "openai",
authMethods: ["api-key"],
envVars: ["OPENAI_API_KEY"],
authEvidence: [
{
type: "local-file-with-env",
fileEnvVar: "OPENAI_CREDENTIALS_FILE",
fallbackPaths: ["${HOME}/.config/openai/credentials.json"],
requiresAnyEnv: ["OPENAI_PROJECT", "OPENAI_ORG"],
requiresAllEnv: ["OPENAI_REGION"],
credentialMarker: "openai-local-credentials",
source: "openai local credentials",
},
],
},
],
cliBackends: ["openai-cli"],
configMigrations: ["legacy-openai-auth"],
requiresRuntime: false,
});
});
it("preserves media-understanding provider metadata from plugin manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "openai",
contracts: {
mediaUnderstandingProviders: ["openai"],
imageGenerationProviders: ["openai"],
tools: ["image_generate"],
},
imageGenerationProviderMetadata: {
openai: {
aliases: ["openai-codex"],
authProviders: ["openai"],
authSignals: [
{
provider: "openai-codex",
providerBaseUrl: {
provider: "openai",
defaultBaseUrl: "https://api.openai.com/v1",
allowedBaseUrls: ["https://api.openai.com/v1"],
},
},
],
configSignals: [
{
rootPath: "plugins.entries.openai.config",
overlayPath: "image",
mode: {
path: "mode",
default: "local",
allowed: ["local"],
},
requiredAny: ["workflow", "workflowPath"],
required: ["promptNodeId"],
},
],
},
},
mediaUnderstandingProviderMetadata: {
openai: {
capabilities: ["image", "audio", "unknown"],
defaultModels: {
image: "gpt-5.4-mini",
audio: "gpt-4o-transcribe",
unknown: "ignored",
},
autoPriority: {
image: 10,
audio: 20,
video: "ignored",
},
nativeDocumentInputs: ["pdf", "docx"],
},
},
toolMetadata: {
image_generate: {
optional: true,
authSignals: [
{
provider: "openai-codex",
},
],
configSignals: [
{
rootPath: "plugins.entries.openai.config",
overlayPath: "image",
required: ["apiKey"],
},
],
},
},
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "openai",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.imageGenerationProviderMetadata).toEqual({
openai: {
aliases: ["openai-codex"],
authProviders: ["openai"],
authSignals: [
{
provider: "openai-codex",
providerBaseUrl: {
provider: "openai",
defaultBaseUrl: "https://api.openai.com/v1",
allowedBaseUrls: ["https://api.openai.com/v1"],
},
},
],
configSignals: [
{
rootPath: "plugins.entries.openai.config",
overlayPath: "image",
mode: {
path: "mode",
default: "local",
allowed: ["local"],
},
requiredAny: ["workflow", "workflowPath"],
required: ["promptNodeId"],
},
],
},
});
expect(registry.plugins[0]?.mediaUnderstandingProviderMetadata).toEqual({
openai: {
capabilities: ["image", "audio"],
defaultModels: {
image: "gpt-5.4-mini",
audio: "gpt-4o-transcribe",
},
autoPriority: {
image: 10,
audio: 20,
},
nativeDocumentInputs: ["pdf"],
},
});
expect(registry.plugins[0]?.toolMetadata).toEqual({
image_generate: {
optional: true,
authSignals: [
{
provider: "openai-codex",
},
],
configSignals: [
{
rootPath: "plugins.entries.openai.config",
overlayPath: "image",
required: ["apiKey"],
},
],
},
});
});
it("preserves external auth provider contracts from plugin manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "acme-ai",
providers: ["acme-ai"],
contracts: {
externalAuthProviders: ["acme-ai"],
},
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "acme-ai",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.contracts).toEqual({
externalAuthProviders: ["acme-ai"],
});
});
it("preserves channel env metadata from plugin manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "slack",
channels: ["slack"],
channelEnvVars: {
slack: ["SLACK_BOT_TOKEN", "SLACK_APP_TOKEN", "SLACK_USER_TOKEN"],
},
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "slack",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.channelEnvVars).toEqual({
slack: ["SLACK_BOT_TOKEN", "SLACK_APP_TOKEN", "SLACK_USER_TOKEN"],
});
});
it("preserves qa runner descriptors from plugin manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "qa-matrix",
qaRunners: [
{
commandName: "matrix",
description: "Run the Matrix live QA lane",
},
],
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "qa-matrix",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.qaRunners).toEqual([
{
commandName: "matrix",
description: "Run the Matrix live QA lane",
},
]);
});
it("preserves channel config metadata from plugin manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "matrix",
channels: ["matrix"],
configSchema: { type: "object" },
channelConfigs: {
matrix: {
schema: {
type: "object",
properties: {
homeserver: { type: "string" },
},
},
uiHints: {
homeserver: {
label: "Homeserver",
},
},
label: "Matrix",
description: "Matrix config",
preferOver: ["matrix-legacy"],
},
},
});
const registry = loadRegistry([
createPluginCandidate({
idHint: "matrix",
rootDir: dir,
origin: "workspace",
}),
]);
expect(registry.plugins[0]?.channelConfigs).toEqual({
matrix: {
schema: {
type: "object",
properties: {
homeserver: { type: "string" },
},
},
uiHints: {
homeserver: {
label: "Homeserver",
},
},
label: "Matrix",
description: "Matrix config",
preferOver: ["matrix-legacy"],
},
});
});
it("hydrates bundled channel config metadata onto manifest records", () => {
const dir = makeTempDir();
const registry = loadRegistry([
createPluginCandidate({
idHint: "telegram",
rootDir: dir,
origin: "bundled",
bundledManifestPath: path.join(dir, "openclaw.plugin.json"),
bundledManifest: {
id: "telegram",
configSchema: { type: "object" },
channels: ["telegram"],
channelConfigs: {
telegram: {
schema: { type: "object" },
},
},
},
}),
]);
const telegramConfig = requireRecord(
registry.plugins[0]?.channelConfigs?.telegram,
"telegram config",
);
expectRecordFields(telegramConfig.schema, "telegram schema", { type: "object" });
});
it("preserves manifest-owned config contracts from plugin manifests", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "acpx",
configSchema: { type: "object" },
configContracts: {
compatibilityMigrationPaths: ["models.bedrockDiscovery"],
compatibilityRuntimePaths: ["tools.web.search.apiKey"],
dangerousFlags: [{ path: "permissionMode", equals: "approve-all" }],
secretInputs: {
bundledDefaultEnabled: false,
paths: [{ path: "mcpServers.*.env.*", expected: "string" }],
},
},
});
const registry = loadSingleCandidateRegistry({
idHint: "acpx",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.configContracts).toEqual({
compatibilityMigrationPaths: ["models.bedrockDiscovery"],
compatibilityRuntimePaths: ["tools.web.search.apiKey"],
dangerousFlags: [{ path: "permissionMode", equals: "approve-all" }],
secretInputs: {
bundledDefaultEnabled: false,
paths: [{ path: "mcpServers.*.env.*", expected: "string" }],
},
});
});
it("resolves contract plugin ids by compatibility runtime path", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "brave",
configSchema: { type: "object" },
contracts: {
webSearchProviders: ["brave"],
},
configContracts: {
compatibilityRuntimePaths: ["tools.web.search.apiKey"],
},
});
const otherDir = makeTempDir();
writeManifest(otherDir, {
id: "google",
configSchema: { type: "object" },
contracts: {
webSearchProviders: ["gemini"],
},
});
const registry = loadRegistry([
createPluginCandidate({
idHint: "brave",
rootDir: dir,
origin: "bundled",
}),
createPluginCandidate({
idHint: "google",
rootDir: otherDir,
origin: "bundled",
}),
]);
expect(
registry.plugins
.filter(
(plugin) =>
(plugin.contracts?.webSearchProviders?.length ?? 0) > 0 &&
(plugin.configContracts?.compatibilityRuntimePaths ?? []).includes(
"tools.web.search.apiKey",
),
)
.map((plugin) => plugin.id),
).toEqual(["brave"]);
});
it("does not promote legacy top-level capability fields into contracts", () => {
const dir = makeTempDir();
writeManifest(dir, {
id: "openai",
providers: ["openai", "openai-codex"],
speechProviders: ["openai"],
mediaUnderstandingProviders: ["openai", "openai-codex"],
imageGenerationProviders: ["openai"],
configSchema: { type: "object" },
});
const registry = loadSingleCandidateRegistry({
idHint: "openai",
rootDir: dir,
origin: "bundled",
});
expect(registry.plugins[0]?.contracts).toBeUndefined();
});
it.each([
{
name: "skips plugins whose minHostVersion is newer than the current host",
minHostVersion: ">=2026.3.22",
env: { OPENCLAW_VERSION: "2026.3.21" } as NodeJS.ProcessEnv,
expectedMessage: "plugin requires OpenClaw >=2026.3.22, but this host is 2026.3.21",
expectWarn: true,
},
{
name: "skips plugins whose beta minHostVersion is newer than the current host",
minHostVersion: ">=2026.5.1-beta.1",
env: { OPENCLAW_VERSION: "2026.4.30" } as NodeJS.ProcessEnv,
expectedMessage: "plugin requires OpenClaw >=2026.5.1-beta.1, but this host is 2026.4.30",
expectWarn: true,
},
{
name: "rejects invalid minHostVersion metadata",
minHostVersion: "2026.3.22",
expectedMessage: "plugin manifest invalid | openclaw.install.minHostVersion must use",
expectWarn: false,
},
{
name: "warns distinctly when host version cannot be determined",
minHostVersion: ">=2026.3.22",
env: { OPENCLAW_VERSION: "unknown" } as NodeJS.ProcessEnv,
expectedMessage: "host version could not be determined",
expectWarn: true,
},
] as const)("$name", ({ minHostVersion, env, expectedMessage, expectWarn }) => {
const dir = makeTempDir();
writeManifest(dir, { id: "synology-chat", configSchema: { type: "object" } });
const registry = loadRegistryForMinHostVersionCase({
rootDir: dir,
minHostVersion,
...(env ? { env } : {}),
});
expect(registry.plugins).toStrictEqual([]);
expectRegistryDiagnosticContains(registry, expectedMessage);
if (expectWarn) {
expect(registry.diagnostics.map((diag) => diag.level)).toContain("warn");
}
});
it("accepts legacy bare minHostVersion metadata for recorded installed globals", () => {
const dir = makeTempDir();
writeManifest(dir, { id: "codex", configSchema: { type: "object" } });
const registry = loadPluginManifestRegistry({
installRecords: {
codex: {
source: "npm",
installPath: dir,
},
},
candidates: [
createPluginCandidate({
idHint: "codex",
rootDir: dir,
packageDir: dir,
origin: "global",
packageManifest: {
install: {
npmSpec: "@openclaw/codex",
minHostVersion: "2026.3.22",
},
},
}),
],
});
expect(registry.plugins.map((plugin) => plugin.id)).toEqual(["codex"]);
expectNoRegistryDiagnosticContains(registry, "openclaw.install.minHostVersion must use");
});
it("does not runtime-gate bundled source plugins by install minHostVersion", () => {
const dir = makeTempDir();
writeManifest(dir, { id: "codex", configSchema: { type: "object" } });
const registry = loadPluginManifestRegistry({
candidates: [
createPluginCandidate({
idHint: "codex",
rootDir: dir,
packageDir: dir,
origin: "bundled",
packageManifest: {
install: {
npmSpec: "@openclaw/codex",
minHostVersion: ">=2026.5.1-beta.1",
},
},
}),
],
env: { OPENCLAW_VERSION: "2026.4.30" } as NodeJS.ProcessEnv,
});
expect(registry.plugins.map((plugin) => plugin.id)).toContain("codex");
expectNoRegistryDiagnosticContains(registry, "requires OpenClaw");
});
it.each([
{
name: "reports bundled plugins as the duplicate winner for auto-discovered globals",
registry: () =>
createDuplicateCandidateRegistry({
pluginId: "feishu",
duplicateOrigin: "global",
}),
expectedMessage: "global plugin will be overridden by bundled plugin",
},
{
name: "reports bundled plugins as the duplicate winner for workspace duplicates",
registry: () =>
createDuplicateCandidateRegistry({
pluginId: "shadowed",
duplicateOrigin: "workspace",
}),
expectedMessage: "workspace plugin will be overridden by bundled plugin",
},
] as const)("$name", ({ registry: buildRegistry, expectedMessage }) => {
const registry = buildRegistry();
expectRegistryDiagnosticContains(registry, expectedMessage);
expect(registry.plugins).toHaveLength(1);
expect(registry.plugins[0]?.origin).toBe("bundled");
});
it("suppresses duplicate warning when candidates share the same physical directory via symlink", () => {
const realDir = makeTempDir();
const manifest = { id: "feishu", configSchema: { type: "object" } };
writeManifest(realDir, manifest);
// Create a symlink pointing to the same directory
const symlinkParent = makeTempDir();
const symlinkPath = path.join(symlinkParent, "feishu-link");
try {
fs.symlinkSync(realDir, symlinkPath, "junction");
} catch {
// On systems where symlinks are not supported (e.g. restricted Windows),
// skip this test gracefully.
return;
}
const candidates: PluginCandidate[] = [
createPluginCandidate({
idHint: "feishu",
rootDir: realDir,
origin: "bundled",
}),
createPluginCandidate({
idHint: "feishu",
rootDir: symlinkPath,
origin: "bundled",
}),
];
expect(countDuplicateWarnings(loadRegistry(candidates))).toBe(0);
});
it("suppresses duplicate warning when candidates have identical rootDir paths", () => {
const dir = makeTempDir();
const manifest = { id: "same-path-plugin", configSchema: { type: "object" } };
writeManifest(dir, manifest);
const candidates: PluginCandidate[] = [
createPluginCandidate({
idHint: "same-path-plugin",
rootDir: dir,
sourceName: "a.ts",
origin: "bundled",
}),
createPluginCandidate({
idHint: "same-path-plugin",
rootDir: dir,
sourceName: "b.ts",
origin: "global",
}),
];
expect(countDuplicateWarnings(loadRegistry(candidates))).toBe(0);
});
it("suppresses duplicate warning when global candidates come from the same package artifact", () => {
const firstDir = makeTempDir();
const secondDir = makeTempDir();
const manifest = { id: "opik-openclaw", configSchema: { type: "object" } };
writeManifest(firstDir, manifest);
writeManifest(secondDir, manifest);
const candidates: PluginCandidate[] = [
createPluginCandidate({
idHint: "opik-openclaw",
rootDir: firstDir,
origin: "global",
packageName: "@opik/opik-openclaw",
packageVersion: "0.2.14",
}),
createPluginCandidate({
idHint: "opik-openclaw",
rootDir: secondDir,
origin: "global",
packageName: "@opik/opik-openclaw",
packageVersion: "0.2.14",
}),
];
expect(countDuplicateWarnings(loadRegistry(candidates))).toBe(0);
});
it("does not warn for id hint mismatches when manifest id is authoritative", () => {
const dir = makeTempDir();
writeManifest(dir, { id: "openai", configSchema: { type: "object" } });
const registry = loadRegistry([
createPluginCandidate({
idHint: "totally-different",
rootDir: dir,
origin: "bundled",
}),
]);
expect(hasPluginIdMismatchWarning(registry)).toBe(false);
});
it.each([
{
name: "loads Codex bundle manifests into the registry",
idHint: "sample-bundle",
bundleFormat: "codex" as const,
setup: (bundleDir: string) => {
setupBundleFixture({
bundleDir,
dirs: [".codex-plugin", "skills", "hooks"],
manifestRelativePath: ".codex-plugin/plugin.json",
manifest: {
name: "Sample Bundle",
description: "Bundle fixture",
skills: "skills",
hooks: "hooks",
},
});
},
expected: {
id: "sample-bundle",
format: "bundle",
bundleFormat: "codex",
hooks: ["hooks"],
skills: ["skills"],
},
expectedCapabilities: ["hooks", "skills"],
},
{
name: "loads Claude bundle manifests with command roots and settings files",
idHint: "claude-sample",
bundleFormat: "claude" as const,
setup: (bundleDir: string) => {
setupBundleFixture({
bundleDir,
dirs: [".claude-plugin", "skill-packs/starter", "commands-pack"],
textFiles: {
"settings.json": '{"hideThinkingBlock":true}',
},
manifestRelativePath: ".claude-plugin/plugin.json",
manifest: {
name: "Claude Sample",
skills: ["skill-packs/starter"],
commands: "commands-pack",
},
});
},
expected: {
id: "claude-sample",
format: "bundle",
bundleFormat: "claude",
skills: ["skill-packs/starter", "commands-pack"],
settingsFiles: ["settings.json"],
},
expectedCapabilities: ["skills", "commands", "settings"],
},
{
name: "loads manifestless Claude bundles into the registry",
idHint: "manifestless-claude",
bundleFormat: "claude" as const,
setup: (bundleDir: string) => {
setupBundleFixture({
bundleDir,
dirs: ["commands"],
textFiles: {
"settings.json": '{"hideThinkingBlock":true}',
},
});
},
expected: {
format: "bundle",
bundleFormat: "claude",
skills: ["commands"],
settingsFiles: ["settings.json"],
},
expectedCapabilities: ["skills", "commands", "settings"],
},
{
name: "loads Cursor bundle manifests into the registry",
idHint: "cursor-sample",
bundleFormat: "cursor" as const,
setup: (bundleDir: string) => {
setupBundleFixture({
bundleDir,
dirs: [".cursor-plugin", "skills", ".cursor/commands", ".cursor/rules"],
textFiles: {
".cursor/hooks.json": '{"hooks":[]}',
".mcp.json": '{"servers":{}}',
},
manifestRelativePath: ".cursor-plugin/plugin.json",
manifest: {
name: "Cursor Sample",
mcpServers: "./.mcp.json",
},
});
},
expected: {
id: "cursor-sample",
format: "bundle",
bundleFormat: "cursor",
skills: ["skills", ".cursor/commands"],
},
expectedCapabilities: ["skills", "commands", "rules", "hooks", "mcpServers"],
},
] as const)("$name", ({ idHint, bundleFormat, setup, expected, expectedCapabilities }) => {
const registry = loadBundleRegistry({
idHint,
bundleFormat,
setup,
});
expect(registry.plugins).toHaveLength(1);
expectRecordFields(registry.plugins[0], "bundle plugin", expected);
expectArrayIncludesAll(
registry.plugins[0]?.bundleCapabilities,
expectedCapabilities,
"bundle capabilities",
);
});
it("prefers higher-precedence origins for the same physical directory (config > workspace > global > bundled)", () => {
const dir = makeTempDir();
mkdirSafe(path.join(dir, "sub"));
const manifest = { id: "precedence-plugin", configSchema: { type: "object" } };
writeManifest(dir, manifest);
// Use a different-but-equivalent path representation without requiring symlinks.
const altDir = path.join(dir, "sub", "..");
const candidates: PluginCandidate[] = [
createPluginCandidate({
idHint: "precedence-plugin",
rootDir: dir,
origin: "bundled",
}),
createPluginCandidate({
idHint: "precedence-plugin",
rootDir: altDir,
origin: "config",
}),
];
const registry = loadRegistry(candidates);
expect(countDuplicateWarnings(registry)).toBe(0);
expect(registry.plugins.length).toBe(1);
expect(registry.plugins[0]?.origin).toBe("config");
});
it("rejects manifest paths that escape plugin root via symlink", () => {
expectUnsafeWorkspaceManifestRejected({ id: "unsafe-symlink", mode: "symlink" });
});
it("rejects manifest paths that escape plugin root via hardlink", () => {
if (process.platform === "win32") {
return;
}
expectUnsafeWorkspaceManifestRejected({ id: "unsafe-hardlink", mode: "hardlink" });
});
it("still rejects config manifest hardlinks outside the Nix store in Nix mode", () => {
if (process.platform === "win32") {
return;
}
const fixture = prepareLinkedManifestFixture({
id: "unsafe-config-hardlink",
mode: "hardlink",
});
if (!fixture.linked) {
return;
}
const registry = loadPluginManifestRegistry({
env: hermeticEnv({ OPENCLAW_NIX_MODE: "1" }),
candidates: [
createPluginCandidate({
idHint: "unsafe-config-hardlink",
rootDir: fixture.rootDir,
origin: "config",
}),
],
});
expect(registry.plugins).toHaveLength(0);
expect(hasUnsafeManifestDiagnostic(registry)).toBe(true);
});
it("allows bundled manifest paths that are hardlinked aliases", () => {
if (process.platform === "win32") {
return;
}
const fixture = prepareLinkedManifestFixture({ id: "bundled-hardlink", mode: "hardlink" });
if (!fixture.linked) {
return;
}
const registry = loadSingleCandidateRegistry({
idHint: "bundled-hardlink",
rootDir: fixture.rootDir,
origin: "bundled",
});
expect(registry.plugins.map((entry) => entry.id)).toContain("bundled-hardlink");
expect(hasUnsafeManifestDiagnostic(registry)).toBe(false);
});
it("resolves load-path manifests from the current env home", () => {
const homeA = makeTempDir();
const homeB = makeTempDir();
const demoA = createManifestPluginRoot({
baseDir: homeA,
pluginId: "demo",
name: "Demo A",
relativePath: path.join("plugins", "demo"),
});
const demoB = createManifestPluginRoot({
baseDir: homeB,
pluginId: "demo",
name: "Demo B",
relativePath: path.join("plugins", "demo"),
});
const config = {
plugins: {
load: {
paths: ["~/plugins/demo"],
},
},
};
const first = loadPluginManifestRegistry({
config,
env: hermeticEnv({
HOME: homeA,
OPENCLAW_HOME: undefined,
OPENCLAW_STATE_DIR: path.join(homeA, ".state"),
}),
});
const second = loadPluginManifestRegistry({
config,
env: hermeticEnv({
HOME: homeB,
OPENCLAW_HOME: undefined,
OPENCLAW_STATE_DIR: path.join(homeB, ".state"),
}),
});
expectCachedPluginRoot({
first,
second,
pluginId: "demo",
firstRoot: demoA,
secondRoot: demoB,
});
});
it("resolves manifests against the current host version", () => {
const dir = makeTempDir();
writeManifest(dir, { id: "synology-chat", configSchema: { type: "object" } });
fs.writeFileSync(path.join(dir, "index.ts"), "export default {}", "utf-8");
const candidates = [
createPluginCandidate({
idHint: "synology-chat",
rootDir: dir,
packageDir: dir,
origin: "global",
packageManifest: {
install: {
npmSpec: "@openclaw/synology-chat",
minHostVersion: ">=2026.3.22",
},
},
}),
];
const olderHost = loadPluginManifestRegistry({
candidates,
env: hermeticEnv({
OPENCLAW_VERSION: "2026.3.21",
}),
});
const newerHost = loadPluginManifestRegistry({
candidates,
env: hermeticEnv({
OPENCLAW_VERSION: "2026.3.22",
}),
});
expect(olderHost.plugins).toStrictEqual([]);
expectRegistryDiagnosticContains(olderHost, "this host is 2026.3.21");
expect(newerHost.plugins.map((plugin) => plugin.id)).toContain("synology-chat");
expectNoRegistryDiagnosticContains(newerHost, "this host is 2026.3.21");
});
});