mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-10 12:37:55 +01:00
Merge remote-tracking branch 'origin/fix/retained-failure-sandbox-cleanup' into measure/remote-warm-2
* origin/fix/retained-failure-sandbox-cleanup: fix(environments): guard the atomic delete for kept restore sources; tell the operator what deleting them loses fix(environments): tear down retain-on-failure sandboxes when their environment is deleted
This commit is contained in:
commit
aa9c94eb4b
7 files changed
+59
-5
No files matched your search
@@ -107,6 +107,10 @@ export type EnvironmentDeleteBlockedReason =
|
||||
*/
|
||||
export interface EnvironmentDeleteReusableLeaseHolder {
|
||||
leaseId: string;
|
||||
/** `reuse_by_environment`: a warm sandbox for the next turn (its workspace
|
||||
* provisions a fresh one). `retain_on_failure`: a stopped sandbox kept as the
|
||||
* only copy of a failed run's workspace files (destroying it loses them). */
|
||||
leasePolicy: string;
|
||||
executionWorkspaceId: string | null;
|
||||
executionWorkspaceName: string | null;
|
||||
issueId: string | null;
|
||||
|
||||
@@ -5534,6 +5534,32 @@ describeEmbeddedPostgres("environmentRuntimeService", () => {
|
||||
});
|
||||
});
|
||||
|
||||
it("destroys a retained restore-source sandbox (retain_on_failure) when its environment is deleted", async () => {
|
||||
const { pluginId, runId, reusableLease } = await seedReusablePluginSandboxLease();
|
||||
await db.update(heartbeatRuns).set({ status: "failed" }).where(eq(heartbeatRuns.id, runId));
|
||||
// A failed run's sandbox kept, stopped, as a workspace-restore source.
|
||||
await db.update(environmentLeases).set({ leasePolicy: "retain_on_failure", status: "released", cleanupStatus: "success",
|
||||
releasedAt: new Date() }).where(eq(environmentLeases.id, reusableLease.id));
|
||||
expect(await environmentService(db).getDeleteBlastRadius(reusableLease.environmentId!))
|
||||
.toMatchObject({ reusableSandboxLeaseCount: 1, canDelete: false,
|
||||
reusableSandboxLeaseHolders: [expect.objectContaining({ leasePolicy: "retain_on_failure" })] });
|
||||
// The atomic delete guard refuses too, not only the blast-radius pre-check.
|
||||
expect(await environmentService(db).removeIfDeletable(reusableLease.environmentId!)).toBeFalsy();
|
||||
const workerManager = {
|
||||
isRunning: vi.fn((id: string) => id === pluginId),
|
||||
call: vi.fn(async (_pluginId: string, method: string) => {
|
||||
if (method === "environmentDestroyLease") return { providerLeaseId: reusableLease.providerLeaseId, state: "destroyed" };
|
||||
throw new Error(`Unexpected plugin method: ${method}`);
|
||||
}),
|
||||
getWorker: vi.fn(() => ({ supportedMethods: ["environmentResumeLease", "environmentReleaseLease", "environmentDestroyLease"] })),
|
||||
} as unknown as PluginWorkerManager;
|
||||
const result = await environmentRuntimeService(db, { pluginWorkerManager: workerManager })
|
||||
.destroyReusableSandboxLeasesForEnvironment({ environmentId: reusableLease.environmentId!, failureReason: "environment_deleted" });
|
||||
expect(result).toEqual({ destroyed: 1, failed: 0, skippedLiveRun: 0 });
|
||||
await expect(environmentService(db).getLeaseById(reusableLease.id)).resolves.toMatchObject({
|
||||
status: "expired", failureReason: "environment_deleted", cleanupStatus: "success" });
|
||||
});
|
||||
|
||||
it("destroys a failed reusable sandbox after successful release before deleting its environment", async () => {
|
||||
const { pluginId, companyId, runId, environment, reusableLease } = await seedReusablePluginSandboxLease();
|
||||
const workerManager = {
|
||||
|
||||
@@ -711,6 +711,7 @@ describeEmbeddedPostgres("environmentService leases", () => {
|
||||
expect(activeImpact?.reusableSandboxLeaseHolders).toEqual([
|
||||
{
|
||||
leaseId: lease.id,
|
||||
leasePolicy: "reuse_by_environment",
|
||||
executionWorkspaceId: workspaceId,
|
||||
executionWorkspaceName: "ACME-7-reusable-lease-holder",
|
||||
issueId,
|
||||
|
||||
@@ -634,6 +634,9 @@ export function environmentRoutes(
|
||||
return "Cannot delete this environment while a sandbox cleanup is pending. Wait for the cleanup sweep to destroy the orphan sandbox, then retry.";
|
||||
}
|
||||
if (impact.reusableSandboxLeaseCount > 0) {
|
||||
if (impact.reusableSandboxLeaseHolders.some(holder => holder.leasePolicy === "retain_on_failure")) {
|
||||
return "Cannot delete this environment while it keeps a failed run's workspace copy (a stopped sandbox kept for file recovery). Deleting the environment with consent destroys that sandbox and the files only it holds.";
|
||||
}
|
||||
return "Cannot delete this environment while it has a reusable sandbox lease. Remove the associated execution workspace or issue so Paperclip can destroy the sandbox, then retry.";
|
||||
}
|
||||
return null;
|
||||
|
||||
@@ -60,7 +60,7 @@ import {
|
||||
runWithRuntimeParent,
|
||||
type StartupSpanContext,
|
||||
} from "@paperclipai/adapter-utils/acpx-engine/startup-timing";
|
||||
import { environmentService } from "./environments.js";
|
||||
import { environmentService, KEPT_SANDBOX_LEASE_POLICIES } from "./environments.js";
|
||||
import { instanceSettingsService } from "./instance-settings.js";
|
||||
import { hasSandboxSnapshotQualification, qualifiedSandboxSnapshotId, usesManagedCloudSandboxImage, type SandboxTemplateIdentity } from "./sandbox-snapshot-qualification.js";
|
||||
import { verifyRecoverableNativeHarnessBackup } from "./native-runtime/native-harness-backup-storage.js";
|
||||
@@ -4321,7 +4321,10 @@ export function environmentRuntimeService(
|
||||
.where(
|
||||
and(
|
||||
eq(environmentLeases.environmentId, input.environmentId),
|
||||
eq(environmentLeases.leasePolicy, "reuse_by_environment"),
|
||||
// Reusable sandboxes, and retain-on-failure sandboxes kept stopped as
|
||||
// workspace-restore sources: both outlive their run, so a deleted
|
||||
// environment must tear them down or they are orphaned.
|
||||
inArray(environmentLeases.leasePolicy, [...KEPT_SANDBOX_LEASE_POLICIES]),
|
||||
// A failed run may have stopped its reusable sandbox without
|
||||
// destroying it; that provider handle still needs scoped teardown.
|
||||
inArray(environmentLeases.status, ["active", "released", "retained", "failed"]),
|
||||
@@ -4360,7 +4363,8 @@ export function environmentRuntimeService(
|
||||
skippedLiveRun += 1;
|
||||
continue;
|
||||
}
|
||||
const lease = await destroyClaimedSandboxLease({ environment, leaseRow, failureReason });
|
||||
const lease = await destroyClaimedSandboxLease({ environment, leaseRow, failureReason, anyLeasePolicy: true,
|
||||
scopeCondition: inArray(environmentLeases.leasePolicy, [...KEPT_SANDBOX_LEASE_POLICIES]) });
|
||||
if (!lease) {
|
||||
// Lost to a racing resume or a concurrent terminal transition — the
|
||||
// lease is no longer ours to destroy.
|
||||
|
||||
@@ -60,6 +60,12 @@ import {
|
||||
type ManagedPluginEnvironmentReconcileAction,
|
||||
} from "./managed-plugin-environments.js";
|
||||
|
||||
/** Lease policies whose sandbox outlives its run: a reusable warm sandbox, and a
|
||||
* retain-on-failure sandbox kept stopped as a workspace-restore source. The
|
||||
* delete blast radius, the atomic delete guard and the consented teardown must
|
||||
* all use this one list, or a delete can orphan a sandbox. */
|
||||
export const KEPT_SANDBOX_LEASE_POLICIES = ["reuse_by_environment", "retain_on_failure"] as const;
|
||||
|
||||
export async function attachSandboxCreation(db: Db, id: string, scope: { companyId: string; environmentId: string; heartbeatRunId?: string | null },
|
||||
attach: (tx: Db) => Promise<EnvironmentLease>): Promise<EnvironmentLease> {
|
||||
return db.transaction(async tx => {
|
||||
@@ -1312,7 +1318,7 @@ export function environmentService(db: Db) {
|
||||
sql`not exists (
|
||||
select 1 from ${environmentLeases}
|
||||
where ${environmentLeases.environmentId} = ${environments.id}
|
||||
and ${environmentLeases.leasePolicy} = 'reuse_by_environment'
|
||||
and ${inArray(environmentLeases.leasePolicy, [...KEPT_SANDBOX_LEASE_POLICIES])}
|
||||
and ${environmentLeases.status} in ('active', 'released', 'retained', 'failed')
|
||||
)`,
|
||||
),
|
||||
@@ -1415,6 +1421,7 @@ export function environmentService(db: Db) {
|
||||
db
|
||||
.select({
|
||||
leaseId: environmentLeases.id,
|
||||
leasePolicy: environmentLeases.leasePolicy,
|
||||
executionWorkspaceId: environmentLeases.executionWorkspaceId,
|
||||
executionWorkspaceName: executionWorkspaces.name,
|
||||
issueId: environmentLeases.issueId,
|
||||
@@ -1427,7 +1434,7 @@ export function environmentService(db: Db) {
|
||||
.where(
|
||||
and(
|
||||
eq(environmentLeases.environmentId, id),
|
||||
eq(environmentLeases.leasePolicy, "reuse_by_environment"),
|
||||
inArray(environmentLeases.leasePolicy, [...KEPT_SANDBOX_LEASE_POLICIES]),
|
||||
inArray(environmentLeases.status, ["active", "released", "retained", "failed"]),
|
||||
),
|
||||
),
|
||||
@@ -1447,6 +1454,7 @@ export function environmentService(db: Db) {
|
||||
const pendingCleanupLeaseCount = countFromRows(pendingCleanupLeaseRows);
|
||||
const reusableSandboxLeaseHolders = reusableSandboxLeaseRows.map((row) => ({
|
||||
leaseId: row.leaseId,
|
||||
leasePolicy: row.leasePolicy,
|
||||
executionWorkspaceId: row.executionWorkspaceId,
|
||||
executionWorkspaceName: row.executionWorkspaceName,
|
||||
issueId: row.issueId,
|
||||
|
||||
@@ -109,6 +109,9 @@ function environmentDeleteBlockMessage(impact: EnvironmentDeleteBlastRadius): st
|
||||
return "Cannot delete this environment while a sandbox cleanup is pending. Wait for the cleanup sweep to destroy the orphan sandbox, then retry.";
|
||||
}
|
||||
if (impact.reusableSandboxLeaseCount > 0) {
|
||||
if (impact.reusableSandboxLeaseHolders.some(holder => holder.leasePolicy === "retain_on_failure")) {
|
||||
return "Cannot delete this environment while it keeps a failed run's workspace copy (a stopped sandbox kept for file recovery). Deleting the environment with consent destroys that sandbox and the files only it holds.";
|
||||
}
|
||||
return "Cannot delete this environment while it has a reusable sandbox lease. Remove the associated execution workspace or issue so Paperclip can destroy the sandbox, then retry.";
|
||||
}
|
||||
return null;
|
||||
@@ -1924,6 +1927,8 @@ export function CompanyEnvironments({ mode = "list" }: CompanyEnvironmentsProps)
|
||||
}
|
||||
// One row per workspace holding blocking sandbox leases (several leases can
|
||||
// share a workspace). A lease whose workspace FK was nulled groups alone.
|
||||
const retainedFailureSourceCount = (deleteBlastRadius?.reusableSandboxLeaseHolders ?? [])
|
||||
.filter(holder => holder.leasePolicy === "retain_on_failure").length;
|
||||
const reusableLeaseHolderGroups = (() => {
|
||||
const groups = new Map<
|
||||
string,
|
||||
@@ -2543,6 +2548,9 @@ export function CompanyEnvironments({ mode = "list" }: CompanyEnvironmentsProps)
|
||||
reusableLeaseOnlyBlock && deleteBlastRadius
|
||||
? `${deleteBlastRadius.reusableSandboxLeaseCount === 1 ? "1 reusable sandbox" : `${deleteBlastRadius.reusableSandboxLeaseCount} reusable sandboxes`} will be destroyed; the workspaces holding them stay open and provision a fresh sandbox on their next run.`
|
||||
: null,
|
||||
reusableLeaseOnlyBlock && retainedFailureSourceCount > 0
|
||||
? `${retainedFailureSourceCount === 1 ? "1 of them is" : `${retainedFailureSourceCount} of them are`} a failed run's workspace copy kept for file recovery; destroying it loses the files only it holds.`
|
||||
: null,
|
||||
agentsUsingEnvironment.length > 0
|
||||
? `${agentsUsingEnvironment.length === 1 ? "1 agent uses" : `${agentsUsingEnvironment.length} agents use`} this environment as their default. Choose the environment those agents should be reassigned to.`
|
||||
: null,
|
||||
|
||||
Reference in new issue
Block a user