mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-01 23:43:16 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Its web server also owns controller admission and user commands. > - A rolling deployment starts a replacement before the old server exits. > - Shared database state alone does not preserve local agent files, browser chunks, or in-process commands. > - This pull request adds an opt-in ephemeral server contract and a local overlap test. > - The benefit is a web server that can relinquish traffic and local files without losing acknowledged work. ## Linked Issues or Issue Description Refs #18403, #18327, #18335, #18341. **Current behavior** The control-plane web server still has local agent-file authority and local command targets. A new container can miss saved bytes or send a command to the wrong process. An existing browser tab also needs chunks from its original build. **Proposed behavior** Eligible servers share only PostgreSQL, object storage and stable secrets. A replacement waits for readiness. The old server drains admitted requests, keeps owner commands available through handoff, and releases controller leases. Explicit maintenance adopts existing files before the volume is removed. **Reason and benefit** This is the application prerequisite for rolling app-only deployments. Schema migrations and permanent multi-replica operation are outside this change. ## What Changed - Store agent-file manifests in PostgreSQL and immutable bytes in S3. Treat local roots as disposable projections. Preserve existing permission checks and edit conflicts. - Add an explicit migration, eligibility and object-retention command to the production runtime bundle. - Add `/api/ready`, admitted-request drain, browser restart signaling and retained immutable UI chunks. - Carry transaction-aware work hints across controllers during handoff and active execution. Keep listeners closed when idle. - Deliver durable Stop and runtime responses to the execution owner. Recheck request lifecycle and access before response dispatch. - Reject local-only configuration in ephemeral mode. Keep the feature disabled for existing installations by default. - Add an isolated PostgreSQL/S3/proxy/browser deployment harness with independent server homes and retained failure evidence. ## Verification - All CI checks pass on `ce17b95019d3cf1cabd357d19b6d37f96782cc5c`: workspace typecheck, build, Runner checks, server/general tests and browser shards. Greptile reviewed the runtime changes at 5/5 with all findings resolved; the final commit updates maps and the plan. - Local targeted checks passed: coordinator 27; Stop/recovery 33; PostgreSQL command delivery 6; route/workspace regressions 8; bootstrap Stop 1; restart recovery 75. PostgreSQL command tests simulate the provider edge. - Local browser proof passed 91 reads and 19 saves; reconnect took 1,013ms. The tab opened Audit from S3 after deletion of A's whole home/build. This uses compiled workspace code and local-trusted auth, not released containers or live agents. - Local workspace typecheck/build passed; current server and runtime bundle passed. The earlier broad local suite was stopped after three hours and is not a passing receipt. Its retained failures and isolated reruns are documented in the plan. - Stacked #18526 adds stricter graceful-exit proof, an unready replacement control, live Runner qualification and a Stop handoff correction. Hosted enablement remains gated on those results and Cloud #1096. No hosted stack has been enabled. ## Risks - Apply migration 0422 before enabling the feature. Existing data must pass each owner's migration and eligibility checks. Do not discard a volume based on a single migration page. - Durable manifests remain authoritative after the opt-in is disabled. Rolling back to a binary that ignores them is unsupported. - Cold directory restoration and complete shutdown timing still need qualification before enabling a hosted stack. - Retained UI assets must cover the supported browser and rollback window. Cleanup is explicit; no new idle maintenance polling is introduced. - This change does not claim production zero downtime or authorize a fleet-wide enablement. ## Model Used OpenAI Codex, GPT-6 family. The exact serving model ID and context-window limit are not exposed in this session. Used reasoning, code editing, shell execution and browser automation. ## 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.7 KiB
JavaScript
160 lines
9.7 KiB
JavaScript
import { execFile } from "node:child_process";
|
|
import { mkdirSync, mkdtempSync, realpathSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
import { fileURLToPath, pathToFileURL } from "node:url";
|
|
import { promisify } from "node:util";
|
|
|
|
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
|
|
import { bundleRuntime, preserveModuleLocation } from "./bundle-runtime.mjs";
|
|
|
|
const execFileAsync = promisify(execFile);
|
|
|
|
function write(file, content) {
|
|
mkdirSync(path.dirname(file), { recursive: true });
|
|
writeFileSync(file, content);
|
|
}
|
|
|
|
describe("bundleRuntime", () => {
|
|
let root;
|
|
|
|
beforeEach(() => {
|
|
root = realpathSync(mkdtempSync(path.join(tmpdir(), "paperclip-bundle-runtime-")));
|
|
const pkg = path.join(root, "packages", "fixture");
|
|
write(path.join(pkg, "package.json"), JSON.stringify({ name: "@paperclipai/fixture", type: "module", exports: { ".": "./src/index.ts" } }));
|
|
write(path.join(pkg, "src", "asset.txt"), "asset beside its source\n");
|
|
write(path.join(pkg, "src", "helper.ts"), "export const double = (value: number): number => value * 2;\n");
|
|
write(path.join(pkg, "src", "index.ts"), [
|
|
"import { readFileSync } from \"node:fs\";",
|
|
"import { double } from \"./helper.js\";",
|
|
"import { onlyForPackage } from \"package-private-dep\";",
|
|
"import { nodeBuild } from \"dual-build-dep\";",
|
|
"export const asset = readFileSync(new URL(\"./asset.txt\", import.meta.url), \"utf8\").trim();",
|
|
"export const location = import.meta.dirname;",
|
|
"export const values = { doubled: double(21), onlyForPackage, nodeBuild };",
|
|
"",
|
|
].join("\n"));
|
|
write(path.join(pkg, "node_modules", "package-private-dep", "package.json"), JSON.stringify({ name: "package-private-dep", type: "module", main: "index.js" }));
|
|
write(path.join(pkg, "node_modules", "package-private-dep", "index.js"), "export const onlyForPackage = \"resolved from the package\";\n");
|
|
write(path.join(pkg, "node_modules", "dual-build-dep", "package.json"), JSON.stringify({
|
|
name: "dual-build-dep", exports: { ".": { module: "./bundler/index.js", default: "./node.cjs" } },
|
|
}));
|
|
write(path.join(pkg, "node_modules", "dual-build-dep", "node.cjs"), "exports.nodeBuild = \"node build\";\n");
|
|
write(path.join(pkg, "node_modules", "dual-build-dep", "bundler", "index.js"), "export * from \"./extensionless\";\n");
|
|
|
|
const server = path.join(root, "server");
|
|
mkdirSync(path.join(server, "node_modules", "@paperclipai"), { recursive: true });
|
|
symlinkSync(pkg, path.join(server, "node_modules", "@paperclipai", "fixture"), "dir");
|
|
write(path.join(server, "package.json"), JSON.stringify({ name: "server", type: "module" }));
|
|
for (const [version, flavor] of [["1", "installed at build"], ["2", "replaced after build"]]) {
|
|
const store = path.join(root, "node_modules", ".pnpm", `server-dep@${version}`);
|
|
write(path.join(store, "package.json"), JSON.stringify({ name: "server-dep", type: "module", main: "index.js" }));
|
|
write(path.join(store, "index.js"), `export const flavor = ${JSON.stringify(flavor)};\n`);
|
|
}
|
|
symlinkSync(path.join(root, "node_modules", ".pnpm", "server-dep@1"), path.join(server, "node_modules", "server-dep"), "dir");
|
|
write(path.join(server, "dist", "late.js"), "import { values } from \"@paperclipai/fixture\";\nexport const late = () => values.doubled + 1;\n");
|
|
write(path.join(server, "dist", "index.js"), [
|
|
"import { asset, location, values } from \"@paperclipai/fixture\";",
|
|
"import { flavor } from \"server-dep\";",
|
|
"import { pathToFileURL } from \"node:url\";",
|
|
"const { late } = await import(\"./late.js\");",
|
|
"// The server only starts when it is the main module.",
|
|
"if (pathToFileURL(process.argv[1]).href === import.meta.url) {",
|
|
" console.log(JSON.stringify({ asset, location, values, flavor, late: late(), entryDir: import.meta.dirname }));",
|
|
"}",
|
|
"",
|
|
].join("\n"));
|
|
});
|
|
|
|
afterEach(() => {
|
|
rmSync(root, { recursive: true, force: true });
|
|
});
|
|
|
|
it("packages a maintenance entry without starting the application or needing a TypeScript loader", async () => {
|
|
const maintenanceEntry = path.join(root, "server", "dist", "maintenance.js");
|
|
write(maintenanceEntry, 'import { asset } from "@paperclipai/fixture"; console.log(JSON.stringify({ asset, phase: process.argv.at(-1) }));');
|
|
const outdir = path.join(root, "server", "dist-runtime");
|
|
await bundleRuntime({ entry: path.join(root, "server", "dist", "index.js"), outdir, maintenanceEntry });
|
|
const { stdout } = await execFileAsync(process.execPath, [path.join(outdir, "agent-files.mjs"), "--phase=eligibility"], { timeout: 30_000 });
|
|
expect(JSON.parse(stdout)).toEqual({ asset: "asset beside its source", phase: "--phase=eligibility" });
|
|
});
|
|
|
|
it("bundles workspace TypeScript and runs with plain node", async () => {
|
|
const outdir = path.join(root, "server", "dist-runtime");
|
|
const summary = await bundleRuntime({ entry: path.join(root, "server", "dist", "index.js"), outdir });
|
|
expect(summary.outfile).toBe(path.join(outdir, "index.mjs"));
|
|
|
|
const { stdout } = await execFileAsync(process.execPath, [summary.outfile], { cwd: path.join(root, "server"), timeout: 30_000 });
|
|
const output = JSON.parse(stdout);
|
|
expect(output.values).toEqual({ doubled: 42, onlyForPackage: "resolved from the package", nodeBuild: "node build" });
|
|
expect(output.late).toBe(43);
|
|
expect(output.asset).toBe("asset beside its source");
|
|
expect(output.location).toBe(path.join(root, "packages", "fixture", "src"));
|
|
expect(output.entryDir).toBe(path.join(root, "server", "dist"));
|
|
});
|
|
|
|
it("keeps database caller locations public in a source-mapped runtime bundle", async () => {
|
|
const captureModule = fileURLToPath(new URL("../../packages/db/src/response-capture.ts", import.meta.url));
|
|
write(path.join(root, "server", "dist", "services", "response-caller.js"), [
|
|
`import { publicDatabaseCallers } from ${JSON.stringify(captureModule)};`,
|
|
'export function callers() { return publicDatabaseCallers(new Error("private-capture-message").stack); }',
|
|
].join("\n"));
|
|
write(path.join(root, "server", "dist", "index.js"), [
|
|
'import { callers } from "./services/response-caller.js";',
|
|
'console.log(JSON.stringify({ callers: callers() }));',
|
|
].join("\n"));
|
|
const summary = await bundleRuntime({ entry: path.join(root, "server", "dist", "index.js"), outdir: path.join(root, "server", "dist-runtime") });
|
|
const env = { ...process.env };
|
|
delete env.NODE_OPTIONS;
|
|
delete env.PAPERCLIP_DB_RESPONSE_CAPTURE_WINDOW;
|
|
const options = { cwd: path.join(root, "server"), env, timeout: 30_000 };
|
|
const plain = JSON.parse((await execFileAsync(process.execPath, [summary.outfile], options)).stdout);
|
|
const mapped = JSON.parse((await execFileAsync(process.execPath, ["--enable-source-maps", summary.outfile], options)).stdout);
|
|
expect(plain.callers).toEqual([]);
|
|
expect(mapped.callers).toEqual([expect.stringMatching(/^services\/response-caller\.js:\d+:\d+$/)]);
|
|
for (const result of [plain, mapped]) {
|
|
const output = JSON.stringify(result);
|
|
expect(output).not.toContain(root);
|
|
expect(output).not.toContain(captureModule);
|
|
expect(output).not.toContain("private-capture-message");
|
|
}
|
|
});
|
|
|
|
it("emits a server module that loads without starting the server", async () => {
|
|
const outdir = path.join(root, "server", "dist-runtime");
|
|
const summary = await bundleRuntime({ entry: path.join(root, "server", "dist", "index.js"), outdir });
|
|
expect(summary.serverModule).toBe(path.join(outdir, "server.mjs"));
|
|
const probe = path.join(root, "server", "probe.mjs");
|
|
write(probe, `await import(${JSON.stringify(pathToFileURL(summary.serverModule).href)});\nconsole.log("loaded");\n`);
|
|
const loaded = await execFileAsync(process.execPath, [probe], { cwd: path.join(root, "server"), timeout: 30_000 });
|
|
expect(loaded.stdout.trim()).toBe("loaded");
|
|
const started = await execFileAsync(process.execPath, [summary.outfile], { cwd: path.join(root, "server"), timeout: 30_000 });
|
|
expect(JSON.parse(started.stdout).late).toBe(43);
|
|
});
|
|
|
|
it("leaves the server's own dependencies to runtime resolution", async () => {
|
|
const outdir = path.join(root, "server", "dist-runtime");
|
|
const summary = await bundleRuntime({ entry: path.join(root, "server", "dist", "index.js"), outdir });
|
|
rmSync(path.join(root, "server", "node_modules", "server-dep"));
|
|
symlinkSync(path.join(root, "node_modules", ".pnpm", "server-dep@2"), path.join(root, "server", "node_modules", "server-dep"), "dir");
|
|
const { stdout } = await execFileAsync(process.execPath, [summary.outfile], { cwd: path.join(root, "server"), timeout: 30_000 });
|
|
expect(JSON.parse(stdout).flavor).toBe("replaced after build");
|
|
});
|
|
|
|
it("keeps third-party packages external", async () => {
|
|
const outdir = path.join(root, "server", "dist-runtime");
|
|
await bundleRuntime({ entry: path.join(root, "server", "dist", "index.js"), outdir });
|
|
const { stdout } = await execFileAsync("grep", ["-rl", "resolved from the package", outdir], { encoding: "utf8" }).catch(() => ({ stdout: "" }));
|
|
expect(stdout.trim()).toBe("");
|
|
});
|
|
});
|
|
|
|
describe("preserveModuleLocation", () => {
|
|
it("replaces import.meta location properties with the original path", () => {
|
|
const file = "/srv/app/packages/x/src/mod.ts";
|
|
const out = preserveModuleLocation("a(import.meta.url); b(import.meta.dirname); c(import.meta.filename); d(import.meta.resolve);", file);
|
|
expect(out).toBe(`a("file:///srv/app/packages/x/src/mod.ts"); b("/srv/app/packages/x/src"); c("/srv/app/packages/x/src/mod.ts"); d(import.meta.resolve);`);
|
|
});
|
|
});
|