Skip to content

The open-source app everyone uses to manage agents at work

8.6 KB
Raw Blame
import { writeEnvironmentCleanup } from "../environment-cleanup-notifications.js";
import { randomUUID } from "node:crypto";
import { and, eq, inArray, ne, sql } from "drizzle-orm";
import { environmentLeases, heartbeatRuns, nativeRunFinalizations, nativeRunResults, type Db } from "@paperclipai/db";
import { remoteTerminationReceipt } from "../remote-execution-termination.js";
import { readNativeWorkspaceSyncReference } from "./native-workspace-sync.js";

type Lease = {
  id: string; companyId: string; heartbeatRunId: string | null;
  provider: string | null; providerLeaseId: string | null;
  metadata: Record<string, unknown> | null;
};

export const NATIVE_WORKSPACE_EXPORT_RESUME_KEY = "nativeWorkspaceExportResume";

export function hasNativeWorkspaceExportResume(lease: Pick<Lease, "metadata">): boolean {
  return Object.prototype.hasOwnProperty.call(lease.metadata ?? {}, NATIVE_WORKSPACE_EXPORT_RESUME_KEY);
}

/** This intent is written before resuming a retained sandbox or terminalizing an
 * accepted result with unexported work. Recovery may stop
 * this exact allocation, but must never fall through to destructive cleanup. */
export function readNativeWorkspaceExportResume(lease: Lease) {
  const value = lease.metadata?.[NATIVE_WORKSPACE_EXPORT_RESUME_KEY];
  if (!value || typeof value !== "object" || Array.isArray(value)) return null;
  const marker = value as Record<string, unknown>;
  if (!["paperclip.workspace-export-resume.v1", "paperclip.workspace-export-resume.v2"].includes(String(marker.schema))
    || marker.companyId !== lease.companyId || marker.runId !== lease.heartbeatRunId || !lease.heartbeatRunId
    || marker.leaseId !== lease.id || marker.provider !== lease.provider || !lease.provider
    || marker.providerLeaseId !== lease.providerLeaseId || !lease.providerLeaseId
    || typeof marker.requestId !== "string" || !marker.requestId
    || typeof marker.resultId !== "string" || !marker.resultId) return null;
  // v1 preceded the intent's explicit plugin pin. Its exact lease already
  // recorded the acquiring plugin; never reconstruct that owner from a driver
  // name, and never override an explicit (even invalid) intent pin.
  const pluginId = marker.schema === "paperclip.workspace-export-resume.v1" && marker.pluginId === undefined
    ? lease.metadata?.pluginId : marker.pluginId;
  if (typeof pluginId !== "string" || !pluginId || pluginId !== lease.metadata?.pluginId) return null;
  return { ...marker, requestId: marker.requestId, resultId: marker.resultId, pluginId };
}

/** Called inside the finalizer's transaction, before its terminal failure is
 * visible to orphan cleanup. A crash cannot expose an untagged failed lease. */
export async function preserveNativeWorkspaceExportLease(db: Db, run: typeof heartbeatRuns.$inferSelect, resultId: string | null) {
  const reference = readNativeWorkspaceSyncReference(run.runnerProfileJson?.nativeWorkspaceSync);
  if (!reference || reference.state !== "prepared" || !resultId) return;
  const [accepted] = await db.select({ id: nativeRunResults.id }).from(nativeRunResults).where(and(
    eq(nativeRunResults.id, resultId), eq(nativeRunResults.companyId, run.companyId),
    eq(nativeRunResults.runId, run.id), eq(nativeRunResults.completionContractId, run.completionContractId!),
    eq(nativeRunResults.schemaStatus, "accepted"),
  )).limit(1);
  if (!accepted) return;
  const [lease] = await db.select().from(environmentLeases).where(and(
    eq(environmentLeases.id, reference.leaseId), eq(environmentLeases.companyId, run.companyId),
    eq(environmentLeases.heartbeatRunId, run.id), eq(environmentLeases.providerLeaseId, reference.providerLeaseId),
  )).for("update").limit(1);
  if (!lease || lease.status !== "active") return;
  const requestId = randomUUID(), now = new Date();
  await writeEnvironmentCleanup(db, tx => tx.update(environmentLeases).set({ status: "pending_cleanup", cleanupStatus: "failed",
    failureReason: "workspace_export_stop_pending", releasedAt: now, updatedAt: now,
    metadata: { ...lease.metadata, remoteExecutionTermination: undefined,
      [NATIVE_WORKSPACE_EXPORT_RESUME_KEY]: { schema: "paperclip.workspace-export-resume.v2", requestId,
        purpose: "terminal_export", companyId: run.companyId, runId: run.id, resultId,
        leaseId: lease.id, provider: lease.provider, providerLeaseId: lease.providerLeaseId,
        pluginId: lease.metadata?.pluginId },
      pendingCleanupAttemptId: requestId, pendingCleanupInFlight: false, pendingCleanupLeaseExpiresAtMs: 0,
      pendingCleanupRetryAfterMs: 0, pendingCleanupRetryAttempts: 0, pendingCleanupRetryCapWarned: false },
  }).where(eq(environmentLeases.id, lease.id)));
}

