refactor: reuse lookup table during gateway plugin load

This commit is contained in:
Shakker
2026-04-27 07:46:49 +01:00
parent b2deb74694
commit 7c985890af
5 changed files with 100 additions and 7 deletions

View File

@@ -2,6 +2,7 @@ import { primeConfiguredBindingRegistry } from "../channels/plugins/binding-regi
import { applyPluginAutoEnable } from "../config/plugin-auto-enable.js";
import type { OpenClawConfig } from "../config/types.openclaw.js";
import type { BundledRuntimeDepsInstallParams } from "../plugins/bundled-runtime-deps.js";
import type { PluginLookUpTable } from "../plugins/plugin-lookup-table.js";
import type { PluginRegistry } from "../plugins/registry.js";
import { pinActivePluginChannelRegistry } from "../plugins/runtime.js";
import {
@@ -32,6 +33,7 @@ type GatewayPluginBootstrapParams = {
coreGatewayMethodNames?: readonly string[];
baseMethods: string[];
pluginIds?: string[];
pluginLookUpTable?: PluginLookUpTable;
preferSetupRuntimeForChannelPlugins?: boolean;
suppressPluginInfoLogs?: boolean;
logDiagnostics?: boolean;
@@ -72,6 +74,9 @@ export function prepareGatewayPluginLoad(params: GatewayPluginBootstrapParams) {
const autoEnabled = applyPluginAutoEnable({
config: activationSourceConfig,
env: process.env,
...(params.pluginLookUpTable?.manifestRegistry
? { manifestRegistry: params.pluginLookUpTable.manifestRegistry }
: {}),
});
const resolvedConfig = autoEnabled.config;
installGatewayPluginRuntimeEnvironment(resolvedConfig);
@@ -89,6 +94,7 @@ export function prepareGatewayPluginLoad(params: GatewayPluginBootstrapParams) {
}),
baseMethods: params.baseMethods,
pluginIds: params.pluginIds,
pluginLookUpTable: params.pluginLookUpTable,
preferSetupRuntimeForChannelPlugins: params.preferSetupRuntimeForChannelPlugins,
suppressPluginInfoLogs: params.suppressPluginInfoLogs,
bundledRuntimeDepsInstaller: params.bundledRuntimeDepsInstaller,

View File

@@ -1,4 +1,5 @@
import { afterEach, beforeAll, beforeEach, describe, expect, test, vi } from "vitest";
import type { PluginLookUpTable } from "../plugins/plugin-lookup-table.js";
import type { PluginRegistry } from "../plugins/registry.js";
import type { PluginRuntimeGatewayRequestScope } from "../plugins/runtime/gateway-request-scope.js";
import type { PluginRuntime } from "../plugins/runtime/types.js";
@@ -108,6 +109,47 @@ const createRegistry = (diagnostics: PluginDiagnostic[]): PluginRegistry => ({
diagnostics,
});
function createLookUpTableForTest(params: {
manifestRegistry?: PluginLookUpTable["manifestRegistry"];
pluginIds?: readonly string[];
}): PluginLookUpTable {
return {
key: "test",
index: {
version: 1,
hostContractVersion: "test",
compatRegistryVersion: "test",
migrationVersion: 1,
policyHash: "test",
generatedAtMs: 1,
installRecords: {},
plugins: [],
diagnostics: [],
},
registryDiagnostics: [],
manifestRegistry: params.manifestRegistry ?? { plugins: [], diagnostics: [] },
plugins: [],
diagnostics: [],
byPluginId: new Map(),
normalizePluginId: (pluginId) => pluginId,
owners: {
channels: new Map(),
channelConfigs: new Map(),
providers: new Map(),
modelCatalogProviders: new Map(),
cliBackends: new Map(),
setupProviders: new Map(),
commandAliases: new Map(),
contracts: new Map(),
},
startup: {
channelPluginIds: [],
configuredDeferredChannelPluginIds: [],
pluginIds: params.pluginIds ?? [],
},
};
}
type ServerPluginsModule = typeof import("./server-plugins.js");
type ServerPluginBootstrapModule = typeof import("./server-plugin-bootstrap.js");
type PluginRuntimeModule = typeof import("../plugins/runtime/index.js");
@@ -372,6 +414,30 @@ describe("loadGatewayPlugins", () => {
);
});
test("reuses a provided lookup table for startup scope and auto-enable manifests", async () => {
loadOpenClawPlugins.mockReturnValue(createRegistry([]));
const manifestRegistry = { plugins: [], diagnostics: [] };
loadGatewayPluginsForTest({
pluginLookUpTable: createLookUpTableForTest({
manifestRegistry,
pluginIds: ["telegram"],
}),
});
expect(loadPluginLookUpTable).not.toHaveBeenCalled();
expect(applyPluginAutoEnable).toHaveBeenCalledWith({
config: {},
env: process.env,
manifestRegistry,
});
expect(loadOpenClawPlugins).toHaveBeenCalledWith(
expect.objectContaining({
onlyPluginIds: ["telegram"],
}),
);
});
test("pins the initial startup channel registry against later active-registry churn", async () => {
const startupRegistry = createRegistry([]);
loadOpenClawPlugins.mockReturnValue(startupRegistry);

View File

@@ -5,7 +5,7 @@ import type { OpenClawConfig } from "../config/types.openclaw.js";
import type { BundledRuntimeDepsInstallParams } from "../plugins/bundled-runtime-deps.js";
import { normalizePluginsConfig } from "../plugins/config-state.js";
import { loadOpenClawPlugins } from "../plugins/loader.js";
import { loadPluginLookUpTable } from "../plugins/plugin-lookup-table.js";
import { loadPluginLookUpTable, type PluginLookUpTable } from "../plugins/plugin-lookup-table.js";
import { createEmptyPluginRegistry } from "../plugins/registry-empty.js";
import { setActivePluginRegistry } from "../plugins/runtime.js";
import { getPluginRuntimeGatewayRequestScope } from "../plugins/runtime/gateway-request-scope.js";
@@ -447,6 +447,7 @@ export function loadGatewayPlugins(params: {
coreGatewayMethodNames?: readonly string[];
baseMethods: string[];
pluginIds?: string[];
pluginLookUpTable?: PluginLookUpTable;
preferSetupRuntimeForChannelPlugins?: boolean;
suppressPluginInfoLogs?: boolean;
bundledRuntimeDepsInstaller?: (params: BundledRuntimeDepsInstallParams) => void;
@@ -456,6 +457,9 @@ export function loadGatewayPlugins(params: {
? applyPluginAutoEnable({
config: params.activationSourceConfig,
env: process.env,
...(params.pluginLookUpTable?.manifestRegistry
? { manifestRegistry: params.pluginLookUpTable.manifestRegistry }
: {}),
})
: undefined;
const autoEnabled =
@@ -475,15 +479,21 @@ export function loadGatewayPlugins(params: {
: applyPluginAutoEnable({
config: params.cfg,
env: process.env,
...(params.pluginLookUpTable?.manifestRegistry
? { manifestRegistry: params.pluginLookUpTable.manifestRegistry }
: {}),
});
const resolvedConfig = autoEnabled.config;
const pluginIds = params.pluginIds ?? [
...loadPluginLookUpTable({
config: resolvedConfig,
activationSourceConfig: params.activationSourceConfig,
workspaceDir: params.workspaceDir,
env: process.env,
}).startup.pluginIds,
...(
params.pluginLookUpTable ??
loadPluginLookUpTable({
config: resolvedConfig,
activationSourceConfig: params.activationSourceConfig,
workspaceDir: params.workspaceDir,
env: process.env,
})
).startup.pluginIds,
];
if (pluginIds.length === 0) {
const pluginRegistry = createEmptyPluginRegistry();

View File

@@ -20,8 +20,10 @@ const repairBundledRuntimeDepsInstallRootAsync = vi.hoisted(() =>
const resolveBundledRuntimeDependencyPackageInstallRoot = vi.hoisted(() =>
vi.fn((_packageRoot: string, _params: unknown) => "/runtime"),
);
const pluginManifestRegistry = vi.hoisted(() => ({ plugins: [], diagnostics: [] }));
const loadPluginLookUpTable = vi.hoisted(() =>
vi.fn((_params: unknown) => ({
manifestRegistry: pluginManifestRegistry,
startup: {
configuredDeferredChannelPluginIds: [],
pluginIds: ["telegram"],
@@ -117,6 +119,7 @@ describe("prepareGatewayPluginBootstrap runtime-deps staging", () => {
repairBundledRuntimeDepsInstallRootAsync.mockReset().mockResolvedValue({});
resolveBundledRuntimeDependencyPackageInstallRoot.mockClear();
loadPluginLookUpTable.mockClear().mockReturnValue({
manifestRegistry: pluginManifestRegistry,
startup: {
configuredDeferredChannelPluginIds: [],
pluginIds: ["telegram"],
@@ -152,6 +155,13 @@ describe("prepareGatewayPluginBootstrap runtime-deps staging", () => {
expect(loadGatewayStartupPlugins).toHaveBeenCalledOnce();
expect(loadPluginLookUpTable).toHaveBeenCalledOnce();
expect(loadGatewayStartupPlugins).toHaveBeenCalledWith(
expect.objectContaining({
pluginLookUpTable: expect.objectContaining({
manifestRegistry: pluginManifestRegistry,
}),
}),
);
expect(scanBundledPluginRuntimeDeps).toHaveBeenCalledWith(
expect.objectContaining({
selectedPluginIds: ["telegram"],

View File

@@ -168,6 +168,7 @@ export async function prepareGatewayPluginBootstrap(params: {
coreGatewayMethodNames: baseMethods,
baseMethods,
pluginIds: startupPluginIds,
pluginLookUpTable,
preferSetupRuntimeForChannelPlugins: deferredConfiguredChannelPluginIds.length > 0,
suppressPluginInfoLogs: deferredConfiguredChannelPluginIds.length > 0,
}));