223 lines
7.8 KiB
TypeScript
223 lines
7.8 KiB
TypeScript
import type {
|
|
AdapterEnvironmentCheck,
|
|
AdapterEnvironmentTestContext,
|
|
AdapterEnvironmentTestResult,
|
|
} from "@paperclipai/adapter-utils";
|
|
import {
|
|
asString,
|
|
asBoolean,
|
|
asNumber,
|
|
asStringArray,
|
|
parseObject,
|
|
ensureAbsoluteDirectory,
|
|
ensureCommandResolvable,
|
|
ensurePathInEnv,
|
|
runChildProcess,
|
|
} from "@paperclipai/adapter-utils/server-utils";
|
|
import path from "node:path";
|
|
import { detectClaudeLoginRequired, parseClaudeStreamJson } from "./parse.js";
|
|
|
|
function summarizeStatus(checks: AdapterEnvironmentCheck[]): AdapterEnvironmentTestResult["status"] {
|
|
if (checks.some((check) => check.level === "error")) return "fail";
|
|
if (checks.some((check) => check.level === "warn")) return "warn";
|
|
return "pass";
|
|
}
|
|
|
|
function isNonEmpty(value: unknown): value is string {
|
|
return typeof value === "string" && value.trim().length > 0;
|
|
}
|
|
|
|
function firstNonEmptyLine(text: string): string {
|
|
return (
|
|
text
|
|
.split(/\r?\n/)
|
|
.map((line) => line.trim())
|
|
.find(Boolean) ?? ""
|
|
);
|
|
}
|
|
|
|
function commandLooksLike(command: string, expected: string): boolean {
|
|
const base = path.basename(command).toLowerCase();
|
|
return base === expected || base === `${expected}.cmd` || base === `${expected}.exe`;
|
|
}
|
|
|
|
function summarizeProbeDetail(stdout: string, stderr: string): string | null {
|
|
const raw = firstNonEmptyLine(stderr) || firstNonEmptyLine(stdout);
|
|
if (!raw) return null;
|
|
const clean = raw.replace(/\s+/g, " ").trim();
|
|
const max = 240;
|
|
return clean.length > max ? `${clean.slice(0, max - 1)}…` : clean;
|
|
}
|
|
|
|
export async function testEnvironment(
|
|
ctx: AdapterEnvironmentTestContext,
|
|
): Promise<AdapterEnvironmentTestResult> {
|
|
const checks: AdapterEnvironmentCheck[] = [];
|
|
const config = parseObject(ctx.config);
|
|
const command = asString(config.command, "claude");
|
|
const cwd = asString(config.cwd, process.cwd());
|
|
|
|
try {
|
|
await ensureAbsoluteDirectory(cwd, { createIfMissing: true });
|
|
checks.push({
|
|
code: "claude_cwd_valid",
|
|
level: "info",
|
|
message: `Working directory is valid: ${cwd}`,
|
|
});
|
|
} catch (err) {
|
|
checks.push({
|
|
code: "claude_cwd_invalid",
|
|
level: "error",
|
|
message: err instanceof Error ? err.message : "Invalid working directory",
|
|
detail: cwd,
|
|
});
|
|
}
|
|
|
|
const envConfig = parseObject(config.env);
|
|
const env: Record<string, string> = {};
|
|
for (const [key, value] of Object.entries(envConfig)) {
|
|
if (typeof value === "string") env[key] = value;
|
|
}
|
|
const runtimeEnv = ensurePathInEnv({ ...process.env, ...env });
|
|
try {
|
|
await ensureCommandResolvable(command, cwd, runtimeEnv);
|
|
checks.push({
|
|
code: "claude_command_resolvable",
|
|
level: "info",
|
|
message: `Command is executable: ${command}`,
|
|
});
|
|
} catch (err) {
|
|
checks.push({
|
|
code: "claude_command_unresolvable",
|
|
level: "error",
|
|
message: err instanceof Error ? err.message : "Command is not executable",
|
|
detail: command,
|
|
});
|
|
}
|
|
|
|
const configApiKey = env.ANTHROPIC_API_KEY;
|
|
const hostApiKey = process.env.ANTHROPIC_API_KEY;
|
|
if (isNonEmpty(configApiKey) || isNonEmpty(hostApiKey)) {
|
|
const source = isNonEmpty(configApiKey) ? "adapter config env" : "server environment";
|
|
checks.push({
|
|
code: "claude_anthropic_api_key_overrides_subscription",
|
|
level: "warn",
|
|
message:
|
|
"ANTHROPIC_API_KEY is set. Claude will use API-key auth instead of subscription credentials.",
|
|
detail: `Detected in ${source}.`,
|
|
hint: "Unset ANTHROPIC_API_KEY if you want subscription-based Claude login behavior.",
|
|
});
|
|
} else {
|
|
checks.push({
|
|
code: "claude_subscription_mode_possible",
|
|
level: "info",
|
|
message: "ANTHROPIC_API_KEY is not set; subscription-based auth can be used if Claude is logged in.",
|
|
});
|
|
}
|
|
|
|
const canRunProbe =
|
|
checks.every((check) => check.code !== "claude_cwd_invalid" && check.code !== "claude_command_unresolvable");
|
|
if (canRunProbe) {
|
|
if (!commandLooksLike(command, "claude")) {
|
|
checks.push({
|
|
code: "claude_hello_probe_skipped_custom_command",
|
|
level: "info",
|
|
message: "Skipped hello probe because command is not `claude`.",
|
|
detail: command,
|
|
hint: "Use the `claude` CLI command to run the automatic login and installation probe.",
|
|
});
|
|
} else {
|
|
const model = asString(config.model, "").trim();
|
|
const effort = asString(config.effort, "").trim();
|
|
const chrome = asBoolean(config.chrome, false);
|
|
const maxTurns = asNumber(config.maxTurnsPerRun, 0);
|
|
const dangerouslySkipPermissions = asBoolean(config.dangerouslySkipPermissions, false);
|
|
const extraArgs = (() => {
|
|
const fromExtraArgs = asStringArray(config.extraArgs);
|
|
if (fromExtraArgs.length > 0) return fromExtraArgs;
|
|
return asStringArray(config.args);
|
|
})();
|
|
|
|
const args = ["--print", "-", "--output-format", "stream-json", "--verbose"];
|
|
if (dangerouslySkipPermissions) args.push("--dangerously-skip-permissions");
|
|
if (chrome) args.push("--chrome");
|
|
if (model) args.push("--model", model);
|
|
if (effort) args.push("--effort", effort);
|
|
if (maxTurns > 0) args.push("--max-turns", String(maxTurns));
|
|
if (extraArgs.length > 0) args.push(...extraArgs);
|
|
|
|
const probe = await runChildProcess(
|
|
`claude-envtest-${Date.now()}-${Math.random().toString(16).slice(2)}`,
|
|
command,
|
|
args,
|
|
{
|
|
cwd,
|
|
env,
|
|
timeoutSec: 45,
|
|
graceSec: 5,
|
|
stdin: "Respond with hello.",
|
|
onLog: async () => {},
|
|
},
|
|
);
|
|
|
|
const parsedStream = parseClaudeStreamJson(probe.stdout);
|
|
const parsed = parsedStream.resultJson;
|
|
const loginMeta = detectClaudeLoginRequired({
|
|
parsed,
|
|
stdout: probe.stdout,
|
|
stderr: probe.stderr,
|
|
});
|
|
const detail = summarizeProbeDetail(probe.stdout, probe.stderr);
|
|
|
|
if (probe.timedOut) {
|
|
checks.push({
|
|
code: "claude_hello_probe_timed_out",
|
|
level: "warn",
|
|
message: "Claude hello probe timed out.",
|
|
hint: "Retry the probe. If this persists, verify Claude can run `Respond with hello` from this directory manually.",
|
|
});
|
|
} else if (loginMeta.requiresLogin) {
|
|
checks.push({
|
|
code: "claude_hello_probe_auth_required",
|
|
level: "warn",
|
|
message: "Claude CLI is installed, but login is required.",
|
|
...(detail ? { detail } : {}),
|
|
hint: loginMeta.loginUrl
|
|
? `Run \`claude login\` and complete sign-in at ${loginMeta.loginUrl}, then retry.`
|
|
: "Run `claude login` in this environment, then retry the probe.",
|
|
});
|
|
} else if ((probe.exitCode ?? 1) === 0) {
|
|
const summary = parsedStream.summary.trim();
|
|
const hasHello = /\bhello\b/i.test(summary);
|
|
checks.push({
|
|
code: hasHello ? "claude_hello_probe_passed" : "claude_hello_probe_unexpected_output",
|
|
level: hasHello ? "info" : "warn",
|
|
message: hasHello
|
|
? "Claude hello probe succeeded."
|
|
: "Claude probe ran but did not return `hello` as expected.",
|
|
...(summary ? { detail: summary.replace(/\s+/g, " ").trim().slice(0, 240) } : {}),
|
|
...(hasHello
|
|
? {}
|
|
: {
|
|
hint: "Try the probe manually (`claude --print - --output-format stream-json --verbose`) and prompt `Respond with hello`.",
|
|
}),
|
|
});
|
|
} else {
|
|
checks.push({
|
|
code: "claude_hello_probe_failed",
|
|
level: "error",
|
|
message: "Claude hello probe failed.",
|
|
...(detail ? { detail } : {}),
|
|
hint: "Run `claude --print - --output-format stream-json --verbose` manually in this directory and prompt `Respond with hello` to debug.",
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
return {
|
|
adapterType: ctx.adapterType,
|
|
status: summarizeStatus(checks),
|
|
checks,
|
|
testedAt: new Date().toISOString(),
|
|
};
|
|
}
|