File size: 7,215 Bytes
4c76b0d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | // Metadata registry loader tests cover metadata-only plugin registry assembly.
import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
import { createInfoWarnErrorLogger } from "../../../test/helpers/mock-logger.js";
import type { PluginLoadOptions } from "../loader.js";
const loadConfigMock = vi.fn();
const applyPluginAutoEnableMock = vi.fn();
const loadOpenClawPluginsMock = vi.fn();
let loadPluginMetadataRegistrySnapshot: typeof import("./metadata-registry-loader.js").loadPluginMetadataRegistrySnapshot;
vi.mock("../../config/config.js", () => ({
getRuntimeConfig: () => loadConfigMock(),
loadConfig: () => loadConfigMock(),
}));
vi.mock("../../config/plugin-auto-enable.js", () => ({
applyPluginAutoEnable: (...args: unknown[]) => applyPluginAutoEnableMock(...args),
}));
vi.mock("../loader.js", () => ({
loadOpenClawPlugins: (...args: unknown[]) => loadOpenClawPluginsMock(...args),
loadPluginRegistryHandle: (options: Record<string, unknown> = {}) =>
loadOpenClawPluginsMock({ ...options, activate: false }),
}));
vi.mock("../../agents/agent-scope.js", () => ({
listAgentEntries: vi.fn<typeof import("../../agents/agent-scope.js").listAgentEntries>(() => []),
resolveAgentWorkspaceDir: () => "/resolved-workspace",
tryResolveConfiguredAgentWorkspaceDir: vi.fn<
typeof import("../../agents/agent-scope.js").tryResolveConfiguredAgentWorkspaceDir
>(() => "/resolved-workspace"),
resolveDefaultAgentId: () => "default",
}));
vi.mock("../control-plane-workspace.js", () => ({
resolvePluginControlPlaneWorkspace: (params: { workspaceDir?: string }) => ({
workspaceDir: params.workspaceDir ?? "/resolved-workspace",
workspaceScope: "selected",
}),
}));
function getOnlyLoadOpenClawPluginsOptions(): PluginLoadOptions {
expect(loadOpenClawPluginsMock).toHaveBeenCalledTimes(1);
const options = loadOpenClawPluginsMock.mock.calls[0]?.[0];
if (!options || typeof options !== "object") {
throw new Error("expected loadOpenClawPlugins to receive plugin load options");
}
return options as PluginLoadOptions;
}
describe("loadPluginMetadataRegistrySnapshot", () => {
beforeAll(async () => {
({ loadPluginMetadataRegistrySnapshot } = await import("./metadata-registry-loader.js"));
});
beforeEach(() => {
loadConfigMock.mockReset();
applyPluginAutoEnableMock.mockReset();
loadOpenClawPluginsMock.mockReset();
loadConfigMock.mockReturnValue({ plugins: {} });
applyPluginAutoEnableMock.mockImplementation((params: { config: unknown }) => ({
config: params.config,
changes: [],
autoEnabledReasons: {},
}));
loadOpenClawPluginsMock.mockReturnValue({ plugins: [], diagnostics: [] });
});
it("defaults to a non-activating validate snapshot", () => {
loadPluginMetadataRegistrySnapshot({
config: { plugins: {} },
activationSourceConfig: { plugins: { allow: ["demo"] } },
env: { HOME: "/tmp/openclaw-home" } as NodeJS.ProcessEnv,
workspaceDir: "/workspace",
onlyPluginIds: ["demo"],
});
const loadOptions = getOnlyLoadOpenClawPluginsOptions();
expect(loadOptions).toMatchObject({
config: { plugins: {} },
activationSourceConfig: { plugins: { allow: ["demo"] } },
autoEnabledReasons: {},
workspaceDir: "/workspace",
env: { HOME: "/tmp/openclaw-home" },
throwOnLoadError: true,
cache: false,
activate: false,
mode: "validate",
loadModules: undefined,
onlyPluginIds: ["demo"],
});
expect(loadOptions.logger).toBeDefined();
});
it("forwards explicit manifest-only requests", () => {
loadPluginMetadataRegistrySnapshot({
config: { plugins: {} },
loadModules: false,
});
const loadOptions = getOnlyLoadOpenClawPluginsOptions();
expect(loadOptions).toMatchObject({
config: { plugins: {} },
activationSourceConfig: { plugins: {} },
autoEnabledReasons: {},
workspaceDir: "/resolved-workspace",
throwOnLoadError: true,
cache: false,
activate: false,
mode: "validate",
loadModules: false,
});
expect(loadOptions.env === process.env).toBe(true);
expect(loadOptions.logger).toBeDefined();
});
it("forwards an explicit logger through metadata snapshots", () => {
const logger = createInfoWarnErrorLogger();
loadPluginMetadataRegistrySnapshot({
config: { plugins: {} },
logger,
workspaceDir: "/workspace",
});
const { env, ...loadOptions } = getOnlyLoadOpenClawPluginsOptions();
expect(loadOptions).toMatchObject({
config: { plugins: {} },
activationSourceConfig: { plugins: {} },
autoEnabledReasons: {},
workspaceDir: "/workspace",
logger,
throwOnLoadError: true,
cache: false,
activate: false,
mode: "validate",
loadModules: undefined,
});
// Preserve the env subset check without handing its values to the matcher.
expect(
env !== undefined && Object.entries(process.env).every(([key, value]) => env[key] === value),
).toBe(true);
});
it("honors explicit load options when reusing a resolved runtime context", () => {
const logger = createInfoWarnErrorLogger();
const env = { HOME: "/tmp/context-home" } as NodeJS.ProcessEnv;
const manifestRegistry = { plugins: [], diagnostics: [] };
loadPluginMetadataRegistrySnapshot({
config: { plugins: { allow: ["compat-provider"] } },
activationSourceConfig: { plugins: { allow: ["raw-plugin"] } },
workspaceDir: "/compat-workspace",
env,
logger,
manifestRegistry,
runtimeContext: {
rawConfig: { plugins: { allow: ["raw-plugin"] } },
config: { plugins: { allow: ["raw-plugin"] } },
activationSourceConfig: { plugins: { allow: ["raw-plugin"] } },
autoEnabledReasons: {},
workspaceDir: "/context-workspace",
env,
logger,
},
});
expect(applyPluginAutoEnableMock).not.toHaveBeenCalled();
expect(getOnlyLoadOpenClawPluginsOptions()).toEqual({
config: { plugins: { allow: ["compat-provider"] } },
activationSourceConfig: { plugins: { allow: ["raw-plugin"] } },
autoEnabledReasons: {},
workspaceDir: "/compat-workspace",
env,
logger,
throwOnLoadError: true,
cache: false,
activate: false,
mode: "validate",
loadModules: undefined,
manifestRegistry,
installRecords: undefined,
});
});
it("preserves explicit empty plugin scopes on metadata snapshots", () => {
loadPluginMetadataRegistrySnapshot({
config: { plugins: {} },
onlyPluginIds: [],
});
const loadOptions = getOnlyLoadOpenClawPluginsOptions();
expect(loadOptions).toMatchObject({
config: { plugins: {} },
activationSourceConfig: { plugins: {} },
autoEnabledReasons: {},
workspaceDir: "/resolved-workspace",
throwOnLoadError: true,
cache: false,
activate: false,
mode: "validate",
loadModules: undefined,
onlyPluginIds: [],
});
expect(loadOptions.env === process.env).toBe(true);
expect(loadOptions.logger).toBeDefined();
});
});
|