Files
openclaw/extensions/acpx/src/ensure.ts
2026-03-04 02:35:12 -05:00

271 lines
7.9 KiB
TypeScript

import fs from "node:fs";
import path from "node:path";
import type { PluginLogger } from "openclaw/plugin-sdk/acpx";
import { ACPX_PINNED_VERSION, ACPX_PLUGIN_ROOT, buildAcpxLocalInstallCommand } from "./config.js";
import {
resolveSpawnFailure,
type SpawnCommandOptions,
spawnAndCollect,
} from "./runtime-internals/process.js";
const SEMVER_PATTERN = /\b\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?\b/;
export type AcpxVersionCheckResult =
| {
ok: true;
version: string;
expectedVersion?: string;
}
| {
ok: false;
reason: "missing-command" | "missing-version" | "version-mismatch" | "execution-failed";
message: string;
expectedVersion?: string;
installCommand: string;
installedVersion?: string;
};
function extractVersion(stdout: string, stderr: string): string | null {
const combined = `${stdout}\n${stderr}`;
const match = combined.match(SEMVER_PATTERN);
return match?.[0] ?? null;
}
function isExpectedVersionConfigured(value: string | undefined): value is string {
return typeof value === "string" && value.trim().length > 0;
}
function supportsPathResolution(command: string): boolean {
return path.isAbsolute(command) || command.includes("/") || command.includes("\\");
}
function isUnsupportedVersionProbe(stdout: string, stderr: string): boolean {
const combined = `${stdout}\n${stderr}`.toLowerCase();
return combined.includes("unknown option") && combined.includes("--version");
}
function resolveVersionFromPackage(command: string, cwd: string): string | null {
if (!supportsPathResolution(command)) {
return null;
}
const commandPath = path.isAbsolute(command) ? command : path.resolve(cwd, command);
let current: string;
try {
current = path.dirname(fs.realpathSync(commandPath));
} catch {
return null;
}
while (true) {
const packageJsonPath = path.join(current, "package.json");
try {
const parsed = JSON.parse(fs.readFileSync(packageJsonPath, "utf8")) as {
name?: unknown;
version?: unknown;
};
if (parsed.name === "acpx" && typeof parsed.version === "string" && parsed.version.trim()) {
return parsed.version.trim();
}
} catch {
// no-op; continue walking up
}
const parent = path.dirname(current);
if (parent === current) {
return null;
}
current = parent;
}
}
function resolveVersionCheckResult(params: {
expectedVersion?: string;
installedVersion: string;
installCommand: string;
}): AcpxVersionCheckResult {
if (params.expectedVersion && params.installedVersion !== params.expectedVersion) {
return {
ok: false,
reason: "version-mismatch",
message: `acpx version mismatch: found ${params.installedVersion}, expected ${params.expectedVersion}`,
expectedVersion: params.expectedVersion,
installCommand: params.installCommand,
installedVersion: params.installedVersion,
};
}
return {
ok: true,
version: params.installedVersion,
expectedVersion: params.expectedVersion,
};
}
export async function checkAcpxVersion(params: {
command: string;
cwd?: string;
expectedVersion?: string;
spawnOptions?: SpawnCommandOptions;
}): Promise<AcpxVersionCheckResult> {
const expectedVersion = params.expectedVersion?.trim() || undefined;
const installCommand = buildAcpxLocalInstallCommand(expectedVersion ?? ACPX_PINNED_VERSION);
const cwd = params.cwd ?? ACPX_PLUGIN_ROOT;
const hasExpectedVersion = isExpectedVersionConfigured(expectedVersion);
const probeArgs = hasExpectedVersion ? ["--version"] : ["--help"];
const spawnParams = {
command: params.command,
args: probeArgs,
cwd,
};
let result: Awaited<ReturnType<typeof spawnAndCollect>>;
try {
result = params.spawnOptions
? await spawnAndCollect(spawnParams, params.spawnOptions)
: await spawnAndCollect(spawnParams);
} catch (error) {
return {
ok: false,
reason: "execution-failed",
message: error instanceof Error ? error.message : String(error),
expectedVersion,
installCommand,
};
}
if (result.error) {
const spawnFailure = resolveSpawnFailure(result.error, cwd);
if (spawnFailure === "missing-command") {
return {
ok: false,
reason: "missing-command",
message: `acpx command not found at ${params.command}`,
expectedVersion,
installCommand,
};
}
return {
ok: false,
reason: "execution-failed",
message: result.error.message,
expectedVersion,
installCommand,
};
}
if ((result.code ?? 0) !== 0) {
if (hasExpectedVersion && isUnsupportedVersionProbe(result.stdout, result.stderr)) {
const installedVersion = resolveVersionFromPackage(params.command, cwd);
if (installedVersion) {
return resolveVersionCheckResult({ expectedVersion, installedVersion, installCommand });
}
}
const stderr = result.stderr.trim();
return {
ok: false,
reason: "execution-failed",
message:
stderr ||
`acpx ${hasExpectedVersion ? "--version" : "--help"} failed with code ${result.code ?? "unknown"}`,
expectedVersion,
installCommand,
};
}
if (!hasExpectedVersion) {
return {
ok: true,
version: "unknown",
expectedVersion,
};
}
const installedVersion = extractVersion(result.stdout, result.stderr);
if (!installedVersion) {
return {
ok: false,
reason: "missing-version",
message: "acpx --version output did not include a parseable version",
expectedVersion,
installCommand,
};
}
return resolveVersionCheckResult({ expectedVersion, installedVersion, installCommand });
}
let pendingEnsure: Promise<void> | null = null;
export async function ensureAcpx(params: {
command: string;
logger?: PluginLogger;
pluginRoot?: string;
expectedVersion?: string;
allowInstall?: boolean;
spawnOptions?: SpawnCommandOptions;
}): Promise<void> {
if (pendingEnsure) {
return await pendingEnsure;
}
pendingEnsure = (async () => {
const pluginRoot = params.pluginRoot ?? ACPX_PLUGIN_ROOT;
const expectedVersion = params.expectedVersion?.trim() || undefined;
const installVersion = expectedVersion ?? ACPX_PINNED_VERSION;
const allowInstall = params.allowInstall ?? true;
const precheck = await checkAcpxVersion({
command: params.command,
cwd: pluginRoot,
expectedVersion,
spawnOptions: params.spawnOptions,
});
if (precheck.ok) {
return;
}
if (!allowInstall) {
throw new Error(precheck.message);
}
params.logger?.warn(
`acpx local binary unavailable or mismatched (${precheck.message}); running plugin-local install`,
);
const install = await spawnAndCollect({
command: "npm",
args: ["install", "--omit=dev", "--no-save", `acpx@${installVersion}`],
cwd: pluginRoot,
});
if (install.error) {
const spawnFailure = resolveSpawnFailure(install.error, pluginRoot);
if (spawnFailure === "missing-command") {
throw new Error("npm is required to install plugin-local acpx but was not found on PATH");
}
throw new Error(`failed to install plugin-local acpx: ${install.error.message}`);
}
if ((install.code ?? 0) !== 0) {
const stderr = install.stderr.trim();
const stdout = install.stdout.trim();
const detail = stderr || stdout || `npm exited with code ${install.code ?? "unknown"}`;
throw new Error(`failed to install plugin-local acpx: ${detail}`);
}
const postcheck = await checkAcpxVersion({
command: params.command,
cwd: pluginRoot,
expectedVersion,
spawnOptions: params.spawnOptions,
});
if (!postcheck.ok) {
throw new Error(`plugin-local acpx verification failed after install: ${postcheck.message}`);
}
params.logger?.info(`acpx plugin-local binary ready (version ${postcheck.version})`);
})();
try {
await pendingEnsure;
} finally {
pendingEnsure = null;
}
}