mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-02 16:58:52 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The web server owns request handling and remote execution coordination. > - Deployment must start a ready replacement while the old server still serves. > - An outage test does not prove that two live servers can overlap safely. > - This pull request adds a separate Product E2E cell for that boundary. > - The existing run, file, recovery, and retained-session checks still apply. ## Linked Issues or Issue Description Refs #18518. The runtime prerequisite is merged; this PR qualifies its ephemeral server and deployment contracts. ## What Changed - Add the explicit `rolling-web-deployment` Codex Daytona workflow. - Start independent A/B/C homes and compiled builds behind a test ingress. - Wait for readiness before routing, then drain and delete the old home. - Observe active authority before handoff and use the existing read-only recovery oracle. - Require ordinary reads and saves to succeed throughout replacement. Read back every accepted save exactly once. - Preserve the five-minute outage suites and their existing validators. - Add a model-free supervisor smoke and an unready replacement control. - Require graceful exit before deleting an old home; forced cleanup cannot satisfy the oracle. - Preserve a durable Stop through lease release/expiry until the recovered execution owner acknowledges it. Permit only fenced reattachment of the original execution for Stop cleanup; submit no new turn. - Exclude events saved by A during shutdown from evidence of B making progress. ## Verification - E2E TypeScript check passed. - Affected harness checks: 143 passed. Catalog, fixture and report checks: 120 passed. - Actual supervisor smoke passed two replacements: 436 reads, 45 saves, zero request failures, and confirmed owned resource cleanup. - B became ready in 18.7 seconds; C became ready in 109.2 seconds. A prior C timeout remains failed evidence. - Fresh browser proof: 11 checks passed, 246 reads, 50 acknowledged saves, zero failures, 1,058ms reconnect, both old homes deleted and cleanup confirmed. - Stop lease-gap regression: three PostgreSQL delivery tests passed with a simulated provider edge. Current server TypeScript build/vendoring passed. - Full harness: 5,814 passed, 17 failed, four skipped. Two shutdown races passed the focused file; two report timeouts passed an isolated 42-test rerun. Onboarding/workflow-security/Pi/date-expired fixtures are unchanged on inspected master; the host embedded PostgreSQL fixture remains a setup limitation. This is not a green full local suite. - CI at `172509b8be` passed all gates. Greptile is 5/5 with every review thread resolved. The earlier access-service race failure passed its isolated regression and the subsequent full CI. - Final review corrections: six focused executor cases, three PostgreSQL command-delivery cases, 19 harness cases and server/E2E typechecks passed. - Three live attempts failed before agent creation: two harness setup gaps were fixed, then provider authentication failed. The saved OpenAI key returns 401; a refresh is pending. The Daytona probe reported cleanup uncertain, and no sandbox with that attempt label was found through the authenticated staging manager. No live model execution is claimed. - Live Runner overlap, released-container qualification and hosted deployment proof remain pending. Merging this opt-in qualification lane does not claim those results. ## Risks - The source lane shares workspace dependencies and does not establish container packaging correctness. - The live workflow needs an explicitly owned S3 bucket, PostgreSQL, pinned remote image and provider credentials. - Qualification cleanup stops all owned processes after failure. A failed replacement must not be reported as a pass. ## Model Used OpenAI Codex, GPT-6. Tool use, code execution and repository review. The runtime does not expose a more specific model ID or 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>
67 lines
4.5 KiB
TypeScript
67 lines
4.5 KiB
TypeScript
/** Test-owned routing/process fault. Recovery stays entirely in production code. */
|
|
import type { MatrixExecution } from "./types.js";
|
|
import type { ControllerOutageReceipt } from "./controller-outage.js";
|
|
|
|
export const ROLLING_WEB_DEPLOYMENT_SUITE = "rolling-web-deployment";
|
|
export const isRollingWebDeployment = (execution: Pick<MatrixExecution, "suite">) => execution.suite.id === ROLLING_WEB_DEPLOYMENT_SUITE;
|
|
|
|
export interface ControllerRollingDeploymentReceipt extends Omit<ControllerOutageReceipt, "schema" | "holdMs" | "signal"> {
|
|
schema: "paperclip.e2e.controller-rolling-deployment/v1";
|
|
signal: "SIGTERM";
|
|
gracefulShutdown?: boolean;
|
|
trafficSwitchedAfterMs?: number;
|
|
homeDeletedAfterMs?: number;
|
|
previousHomeRemoved?: boolean;
|
|
probes?: { reads: number; writes: number; verifiedWrites: number; failures: string[] };
|
|
}
|
|
|
|
export function validControllerRollingDeploymentReceipt(value: unknown, requestId?: string): value is ControllerRollingDeploymentReceipt {
|
|
if (!value || typeof value !== "object") return false;
|
|
const r = value as ControllerRollingDeploymentReceipt;
|
|
const times = [r.replacementStartedAfterMs, r.readyAfterMs, r.trafficSwitchedAfterMs, r.stoppedAfterMs, r.homeDeletedAfterMs];
|
|
return r.schema === "paperclip.e2e.controller-rolling-deployment/v1" && r.signal === "SIGTERM"
|
|
&& /^[A-Za-z0-9._:-]{1,200}$/.test(r.requestId) && (requestId === undefined || r.requestId === requestId)
|
|
&& Number.isFinite(Date.parse(r.startedAt))
|
|
&& Number.isSafeInteger(r.previousPid) && r.previousPid > 0
|
|
&& Number.isSafeInteger(r.replacementPid) && r.replacementPid! > 0 && r.previousPid !== r.replacementPid
|
|
&& r.cacheDiscarded === true && r.previousHomeRemoved === true && r.gracefulShutdown === true
|
|
&& times.every(ms => typeof ms === "number" && Number.isFinite(ms) && ms >= 0)
|
|
&& r.replacementStartedAfterMs! <= r.readyAfterMs! && r.readyAfterMs! <= r.trafficSwitchedAfterMs!
|
|
&& r.trafficSwitchedAfterMs! <= r.stoppedAfterMs! && r.stoppedAfterMs! <= r.homeDeletedAfterMs!
|
|
&& r.homeDeletedAfterMs! < 420_000
|
|
&& Boolean(r.probes && Number.isSafeInteger(r.probes.reads) && r.probes.reads > 0
|
|
&& Number.isSafeInteger(r.probes.writes) && r.probes.writes > 0 && r.probes.verifiedWrites === r.probes.writes
|
|
&& Array.isArray(r.probes.failures) && r.probes.failures.length === 0);
|
|
}
|
|
|
|
export async function rollController<T extends { pid?: number }>(input: {
|
|
requestId: string; previousPid: number; start: () => Promise<T>;
|
|
waitForReady: (replacement: T) => Promise<void>; switchTraffic: (replacement: T) => void;
|
|
stopPrevious: () => Promise<void>; deletePreviousHome: () => Promise<void>;
|
|
beforeHandoff?: (receipt: ControllerRollingDeploymentReceipt) => Promise<void>;
|
|
afterPreviousStopped?: (receipt: ControllerRollingDeploymentReceipt) => Promise<void>;
|
|
afterHandoff?: (receipt: ControllerRollingDeploymentReceipt, record: () => Promise<void>) => Promise<void>;
|
|
cancelled: () => boolean; record: (receipt: ControllerRollingDeploymentReceipt) => Promise<void>;
|
|
}): Promise<ControllerRollingDeploymentReceipt> {
|
|
const started = performance.now();
|
|
const receipt: ControllerRollingDeploymentReceipt = { schema: "paperclip.e2e.controller-rolling-deployment/v1",
|
|
requestId: input.requestId, previousPid: input.previousPid, startedAt: new Date().toISOString(), signal: "SIGTERM" };
|
|
const elapsed = () => performance.now() - started;
|
|
const check = () => { if (input.cancelled()) throw new Error("Wrapper shutdown interrupted the rolling deployment"); };
|
|
const record = () => input.record({ ...receipt });
|
|
check(); await record();
|
|
receipt.replacementStartedAfterMs = elapsed();
|
|
const replacement = await input.start(); receipt.replacementPid = replacement.pid; await record();
|
|
await input.waitForReady(replacement); check(); receipt.readyAfterMs = elapsed(); await record();
|
|
// Capture while A still owns its live lease. B may adopt immediately after
|
|
// SIGTERM, so an observation taken after A exits would miss that boundary.
|
|
await input.beforeHandoff?.(receipt); check();
|
|
input.switchTraffic(replacement); receipt.trafficSwitchedAfterMs = elapsed(); await record();
|
|
await input.stopPrevious(); receipt.gracefulShutdown = true; receipt.stoppedAfterMs = elapsed(); await record();
|
|
await input.afterPreviousStopped?.(receipt); check(); await record();
|
|
await input.deletePreviousHome(); receipt.homeDeletedAfterMs = elapsed();
|
|
receipt.previousHomeRemoved = true; receipt.cacheDiscarded = true; await record();
|
|
await input.afterHandoff?.(receipt, record);
|
|
return receipt;
|
|
}
|