mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-08 19:56:31 +02:00
## Thinking Path > - Paperclip is the open source control plane people use to manage AI-agent companies > - Operators need a predictable installation path that survives beyond an ephemeral `npx` process > - A durable installation needs an owned per-user payload store, stable command shim, safe shell integration, and supported service lifecycle > - Updates must preserve recoverability by backing up data, installing side-by-side, verifying the new payload, and retaining rollback state > - Bootstrap scripts and privileged service operations must fail closed across download, filesystem, ownership, and consent boundaries > - This pull request integrates managed install, update, rollback, service, uninstall, doctor, bootstrap-installer, and runtime-serving support into one workflow > - The benefit is a recoverable, inspectable, and documented installation lifecycle with explicit safety boundaries across Linux, macOS, containers, WSL, npm, npx, and source checkouts ## Linked Issues or Issue Description ### Problem Paperclip lacks a first-class durable installation and lifecycle workflow. Operators currently have to assemble npm/npx installation, PATH setup, background-service management, updates, rollback, diagnostics, and uninstall behavior themselves. That makes upgrades harder to recover, creates inconsistent behavior across platforms, and leaves shell/download/service trust boundaries without one documented implementation. ### Proposed Solution Add a managed per-user install store and stable shim, a verified shell bootstrap installer, service lifecycle commands, install-mode-aware update/rollback behavior, doctor checks, and documentation. Managed updates back up the database, install and smoke-test a side-by-side payload, atomically switch `current`, and retain prior payloads. The shell installer pins registry/download trust boundaries and requires explicit consent for non-interactive privileged actions. ### Alternatives Considered - Keep recommending `npx`: simple for evaluation, but ephemeral and unsuitable for stable services, atomic updates, or rollback. - Require global npm installation only: familiar, but cannot provide the owned side-by-side payload store and retained rollback semantics. - Split the capability across multiple PRs: rejected because install, update, service, uninstall, bootstrap, and serving behavior share contracts and security boundaries that need review together. ### Related Pull Requests - Supersedes #10042 and #10044 with one integrated final diff. - Incorporates and replaces the closed preparatory work in #10032 and #10034. ## What Changed - Added `paperclipai install`, `update`/`upgrade`, rollback, uninstall, service lifecycle, onboarding integration, and managed-install doctor checks. - Added a private managed payload store, verified manifest/marker ownership, exclusive mutation locks, atomic manifest/current/shim writes, retained previous payloads, and provenance validation. - Added npm and GitHub-ref install sources with exact target resolution, registry isolation, database backup, side-by-side verification, atomic activation, service restart coordination, and failure rollback. - Made managed-update backups report actionable service-start and `--no-backup` recovery guidance for unreachable databases, while clean never-onboarded instances skip an empty backup. - Added systemd user and launchd service definitions, status/health/log commands, single-instance coordination, stale-port recovery, and explicit sudo/lingering consent handling. - Added the `scripts/install.sh` bootstrap path with checked two-stage downloads, pinned public npm registry usage, platform checks, dry-run/non-interactive controls, and Docker fixtures. - Added embedded Postgres/native bootstrap integration, hot-restart/systemd-notify serving support, passive update notices, configuration contracts, README/CLI/install documentation, and focused regression tests. - Security re-review should explicitly re-verify: (1) `addManagedPathBlock`/`removeManagedPathBlock` reject symlinked or non-regular rc files, assert current-user ownership, preserve restrictive modes, and replace atomically; (2) managed shim replacement rejects unsafe parents, foreign-owned or multiply linked files, and uses checked atomic replacement; (3) the shell installer and sudo path preserve explicit consent and checked downloads; and (4) installed service/runtime serving remains bound to the validated managed shim and instance configuration. ## Verification - `bash -n scripts/install.sh scripts/clean-install-git.sh scripts/clean-install-npm.sh scripts/test-install-sh-docker.sh` - `pnpm exec vitest run cli/src/__tests__/install-store.test.ts cli/src/__tests__/install-command.test.ts cli/src/__tests__/managed-install-check.test.ts cli/src/__tests__/onboard-service.test.ts cli/src/__tests__/service-health-check.test.ts cli/src/__tests__/service-manager.test.ts cli/src/__tests__/update-command.test.ts cli/src/__tests__/update-notice.test.ts packages/db/src/embedded-postgres-native.test.ts` — 9 files, 66 tests passed - `pnpm --dir cli typecheck` - `pnpm --dir cli build` - Follow-up verification: `pnpm exec vitest run cli/src/__tests__/update-command.test.ts` (14/14), `pnpm --dir cli typecheck`, `pnpm --dir cli build`, and `pnpm --filter @paperclipai/server typecheck`. - `pnpm -r typecheck` - `pnpm build` - Full `pnpm test:run` exercised all suites; an injected static AWS credential changed one unrelated doctor expectation, which passed when those credentials were removed. A second run cleared that case and exposed stale pre-existing adapter-utils `dist` output; rebuilding `@paperclipai/adapter-utils` made the isolated test pass. The updated PR CI is the authoritative clean-workspace full-suite run. ## Risks - Installer/update code writes executable shims, symlinks, shell rc blocks, service definitions, and managed payloads; ownership, regular-file, symlink, hard-link, marker, and path-containment checks fail closed before destructive changes. - The bootstrap installer executes downloaded tooling; downloads are staged and checked before execution, npm traffic is pinned to the public registry, and non-interactive privileged behavior requires explicit consent. - Linux lingering may invoke `sudo`; the command is surfaced and confirmed before execution, and unsupported service managers fall back to foreground-run guidance. - Database migrations remain forward-only; payload rollback does not reverse migrations, so managed updates create a backup before activation unless explicitly disabled. - Service restart and runtime serving touch process/port ownership; lifecycle locks, health/version checks, and stable-shim service definitions reduce split-brain and stale-process risk. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex coding agents using GPT-5.5 and GPT-5.6-sol, with reasoning, repository/API access, shell execution, and test tooling. The runtime did not expose a reliable context-window size. ## 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> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
224 lines
11 KiB
TypeScript
224 lines
11 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import * as p from "@clack/prompts";
|
|
import type { Command } from "commander";
|
|
import { readConfig, resolveConfigPath } from "../config/store.js";
|
|
import { resolvePaperclipInstanceId, resolvePaperclipInstanceRoot } from "../config/home.js";
|
|
import { detectServiceManager, type ServiceManager, type ServiceStatus } from "../services/service-manager.js";
|
|
import { buildLocalHealthUrl } from "../utils/health-url.js";
|
|
|
|
type CommonOptions = { instance?: string; json?: boolean };
|
|
type HealthResult = { ok: boolean; serverVersion: string | null; error?: string };
|
|
|
|
function output(value: unknown, json: boolean | undefined): void {
|
|
if (json) console.log(JSON.stringify(value, null, 2));
|
|
else if (typeof value === "string") console.log(value);
|
|
else console.log(JSON.stringify(value, null, 2));
|
|
}
|
|
|
|
async function resolveManager(opts: CommonOptions): Promise<ServiceManager | null> {
|
|
const detection = await detectServiceManager({ instanceId: opts.instance });
|
|
if (detection.supported) return detection.manager;
|
|
output({ supported: false, message: detection.reason }, opts.json);
|
|
return null;
|
|
}
|
|
|
|
function healthUrl(instanceId: string): string {
|
|
process.env.PAPERCLIP_INSTANCE_ID = instanceId;
|
|
const config = readConfig(resolveConfigPath());
|
|
return buildLocalHealthUrl(config?.server.host, config?.server.port ?? 3100);
|
|
}
|
|
|
|
async function probeHealth(instanceId: string): Promise<HealthResult> {
|
|
try {
|
|
const response = await fetch(healthUrl(instanceId), { signal: AbortSignal.timeout(2_000) });
|
|
const body = await response.json() as { status?: unknown; serverVersion?: unknown; version?: unknown };
|
|
return { ok: response.ok && body.status === "ok", serverVersion: typeof body.serverVersion === "string" ? body.serverVersion : typeof body.version === "string" ? body.version : null };
|
|
} catch (error) {
|
|
return { ok: false, serverVersion: null, error: error instanceof Error ? error.message : String(error) };
|
|
}
|
|
}
|
|
|
|
async function waitForHealth(instanceId: string, expectedVersion: string | null, timeoutMs = 60_000): Promise<HealthResult> {
|
|
const deadline = Date.now() + timeoutMs;
|
|
let last: HealthResult = { ok: false, serverVersion: null };
|
|
while (Date.now() < deadline) {
|
|
last = await probeHealth(instanceId);
|
|
if (last.ok && (!expectedVersion || last.serverVersion === expectedVersion)) return last;
|
|
await new Promise((resolve) => setTimeout(resolve, 500));
|
|
}
|
|
throw new Error(`Paperclip service did not become healthy${expectedVersion ? ` at version ${expectedVersion}` : ""}: ${last.error ?? `reported ${last.serverVersion ?? "no version"}`}`);
|
|
}
|
|
|
|
export function resolveRestartExpectedVersion(expectedVersion: string | null | undefined): string | null {
|
|
return expectedVersion ?? null;
|
|
}
|
|
|
|
export async function withHotRestartLock<T>(
|
|
instanceId: string,
|
|
callback: () => Promise<T>,
|
|
options: { timeoutMs?: number; pollMs?: number; isProcessAlive?: (pid: number) => boolean } = {},
|
|
): Promise<T> {
|
|
const instanceRoot = resolvePaperclipInstanceRoot(instanceId);
|
|
const lockPath = path.join(instanceRoot, "hot-restart.lock");
|
|
const token = `${process.pid}:${Date.now()}:${Math.random().toString(16).slice(2)}`;
|
|
const deadline = Date.now() + (options.timeoutMs ?? 120_000);
|
|
const pollMs = options.pollMs ?? 100;
|
|
const isProcessAlive = options.isProcessAlive ?? ((pid: number) => {
|
|
try {
|
|
process.kill(pid, 0);
|
|
return true;
|
|
} catch (error) {
|
|
return (error as NodeJS.ErrnoException).code !== "ESRCH";
|
|
}
|
|
});
|
|
await fs.mkdir(instanceRoot, { recursive: true });
|
|
|
|
while (true) {
|
|
try {
|
|
await fs.writeFile(lockPath, `${token}\n`, { encoding: "utf8", mode: 0o600, flag: "wx" });
|
|
break;
|
|
} catch (error) {
|
|
if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error;
|
|
try {
|
|
const existingToken = (await fs.readFile(lockPath, "utf8")).trim();
|
|
const ownerPid = Number.parseInt(existingToken.split(":", 1)[0] ?? "", 10);
|
|
if (Number.isInteger(ownerPid) && ownerPid > 0 && !isProcessAlive(ownerPid)) {
|
|
if ((await fs.readFile(lockPath, "utf8")).trim() === existingToken) {
|
|
await fs.rm(lockPath, { force: true });
|
|
continue;
|
|
}
|
|
}
|
|
} catch (readError) {
|
|
if ((readError as NodeJS.ErrnoException).code === "ENOENT") continue;
|
|
throw readError;
|
|
}
|
|
if (Date.now() >= deadline) {
|
|
throw new Error(
|
|
`Another restart for instance ${instanceId} is still running. ` +
|
|
`If no restart process is active, remove the stale lock at ${lockPath} and retry.`,
|
|
);
|
|
}
|
|
await new Promise((resolve) => setTimeout(resolve, pollMs));
|
|
}
|
|
}
|
|
|
|
try {
|
|
return await callback();
|
|
} finally {
|
|
try {
|
|
if ((await fs.readFile(lockPath, "utf8")).trim() === token) {
|
|
await fs.rm(lockPath, { force: true });
|
|
}
|
|
} catch (error) {
|
|
if ((error as NodeJS.ErrnoException).code !== "ENOENT") throw error;
|
|
}
|
|
}
|
|
}
|
|
|
|
async function writeHotRestartIntent(status: ServiceStatus, instanceId: string, drainRequired: boolean): Promise<{ requestedAt: string }> {
|
|
if (!status.pid) throw new Error(`Cannot restart ${status.serviceName}: supervisor did not report a server pid.`);
|
|
const health = await probeHealth(instanceId);
|
|
const instanceRoot = resolvePaperclipInstanceRoot(instanceId);
|
|
const requestedAt = new Date().toISOString();
|
|
await fs.mkdir(instanceRoot, { recursive: true });
|
|
await fs.rm(path.join(instanceRoot, "hot-restart-report.json"), { force: true });
|
|
await fs.writeFile(path.join(instanceRoot, "hot-restart-intent.json"), `${JSON.stringify({
|
|
version: 1,
|
|
requestedAt,
|
|
previousServerPid: status.pid,
|
|
previousServerVersion: health.serverVersion,
|
|
drainRequired,
|
|
requestedByRunId: process.env.PAPERCLIP_RUN_ID?.trim() || null,
|
|
}, null, 2)}\n`, "utf8");
|
|
return { requestedAt };
|
|
}
|
|
|
|
async function waitForRestartReport(instanceId: string, requestedAt: string, timeoutMs = 10_000): Promise<unknown | null> {
|
|
const reportPath = path.join(resolvePaperclipInstanceRoot(instanceId), "hot-restart-report.json");
|
|
const deadline = Date.now() + timeoutMs;
|
|
while (Date.now() < deadline) {
|
|
try {
|
|
const report = JSON.parse(await fs.readFile(reportPath, "utf8")) as { requestedAt?: unknown };
|
|
if (report.requestedAt === requestedAt) return report;
|
|
} catch (error) {
|
|
if ((error as NodeJS.ErrnoException).code !== "ENOENT") throw error;
|
|
}
|
|
await new Promise((resolve) => setTimeout(resolve, 250));
|
|
}
|
|
return null;
|
|
}
|
|
|
|
export async function restartManagedService(input: { instanceId?: string; expectedVersion?: string | null; waitForDrain?: boolean } = {}): Promise<{ status: ServiceStatus; health: HealthResult; report: unknown | null }> {
|
|
const instanceId = resolvePaperclipInstanceId(input.instanceId);
|
|
return withHotRestartLock(instanceId, async () => {
|
|
const detection = await detectServiceManager({ instanceId });
|
|
if (!detection.supported) throw new Error(detection.reason);
|
|
const before = await detection.manager.status();
|
|
const intent = await writeHotRestartIntent(before, instanceId, input.waitForDrain ?? false);
|
|
await detection.manager.restart();
|
|
const health = await waitForHealth(instanceId, resolveRestartExpectedVersion(input.expectedVersion));
|
|
return { status: await detection.manager.status(), health, report: await waitForRestartReport(instanceId, intent.requestedAt) };
|
|
});
|
|
}
|
|
|
|
export function registerServiceCommands(program: Command): void {
|
|
const service = program.command("service").description("Manage Paperclip as a background service");
|
|
const common = (command: Command) => command.option("-i, --instance <id>", "Local instance id (default: default)").option("--json", "Print machine-readable JSON", false);
|
|
|
|
common(service.command("install").description("Install and register the background service"))
|
|
.option("--no-start-now", "Install without starting now")
|
|
.option("--no-start-on-login", "Install without enabling start on login")
|
|
.option("--enable-linger", "Allow systemd startup without an active login session", false)
|
|
.action(async (opts) => {
|
|
const manager = await resolveManager(opts); if (!manager) return;
|
|
const result = await manager.install({ startNow: opts.startNow, startOnLogin: opts.startOnLogin });
|
|
let lingerEnabled = false;
|
|
if (manager.enableLinger) {
|
|
let consent = opts.enableLinger === true;
|
|
if (!consent && process.stdin.isTTY && process.stdout.isTTY) {
|
|
consent = await p.confirm({ message: "Allow Paperclip to run without an active login session? This runs 'loginctl enable-linger' for your user and may request system authorization.", initialValue: false }) === true;
|
|
}
|
|
if (consent) { await manager.enableLinger(); lingerEnabled = true; }
|
|
}
|
|
output({ installed: true, changed: result.changed, platform: manager.platform, serviceName: manager.serviceName, definitionPath: manager.definitionPath, lingerEnabled }, opts.json);
|
|
});
|
|
|
|
common(service.command("uninstall").description("Stop, disable, and remove the background service")).action(async (opts) => {
|
|
const manager = await resolveManager(opts); if (!manager) return;
|
|
await manager.uninstall();
|
|
const status = await manager.status();
|
|
if (status.installed || status.active) throw new Error(`${manager.serviceName} is still loaded after uninstall.`);
|
|
output({ uninstalled: true, serviceName: manager.serviceName }, opts.json);
|
|
});
|
|
|
|
for (const verb of ["start", "stop"] as const) {
|
|
common(service.command(verb).description(`${verb === "start" ? "Start" : "Stop"} the background service`)).action(async (opts) => {
|
|
const manager = await resolveManager(opts); if (!manager) return;
|
|
await manager[verb]();
|
|
output(await manager.status(), opts.json);
|
|
});
|
|
}
|
|
|
|
common(service.command("restart").description("Hot-restart the service while preserving active agent runs"))
|
|
.option("--wait", "Wait for active runs to drain instead of adopting them", false)
|
|
.option("--expected-version <version>", "Require the restarted server to report this version")
|
|
.action(async (opts) => output(await restartManagedService({ instanceId: opts.instance, expectedVersion: opts.expectedVersion, waitForDrain: opts.wait }), opts.json));
|
|
|
|
common(service.command("status").description("Show supervisor and health status")).action(async (opts) => {
|
|
const manager = await resolveManager(opts); if (!manager) return;
|
|
const instanceId = resolvePaperclipInstanceId(opts.instance);
|
|
output({ ...await manager.status(), health: await probeHealth(instanceId) }, opts.json);
|
|
});
|
|
|
|
common(service.command("logs").description("Show service logs"))
|
|
.option("-f, --follow", "Follow new log output", false)
|
|
.option("-n, --lines <count>", "Number of recent lines", "100")
|
|
.action(async (opts) => {
|
|
const manager = await resolveManager(opts); if (!manager) return;
|
|
const lines = Number.parseInt(opts.lines, 10);
|
|
if (!Number.isInteger(lines) || lines < 1) throw new Error("--lines must be a positive integer.");
|
|
await manager.logs(opts.follow, lines);
|
|
});
|
|
}
|