Files
fusion/packages/dashboard/src/claude-cli-probe.ts
Fusion d3e1c28cef fix(plugins): re-export probe symbols + declare plugin deps in dashboard
- Hermes / OpenClaw plugin index.ts now re-export `probeHermesBinary` /
  `probeOpenClawBinary` and their status types so the dashboard's
  `runtime-provider-probes.ts` façade can import them via the public
  package entry instead of deep paths.
- Dashboard `package.json` adds `@fusion-plugin-examples/hermes-runtime`,
  `…/openclaw-runtime`, `…/paperclip-runtime` as workspace deps so
  pnpm symlinks them into `packages/dashboard/node_modules/`. Without
  these, the new probe imports failed with "Cannot find module" during
  `pnpm typecheck`.

This clears 6 of the 9 outstanding typecheck errors. The remaining 3 are
in the in-flight Hermes plugin rewrite (runtime-adapter still imports
from a deleted `./pi-module.js`; the new `index.ts` calls a factory
with the wrong arg type) and should be resolved by the same change set
that landed the rewrite.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-27 22:17:54 -07:00

149 lines
4.7 KiB
TypeScript

/**
* Probe for the locally-installed Claude CLI binary.
*
* Used by GET /api/providers/claude-cli/status to power the "Anthropic —
* via Claude CLI" provider card. The card shows `authenticated=true` only
* when the binary is on PATH *and* the user has flipped on `useClaudeCli`.
*
* Intentional design choices:
*
* - No caching. The user's PATH can change between requests (nvm switches,
* fresh terminal, etc.) — we'd rather pay one `spawn()` per poll than
* serve a stale "claude not installed" response. Claude's `--version`
* flag exits in ~40ms, so cost is negligible.
*
* - Short timeout. A misbehaving `claude` shim could hang indefinitely;
* we cap the probe at 2s and report `available: false` with a timeout
* reason rather than blocking the HTTP request.
*
* - No authorization. We never shell-interpolate PATH or user input.
* We spawn `claude --version` directly with argv, no shell.
*/
import { spawn } from "node:child_process";
/** Result shape returned to the dashboard status endpoint. */
export interface ClaudeCliBinaryStatus {
/** True if the `claude` binary was found on PATH and ran to completion. */
available: boolean;
/** Trimmed stdout from `claude --version`, if available. */
version?: string;
/** Absolute path, if we could resolve it via `which`. */
binaryPath?: string;
/** Human-readable failure reason when `available === false`. */
reason?: string;
/** Wall-clock duration of the probe, useful for debugging slow paths. */
probeDurationMs: number;
}
/** Default probe timeout. Claude's --version is fast; 2s is generous. */
const PROBE_TIMEOUT_MS = 2000;
/**
* Spawn `claude --version` and return a structured status result.
*
* Never throws — any failure is captured as `available: false` with a reason
* so the caller (an HTTP handler) can render the provider card without
* try/catch.
*/
export async function probeClaudeCli(
options: { timeoutMs?: number } = {},
): Promise<ClaudeCliBinaryStatus> {
const startedAt = Date.now();
const timeoutMs = options.timeoutMs ?? PROBE_TIMEOUT_MS;
const binaryPath = await tryResolveBinaryPath("claude");
return new Promise<ClaudeCliBinaryStatus>((resolvePromise) => {
const finish = (result: Omit<ClaudeCliBinaryStatus, "probeDurationMs">): void => {
resolvePromise({ ...result, probeDurationMs: Date.now() - startedAt });
};
let settled = false;
const child = spawn(binaryPath ?? "claude", ["--version"], {
stdio: ["ignore", "pipe", "pipe"],
});
const timer = setTimeout(() => {
if (settled) return;
settled = true;
try {
child.kill("SIGKILL");
} catch {
// Process already gone — nothing to do.
}
finish({
available: false,
binaryPath,
reason: `Probe timed out after ${timeoutMs}ms`,
});
}, timeoutMs);
let stdout = "";
let stderr = "";
child.stdout?.on("data", (chunk) => {
stdout += chunk.toString("utf-8");
});
child.stderr?.on("data", (chunk) => {
stderr += chunk.toString("utf-8");
});
child.on("error", (err) => {
if (settled) return;
settled = true;
clearTimeout(timer);
const isNotFound = (err as NodeJS.ErrnoException).code === "ENOENT";
finish({
available: false,
binaryPath,
reason: isNotFound ? "`claude` not found on PATH" : err.message,
});
});
child.on("close", (code) => {
if (settled) return;
settled = true;
clearTimeout(timer);
if (code === 0) {
finish({
available: true,
version: stdout.trim() || undefined,
binaryPath,
});
} else {
finish({
available: false,
binaryPath,
reason:
stderr.trim() || `claude --version exited with code ${String(code)}`,
});
}
});
});
}
/**
* Best-effort `which claude`. We don't fail probe on inability to resolve
* the path — the spawn above is the actual authority. This is just for
* surfacing a friendly "found at /opt/homebrew/bin/claude" in the UI.
*/
async function tryResolveBinaryPath(binary: string): Promise<string | undefined> {
return new Promise((resolvePromise) => {
const which = process.platform === "win32" ? "where" : "which";
const child = spawn(which, [binary], { stdio: ["ignore", "pipe", "ignore"] });
let out = "";
child.stdout?.on("data", (chunk) => {
out += chunk.toString("utf-8");
});
child.on("error", () => resolvePromise(undefined));
child.on("close", (code) => {
if (code === 0) {
const first = out.trim().split(/\r?\n/)[0];
resolvePromise(first?.length ? first : undefined);
} else {
resolvePromise(undefined);
}
});
});
}