fix(openshell): bundle upstream cli fallback

vincentkoc · vincentkoc · commit 009980465fd1 · 2026-03-22T19:20:33.000-07:00
diff --git a/extensions/openshell/src/cli.test.ts b/extensions/openshell/src/cli.test.ts
@@ -1,8 +1,18 @@
-import { describe, expect, it } from "vitest";
-import { buildExecRemoteCommand, buildOpenShellBaseArgv, shellEscape } from "./cli.js";
+import { afterEach, describe, expect, it } from "vitest";
+import {
+  buildExecRemoteCommand,
+  buildOpenShellBaseArgv,
+  resolveOpenShellCommand,
+  setBundledOpenShellCommandResolverForTest,
+  shellEscape,
+} from "./cli.js";
 import { resolveOpenShellPluginConfig } from "./config.js";
 
 describe("openshell cli helpers", () => {
+  afterEach(() => {
+    setBundledOpenShellCommandResolverForTest();
+  });
+
   it("builds base argv with gateway overrides", () => {
     const config = resolveOpenShellPluginConfig({
       command: "/usr/local/bin/openshell",
@@ -18,6 +28,20 @@ describe("openshell cli helpers", () => {
     ]);
   });
 
+  it("prefers the bundled openshell command when available", () => {
+    setBundledOpenShellCommandResolverForTest(() => "/tmp/node_modules/.bin/openshell");
+    const config = resolveOpenShellPluginConfig(undefined);
+
+    expect(resolveOpenShellCommand("openshell")).toBe("/tmp/node_modules/.bin/openshell");
+    expect(buildOpenShellBaseArgv(config)).toEqual(["/tmp/node_modules/.bin/openshell"]);
+  });
+
+  it("falls back to the PATH command when no bundled openshell is present", () => {
+    setBundledOpenShellCommandResolverForTest(() => null);
+
+    expect(resolveOpenShellCommand("openshell")).toBe("openshell");
+  });
+
   it("shell escapes single quotes", () => {
     expect(shellEscape(`a'b`)).toBe(`'a'"'"'b'`);
   });
diff --git a/extensions/openshell/src/cli.ts b/extensions/openshell/src/cli.ts
@@ -1,3 +1,6 @@
+import fs from "node:fs";
+import { createRequire } from "node:module";
+import path from "node:path";
 import {
   buildExecRemoteCommand,
   createSshSandboxSessionFromConfigText,
@@ -9,14 +12,54 @@ import type { ResolvedOpenShellPluginConfig } from "./config.js";
 
 export { buildExecRemoteCommand, shellEscape } from "openclaw/plugin-sdk/sandbox";
 
+const require = createRequire(import.meta.url);
+
+let cachedBundledOpenShellCommand: string | null | undefined;
+let bundledCommandResolverForTest: (() => string | null) | undefined;
+
 export type OpenShellExecContext = {
   config: ResolvedOpenShellPluginConfig;
   sandboxName: string;
   timeoutMs?: number;
 };
 
+export function setBundledOpenShellCommandResolverForTest(resolver?: () => string | null): void {
+  bundledCommandResolverForTest = resolver;
+  cachedBundledOpenShellCommand = undefined;
+}
+
+function resolveBundledOpenShellCommand(): string | null {
+  if (bundledCommandResolverForTest) {
+    return bundledCommandResolverForTest();
+  }
+  if (cachedBundledOpenShellCommand !== undefined) {
+    return cachedBundledOpenShellCommand;
+  }
+  try {
+    const packageJsonPath = require.resolve("openshell/package.json");
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8")) as {
+      bin?: string | Record<string, string>;
+    };
+    const relativeBin =
+      typeof packageJson.bin === "string" ? packageJson.bin : packageJson.bin?.openshell;
+    cachedBundledOpenShellCommand = relativeBin
+      ? path.resolve(path.dirname(packageJsonPath), relativeBin)
+      : null;
+  } catch {
+    cachedBundledOpenShellCommand = null;
+  }
+  return cachedBundledOpenShellCommand;
+}
+
+export function resolveOpenShellCommand(command: string): string {
+  if (command !== "openshell") {
+    return command;
+  }
+  return resolveBundledOpenShellCommand() ?? command;
+}
+
 export function buildOpenShellBaseArgv(config: ResolvedOpenShellPluginConfig): string[] {
-  const argv = [config.command];
+  const argv = [resolveOpenShellCommand(config.command)];
   if (config.gateway) {
     argv.push("--gateway", config.gateway);
   }
diff --git a/package.json b/package.json
@@ -811,6 +811,9 @@
       "optional": true
     }
   },
+  "optionalDependencies": {
+    "openshell": "0.1.0"
+  },
   "engines": {
     "node": ">=22.16.0"
   },
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