/** Only verified copyback plus commitment permits the original ephemeral
 * destroy policy. A terminal failure or merely accepted result is insufficient. */
export async function releaseCompletedNativeWorkspaceExportRetention(db: Db, lease: Lease) {
  const marker = readNativeWorkspaceExportResume(lease);
  if (!marker) return null;
  const [bound] = await db.select({ run: heartbeatRuns, coordinator: nativeRunFinalizations }).from(heartbeatRuns)
    .innerJoin(nativeRunFinalizations, and(eq(nativeRunFinalizations.runId, heartbeatRuns.id), eq(nativeRunFinalizations.companyId, heartbeatRuns.companyId)))
    .where(and(eq(heartbeatRuns.id, lease.heartbeatRunId!), eq(heartbeatRuns.companyId, lease.companyId),
      inArray(heartbeatRuns.status, ["succeeded", "failed", "cancelled", "timed_out", "interrupted"]),
      eq(heartbeatRuns.nativePhase, "committed"),
      eq(nativeRunFinalizations.phase, "committed"), eq(nativeRunFinalizations.resultId, marker.resultId))).limit(1);
  const reference = readNativeWorkspaceSyncReference(bound?.run.runnerProfileJson?.nativeWorkspaceSync);
  if (!reference || reference.state !== "finalized" || !reference.finalHostSha256
    || reference.resourceDisposition !== "destroy" || reference.leaseId !== lease.id || reference.providerLeaseId !== lease.providerLeaseId) return null;
  const [otherOwner] = await db.select({ id: environmentLeases.id }).from(environmentLeases).where(and(
    ne(environmentLeases.id, lease.id), eq(environmentLeases.provider, lease.provider!),
    eq(environmentLeases.providerLeaseId, lease.providerLeaseId!), inArray(environmentLeases.status, ["active", "retained", "pending_cleanup"]),
  )).limit(1);
  if (otherOwner) return null;
  const [released] = await db.update(environmentLeases).set({
    metadata: sql`${environmentLeases.metadata} - 'nativeWorkspaceExportResume'`,
  }).where(and(eq(environmentLeases.id, lease.id), eq(environmentLeases.companyId, lease.companyId),
    eq(environmentLeases.heartbeatRunId, lease.heartbeatRunId!), eq(environmentLeases.providerLeaseId, lease.providerLeaseId!),
    eq(environmentLeases.provider, lease.provider!), sql`${environmentLeases.metadata}->>'pluginId' = ${marker.pluginId}`,
    eq(environmentLeases.status, "active"),
    sql`${environmentLeases.metadata}->'nativeWorkspaceExportResume'->>'requestId' = ${marker.requestId}`,
  )).returning();
  return released ?? null;
}

/** A late cleanup receipt cannot rewrite a rebound lease or a newer attempt. */
export async function settleNativeWorkspaceExportResume(db: Db, lease: Lease, options: {
  attemptId: string; receipt?: unknown; status?: "released" | "expired";
}) {
  const marker = readNativeWorkspaceExportResume(lease);
  if (!marker) return null;
  const receipt = remoteTerminationReceipt(lease, options.receipt);
  const stopped = receipt?.state === "stopped";
  const now = new Date();
  const [row] = await writeEnvironmentCleanup(db, tx => tx.update(environmentLeases).set({
    status: stopped ? options.status ?? "released" : "pending_cleanup", cleanupStatus: stopped ? "success" : "failed",
    releasedAt: now, lastUsedAt: now, updatedAt: now,
    metadata: sql`(${environmentLeases.metadata} - 'remoteExecutionTermination'
      ${stopped ? sql`- 'nativeWorkspaceExportResume'` : sql``}) || ${JSON.stringify({
        ...(stopped ? { remoteExecutionTermination: receipt } : {}),
        pendingCleanupInFlight: false, pendingCleanupLeaseExpiresAtMs: 0,
      })}::jsonb`,
  }).where(and(eq(environmentLeases.id, lease.id), eq(environmentLeases.companyId, lease.companyId),
    eq(environmentLeases.heartbeatRunId, lease.heartbeatRunId!), eq(environmentLeases.provider, lease.provider!),
    eq(environmentLeases.providerLeaseId, lease.providerLeaseId!), eq(environmentLeases.status, "pending_cleanup"),
    sql`${environmentLeases.metadata}->>'pendingCleanupAttemptId' = ${options.attemptId}`,
    sql`${environmentLeases.metadata}->'nativeWorkspaceExportResume'->>'requestId' = ${marker.requestId}`,
    sql`${environmentLeases.metadata}->>'pluginId' = ${marker.pluginId}`,
  )).returning());
  return row ?? null;
}