mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-29 04:25:52 +01:00
fix(runner): retain startup Stop and exhaust reconnect recovery (#17812)
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Operators must be able to stop a remote runner while it starts. > - Remote artifact staging can finish after the transport's bounded cleanup wait. > - The launcher discarded an early Stop request and could dispatch after staging. > - A separate path missed the runner's plain-text reconnect expiry receipt. > - This change retains startup cancellation and ends an exhausted reconnect incident. > - Public package imports and a source-bound profile keep the regressions buildable and admission checks intact. ## Linked Issues or Issue Description Related work: Refs #16835, Refs #16843, Refs #16855. **What happened?** The HTTP Stop route returned 200 and recorded a cancelled run. After bounded bootstrap cleanup, releasing artifact staging still dispatched one launch RPC. A separate reconnect test accepted a replacement after the runner reported that its grace period had expired. The first PR head also failed CI. The HTTP regression imported Runner source across the server TypeScript boundary. Its event receipt mock read a field that is not present on both event forms. The changed transport also invalidated the pinned Copilot source identity. **Expected behavior** A cancelled launch must remain cancelled after staging. An exhausted reconnect receipt must end that incident. Regression tests must use public package contracts. The source identity must cover the changed transport without replacing historical profile bytes. **Steps to reproduce** 1. Hold the remote launcher's artifact staging promise. 2. Call the board Stop route and let bootstrap cleanup reach its preparation deadline. 3. Release staging and count launch RPCs. 4. For reconnect expiry, end an owned runner with its coded or plain-text expiry message. 5. Run the server typecheck and the Copilot profile identity check. ## What Changed - Retain cancellation through staging, trace publication and an in-flight launch RPC. - Apply a deferred signal through the existing identity checks when the launch identity arrives. - Preserve an earlier KILL request when a later TERM request arrives. - Recognize both coded and plain-text reconnect expiry receipts. - Test the real board Stop route and heartbeat cancellation with PostgreSQL. Use public Runner exports and handle both event receipt forms. - Generate source-bound Copilot profile v65 after integrating current master. Preserve exact published v62, v63 and v64 fixtures, retain the earlier v63 reconnect candidate as historical evidence, and reject historical profiles for a current launch. - Document process evidence, retained uncertainty and the limits of cleanup and continuation evidence. ## Verification - At current integration head `2b96ee3adcb3be642c538436113e1159d92f843d`, launcher and HTTP Stop regressions: 21 passed. This includes the existing process-generation and exact-exit safety cases on the integrated base. The HTTP case includes bootstrap expiry; it is not isolated Stop-only settlement proof. - At current integration head, reconnect expiry regressions: 2 passed, for coded and plain-text receipts. - At current integration head `2b96ee3adcb3be642c538436113e1159d92f843d`, the Copilot installation and identity suite passed all 63 tests and the canonical generator check passed. Before regeneration, the merged-tree admission test failed with a transport source hash mismatch and the generator reported a stale identity. Published v62, v63 and v64 bytes remain unchanged; the prior reconnect candidate is preserved separately. The v62 fixture SHA-256 remains `faa4d1b35267b54e134a8e0c84586fe1196d8fad5525cb53aa195aae53ca6e83`. - Current integration head passed all 86 focused tests, the full recursive repository typecheck and the root repository build. The normal server typecheck also passed, including its full Runner release rebuild. - Historical full recursive repository typecheck and the root repository build passed at `187bb85b4fa1fbd2ffaec992650a1c8557df9ebe`. Server typecheck also passed through the normal package script and a direct full server TypeScript check. The prerequisite full Runner release build passed. - The historical HTTP baseline returned 200 and dispatched one late launch RPC. The repair returned 200 and dispatched zero in the bounded fixture. - Earlier failures remain part of the evidence: the first head failed TypeScript package boundaries and source identity. One local HTTP run failed before migrations; it passed after the disposable test database received normal migrations. Earlier sandbox-wide checks ran out of memory or lacked Cargo. Those runs did not pass. - Historical head `187bb85b4fa1fbd2ffaec992650a1c8557df9ebe` received Greptile 5/5 with no actionable findings and all hosted gates passed in run `40412261957`: 53 successful check runs, four expected skips and a successful legacy Snyk status. Those results predate the master integration and do not establish current-head readiness. - Current integration head `2b96ee3adcb3be642c538436113e1159d92f843d` includes master `bd382eee536f4ada680072b1cc19100163c3d04a`. All current-head hosted gates passed in run `40512885858`: 53 successful check runs, four expected skips and a successful legacy Snyk status, with zero pending or failed checks. Build passed at 13:42:36 UTC and the final `ci / verify` aggregate (job `122224566238`) passed at 13:43:00 UTC on 2026-10-27. Greptile reviewed exact head `2b96ee3adcb3be642c538436113e1159d92f843d` at 5/5 (updated 2026-10-27 13:36:41 UTC), with no actionable findings and no open inline threads. The hosted partitions passed full-suite verification, including browser and release gates. The wider qualification limits below remain in force. - Local setup on current master initially failed frozen install with `ERR_PNPM_LOCKFILE_CONFIG_MISMATCH` because `patchedDependencies` differs from the lockfile. Pinned pnpm 9.15.4 hydrated dependencies with `--no-frozen-lockfile --ignore-scripts`; its generated lockfile change was restored. This PR changes no lockfile or workflow. - Reproduce the Stop tests from `server`: `pnpm exec vitest run src/services/native-runtime/native-session-executor.test.ts -t 'remote runner process supervision|HTTP Stop during remote runner staging'`. The test accepts a guarded disposable `_test` database through `PAPERCLIP_TEST_DATABASE_URL`, or starts its normal embedded database. - Reproduce reconnect tests from `packages/paperclip-runner`: `pnpm exec vitest run src/live/runnerd-codex-transport.test.ts -t 'does not restart an exhausted reconnect'`. Build the normal test runner first. - Reproduce profile checks from `packages/paperclip-runner`: `node scripts/copilot-profile-identity.mjs --check` and `pnpm exec vitest run src/drivers/acpx/copilot-installation.test.ts`. ## Risks - The wider qualification is incomplete. Verified-stopped replacement and concurrent recovery plus Stop each entered two physical provider processes. Both fail the original requirement of at most one physical provider entry. Passing fixture assertions do not make all incident scenarios accepted. - HTTP concurrent recovery, shared provider-attempt accounting, server-admitted restored continuation, live-provider behavior and product cleanup settlement remain unrun or unproved. - Accepting a deferred signal is not proof that a dispatched process stopped. The existing monitor remains authoritative. - The HTTP test uses the real route, heartbeat cancellation and PostgreSQL state. Execution lease and event ports, plus the launch RPC, are controlled fixtures. Bootstrap expiry participates in this case. - The local incident matrix uses an installed runner binary and a scripted provider. It does not qualify a live provider. Local fixture teardown does not certify product cleanup settlement. - This change does not authorize historical turn replay. It does not change ownership, pause, approval or provider-attempt gates. ## Model Used OpenAI Codex, GPT-6 family. The runtime does not expose the exact serving model ID or context-window size. The agent used reasoning, repository inspection, shell execution and connected GitHub tools. ## 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>
This commit is contained in:
1 parent
bd382eee53
commit
db70c5acd9
14 files changed
+506
-16
No files matched your search
@@ -313,6 +313,8 @@ vi.mock("./current-wake-comments.js", () => ({
|
||||
}));
|
||||
|
||||
vi.mock("../activity-log.js", () => ({
|
||||
logActivity: vi.fn(async () => undefined),
|
||||
publishPluginDomainEvent: vi.fn(async () => undefined),
|
||||
persistActivity: state.persistActivity,
|
||||
publishActivity: state.publishActivity,
|
||||
}));
|
||||
@@ -884,6 +886,83 @@ describe("remote runner launch fingerprint compatibility", () => {
|
||||
});
|
||||
|
||||
describe("remote runner process supervision", () => {
|
||||
it.each(["staging", "dispatch trace"])("retains cancellation during %s without a launch RPC", async (boundary) => {
|
||||
let enter!: () => void;
|
||||
let release!: () => void;
|
||||
const entered = new Promise<void>(resolve => { enter = resolve; });
|
||||
const gate = new Promise<void>(resolve => { release = resolve; });
|
||||
const pause = async () => { enter(); await gate; };
|
||||
const execute = vi.fn();
|
||||
const handle = createRemoteRunnerProcessLauncher({
|
||||
target: { kind: "remote", transport: "sandbox", environmentId: "environment", leaseId: "lease", remoteCwd: "/workspace" },
|
||||
runner: { execute } as never,
|
||||
remoteBinary: "/runtime/runnerd", processIdentityPath: "/runtime/identity",
|
||||
stateDirectory: "/runtime", diagnosticsDirectory: "/runtime/diagnostics", runnerInstanceId: "runner-remote",
|
||||
...(boundary === "staging" ? { ensureArtifact: pause } : { trace: { record: pause } as never }),
|
||||
})({ command: "/controller/runnerd", args: [], cwd: "/controller", environment: {} });
|
||||
try {
|
||||
await entered;
|
||||
expect(handle.child.kill("SIGTERM")).toBe(true);
|
||||
expect(handle.isExitConfirmed?.()).toBe(false);
|
||||
expect(execute).not.toHaveBeenCalled();
|
||||
release();
|
||||
await expect(handle.completion).resolves.toMatchObject({ code: null, signal: "SIGTERM" });
|
||||
expect(handle.isExitConfirmed?.()).toBe(true);
|
||||
expect(execute).not.toHaveBeenCalled();
|
||||
} finally {
|
||||
release();
|
||||
await handle.completion;
|
||||
}
|
||||
});
|
||||
|
||||
it("defers an in-flight launch signal until its exact identity is available", async () => {
|
||||
let enter!: () => void;
|
||||
let release!: () => void;
|
||||
let releaseMonitor!: () => void;
|
||||
const entered = new Promise<void>(resolve => { enter = resolve; });
|
||||
const gate = new Promise<void>(resolve => { release = resolve; });
|
||||
const monitor = new Promise<void>(resolve => { releaseMonitor = resolve; });
|
||||
let nonce = "";
|
||||
const ok = { exitCode: 0, signal: null, timedOut: false, stdout: "", stderr: "" };
|
||||
const execute = vi.fn(async (input: { args?: string[] }) => {
|
||||
const label = input.args?.[2];
|
||||
if (label === "paperclip-runner-launch") {
|
||||
nonce = input.args![4]!;
|
||||
enter(); await gate;
|
||||
return ok;
|
||||
}
|
||||
if (label === "paperclip-runner-process-identity") return { ...ok, stdout: `${nonce}\n4321\n2026-09-06T00:00:00.000Z\nrunner-remote\n` };
|
||||
if (label === "paperclip-runner-monitor") { await monitor; return { ...ok, exitCode: 45 }; }
|
||||
if (label === "paperclip-runner-signal") return ok;
|
||||
return { ...ok, exitCode: 1 };
|
||||
});
|
||||
const handle = createRemoteRunnerProcessLauncher({
|
||||
target: { kind: "remote", transport: "sandbox", environmentId: "environment", leaseId: "lease", remoteCwd: "/workspace" },
|
||||
runner: { execute } as never,
|
||||
remoteBinary: "/runtime/runnerd", processIdentityPath: "/runtime/identity",
|
||||
stateDirectory: "/runtime", diagnosticsDirectory: "/runtime/diagnostics", runnerInstanceId: "runner-remote",
|
||||
})({ command: "/controller/runnerd", args: [], cwd: "/controller", environment: {} });
|
||||
try {
|
||||
await entered;
|
||||
expect(handle.child.kill("SIGKILL")).toBe(true);
|
||||
expect(handle.child.kill("SIGTERM")).toBe(true);
|
||||
expect(execute.mock.calls.some(([input]) => input.args?.[2] === "paperclip-runner-signal")).toBe(false);
|
||||
expect(handle.isExitConfirmed?.()).toBe(false);
|
||||
release();
|
||||
await vi.waitFor(() => expect(execute.mock.calls.filter(([input]) => input.args?.[2] === "paperclip-runner-signal")).toHaveLength(1));
|
||||
const signal = execute.mock.calls.find(([input]) => input.args?.[2] === "paperclip-runner-signal")![0];
|
||||
expect(signal.args?.slice(3)).toEqual(["/runtime/identity", nonce, "runner-remote", "4321"]);
|
||||
expect(signal.args?.[1]).toContain('kill -KILL "$expected_pid"');
|
||||
expect(handle.isExitConfirmed?.()).toBe(false);
|
||||
releaseMonitor();
|
||||
await handle.completion;
|
||||
expect(handle.isExitConfirmed?.()).toBe(true);
|
||||
expect(execute.mock.calls.filter(([input]) => input.args?.[2] === "paperclip-runner-launch")).toHaveLength(1);
|
||||
} finally {
|
||||
release(); releaseMonitor();
|
||||
await handle.completion;
|
||||
}
|
||||
});
|
||||
it.each(["exit", "unreadable", "changed generation"] as const)("requires an exit receipt when process metadata changes during supervision (%s)", async failure => {
|
||||
const root = await mkdtemp(join(tmpdir(), "runner-exit-receipt-"));
|
||||
const marker = join(root, "identity");
|
||||
@@ -14833,3 +14912,91 @@ it("keeps an ACPX missing runtime package failure actionable and stops automatic
|
||||
expect(code).toBe("native_provider_runtime_missing");
|
||||
expect(nativeSessionFailureDisposition(1, new Date(), code)).toEqual({ phase: "terminal_failure", failureCode: code, nextAttemptAt: null });
|
||||
});
|
||||
describe("HTTP Stop during remote runner staging", () => {
|
||||
it("does not dispatch after Stop and bounded bootstrap cleanup", async () => {
|
||||
const { createCapabilityRunnerdCodexTransport } = await import("@paperclipai/paperclip-runner/live");
|
||||
const { createNativeSessionBackend } = await import("@paperclipai/paperclip-runner");
|
||||
|
||||
vi.spyOn(runEventWriter, "appendHeartbeatRunEvent").mockResolvedValue({ row: { seq: 1 }, disposition: "committed", highestContiguousSourceSeq: 1 } as never);
|
||||
const root = await mkdtemp(join(tmpdir(), "remote-startup-stop-"));
|
||||
const retained = join(root, "retained.txt");
|
||||
const artifact = join(root, "unexecuted-artifact");
|
||||
await writeFile(retained, "preserve exact bytes\n");
|
||||
await writeFile(artifact, "fixture; launch RPC rejects before execution\n");
|
||||
let enter!: () => void, release!: () => void;
|
||||
const entered = new Promise<void>(resolve => { enter = resolve; });
|
||||
const gate = new Promise<void>(resolve => { release = resolve; });
|
||||
let dispatches = 0;
|
||||
const launch = createRemoteRunnerProcessLauncher({
|
||||
target: { kind: "remote", transport: "sandbox", environmentId: "controlled", leaseId: "controlled", remoteCwd: root },
|
||||
runner: { execute: async (input: { args?: string[] }) => {
|
||||
if (input.args?.[2] === "paperclip-runner-launch") { dispatches++; }
|
||||
return { exitCode: 1, timedOut: false, stdout: "", stderr: "controlled RPC failure; no process started", signal: null };
|
||||
} } as never,
|
||||
remoteBinary: artifact, processIdentityPath: join(root, "identity"), stateDirectory: root,
|
||||
diagnosticsDirectory: join(root, "diagnostics"), runnerInstanceId: "runner",
|
||||
ensureArtifact: async () => { enter(); await gate; },
|
||||
});
|
||||
const bundle = createCapabilityRunnerdCodexTransport({
|
||||
stateDirectory: join(root, "transport"), runnerBinary: artifact, codexCommand: artifact,
|
||||
provider: "codex", closeGraceMs: 100, sourceCodexHome: "", environment: { PATH: process.env.PATH },
|
||||
runnerProcessLauncher: launch,
|
||||
controlPlaneRegistration: async authority => { await authority.start(); return { connectUrl: authority.connectUrl, release: async () => { await authority.stop(); } }; },
|
||||
});
|
||||
const dbModule = await import("@paperclipai/db");
|
||||
const { resolveExternalTestDatabaseUrl } = await import("../../__tests__/helpers/external-test-database.js");
|
||||
const externalUrl = resolveExternalTestDatabaseUrl("PAPERCLIP_TEST_DATABASE_URL");
|
||||
const temporary = externalUrl
|
||||
? { connectionString: externalUrl, cleanup: () => dbModule.closeRegisteredClients(externalUrl) }
|
||||
: await dbModule.startEmbeddedPostgresTestDatabase("remote-staging-http-");
|
||||
const httpDb = dbModule.createDb(temporary.connectionString);
|
||||
const localExecution = { ...execution, binding: { ...execution.binding,
|
||||
companyId: randomUUID(), agentId: randomUUID(), issueId: randomUUID(), runId: randomUUID(), executionWorkspaceId: randomUUID() },
|
||||
workspace: { ...execution.workspace, cwd: root } };
|
||||
const { companyId, agentId, issueId, runId } = localExecution.binding;
|
||||
await httpDb.insert(dbModule.companies).values({ id: companyId, name: "Controlled Stop", issuePrefix: "STOP" });
|
||||
await httpDb.insert(dbModule.agents).values({ id: agentId, companyId, name: "Controlled agent" });
|
||||
await httpDb.insert(dbModule.issues).values({ id: issueId, companyId, title: "Controlled Stop", status: "in_progress", assigneeAgentId: agentId });
|
||||
await httpDb.insert(dbModule.heartbeatRuns).values({ id: runId, companyId, agentId, nativeIssueId: issueId,
|
||||
invocationSource: "on_demand", status: "running", runtimeMode: "native" });
|
||||
await httpDb.insert(dbModule.nativeRunFinalizations).values({ runId, companyId, issueId, phase: "observed" });
|
||||
const originalIssueService = issueServiceModule.issueService;
|
||||
vi.spyOn(issueServiceModule, "issueService").mockImplementation(db => db === httpDb ? originalIssueService(db) : ({ update: vi.fn(async () => ({ status: "blocked", statusVersion: 1 })) } as never));
|
||||
const { default: express } = await import("express");
|
||||
const { default: request } = await import("supertest");
|
||||
const { agentRoutes } = await import("../../routes/agents.js");
|
||||
const { errorHandler } = await import("../../middleware/error-handler.js");
|
||||
const app = express(); app.use(express.json());
|
||||
app.use((req, _res, next) => { req.actor = { type: "board", source: "local_implicit", userId: "fixture-board", companyIds: [companyId] }; next(); });
|
||||
const httpErrors: string[] = [];
|
||||
app.use("/api", agentRoutes(httpDb));
|
||||
app.use((error: Error, _req: unknown, _res: unknown, next: (error: Error) => void) => { httpErrors.push(error.stack ?? String(error)); next(error); });
|
||||
app.use(errorHandler);
|
||||
const backend = createNativeSessionBackend(localExecution, { codexTransportFactory: () => bundle.transport, runnerInstanceId: "runner", workingDirectoryAuthority: "remote_runner", environment: { PAPERCLIP_WORKSPACE_CWD: root, PATH: process.env.PATH } });
|
||||
// Execute real startup and transport code. The execution lease/event sink
|
||||
// are controlled ports; HTTP cancellation uses a fresh PostgreSQL database.
|
||||
state.execute.mockReset().mockImplementationOnce(options => executeNativeSession({ ...options, timeoutMs: 1000,
|
||||
controlPlane: { async openRun() {}, async checkpointSession() {}, async appendEvent(event) { const sequence = "sourceSeq" in event ? event.sourceSeq : event.sequence; return { cursor: sequence, highestContiguousSourceSeq: sequence, disposition: "committed" as const }; }, async replayEvents() { return { events: [], highestContiguousSourceSeq: 0 }; }, async completeRun() {} },
|
||||
}));
|
||||
const outcome = executePaperclipNativeSession({ db: leaseDb(localExecution), execution: localExecution, runnerInstanceId: "runner", backend, useRunnerd: false }).catch(error => error);
|
||||
|
||||
let stopping: Promise<unknown> | undefined;
|
||||
try {
|
||||
await Promise.race([entered, outcome.then(result => { throw new Error(`startup ended before staging: ${result instanceof Error ? result.stack : JSON.stringify(result)}`); })]);
|
||||
stopping = request(app).post(`/api/heartbeat-runs/${runId}/cancel`).send({}).then(response => ({ status: response.status, body: response.body })).catch(error => error);
|
||||
await new Promise(resolve => setTimeout(resolve, 1400));
|
||||
const close = await bundle.transport.close("join already requested bootstrap cleanup").catch(error => error);
|
||||
expect(close).toBeInstanceOf(Error);
|
||||
release();
|
||||
const result = await outcome;
|
||||
const stop = await stopping;
|
||||
await new Promise(resolve => setTimeout(resolve, 50));
|
||||
expect(result).toBeInstanceOf(Error);
|
||||
expect(httpErrors).toEqual([]);
|
||||
expect(await readFile(retained, "utf8")).toBe("preserve exact bytes\n");
|
||||
await expect(access(join(root, "identity"))).rejects.toThrow();
|
||||
expect(stop).toMatchObject({ status: 200, body: { status: "cancelled" } });
|
||||
expect(dispatches).toBe(0);
|
||||
} finally { release(); await outcome; await stopping; await bundle.transport.detachControllerForRestart?.().catch(() => {}); await temporary.cleanup(); await rm(root, { recursive: true, force: true }); }
|
||||
}, 120000);
|
||||
});
|
||||
Reference in new issue
Block a user