mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-11 05:11:49 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Native agents keep remote processes and conversation history across warm turns. > - A completed turn can leave handoff authority only in controller memory. > - Losing that controller can block a follow-up even while its sandbox survives. > - This pull request verifies durable ownership and reconnects the exact prior process before handing it to the next run. > - Healthy follow-ups stay warm. Recovery preserves saved work without replaying a completed turn. ## Linked Issues or Issue Description **What happened?** A remote warm turn can finish without suspended backup authority. A replacement controller rejects that prior owner even when its exact process and completed checkpoint remain. A single unavailable identity probe can also stop an otherwise valid reattachment. **Expected behavior** Keep healthy follow-ups warm. Recover a completed session after proving that its controller stopped and that the successor holds current authority. Reuse compatible processes; otherwise save and resume the conversation. Retry unavailable identity reads within one shared deadline. **Steps to reproduce** Use `doc/testing-native-remote-continuity.md`. Its Linux cases execute real turns through PostgreSQL, TLS ingress, and the Rust runner. They kill a separate controller process, recover old checkpoint metadata, and change process configuration. The provider is deterministic. Related: #16432 and #16441 fix live warm-owner handoffs. #16341 adds recovery diagnostics. #14695 covers provider process retention. ## What Changed - Preserve warm process reuse between healthy remote turns. - Verify a committed prior result, stopped controller, matching checkpoint and sandbox, and current task/coordinator ownership before recovering an orphaned warm session. - Reconnect through the prior run route, then use the existing authenticated run attachment to change authority. - Persist a process-configuration digest. Close and save recovered sessions when old or changed configuration cannot support reuse. - Retry unavailable state, marker, and process reads within one 30-second deadline. Keep signals and definitive identity failures single-attempt. - Record closed recovery diagnostics, including unreadable or malformed saved state. - Retire the recovery-only ownership check after verified attachment, so later warm turns use their current authority. - Add real-process Linux regressions and refusal controls. - Expose the existing source-only file-recovery form for retained native holds, with the same board authority, evidence, and exact stop-receipt requirements as legacy holds. Recording recovered files does not change task status or replay a run. ## Verification - `pnpm -r typecheck` passed; the server check was repeated for the third-turn fix. - `pnpm build` passed after the final UI change. The UI typecheck, token gates, and map checks also pass. - Four Linux continuity cases passed: warm reuse, controller loss, legacy checkpoint metadata, and changed configuration. Each creates one conversation and starts exactly three turns, including a healthy follow-up after recovery. The fixture uses expired prior leases; the third turn keeps the runner and provider processes. - Greptile caught the retained recovery gate; the third-turn regression now covers it. An initial test omitted the heartbeat’s saved input and left a test process after failure; the fixture was corrected and its disposable container reset before the passing run. - The current focused executor/restart group passes all 749 tests, including the original failure classifications. - Native file-recovery and UI tests pass (52 tests), including blocked tasks and both native and legacy holds. - After merging current master and retaining its equivalent CI expression check, the CI policy tests pass (15 tests) and all four three-turn Linux continuity cases pass again on `dec418ae55ff21b4fb067132613658cce445f181`. - `pnpm test:run` completed its general server group with 20,572 passes, 103 skips, and three failures: the skill-audit child process and two HTTP test timeouts. The same three suites then passed in isolation (89 tests) without code changes. That local command stopped before later groups; the complete final-head CI, including general, serialized, Runner, build, and browser gates, is green. - Greptile reviewed the combined head `dec418ae55ff21b4fb067132613658cce445f181` at 5/5 with no actionable findings; both earlier findings are resolved. All final-head CI gates and the security scan passed. Staging deployment and retained-incident disposition remain deployment acceptance work. ## Risks - Recovery requires exact durable evidence. Live conflicting controllers, replacement sandboxes, Stop/pause, and uncertain effects must remain blocked. - After controller loss, tool-contract or process-configuration changes can restart the provider. Normal healthy follow-ups retain their processes. - The new idle-recovery path has Linux fake-provider evidence. Live Codex/OpenCode and retained quarantined-state recovery still need staging qualification. - No database schema, telemetry, or runner protocol changes. ## Model Used OpenAI GPT-6 through Codex, with reasoning, repository inspection, code execution, and browser tools. The session does not expose a more specific model version 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 (targeted checks and isolated reruns; full-run limitation recorded above) - [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 on `dec418ae55ff21b4fb067132613658cce445f181` - [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>
110 lines
7.7 KiB
TypeScript
110 lines
7.7 KiB
TypeScript
import { and, eq } from "drizzle-orm";
|
|
import { agents, companies, environmentLeases, heartbeatRuns, issues, nativeRunFinalizations, type Db } from "@paperclipai/db";
|
|
import type { AdapterExecutionTarget } from "@paperclipai/adapter-utils/execution-target";
|
|
import { parseNativeExecutionInput, type NativeExecutionInput, type PersistedNativeSession } from "../../vendor/paperclip-runner/index.js";
|
|
import { currentNativeControllerIdentity, evaluateNativeControllerTakeover } from "./native-restart-recovery.js";
|
|
|
|
export type RemoteWarmSessionRecovery = {
|
|
identity: Record<string, string>;
|
|
checkpoint: PersistedNativeSession;
|
|
previousExecution: NativeExecutionInput;
|
|
reuseProcess: boolean;
|
|
remote: { providerLeaseId: string; remoteCwd: string };
|
|
revalidate: (leaseOwner: string) => Promise<void>;
|
|
};
|
|
|
|
export async function inspectRemoteWarmSessionRecovery(input: {
|
|
db: Db;
|
|
execution: NativeExecutionInput;
|
|
target: Extract<AdapterExecutionTarget, { kind: "remote" }>;
|
|
identity: Record<string, unknown>;
|
|
readControlState: () => Record<string, unknown>;
|
|
matchesExecution: (previous: NativeExecutionInput) => boolean;
|
|
loadCheckpoint: (previous: NativeExecutionInput) => PersistedNativeSession | null;
|
|
canReuseProcess: (previous: NativeExecutionInput) => boolean;
|
|
}): Promise<RemoteWarmSessionRecovery> {
|
|
const deny = (): never => { throw new Error("runner_state_identity_mismatch: prior_owner_terminal_state_indeterminate"); };
|
|
const { binding } = input.execution;
|
|
const { target } = input;
|
|
const identity: Record<string, string> = {};
|
|
for (const key of ["runId", "normalizedSessionId", "runnerInstanceId", "environmentLeaseId", "turnId", "itemId"]) {
|
|
const value = input.identity[key];
|
|
if (typeof value !== "string" || !value) return deny();
|
|
identity[key] = value;
|
|
}
|
|
if (target.transport !== "sandbox" || !target.leaseId || !target.environmentId ||
|
|
!target.providerKey || !target.sandboxLeaseAcquisition || target.sandboxLeaseAcquisition.outcome !== "resumed" ||
|
|
identity.runId === binding.runId) return deny();
|
|
const providerLeaseId = target.sandboxLeaseAcquisition.providerLeaseId;
|
|
const [prior] = await input.db.select({ run: heartbeatRuns, owner: nativeRunFinalizations })
|
|
.from(heartbeatRuns).innerJoin(nativeRunFinalizations, eq(nativeRunFinalizations.runId, heartbeatRuns.id))
|
|
.where(and(eq(heartbeatRuns.id, identity.runId), eq(heartbeatRuns.companyId, binding.companyId),
|
|
eq(heartbeatRuns.agentId, binding.agentId), eq(heartbeatRuns.nativeIssueId, binding.issueId)));
|
|
if (!prior || prior.run.status !== "succeeded" || prior.owner.phase !== "committed" ||
|
|
!prior.owner.resultId || prior.owner.leaseOwner || !prior.owner.controllerPid ||
|
|
!prior.owner.controllerProcessStartedAt || !prior.owner.controllerBootId) return deny();
|
|
const previous = parseNativeExecutionInput(prior.run.runnerProfileJson?.nativeExecutionInput);
|
|
if (previous.binding.runId !== identity.runId || !input.matchesExecution(previous)) return deny();
|
|
const checkpoint = input.loadCheckpoint(previous);
|
|
if (!checkpoint || checkpoint.identity.runId !== identity.runId ||
|
|
checkpoint.identity.companyId !== binding.companyId || checkpoint.identity.issueId !== binding.issueId ||
|
|
checkpoint.identity.agentId !== binding.agentId || checkpoint.identity.sessionId !== identity.normalizedSessionId ||
|
|
checkpoint.driverKind !== previous.session.driverKind || !checkpoint.providerSessionId ||
|
|
checkpoint.activeTurnId !== null || checkpoint.pendingRuntimeRequests?.length !== 0) return deny();
|
|
const control = input.readControlState();
|
|
const commands = control.commands;
|
|
const events = control.committedEvents;
|
|
const terminal = Array.isArray(events) ? events.at(-1) : undefined;
|
|
if (!Array.isArray(commands) || commands.some(command => command.status !== "completed") ||
|
|
terminal?.eventType !== "run.terminal" || terminal?.envelope?.runId !== identity.runId ||
|
|
terminal?.envelope?.normalizedSessionId !== identity.normalizedSessionId ||
|
|
Object.entries(identity).some(([key, value]) => (control.identity as Record<string, unknown>)?.[key] !== value)) return deny();
|
|
const assertPriorStopped = async () => {
|
|
const stopped = await evaluateNativeControllerTakeover({ owner: prior.owner, now: new Date(), requireStoppedController: true });
|
|
if (!stopped.allowed) return deny();
|
|
};
|
|
await assertPriorStopped();
|
|
const priorLeases = await input.db.select().from(environmentLeases).where(and(
|
|
eq(environmentLeases.companyId, binding.companyId), eq(environmentLeases.heartbeatRunId, identity.runId),
|
|
eq(environmentLeases.issueId, binding.issueId), eq(environmentLeases.environmentId, target.environmentId),
|
|
eq(environmentLeases.provider, target.providerKey), eq(environmentLeases.providerLeaseId, providerLeaseId),
|
|
));
|
|
if (priorLeases.length !== 1 || priorLeases[0].metadata?.remoteCwd !== target.remoteCwd ||
|
|
!["released", "expired", "active"].includes(priorLeases[0].status)) return deny();
|
|
return {
|
|
identity, checkpoint, previousExecution: previous, reuseProcess: input.canReuseProcess(previous),
|
|
remote: { providerLeaseId, remoteCwd: target.remoteCwd },
|
|
revalidate: async leaseOwner => {
|
|
await assertPriorStopped();
|
|
const controller = await currentNativeControllerIdentity();
|
|
const [current] = await input.db.select({ run: heartbeatRuns, owner: nativeRunFinalizations, issue: issues, agent: agents, company: companies })
|
|
.from(heartbeatRuns).innerJoin(nativeRunFinalizations, eq(nativeRunFinalizations.runId, heartbeatRuns.id))
|
|
.innerJoin(issues, eq(issues.id, heartbeatRuns.nativeIssueId))
|
|
.innerJoin(agents, and(eq(agents.id, heartbeatRuns.agentId), eq(agents.companyId, heartbeatRuns.companyId)))
|
|
.innerJoin(companies, eq(companies.id, heartbeatRuns.companyId))
|
|
.where(and(eq(heartbeatRuns.id, binding.runId), eq(heartbeatRuns.companyId, binding.companyId),
|
|
eq(heartbeatRuns.agentId, binding.agentId), eq(heartbeatRuns.nativeIssueId, binding.issueId)));
|
|
const [lease] = await input.db.select().from(environmentLeases).where(and(
|
|
eq(environmentLeases.id, target.leaseId!), eq(environmentLeases.companyId, binding.companyId),
|
|
eq(environmentLeases.heartbeatRunId, binding.runId), eq(environmentLeases.issueId, binding.issueId),
|
|
));
|
|
const [priorOwner] = await input.db.select().from(nativeRunFinalizations).where(and(
|
|
eq(nativeRunFinalizations.runId, identity.runId), eq(nativeRunFinalizations.companyId, binding.companyId),
|
|
eq(nativeRunFinalizations.issueId, binding.issueId),
|
|
));
|
|
if (!current || current.run.status !== "running" || current.run.resultJson?.nativeCancellation ||
|
|
current.company.status !== "active" || current.agent.lifecycleState !== "ready" ||
|
|
["paused", "terminated", "pending_approval"].includes(current.agent.status) ||
|
|
!priorOwner || priorOwner.leaseOwner || priorOwner.phase !== "committed" ||
|
|
priorOwner.resultId !== prior.owner.resultId || priorOwner.controllerBootId !== prior.owner.controllerBootId ||
|
|
current.owner.leaseOwner !== leaseOwner || !current.owner.leaseExpiresAt ||
|
|
current.owner.leaseExpiresAt <= new Date() || current.owner.resultId ||
|
|
current.owner.controllerBootId !== controller.bootId || current.owner.controllerPid !== controller.pid ||
|
|
current.issue.executionRunId !== binding.runId || current.issue.assigneeAgentId !== binding.agentId ||
|
|
current.issue.status !== "in_progress" || !lease || lease.status !== "active" ||
|
|
lease.environmentId !== target.environmentId || lease.provider !== target.providerKey ||
|
|
lease.providerLeaseId !== providerLeaseId || lease.metadata?.remoteCwd !== target.remoteCwd) return deny();
|
|
},
|
|
};
|
|
}
|