fix(cli): keep plugin parent help lightweight

This commit is contained in:
Vincent Koc
2026-05-14 14:09:12 +08:00
parent c635f0087e
commit 2ab08c8a19
7 changed files with 62 additions and 15 deletions
+1
View File
@@ -13,6 +13,7 @@ Docs: https://docs.openclaw.ai
- Plugins: discover provider plugins from `setup.providers[].envVars` credentials during provider discovery while keeping the deprecated `providerAuthEnvVars` fallback. (#81542) Thanks @JARVIS-Glasses.
- Docs/Codex harness: clarify that per-agent `CODEX_HOME` isolates `~/.codex` while inherited `HOME` intentionally keeps `.agents` discovery and subprocess user-home state available.
- CLI/plugins: keep bare plugin and parent-command help on the lightweight path, avoiding plugin registry discovery before rendering help.
- CLI tables: preserve muted/color styling on wrapped continuation lines after multiline cells, keeping `openclaw plugins list` descriptions readable.
- iOS: restore first-use Contacts, Calendar, and Reminders permission prompts and add Privacy & Access status/actions in Settings. Thanks @BunsDev.
- Canvas: return not found for malformed percent-encoded Canvas/A2UI/document asset paths and keep decoded parent traversal blocked before path normalization.
@@ -7,15 +7,13 @@ afterEach(() => {
});
describe("listBundledChannelCatalogEntries discovery failures", () => {
it("falls back when bundled plugin catalog discovery is unavailable during import", async () => {
it("falls back when bundled package metadata is unavailable during import", async () => {
vi.doMock("../infra/openclaw-root.js", () => ({
resolveOpenClawPackageRootSync: () => null,
resolveOpenClawPackageRoot: async () => null,
}));
vi.doMock("../plugins/channel-catalog-registry.js", () => ({
listChannelCatalogEntries() {
throw new ReferenceError("Cannot access 'discoverOpenClawPlugins' before initialization.");
},
vi.doMock("../plugins/bundled-dir.js", () => ({
resolveBundledPluginsDir: () => undefined,
}));
const catalog = await importFreshModule<typeof import("./bundled-channel-catalog-read.js")>(
+22 -3
View File
@@ -2,7 +2,7 @@ import fs from "node:fs";
import path from "node:path";
import { tryReadJsonSync } from "../infra/json-files.js";
import { resolveOpenClawPackageRootSync } from "../infra/openclaw-root.js";
import { listChannelCatalogEntries } from "../plugins/channel-catalog-registry.js";
import { resolveBundledPluginsDir } from "../plugins/bundled-dir.js";
import type { PluginPackageChannel } from "../plugins/manifest.js";
import { normalizeOptionalLowercaseString } from "../shared/string-coerce.js";
@@ -21,6 +21,7 @@ type BundledChannelCatalogEntry = {
const OFFICIAL_CHANNEL_CATALOG_RELATIVE_PATH = path.join("dist", "channel-catalog.json");
const officialCatalogFileCache = new Map<string, ChannelCatalogEntryLike[] | null>();
const bundledPackageCatalogCache = new Map<string, ChannelCatalogEntryLike[] | null>();
function listPackageRoots(): string[] {
return [
@@ -29,10 +30,28 @@ function listPackageRoots(): string[] {
].filter((entry, index, all): entry is string => Boolean(entry) && all.indexOf(entry) === index);
}
function readBundledExtensionCatalogEntriesSync(): PluginPackageChannel[] {
function readBundledExtensionCatalogEntriesSync(): ChannelCatalogEntryLike[] {
const pluginsDir = resolveBundledPluginsDir();
if (!pluginsDir) {
return [];
}
const cached = bundledPackageCatalogCache.get(pluginsDir);
if (cached !== undefined) {
return cached ?? [];
}
try {
return listChannelCatalogEntries({ origin: "bundled" }).map((entry) => entry.channel);
const entries = fs
.readdirSync(pluginsDir, { withFileTypes: true })
.filter((entry) => entry.isDirectory())
.flatMap((entry): ChannelCatalogEntryLike[] => {
const packageJsonPath = path.join(pluginsDir, entry.name, "package.json");
const parsed = tryReadJsonSync<ChannelCatalogEntryLike>(packageJsonPath);
return parsed ? [parsed] : [];
});
bundledPackageCatalogCache.set(pluginsDir, entries);
return entries;
} catch {
bundledPackageCatalogCache.set(pluginsDir, null);
return [];
}
}
+3 -3
View File
@@ -65,14 +65,14 @@ async function registerSubCliWithPluginCommands(
const invocation = resolveCliArgvInvocation(process.argv);
const shouldRegisterPluginCommands =
!invocation.hasHelpOrVersion &&
(invocation.commandPath.length <= 1 ||
resolveCliCommandPathPolicy(invocation.commandPath).loadPlugins !== "never");
const { registerPluginCliCommandsFromValidatedConfig } = await import("../../plugins/cli.js");
resolveCliCommandPathPolicy(invocation.commandPath).loadPlugins !== "never";
if (pluginCliPosition === "before" && shouldRegisterPluginCommands) {
const { registerPluginCliCommandsFromValidatedConfig } = await import("../../plugins/cli.js");
await registerPluginCliCommandsFromValidatedConfig(program);
}
await registerSubCli();
if (pluginCliPosition === "after" && shouldRegisterPluginCommands) {
const { registerPluginCliCommandsFromValidatedConfig } = await import("../../plugins/cli.js");
await registerPluginCliCommandsFromValidatedConfig(program);
}
}
+2 -2
View File
@@ -253,13 +253,13 @@ describe("registerSubCliCommands", () => {
expect(registerPluginCliCommandsFromValidatedConfig).not.toHaveBeenCalled();
});
it("keeps plugin CLI registrations available for the plugins command root", async () => {
it("does not preload plugin CLI registrations for bare plugin parent help", async () => {
process.argv = ["node", "openclaw", "plugins"];
const program = new Command().name("openclaw");
await registerSubCliByName(program, "plugins");
expect(registerPluginsCli).toHaveBeenCalledTimes(1);
expect(registerPluginCliCommandsFromValidatedConfig).toHaveBeenCalledTimes(1);
expect(registerPluginCliCommandsFromValidatedConfig).not.toHaveBeenCalled();
});
});
+22 -2
View File
@@ -18,6 +18,22 @@ import {
import { isReservedNonPluginCommandRoot } from "./command-registration-policy.js";
const ROOT_HELP_ALIASES = new Set(["tools"]);
const BARE_PARENT_DEFAULT_HELP_COMMANDS = new Set([
"approvals",
"channels",
"cron",
"devices",
"mcp",
"plugins",
]);
function isBareParentDefaultHelpArgv(argv: string[]): boolean {
const invocation = resolveCliArgvInvocation(argv);
const [primary, extra] = invocation.commandPath;
return !invocation.hasHelpOrVersion && primary !== undefined && extra === undefined
? BARE_PARENT_DEFAULT_HELP_COMMANDS.has(primary)
: false;
}
export function rewriteUpdateFlagArgv(argv: string[]): string[] {
const index = argv.indexOf("--update");
@@ -32,7 +48,11 @@ export function rewriteUpdateFlagArgv(argv: string[]): string[] {
export function shouldEnsureCliPath(argv: string[]): boolean {
const invocation = resolveCliArgvInvocation(argv);
if (invocation.hasHelpOrVersion || shouldStartCrestodianForBareRoot(argv)) {
if (
invocation.hasHelpOrVersion ||
shouldStartCrestodianForBareRoot(argv) ||
isBareParentDefaultHelpArgv(argv)
) {
return false;
}
return resolveCliCommandPathPolicy(invocation.commandPath).ensureCliPath;
@@ -91,7 +111,7 @@ export function shouldStartProxyForCli(argv: string[]): boolean {
if (invocation.hasHelpOrVersion || !primary) {
return false;
}
if (invocation.commandPath.length === 1 && primary === "channels") {
if (isBareParentDefaultHelpArgv(policyArgv)) {
return false;
}
return resolveCliNetworkProxyPolicy(policyArgv) === "default";
+9
View File
@@ -114,6 +114,8 @@ describe("shouldEnsureCliPath", () => {
it("skips path bootstrap for read-only fast paths", () => {
expect(shouldEnsureCliPath(["node", "openclaw"])).toBe(false);
expect(shouldEnsureCliPath(["node", "openclaw", "--profile", "work"])).toBe(false);
expect(shouldEnsureCliPath(["node", "openclaw", "plugins"])).toBe(false);
expect(shouldEnsureCliPath(["node", "openclaw", "mcp"])).toBe(false);
expect(shouldEnsureCliPath(["node", "openclaw", "status"])).toBe(false);
expect(shouldEnsureCliPath(["node", "openclaw", "--log-level", "debug", "status"])).toBe(false);
expect(shouldEnsureCliPath(["node", "openclaw", "sessions", "--json"])).toBe(false);
@@ -170,6 +172,13 @@ describe("shouldStartProxyForCli", () => {
expect(shouldStartProxyForCli(["node", "openclaw", "--update"])).toBe(true);
expect(shouldStartProxyForCli(["node", "openclaw", "--profile", "p", "--update"])).toBe(true);
});
it("skips managed proxy routing for bare parent default help", () => {
expect(shouldStartProxyForCli(["node", "openclaw", "plugins"])).toBe(false);
expect(shouldStartProxyForCli(["node", "openclaw", "channels"])).toBe(false);
expect(shouldStartProxyForCli(["node", "openclaw", "devices"])).toBe(false);
expect(shouldStartProxyForCli(["node", "openclaw", "mcp"])).toBe(false);
});
});
describe("shouldUseRootHelpFastPath", () => {