File size: 5,410 Bytes
f778c12 | 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 | // Channel setup plugin install/reload helpers used by onboarding and channel commands.
import { resolveAgentWorkspaceDir, resolveDefaultAgentId } from "../../agents/agent-scope.js";
import type { ChannelPluginCatalogEntry } from "../../channels/plugins/catalog.js";
import { applyPluginAutoEnable } from "../../config/plugin-auto-enable.js";
import type { OpenClawConfig } from "../../config/types.openclaw.js";
import { createSubsystemLogger } from "../../logging/subsystem.js";
import {
resolveConfiguredChannelPluginIds,
resolveDiscoverableScopedChannelPluginIds,
} from "../../plugins/channel-plugin-ids.js";
import { loadPluginRegistryHandle } from "../../plugins/loader.js";
import type { PluginRegistry } from "../../plugins/registry.js";
import type { RuntimeEnv } from "../../runtime.js";
import type { WizardPrompter } from "../../wizard/prompts.js";
import {
ensureOnboardingPluginInstalled,
type OnboardingPluginInstallEntry,
type OnboardingPluginInstallStatus,
} from "../onboarding-plugin-install.js";
import { getTrustedChannelPluginCatalogEntry } from "./trusted-catalog.js";
type InstallResult = {
cfg: OpenClawConfig;
installed: boolean;
pluginId?: string;
status: OnboardingPluginInstallStatus;
};
function toOnboardingPluginInstallEntry(
entry: ChannelPluginCatalogEntry,
): OnboardingPluginInstallEntry {
return {
pluginId: entry.pluginId ?? entry.id,
label: entry.meta.label,
install: entry.install,
...(entry.trustedSourceLinkedOfficialInstall
? { trustedSourceLinkedOfficialInstall: true }
: {}),
};
}
/** Install or reuse the plugin package required by a trusted channel catalog entry. */
export async function ensureChannelSetupPluginInstalled(params: {
cfg: OpenClawConfig;
entry: ChannelPluginCatalogEntry;
prompter: WizardPrompter;
runtime: RuntimeEnv;
workspaceDir?: string;
promptInstall?: boolean;
autoConfirmSingleSource?: boolean;
beforePersistentEffect?: () => Promise<void>;
}): Promise<InstallResult> {
const result = await ensureOnboardingPluginInstalled({
cfg: params.cfg,
entry: toOnboardingPluginInstallEntry(params.entry),
prompter: params.prompter,
runtime: params.runtime,
workspaceDir: params.workspaceDir,
...(params.promptInstall !== undefined ? { promptInstall: params.promptInstall } : {}),
...(params.autoConfirmSingleSource !== undefined
? { autoConfirmSingleSource: params.autoConfirmSingleSource }
: {}),
...(params.beforePersistentEffect
? { beforePersistentEffect: params.beforePersistentEffect }
: {}),
});
return {
cfg: result.cfg,
installed: result.installed,
pluginId: result.pluginId,
status: result.status,
};
}
function loadChannelSetupPluginRegistry(params: {
cfg: OpenClawConfig;
runtime: RuntimeEnv;
workspaceDir?: string;
onlyPluginIds?: string[];
forceSetupOnlyChannelPlugins?: boolean;
}): PluginRegistry {
const autoEnabled = applyPluginAutoEnable({ config: params.cfg, env: process.env });
const resolvedConfig = autoEnabled.config;
const workspaceDir =
params.workspaceDir ??
resolveAgentWorkspaceDir(resolvedConfig, resolveDefaultAgentId(resolvedConfig));
const onlyPluginIds =
params.onlyPluginIds ??
resolveConfiguredChannelPluginIds({
config: resolvedConfig,
activationSourceConfig: params.cfg,
workspaceDir,
env: process.env,
});
const log = createSubsystemLogger("plugins");
return loadPluginRegistryHandle({
config: resolvedConfig,
activationSourceConfig: params.cfg,
autoEnabledReasons: autoEnabled.autoEnabledReasons,
workspaceDir,
cache: false,
logger: log,
onlyPluginIds,
includeSetupOnlyChannelPlugins: true,
forceSetupOnlyChannelPlugins: params.forceSetupOnlyChannelPlugins,
channelPluginLoadIntent: "setup",
});
}
function resolveScopedChannelPluginId(params: {
cfg: OpenClawConfig;
channel: string;
pluginId?: string;
workspaceDir?: string;
}): string | undefined {
const explicitPluginId = params.pluginId?.trim();
if (explicitPluginId) {
return explicitPluginId;
}
return (
getTrustedChannelPluginCatalogEntry(params.channel, {
cfg: params.cfg,
workspaceDir: params.workspaceDir,
})?.pluginId ?? resolveUniqueManifestScopedChannelPluginId(params)
);
}
function resolveUniqueManifestScopedChannelPluginId(params: {
cfg: OpenClawConfig;
channel: string;
workspaceDir?: string;
}): string | undefined {
const matches = resolveDiscoverableScopedChannelPluginIds({
config: params.cfg,
channelIds: [params.channel],
workspaceDir: params.workspaceDir,
env: process.env,
});
return matches.length === 1 ? matches[0] : undefined;
}
/** Load an inactive setup-plugin registry snapshot for resolving a channel without side effects. */
export function loadChannelSetupPluginRegistrySnapshotForChannel(params: {
cfg: OpenClawConfig;
runtime: RuntimeEnv;
channel: string;
pluginId?: string;
workspaceDir?: string;
forceSetupOnlyChannelPlugins?: boolean;
}): PluginRegistry {
const scopedPluginId = resolveScopedChannelPluginId({
cfg: params.cfg,
channel: params.channel,
pluginId: params.pluginId,
workspaceDir: params.workspaceDir,
});
return loadChannelSetupPluginRegistry({
...params,
...(scopedPluginId ? { onlyPluginIds: [scopedPluginId] } : {}),
});
}
|