mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-30 13:20:54 +01:00
## Thinking Path > - Paperclip manages agents and their work. > - Native Runner providers need verified executables before they can run. > - Google Antigravity ships a native ACP server and a helper executable. > - An archive hash alone does not verify the installed runtime or its child process cleanup. > - This pull request adds a pinned installer and a small, verified compatibility patch. > - Later pull requests add Runner execution, account setup, and the recorded user journey eval. ## Linked Issues or Issue Description Refs: #12503, #14938. Those pull requests use the legacy CLI adapter. This stack adds native Runner ACP support. **Agent or provider** Google Antigravity ACP 1.4.3. **Why this adapter is useful** Users need a reproducible runtime before they can select Antigravity for a Paperclip agent. **How the agent is invoked** The installer prepares the native ACP server and helper. This pull request does not enable task execution. Default execution remains closed pending qualification. ## What Changed - Pin the complete macOS ARM64 runtime closure. Keep other platforms as inventory only. - Verify archive entries, installed bytes, ownership, and cache layout. - Patch exact upstream code anchors for model admission, instruction loading, native process ownership, and per-call file tool completion. - Package a self-contained installer and expose `paperclipai runtime setup antigravity`. - Record candidate limitations and historical acceptance evidence. ## Verification - Runtime provisioning, packaging, metadata, and patch support tests: 62 passed. The separate exact pinned native patch run passed all 5 tests with no skips and no Google authentication. - CLI runtime setup tests: 5 passed. - Map contract check passed. Staged diff whitespace check passed. - The first test command ran before dependency installation and failed on missing esbuild. The same command passed after installation. - Current master has a stale lockfile. Dependencies were resolved locally with scripts disabled. The generated lockfile is excluded from this pull request. - Final head: required `ci / verify` and `ci / e2e` passed, and Greptile is 5/5 with both review threads resolved. The optional external Paperclip Review remains queued. Two original timing failures are retained; one failed-job rerun passed without source or deadline changes. ## Risks - The patch depends on exact upstream native code. A new upstream release must get a new verified closure. - Only macOS ARM64 has a complete verified runtime. Installation does not qualify authentication, task execution, or other platforms. - The installer downloads official Google assets when the verified cache is absent. ## Model Used OpenAI Codex (GPT-6). The host did not expose the exact model revision or context limit. The model used tools for code edits, test execution, and review. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
160 lines
9.6 KiB
TypeScript
160 lines
9.6 KiB
TypeScript
import { spawn } from "node:child_process";
|
|
import { lstat, readFile, realpath } from "node:fs/promises";
|
|
import { dirname, join, resolve } from "node:path";
|
|
import { fileURLToPath, pathToFileURL } from "node:url";
|
|
import type { Command } from "commander";
|
|
|
|
/** Resolve the public server dependency, without importing/starting the server. */
|
|
export async function resolvePiProvisioner(serverUrl: string): Promise<string> {
|
|
const url = new URL(serverUrl);
|
|
if (url.protocol !== "file:" || url.search || url.hash) throw new Error("Pi setup requires an installed Paperclip server");
|
|
const entry = await realpath(fileURLToPath(url));
|
|
if (!entry.endsWith("/dist/index.js")) throw new Error("Pi setup requires the published server layout");
|
|
const root = resolve(dirname(entry), "..");
|
|
const manifest = join(root, "package.json");
|
|
const info = await lstat(manifest);
|
|
if (!info.isFile() || info.isSymbolicLink() || info.size > 65536 || JSON.parse(await readFile(manifest, "utf8")).name !== "@paperclipai/server") throw new Error("Pi setup server package identity is invalid");
|
|
const provisioner = join(root, "dist/vendor/paperclip-runner/cli/provision-pi.cjs");
|
|
if (await realpath(provisioner) !== provisioner || !(await lstat(provisioner)).isFile()) throw new Error("Pi setup entrypoint escapes its server package");
|
|
return provisioner;
|
|
}
|
|
|
|
export async function resolveRemoteCompanionImporter(serverUrl: string): Promise<string> {
|
|
const provisioner = await resolvePiProvisioner(serverUrl);
|
|
const serverRoot = resolve(dirname(provisioner), "../../../..");
|
|
const modulePath = join(serverRoot, "dist/services/native-runtime/remote-pi-companion.js");
|
|
if (await realpath(modulePath) !== modulePath || !(await lstat(modulePath)).isFile()) throw new Error("Remote companion importer escapes its installed server");
|
|
return modulePath;
|
|
}
|
|
|
|
/** Public downloads may use operator network settings, never application secrets. */
|
|
export function buildPiSetupEnvironment(source: NodeJS.ProcessEnv = process.env): NodeJS.ProcessEnv {
|
|
const environment: NodeJS.ProcessEnv = { PATH: source.PATH ?? "/usr/bin:/bin", LANG: "C.UTF-8" };
|
|
for (const key of ["LC_ALL", "HTTPS_PROXY", "HTTP_PROXY", "NO_PROXY", "https_proxy", "http_proxy", "no_proxy", "SSL_CERT_FILE", "SSL_CERT_DIR", "NODE_EXTRA_CA_CERTS"]) {
|
|
if (typeof source[key] === "string") environment[key] = source[key];
|
|
}
|
|
return environment;
|
|
}
|
|
|
|
export async function setupPiRuntime(): Promise<void> {
|
|
const provisioner = await resolvePiProvisioner(import.meta.resolve("@paperclipai/server"));
|
|
// Only explicit setup downloads. Enable Node's proxy handling for the helper;
|
|
// provider keys, npm configuration, HOME and Node injection remain excluded.
|
|
const child = spawn(process.execPath, ["--use-env-proxy", provisioner], {
|
|
stdio: "inherit", env: buildPiSetupEnvironment(),
|
|
});
|
|
const cancel = () => { if (child.exitCode === null && child.signalCode === null) child.kill("SIGTERM"); };
|
|
process.on("SIGINT", cancel); process.on("SIGTERM", cancel);
|
|
try {
|
|
await new Promise<void>((accept, reject) => {
|
|
let spawnError: Error | undefined;
|
|
child.on("error", error => { spawnError = error; });
|
|
child.once("close", (code, signal) => {
|
|
if (spawnError) reject(spawnError);
|
|
else if (code !== 0 || signal) reject(new Error("Pi setup did not finish. Review its error; an existing invalid installation is never replaced automatically."));
|
|
else accept();
|
|
});
|
|
});
|
|
} finally { process.off("SIGINT", cancel); process.off("SIGTERM", cancel); }
|
|
}
|
|
|
|
/** Resolve the installed public dependency without importing or starting it. */
|
|
export async function resolveCursorProvisioner(serverUrl: string): Promise<string> {
|
|
const url = new URL(serverUrl);
|
|
if (url.protocol !== "file:" || url.search || url.hash) throw new Error("Cursor setup requires an installed Paperclip server");
|
|
const entry = await realpath(fileURLToPath(url));
|
|
if (!entry.endsWith("/dist/index.js")) throw new Error("Cursor setup requires the published server layout");
|
|
const root = resolve(dirname(entry), "..");
|
|
const manifest = join(root, "package.json");
|
|
const info = await lstat(manifest);
|
|
if (!info.isFile() || info.isSymbolicLink() || info.size > 65536 || JSON.parse(await readFile(manifest, "utf8")).name !== "@paperclipai/server") throw new Error("Cursor setup server package identity is invalid");
|
|
const provisioner = join(root, "dist/vendor/paperclip-runner/cli/provision-cursor.cjs");
|
|
if (await realpath(provisioner) !== provisioner || !(await lstat(provisioner)).isFile()) throw new Error("Cursor setup entrypoint escapes its server package");
|
|
return provisioner;
|
|
}
|
|
|
|
export async function setupCursorRuntime(): Promise<void> {
|
|
const provisioner = await resolveCursorProvisioner(import.meta.resolve("@paperclipai/server"));
|
|
const child = spawn(process.execPath, [provisioner], {
|
|
stdio: "inherit", env: { PATH: process.env.PATH ?? "/usr/bin:/bin", LANG: "C.UTF-8" },
|
|
});
|
|
const cancel = () => { if (child.exitCode === null && child.signalCode === null) child.kill("SIGTERM"); };
|
|
process.on("SIGINT", cancel); process.on("SIGTERM", cancel);
|
|
try {
|
|
await new Promise<void>((accept, reject) => {
|
|
let spawnError: Error | undefined;
|
|
child.on("error", error => { spawnError = error; });
|
|
child.once("close", (code, signal) => {
|
|
if (spawnError) reject(spawnError);
|
|
else if (code !== 0 || signal) reject(new Error("Cursor setup did not finish. Review its error; an invalid installation is never replaced automatically."));
|
|
else accept();
|
|
});
|
|
});
|
|
} finally { process.off("SIGINT", cancel); process.off("SIGTERM", cancel); }
|
|
}
|
|
|
|
/** Resolve Antigravity setup without importing the server or starting a provider. */
|
|
export async function resolveAntigravityProvisioner(serverUrl: string): Promise<string> {
|
|
const url = new URL(serverUrl);
|
|
if (url.protocol !== "file:" || url.search || url.hash) throw new Error("Antigravity setup requires an installed Paperclip server");
|
|
const entry = await realpath(fileURLToPath(url));
|
|
if (!entry.endsWith("/dist/index.js")) throw new Error("Antigravity setup requires the published server layout");
|
|
const root = resolve(dirname(entry), "..");
|
|
const manifest = join(root, "package.json");
|
|
const info = await lstat(manifest);
|
|
if (!info.isFile() || info.isSymbolicLink() || info.size > 65536 || JSON.parse(await readFile(manifest, "utf8")).name !== "@paperclipai/server") throw new Error("Antigravity setup server package identity is invalid");
|
|
const provisioner = join(root, "dist/vendor/paperclip-runner/cli/provision-antigravity.cjs");
|
|
if (await realpath(provisioner) !== provisioner || !(await lstat(provisioner)).isFile()) throw new Error("Antigravity setup entrypoint escapes its server package");
|
|
return provisioner;
|
|
}
|
|
|
|
export async function setupAntigravityRuntime(): Promise<void> {
|
|
const provisioner = await resolveAntigravityProvisioner(import.meta.resolve("@paperclipai/server"));
|
|
const child = spawn(process.execPath, ["--use-env-proxy", provisioner], {
|
|
// Setup only downloads public assets. Reuse the existing network allowlist;
|
|
// runtime credentials and process-loader settings never reach this child.
|
|
stdio: "inherit", env: buildPiSetupEnvironment(),
|
|
});
|
|
const cancel = () => { if (child.exitCode === null && child.signalCode === null) child.kill("SIGTERM"); };
|
|
process.on("SIGINT", cancel); process.on("SIGTERM", cancel);
|
|
try {
|
|
await new Promise<void>((accept, reject) => {
|
|
let spawnError: Error | undefined;
|
|
child.on("error", error => { spawnError = error; });
|
|
child.once("close", (code, signal) => {
|
|
if (spawnError) reject(spawnError);
|
|
else if (code !== 0 || signal) reject(new Error("Antigravity setup did not finish. Review its error; an invalid installation is never replaced automatically."));
|
|
else accept();
|
|
});
|
|
});
|
|
} finally { process.off("SIGINT", cancel); process.off("SIGTERM", cancel); }
|
|
}
|
|
|
|
|
|
export function registerRuntimeCommands(program: Command): void {
|
|
const runtime = program.command("runtime").description("Manage explicitly installed agent runtimes");
|
|
runtime.command("import-remote <directory>")
|
|
.description("Import a verified Linux Pi companion into the installed server (no downloads)")
|
|
.requiredOption("--sha256 <digest>", "SHA256 of companion.json from the trusted release")
|
|
.action(async (directory: string, options: { sha256: string }) => {
|
|
const modulePath = await resolveRemoteCompanionImporter(import.meta.resolve("@paperclipai/server"));
|
|
const importer = await import(pathToFileURL(modulePath).href) as { importRemotePiCompanion(input: { directory: string; sha256: string; checkCancelled: () => void }): Promise<unknown> };
|
|
let cancelled = false;
|
|
const cancel = () => { cancelled = true; };
|
|
process.on("SIGINT", cancel); process.on("SIGTERM", cancel);
|
|
try {
|
|
const result = await importer.importRemotePiCompanion({ directory, sha256: options.sha256,
|
|
checkCancelled: () => { if (cancelled) throw new Error("Remote companion import cancelled"); } });
|
|
console.log(JSON.stringify(result));
|
|
} finally { process.off("SIGINT", cancel); process.off("SIGTERM", cancel); }
|
|
});
|
|
runtime.command("setup <provider>")
|
|
.description("Install and verify a pinned Pi, Cursor, or Antigravity runtime (public downloads; no model calls)")
|
|
.action(async (provider: string) => {
|
|
if (provider === "pi") await setupPiRuntime();
|
|
else if (provider === "cursor") await setupCursorRuntime();
|
|
else if (provider === "antigravity") await setupAntigravityRuntime();
|
|
else throw new Error("Supported runtime setup: paperclipai runtime setup pi, cursor, or antigravity");
|
|
});
|
|
}
|