mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-02 08:28:48 +01:00
218 lines
9.0 KiB
TypeScript
218 lines
9.0 KiB
TypeScript
import { randomUUID } from "node:crypto";
|
|
import { and, eq, gt, lte, sql } from "drizzle-orm";
|
|
import { heartbeatRuns, livenessDb, type Db } from "@paperclipai/db";
|
|
import type { LegacyControllerLeaseLossCause, LegacyControllerLeaseLossTiming } from "./run-cancellation.js";
|
|
|
|
// A boot UUID has meaning across containers; a numeric PID does not.
|
|
export const legacyControllerBootId = randomUUID();
|
|
export const LEGACY_CONTROLLER_LEASE_MS = 60_000;
|
|
export const LEGACY_CONTROLLER_RENEW_MS = 10_000;
|
|
|
|
type Run = typeof heartbeatRuns.$inferSelect;
|
|
|
|
/** A lease lost before adapter dispatch: no provider work began, so the
|
|
* continuation is retryable rather than an opaque `setup_failed`. */
|
|
export const CONTROLLER_LEASE_LOST_FAILURE_CODE = "controller_lease_lost";
|
|
|
|
/** Abort reason for a lost lease, so completion can attribute the stop. */
|
|
export class LegacyControllerLeaseLostError extends Error {
|
|
constructor(
|
|
readonly leaseLossCause: LegacyControllerLeaseLossCause,
|
|
readonly leaseLossTiming?: LegacyControllerLeaseLossTiming,
|
|
) {
|
|
super("Legacy controller lease lost");
|
|
this.name = "LegacyControllerLeaseLostError";
|
|
}
|
|
}
|
|
|
|
/** Commit these fields in the same UPDATE that claims a queued run. */
|
|
export function legacyControllerClaim(runtimeMode: string) {
|
|
if (runtimeMode === "native") return {};
|
|
return {
|
|
controllerBootId: legacyControllerBootId,
|
|
controllerLeaseExpiresAt: sql`clock_timestamp() + interval '60 seconds'`,
|
|
executionStage: "preparing",
|
|
};
|
|
}
|
|
|
|
export async function renewLegacyControllerLease(
|
|
db: Db,
|
|
run: Pick<Run, "id" | "companyId" | "controllerBootId">,
|
|
stage?: "dispatching",
|
|
): Promise<boolean> {
|
|
const [renewed] = await db.update(heartbeatRuns).set({
|
|
controllerLeaseExpiresAt: sql`clock_timestamp() + interval '60 seconds'`,
|
|
...(stage ? { executionStage: stage } : {}),
|
|
}).where(and(
|
|
eq(heartbeatRuns.id, run.id), eq(heartbeatRuns.companyId, run.companyId),
|
|
eq(heartbeatRuns.runtimeMode, "legacy"), eq(heartbeatRuns.status, "running"),
|
|
eq(heartbeatRuns.controllerBootId, legacyControllerBootId),
|
|
gt(heartbeatRuns.controllerLeaseExpiresAt, sql`clock_timestamp()`),
|
|
)).returning({ id: heartbeatRuns.id });
|
|
return Boolean(renewed);
|
|
}
|
|
|
|
/** One attempt may wait at most this long; a timed-out attempt is retried
|
|
* until the lease deadline instead of holding the renewal for the whole lease. */
|
|
export const LEGACY_CONTROLLER_RENEWAL_STATEMENT_TIMEOUT_MS = 10_000;
|
|
|
|
function isStatementTimeout(error: unknown): boolean {
|
|
for (let cause = error, depth = 0; cause && depth < 4; cause = (cause as { cause?: unknown }).cause, depth++) {
|
|
if ((cause as { code?: unknown }).code === "57014") return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/** Renew on the private liveness pool so the write cannot queue behind an
|
|
* unrelated slow statement on a busy shared connection. */
|
|
async function renewOnLivenessPool(
|
|
db: Db,
|
|
run: Pick<Run, "id" | "companyId" | "controllerBootId">,
|
|
stage: "dispatching" | undefined,
|
|
statementTimeoutMs: number,
|
|
): Promise<boolean> {
|
|
return livenessDb(db).transaction(async (tx) => {
|
|
await tx.execute(sql`select set_config('statement_timeout', ${`${statementTimeoutMs}ms`}, true)`);
|
|
return renewLegacyControllerLease(tx as unknown as Db, run, stage);
|
|
});
|
|
}
|
|
|
|
export async function liveLegacyControllerExpiresAt(db: Db, run: Run): Promise<Date | null> {
|
|
if (run.runtimeMode === "native" || !run.controllerBootId) return null;
|
|
const [owner] = await db.select({ expiresAt: heartbeatRuns.controllerLeaseExpiresAt }).from(heartbeatRuns).where(and(
|
|
eq(heartbeatRuns.id, run.id), eq(heartbeatRuns.companyId, run.companyId),
|
|
eq(heartbeatRuns.status, "running"),
|
|
gt(heartbeatRuns.controllerLeaseExpiresAt, sql`clock_timestamp()`),
|
|
));
|
|
return owner?.expiresAt ?? null;
|
|
}
|
|
|
|
export async function hasLiveLegacyController(db: Db, run: Run): Promise<boolean> {
|
|
return (await liveLegacyControllerExpiresAt(db, run)) !== null;
|
|
}
|
|
|
|
export type RevokedLegacyControllerState = Pick<Run, "executionStage" | "processPid" | "processGroupId">;
|
|
|
|
/** Atomically revoke an expired controller. Renewal and revocation serialize on
|
|
* the run row. Expiry permits cleanup, never dispatch of a replacement agent.
|
|
* Returns the stage and process identifiers committed with the revocation, or
|
|
* null when another writer owns the row. They cannot advance afterwards,
|
|
* because renewal requires the replaced boot ID. */
|
|
export async function revokeExpiredLegacyControllerWithState(
|
|
db: Db,
|
|
run: Run,
|
|
): Promise<RevokedLegacyControllerState | null> {
|
|
if (run.runtimeMode === "native" || !run.controllerBootId) {
|
|
return { executionStage: run.executionStage, processPid: run.processPid, processGroupId: run.processGroupId };
|
|
}
|
|
const [revoked] = await db.update(heartbeatRuns).set({
|
|
controllerBootId: randomUUID(),
|
|
controllerLeaseExpiresAt: sql`clock_timestamp() + interval '60 seconds'`,
|
|
}).where(and(
|
|
eq(heartbeatRuns.id, run.id), eq(heartbeatRuns.companyId, run.companyId),
|
|
eq(heartbeatRuns.status, "running"),
|
|
eq(heartbeatRuns.controllerBootId, run.controllerBootId),
|
|
lte(heartbeatRuns.controllerLeaseExpiresAt, sql`clock_timestamp()`),
|
|
)).returning({
|
|
executionStage: heartbeatRuns.executionStage,
|
|
processPid: heartbeatRuns.processPid,
|
|
processGroupId: heartbeatRuns.processGroupId,
|
|
});
|
|
return revoked ?? null;
|
|
}
|
|
|
|
export async function revokeExpiredLegacyController(db: Db, run: Run): Promise<boolean> {
|
|
return (await revokeExpiredLegacyControllerWithState(db, run)) !== null;
|
|
}
|
|
|
|
/** Abort the adapter if the controller cannot renew. Bound each check by the
|
|
* lease duration even when the database connection never settles. */
|
|
export function watchLegacyControllerLease(
|
|
db: Db,
|
|
run: Run,
|
|
controller: AbortController,
|
|
{ renewalStatementTimeoutMs = LEGACY_CONTROLLER_RENEWAL_STATEMENT_TIMEOUT_MS } = {},
|
|
) {
|
|
if (run.runtimeMode === "native" || !run.controllerBootId) {
|
|
return { stop() {}, async assertOwned(_stage?: "dispatching") {} };
|
|
}
|
|
let stopped = false;
|
|
let pending = false;
|
|
// Timing evidence for a loss: a renewal still in flight at the deadline
|
|
// points at the database; a late deadline callback points at the event loop.
|
|
let lastRenewedAt = Date.now();
|
|
let renewalCount = 0;
|
|
const renewalsInFlight = new Set<{ startedAt: number }>();
|
|
let deadlineDueAt = 0;
|
|
let deadline: ReturnType<typeof setTimeout> | undefined;
|
|
const lost = (cause: LegacyControllerLeaseLossCause) => {
|
|
if (stopped || controller.signal.aborted) return;
|
|
const now = Date.now();
|
|
const oldestRenewal = Math.min(...[...renewalsInFlight].map((renewal) => renewal.startedAt));
|
|
controller.abort(new LegacyControllerLeaseLostError(cause, {
|
|
sinceRenewalMs: now - lastRenewedAt,
|
|
renewalPendingMs: renewalsInFlight.size > 0 ? now - oldestRenewal : null,
|
|
deadlineLateMs: cause === "renewal_deadline" ? Math.max(0, now - deadlineDueAt) : null,
|
|
renewalCount,
|
|
}));
|
|
};
|
|
const deadlinePassed = () => lost("renewal_deadline");
|
|
const armDeadline = (delayMs: number) => {
|
|
clearTimeout(deadline);
|
|
deadlineDueAt = Date.now() + delayMs;
|
|
deadline = setTimeout(deadlinePassed, delayMs);
|
|
deadline.unref();
|
|
};
|
|
armDeadline(Math.max(0, (run.controllerLeaseExpiresAt?.getTime() ?? 0) - Date.now()));
|
|
const assertOwned = async (stage?: "dispatching") => {
|
|
if (stopped) return;
|
|
controller.signal.throwIfAborted();
|
|
const startedAt = Date.now();
|
|
const renewal = { startedAt };
|
|
renewalsInFlight.add(renewal);
|
|
let onAbort!: () => void;
|
|
const aborted = new Promise<never>((_, reject) => {
|
|
onAbort = () => reject(controller.signal.reason);
|
|
controller.signal.addEventListener("abort", onAbort, { once: true });
|
|
});
|
|
// The successful attempt's UPDATE writes a fresh lease, so the local
|
|
// deadline is measured from that attempt rather than the first one.
|
|
let attemptStartedAt = startedAt;
|
|
const renew = async () => {
|
|
for (;;) {
|
|
attemptStartedAt = Date.now();
|
|
try {
|
|
return await renewOnLivenessPool(db, run, stage, renewalStatementTimeoutMs);
|
|
} catch (error) {
|
|
if (!isStatementTimeout(error) || stopped || controller.signal.aborted) throw error;
|
|
}
|
|
}
|
|
};
|
|
let renewed: boolean;
|
|
try {
|
|
renewed = await Promise.race([renew(), aborted]);
|
|
} finally {
|
|
renewalsInFlight.delete(renewal);
|
|
controller.signal.removeEventListener("abort", onAbort);
|
|
}
|
|
if (stopped) return;
|
|
if (!renewed) {
|
|
lost("renewal_rejected");
|
|
controller.signal.throwIfAborted();
|
|
}
|
|
controller.signal.throwIfAborted();
|
|
if (!stopped) {
|
|
lastRenewedAt = Date.now();
|
|
renewalCount += 1;
|
|
armDeadline(Math.max(0, LEGACY_CONTROLLER_LEASE_MS - (Date.now() - attemptStartedAt)));
|
|
}
|
|
};
|
|
const timer = setInterval(() => {
|
|
if (pending || stopped) return;
|
|
pending = true;
|
|
void assertOwned().catch(() => lost("renewal_error")).finally(() => { pending = false; });
|
|
}, LEGACY_CONTROLLER_RENEW_MS);
|
|
timer.unref();
|
|
return { assertOwned, stop() { stopped = true; clearInterval(timer); clearTimeout(deadline); } };
|
|
}
|