Files
PaperClipAI/server/src/services/remote-workspaces.integration.test.ts
T
DottaandPaperclip 71a20453e1 fix(workspaces): honor inherited remote workspace bindings (#18611)
## Thinking Path

> - Paperclip manages AI agents and their work.
> - Task creation can bind a child to its parent's execution workspace.
> - Native sandbox runs reserve that workspace before the provider
starts.
> - Remote reservation rejected inherited isolated workspaces and
operator branches because the original source task differed.
> - This check stopped valid child tasks before their existing access
and writer checks could run.
> - This pull request uses the persisted binding and existing
source-access checks to admit that continuation.
> - The benefit is that authorized child tasks can continue saved work
while the single-writer lock stays effective.

## Linked Issues or Issue Description

**What happened?**

A child inherited an active isolated remote workspace through normal
task creation. Its next run failed during setup with `Workspace
ownership changed.` No provider work started. The reservation guard
treated the original `sourceIssueId` as exclusive ownership, although
task creation had persisted a valid child binding.

**Expected behavior**

A bound child or follow-up can reserve the workspace after the prior
writer saves. Current task/run access, source visibility, trust, company
scope, closed-workspace state, and writer checks must still apply. The
original source task remains provenance.

**Steps to reproduce**

1. Create a task with an active saved remote isolated workspace or
operator branch.
2. Create a child without an explicit workspace override.
3. Confirm that the child inherited the execution workspace ID.
4. Start its native sandbox run. The old reservation guard rejects it
before provider execution.

**Paperclip version or commit**

Reproduced on source based on
`06bc8db75c71142ed108e0f331394c5187015d6a`. The same guard is present at
`1a6017d6460267ad89d7e1784e2b521c28d8e9ac`.

Related: #17156 proposes separate workspaces for child tasks. This
repair preserves the current inheritance contract and enforces the
remote writer lock. #16911 addresses child bindings across repositories.

## What Changed

- Remove the original-task equality restriction for active remote
workspaces. Keep the existing persisted-binding and retained-source
authorization path. Explicit task-root selection follows the existing V1
filesystem contract; task-assignment grants do not define filesystem
permissions.
- Keep closed workspace rejection and unfinished-writer checks.
- Add database-backed regressions for inheritance, replay, competing
children, an unbound task, private source data, company isolation, and
closed records.
- Extend real save/restore tests for inherited isolated workspaces and
operator branches. Keep shared-workspace discovery coverage.
- Update the development guide and workspace maps.

## Verification

- Red: before the repair, the inherited isolated/operator cases fail
with `Workspace ownership changed.` The shared case passes. The unfixed
suite has five failures and four passes.
- Green: 11 reservation cases pass with real PostgreSQL 18 in an
isolated Docker container.
- An earlier run of the four affected workspace/preparation/trust suites
passed 191 tests. The review follow-up passes all 15 selected
reservation/save/restore cases. Inherited cases remove the original
files, use a distinct allocation and target, restore the saved file,
append child work, and independently read that work from the child's new
snapshot. Shared-source discovery stays covered. The filter excludes 42
other integration cases.
- `pnpm -r typecheck`, `pnpm build`, `node scripts/check-maps.mjs`, and
`git diff --check` pass. A direct server typecheck also passes after the
final test edit.
- `pnpm test:run` stopped in its first chat shard: 338 passed, one
Discord receiver-lease setup failure, 1,478 outside the shard. The
failing test passes in isolation on both the unchanged baseline and the
fix. Its suite-order failure is not explained by that retry and remains
recorded. The unchanged baseline also fails three other Discord
publication cases in that chat shard, while its next chat shard passes.
This does not reproduce or explain the original lease failure; both
results remain recorded. CI is complete on `e697f6e1b8`: 54 successful
check runs, one successful legacy status, three skipped checks, and one
neutral check. No check is pending or failed. Greptile gives this commit
5/5 with no remaining findings. The security reviewer accepted the
V1-contract explanation; both review threads are resolved.
- Live sandbox acceptance remains unverified. The available test
credentials could not resolve the required sandbox snapshot. The
provider rejected creation before workspace execution, and a scoped
follow-up found no allocation. No live model turn, deployment, or
original-task recovery is claimed.
- Local environment: macOS arm64, Node 26.4.0, pnpm 9.15.4. Native
PostgreSQL startup hit the host semaphore limit; tests use disposable
Docker databases. No shared database was reset.

## Risks

- A bound child can now write after the prior writer releases the
workspace. Incorrect binding or access checks could expose source data.
Regressions cover unbound, private-source, and foreign-company
rejection.
- Concurrent children must not become two writers. A real transaction
race grants exactly one reservation; saved-file tests keep the second
writer blocked until save completes.
- No schema or migration changes. This PR does not change task-creation
inheritance, requested models, credentials, trust, approval gates, or
recovery budgets.

## Model Used

- OpenAI Codex, based on GPT-6. The exact serving model ID and context
window are not exposed in this session. Used reasoning, tool use, code
execution, and browser diagnostics. No sub-agents were used.

## 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 — the targeted workspace
suites pass; the full local chat-suite failure and baseline comparison
are documented 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
- [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>
2026-11-02 09:36:05 -06:00

1071 lines
87 KiB
TypeScript

import { randomUUID } from "node:crypto";
import { execFile } from "node:child_process";
import { promisify } from "node:util";
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { pathToFileURL } from "node:url";
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
import { and, eq, sql } from "drizzle-orm";
import { activityLog, agents, agentWakeupRequests, applyPendingMigrations, closeRegisteredClients, companies, createDb, environmentLeases, environments,
executionWorkspaces, executionWorkspaceSnapshots, heartbeatRunEvents, heartbeatRuns, issueRecoveryActions, issues, livenessDb, nativeRunFinalizations, projects, projectWorkspaces, workspaceOperations } from "@paperclipai/db";
import type { AdapterExecutionTarget } from "@paperclipai/adapter-utils/execution-target";
import type { CommandManagedRuntimeRunner } from "@paperclipai/adapter-utils/command-managed-runtime";
import type { Environment, EnvironmentLease } from "@paperclipai/shared";
import { createStorageService } from "../storage/service.js";
import { createLocalDiskStorageProvider } from "../storage/local-disk-provider.js";
import { createS3StorageProvider } from "../storage/s3-provider.js";
import type { StorageService } from "../storage/types.js";
import { createSavedWorkspaceLoader, prepareRemoteWorkspace, readRemoteWorkspaceAuthority,
clearRemoteWorkspaceLocationForReleasedLease, createRemoteWorkspaceGitAuth, prepareRemoteWorkspaceRepository,
reserveRemoteWorkspace, saveRemoteWorkspace, shouldUseRemoteWorkspaces } from "./remote-workspaces.js";
import type { createGitRemoteAuthProvider } from "./git-credentials.js";
import { reconcileSafeNativeReplacements } from "./native-runtime/native-safe-replacement.js";
import { remoteTerminationReceipt } from "./remote-execution-termination.js";
import { appendHeartbeatRunEvent } from "./heartbeat-run-events.js";
import { createRemoteWorkspaceFiles } from "./remote-workspace-files.js";
import { workspaceFileResourceService } from "./workspace-file-resources.js";
import { nativeWorkspaceExportPendingForLease, preserveRemoteWorkspacePreparationFailure } from "./native-runtime/native-workspace-finalization-state.js";
import { preserveOrphanedNativeWorkspace } from "./native-runtime/native-failed-workspace-recovery.js";
import { terminalizeLegacyExecution } from "./legacy-execution-recovery.js";
import { environmentRuntimeService } from "./environment-runtime.js";
import { legacyControllerClaim, renewLegacyControllerLease } from "./legacy-controller-lease.js";
import { migrateRemoteWorkspace } from "./remote-workspace-migration.js";
import { registerRemoteWorkspaceSnapshotRetentionWork, remoteWorkspaceSnapshotRetentionService } from "./remote-workspace-snapshot-retention.js";
import { createDeliveryWorkCoordinator } from "./delivery-work-coordinator.js";
import { issueService } from "./issues.js";
import { instanceSettingsService } from "./instance-settings.js";
const exec = promisify(execFile);
const databaseUrl = process.env.PAPERCLIP_REMOTE_WORKSPACE_TEST_DATABASE_URL;
if (databaseUrl && !/^remote_workspace_[a-z_]*test$/.test(new URL(databaseUrl).pathname.slice(1))) throw new Error("Disposable workspace database required");
const suite = databaseUrl ? describe : describe.skip;
const s3Bucket = process.env.PAPERCLIP_REMOTE_WORKSPACE_TEST_S3_BUCKET;
if (s3Bucket && !s3Bucket.startsWith("paperclip-workspace-")) throw new Error("Disposable workspace S3 bucket required");
suite("remote workspace lifecycle with real Postgres and independent filesystem execution", () => {
let db: ReturnType<typeof createDb>, root: string, storage: StorageService;
let ids: { company: string; agent: string; issue: string; run: string; environment: string; lease: string };
beforeAll(async () => { await applyPendingMigrations(databaseUrl!); db = createDb(databaseUrl!); }, 120_000);
afterAll(async () => { await closeRegisteredClients(databaseUrl!); });
beforeEach(async () => {
vi.stubEnv("DATABASE_URL", databaseUrl!); vi.stubEnv("PAPERCLIP_SECRETS_MASTER_KEY", "62".repeat(32));
root = await fs.realpath(await fs.mkdtemp(path.join(os.tmpdir(), "pc-remote-workspace-lifecycle-")));
storage = s3Bucket ? createStorageService(createS3StorageProvider({ bucket: s3Bucket, region: "us-east-1", prefix: "lifecycle-tests" }))
: { ...createStorageService(createLocalDiskStorageProvider(path.join(root, "objects"))), provider: "s3" };
ids = Object.fromEntries(["company", "agent", "issue", "run", "environment", "lease"].map(key => [key, randomUUID()])) as typeof ids;
await db.insert(companies).values({ id: ids.company, name: "Disposable remote workspace proof", issuePrefix: "RWP" });
await db.insert(agents).values({ id: ids.agent, companyId: ids.company, name: "Native worker", adapterType: "paperclip_runner" });
await db.insert(environments).values({ id: ids.environment, name: `Independent filesystem execution ${ids.environment}`, driver: "sandbox", config: {} });
await db.insert(issues).values({ id: ids.issue, companyId: ids.company, title: "Use a remote workspace", status: "in_progress", assigneeAgentId: ids.agent });
await db.insert(heartbeatRuns).values({ id: ids.run, companyId: ids.company, agentId: ids.agent, nativeIssueId: ids.issue,
runtimeMode: "native", status: "running" });
await db.insert(environmentLeases).values({ id: ids.lease, companyId: ids.company, environmentId: ids.environment,
heartbeatRunId: ids.run, issueId: ids.issue, provider: "daytona", providerLeaseId: `allocation-${ids.lease}`, status: "active" });
});
afterEach(async () => {
const snapshots = await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.companyId, ids.company));
for (const row of snapshots) for (const key of new Set([row.objectKey, ...(Array.isArray(row.metadata?.uploads)
? (row.metadata.uploads as { objectKey: string }[]).map(item => item.objectKey) : [])].filter((value): value is string => !!value))) {
await storage.deleteObject(ids.company, key);
}
await db.delete(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.companyId, ids.company));
await db.delete(workspaceOperations).where(eq(workspaceOperations.companyId, ids.company));
await db.delete(activityLog).where(eq(activityLog.companyId, ids.company));
await db.delete(environmentLeases).where(eq(environmentLeases.companyId, ids.company));
await db.delete(nativeRunFinalizations).where(eq(nativeRunFinalizations.companyId, ids.company));
await db.delete(issueRecoveryActions).where(eq(issueRecoveryActions.companyId, ids.company));
await db.delete(heartbeatRunEvents).where(eq(heartbeatRunEvents.companyId, ids.company));
await db.delete(heartbeatRuns).where(eq(heartbeatRuns.companyId, ids.company));
await db.delete(agentWakeupRequests).where(eq(agentWakeupRequests.companyId, ids.company));
await db.update(issues).set({ executionWorkspaceId: null }).where(eq(issues.companyId, ids.company));
await db.delete(executionWorkspaces).where(eq(executionWorkspaces.companyId, ids.company));
await db.delete(issues).where(eq(issues.companyId, ids.company));
await db.delete(projectWorkspaces).where(eq(projectWorkspaces.companyId, ids.company));
await db.delete(projects).where(eq(projects.companyId, ids.company));
await db.delete(agents).where(eq(agents.companyId, ids.company));
await db.delete(companies).where(eq(companies.id, ids.company));
await db.delete(environments).where(eq(environments.id, ids.environment));
await fs.rm(root, { recursive: true, force: true }); vi.unstubAllEnvs();
});
async function target(name: string): Promise<Extract<AdapterExecutionTarget, { transport: "sandbox" }>> {
const remoteCwd = path.join(root, name); await fs.mkdir(remoteCwd);
const runner: CommandManagedRuntimeRunner = {
execute: async input => {
try {
const result = await exec(input.command, input.args ?? [], { cwd: input.cwd ?? remoteCwd,
env: { ...process.env, ...input.env }, timeout: input.timeoutMs, maxBuffer: 4 * 1024 * 1024 });
return { exitCode: 0, stdout: result.stdout, stderr: result.stderr, timedOut: false, signal: null, pid: process.pid, startedAt: new Date().toISOString() };
} catch (error) { const failed = error as { code?: number; stdout?: string; stderr?: string };
return { exitCode: typeof failed.code === "number" ? failed.code : 1, stdout: failed.stdout ?? "", stderr: failed.stderr ?? "", timedOut: false, signal: null, pid: process.pid, startedAt: new Date().toISOString() }; }
},
syncIn: async operations => transfer(operations), syncOut: async operations => transfer(operations),
};
return { kind: "remote", transport: "sandbox", remoteCwd, runner, provider: "daytona", leaseId: ids.lease,
sandboxId: `allocation-${ids.lease}`, timeoutMs: 300_000 } as Extract<AdapterExecutionTarget, { transport: "sandbox" }>;
}
async function transfer(operations: Parameters<NonNullable<CommandManagedRuntimeRunner["syncIn"]>>[0]) {
const results = [];
for (const operation of operations) {
let bytes = 0;
for (const file of operation.files) {
await fs.mkdir(path.dirname(file.targetPath), { recursive: true });
await fs.cp(file.sourcePath, file.targetPath, { recursive: file.kind === "directory" });
if (file.kind === "file") bytes += (await fs.stat(file.targetPath)).size;
}
results.push({ operationId: operation.operationId, filesTransferred: operation.files.length, bytesTransferred: bytes });
}
return { operations: results };
}
const lease = async () => (await db.select().from(environmentLeases).where(eq(environmentLeases.id, ids.lease)))[0]! as EnvironmentLease;
const workspace = async (id: string) => (await db.select().from(executionWorkspaces).where(eq(executionWorkspaces.id, id)))[0]!;
const reserve = (source: Parameters<typeof reserveRemoteWorkspace>[0]["source"]) => reserveRemoteWorkspace({ db, storage,
companyId: ids.company, issueId: ids.issue, runId: ids.run, agentId: ids.agent, environmentId: ids.environment,
projectId: null, projectWorkspaceId: null, existingWorkspaceId: null, source });
it("prepares, saves and restores task files without a controller checkout or original allocation", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("sandbox-A");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
expect(readRemoteWorkspaceAuthority(prepared.workspace.metadata)?.snapshotId).toBeTruthy();
expect(await fs.readdir(path.join(prepared.remoteRoot, ".paperclip-runtime", "workspace-snapshots"))).toEqual([]);
await fs.writeFile(path.join(prepared.remoteRoot, "report.md"), "useful saved result\n");
await fs.mkdir(path.join(prepared.remoteRoot, "empty-folder"));
await fs.writeFile(path.join(prepared.remoteRoot, "binary.bin"), Buffer.from([0, 1, 255]));
const saved = await saveRemoteWorkspace({ db, storage, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, assertOwned: async () => undefined });
const current = await workspace(reserved.id);
expect(readRemoteWorkspaceAuthority(current.metadata)).toMatchObject({ dirty: false, writerRunId: null, snapshotId: saved.snapshotId });
await fs.rm(path.dirname(prepared.remoteRoot), { recursive: true, force: true });
const second = await target("sandbox-B");
const nextRun = randomUUID(), nextLease = randomUUID();
await db.insert(heartbeatRuns).values({ id: nextRun, companyId: ids.company, agentId: ids.agent, nativeIssueId: ids.issue, runtimeMode: "native", status: "running" });
await db.insert(environmentLeases).values({ id: nextLease, companyId: ids.company, environmentId: ids.environment,
heartbeatRunId: nextRun, issueId: ids.issue, provider: "daytona", providerLeaseId: `allocation-${nextLease}`, status: "active" });
const reservedAgain = await reserveRemoteWorkspace({ db, storage, companyId: ids.company, issueId: ids.issue, runId: nextRun,
agentId: ids.agent, environmentId: ids.environment, projectId: null, projectWorkspaceId: null, existingWorkspaceId: reserved.id, source: { kind: "empty" } });
const newLease = (await db.select().from(environmentLeases).where(eq(environmentLeases.id, nextLease)))[0]! as EnvironmentLease;
const restored = await prepareRemoteWorkspace({ db, storage, workspace: reservedAgain, runId: nextRun, lease: newLease, target: second });
expect(await fs.readFile(path.join(restored.remoteRoot, "report.md"), "utf8")).toBe("useful saved result\n");
expect(await fs.readFile(path.join(restored.remoteRoot, "binary.bin"))).toEqual(Buffer.from([0, 1, 255]));
expect((await fs.stat(path.join(restored.remoteRoot, "empty-folder"))).isDirectory()).toBe(true);
const browse = await createSavedWorkspaceLoader(db, storage)({ companyId: ids.company, workspaceId: reserved.id, snapshotId: saved.snapshotId });
try { expect(await fs.readFile(path.join(browse.root, "report.md"), "utf8")).toContain("useful saved result"); } finally { await browse.cleanup(); }
}, 60_000);
it.each(["path", "file-url"] as const)("cold restores an imported secondary %s repository and acquires only a new descriptor", async sourceKind => {
const origin = path.join(root, "import-origin"), original = path.join(root, "old-checkout");
await fs.mkdir(origin); await fs.mkdir(original);
const git = (cwd: string, ...args: string[]) => exec("git", ["-C", cwd, "-c", "user.name=Import fixture", "-c", "user.email=import@example.invalid", ...args]);
await git(origin, "init", "--initial-branch=main");
await fs.writeFile(path.join(origin, "code.txt"), "saved secondary baseline\n");
await git(origin, "add", "."); await git(origin, "commit", "-m", "Import baseline");
const repoUrl = sourceKind === "path" ? origin : pathToFileURL(origin).href;
await git(original, "clone", repoUrl, "secondary");
await fs.writeFile(path.join(original, "secondary", "untracked.txt"), "imported secondary work\n");
const pinnedCommit = (await git(origin, "rev-parse", "HEAD")).stdout.trim();
const repository = { id: randomUUID(), relativePath: "secondary", repoUrl, ref: "HEAD", pinnedCommit };
const source = { kind: "empty" as const, repositories: [repository] };
await db.update(heartbeatRuns).set({ status: "succeeded", finishedAt: new Date() }).where(eq(heartbeatRuns.id, ids.run));
const [local] = await db.insert(executionWorkspaces).values({ companyId: ids.company, sourceIssueId: ids.issue,
mode: "isolated_workspace", strategyType: "project_primary", providerType: "local_fs", name: "Imported secondary",
cwd: original, providerRef: original }).returning();
await db.update(issues).set({ executionWorkspaceId: local.id }).where(eq(issues.id, ids.issue));
await migrateRemoteWorkspace({ db, storage, companyId: ids.company, workspaceId: local.id, source, apply: true });
const imported = readRemoteWorkspaceAuthority((await workspace(local.id)).metadata)!;
expect(imported.source).toEqual(source);
await fs.rm(original, { recursive: true }); await fs.rm(origin, { recursive: true });
// This descriptor was not in the committed import. It must still use normal
// acquisition rather than treating a missing directory as saved bytes.
const newOrigin = path.join(root, "new-origin"); await fs.mkdir(newOrigin);
await git(newOrigin, "init", "--initial-branch=main");
await fs.writeFile(path.join(newOrigin, "new.txt"), "newly acquired work\n");
await git(newOrigin, "add", "."); await git(newOrigin, "commit", "-m", "New source");
const added = { id: randomUUID(), relativePath: "new-repository", repoUrl: newOrigin, ref: "HEAD" };
const nextRun = randomUUID(), nextLease = randomUUID();
await db.insert(heartbeatRuns).values({ id: nextRun, companyId: ids.company, agentId: ids.agent, nativeIssueId: ids.issue,
runtimeMode: "native", status: "running" });
await db.insert(environmentLeases).values({ id: nextLease, companyId: ids.company, environmentId: ids.environment,
heartbeatRunId: nextRun, issueId: ids.issue, provider: "daytona", providerLeaseId: `allocation-${nextLease}`, status: "active" });
const reserved = await reserveRemoteWorkspace({ db, storage, companyId: ids.company, issueId: ids.issue, runId: nextRun,
agentId: ids.agent, environmentId: ids.environment, projectId: null, projectWorkspaceId: null,
existingWorkspaceId: local.id, source });
const next = (await db.select().from(environmentLeases).where(eq(environmentLeases.id, nextLease)))[0]! as EnvironmentLease;
const remote = await target("import-restored-sandbox");
const restored = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: nextRun, lease: next, target: remote,
source: { ...source, repositories: [repository, added] } });
const secondary = path.join(restored.remoteRoot, "secondary");
expect((await git(secondary, "rev-parse", "HEAD")).stdout.trim()).toBe(pinnedCommit);
expect((await git(secondary, "remote")).stdout.trim()).toBe("");
expect(await fs.readFile(path.join(secondary, "untracked.txt"), "utf8")).toBe("imported secondary work\n");
expect(await fs.readFile(path.join(restored.remoteRoot, added.relativePath, "new.txt"), "utf8")).toBe("newly acquired work\n");
expect(readRemoteWorkspaceAuthority(restored.workspace.metadata)).toMatchObject({ source, snapshotId: imported.snapshotId });
const resolveGitAuth = vi.fn(async () => null);
const admission = { db, storage, workspace: restored.workspace, runId: nextRun, lease: restored.lease, target: remote,
repository: { ...repository, ref: null }, resolveGitAuth };
// Registered admission encodes the stored default HEAD as null. It must
// verify the same saved descriptor without changing the source identity.
await expect(prepareRemoteWorkspaceRepository(admission)).resolves.toMatchObject({ cwd: secondary, pinnedCommit });
const beforeChanged = readRemoteWorkspaceAuthority((await workspace(local.id)).metadata)!;
await expect(prepareRemoteWorkspaceRepository({ ...admission,
workspace: await workspace(local.id), repository: { ...repository, ref: null, repoUrl: newOrigin } }))
.rejects.toThrow("remote_workspace_operation_failed");
expect(readRemoteWorkspaceAuthority((await workspace(local.id)).metadata)).toEqual(beforeChanged);
expect(resolveGitAuth).not.toHaveBeenCalled();
const newRepository = { ...added, id: randomUUID(), relativePath: "wrapper-new", ref: null };
await expect(prepareRemoteWorkspaceRepository({ ...admission, workspace: await workspace(local.id), repository: newRepository }))
.resolves.toMatchObject({ cwd: path.join(restored.remoteRoot, "wrapper-new") });
expect(resolveGitAuth).toHaveBeenCalledOnce();
expect(await fs.readFile(path.join(restored.remoteRoot, "wrapper-new", "new.txt"), "utf8")).toBe("newly acquired work\n");
expect(readRemoteWorkspaceAuthority((await workspace(local.id)).metadata)!.source).toEqual(source);
}, 60_000);
it.runIf(process.platform !== "win32" && process.getuid?.() !== 0)("cleans saved reads with read-only folders without changing modes or following symlinks", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("read-only-sandbox");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
const locked = path.join(prepared.remoteRoot, "locked"), outside = path.join(root, "outside");
await fs.mkdir(locked); await fs.writeFile(path.join(locked, "report.txt"), "saved read-only result\n", { mode: 0o444 });
await fs.mkdir(outside); await fs.writeFile(path.join(outside, "keep.txt"), "outside the extraction\n", { mode: 0o444 });
await fs.chmod(locked, 0o555); await fs.chmod(outside, 0o555);
let extraction: Awaited<ReturnType<ReturnType<typeof createSavedWorkspaceLoader>>> | undefined;
try {
const saved = await saveRemoteWorkspace({ db, storage, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, assertOwned: async () => undefined });
const savedTemp = path.join(root, "saved-reads"); await fs.mkdir(savedTemp); vi.stubEnv("TMPDIR", savedTemp);
const loadSavedWorkspace = createSavedWorkspaceLoader(db, storage);
extraction = await loadSavedWorkspace({ companyId: ids.company, workspaceId: reserved.id, snapshotId: saved.snapshotId });
expect((await fs.stat(path.join(extraction.root, "locked"))).mode & 0o777).toBe(0o555);
expect((await fs.stat(path.join(extraction.root, "locked", "report.txt"))).mode & 0o777).toBe(0o444);
expect(await fs.readFile(path.join(extraction.root, "locked", "report.txt"), "utf8")).toBe("saved read-only result\n");
// Cleanup must unlink a symlink without changing its external target.
await fs.symlink(outside, path.join(extraction.root, "outside-link"));
await extraction.cleanup();
await expect(fs.access(path.dirname(extraction.root))).rejects.toMatchObject({ code: "ENOENT" });
expect((await fs.stat(outside)).mode & 0o777).toBe(0o555);
expect((await fs.stat(path.join(outside, "keep.txt"))).mode & 0o777).toBe(0o444);
expect(await fs.readFile(path.join(outside, "keep.txt"), "utf8")).toBe("outside the extraction\n");
expect((await fs.stat(locked)).mode & 0o777).toBe(0o555);
const current = await workspace(reserved.id), authority = readRemoteWorkspaceAuthority(current.metadata)!;
await db.update(executionWorkspaces).set({ metadata: { ...current.metadata, remoteWorkspace: { ...authority, location: null } } })
.where(eq(executionWorkspaces.id, reserved.id));
const files = workspaceFileResourceService(db, undefined, { remoteFiles: createRemoteWorkspaceFiles(db, { loadSavedWorkspace }) });
expect(await files.readContent(ids.issue, { workspace: "execution", path: "locked/report.txt" }))
.toMatchObject({ content: { data: "saved read-only result\n" }, resource: { source: { kind: "saved" } } });
expect(await fs.readdir(savedTemp)).toEqual([]);
expect(await files.list(ids.issue, { workspace: "execution", mode: "all" })).toMatchObject({ state: "available" });
expect(await fs.readdir(savedTemp)).toEqual([]);
await expect(files.readContent(ids.issue, { workspace: "execution", path: "missing.txt" })).rejects.toMatchObject({ status: 404 });
expect(await fs.readdir(savedTemp)).toEqual([]);
} finally {
if (extraction) {
await fs.chmod(path.join(extraction.root, "locked"), 0o700).catch(() => undefined);
await fs.rm(path.dirname(extraction.root), { recursive: true, force: true });
}
await fs.chmod(locked, 0o700); await fs.chmod(outside, 0o700);
}
}, 60_000);
it("forwards cancellation through saved file access and removes failed extraction scratch", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("cancelled-saved-read");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
await fs.writeFile(path.join(prepared.remoteRoot, "report.txt"), "saved result\n");
const saved = await saveRemoteWorkspace({ db, storage, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, assertOwned: async () => undefined });
const current = await workspace(reserved.id), authority = readRemoteWorkspaceAuthority(current.metadata)!;
await db.update(executionWorkspaces).set({ metadata: { ...current.metadata, remoteWorkspace: { ...authority, location: null } } })
.where(eq(executionWorkspaces.id, reserved.id));
const savedTemp = path.join(root, "cancelled-reads"); await fs.mkdir(savedTemp); vi.stubEnv("TMPDIR", savedTemp);
for (const mode of ["abort", "storage_failure"] as const) {
const controller = new AbortController(), failure = new Error("Saved object unavailable");
let observedSignal: AbortSignal | undefined;
const interruptedStorage: StorageService = { ...storage, getObject: async (companyId, objectKey, options) => {
observedSignal = options?.signal;
if (mode === "storage_failure") throw failure;
const object = await storage.getObject(companyId, objectKey, options);
controller.abort(new DOMException("Saved read cancelled", "AbortError"));
return object;
} };
const remoteFiles = createRemoteWorkspaceFiles(db, { loadSavedWorkspace: createSavedWorkspaceLoader(db, interruptedStorage) });
let readError: unknown;
const access = await remoteFiles.open({ companyId: ids.company, workspaceId: reserved.id, signal: controller.signal })
.catch(error => { readError = error; return null; });
await access?.close();
expect(observedSignal).toBe(controller.signal);
if (mode === "storage_failure") expect(readError).toBe(failure);
else expect(readError).toMatchObject({ name: "AbortError" });
expect(await fs.readdir(savedTemp)).toEqual([]);
}
const cancelled = new DOMException("Already cancelled", "AbortError");
const getObject = vi.fn(storage.getObject.bind(storage));
await expect(createSavedWorkspaceLoader(db, { ...storage, getObject })({ companyId: ids.company,
workspaceId: reserved.id, snapshotId: saved.snapshotId, signal: AbortSignal.abort(cancelled) })).rejects.toBe(cancelled);
expect(getObject).not.toHaveBeenCalled();
expect(await fs.readdir(savedTemp)).toEqual([]);
}, 60_000);
it("reconnects to the same live folder without replaying preparation or overwriting unsaved edits", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("same-sandbox");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
await fs.writeFile(path.join(prepared.remoteRoot, "in-flight.txt"), "still running");
const before = await workspace(reserved.id);
const reattached = await prepareRemoteWorkspace({ db, storage, workspace: before, runId: ids.run, lease: await lease(), target: first,
provisionCommand: "exit 99" });
expect(reattached.remoteRoot).toBe(prepared.remoteRoot);
expect(await fs.readFile(path.join(reattached.remoteRoot, "in-flight.txt"), "utf8")).toBe("still running");
expect((await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.companyId, ids.company))).length).toBe(1);
}, 60_000);
it("fences stale same-run preparation from replacing a dirty workspace allocation or lease", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("dirty-owner");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run,
lease: await lease(), target: first, assertOwned: async () => undefined });
await fs.writeFile(path.join(prepared.remoteRoot, "unsaved.txt"), "only the first allocation has this work\n");
const originalAuthority = readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)!;
for (const sameAllocation of [false, true]) {
const leaseId = randomUUID();
const providerLeaseId = sameAllocation ? prepared.lease.providerLeaseId! : `allocation-${leaseId}`;
await db.insert(environmentLeases).values({ id: leaseId, companyId: ids.company, environmentId: ids.environment,
heartbeatRunId: ids.run, issueId: ids.issue, provider: "daytona", providerLeaseId, status: "active" });
const replacementLease = (await db.select().from(environmentLeases).where(eq(environmentLeases.id, leaseId)))[0]! as EnvironmentLease;
const replacement = sameAllocation ? first : await target("stale-replacement");
await expect(prepareRemoteWorkspace({ db, storage, workspace: sameAllocation ? await workspace(reserved.id) : reserved, runId: ids.run,
lease: replacementLease, target: replacement, assertOwned: async () => undefined }))
.rejects.toThrow("remote_workspace_authority_changed");
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)).toEqual(originalAuthority);
expect(await fs.readFile(path.join(prepared.remoteRoot, "unsaved.txt"), "utf8"))
.toBe("only the first allocation has this work\n");
}
}, 60_000);
it("publishes a cold restored workspace despite lost cleanup replies and retries cleanup without overwriting later edits", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("restore-cleanup-source");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run,
lease: await lease(), target: first });
await fs.writeFile(path.join(prepared.remoteRoot, "saved.txt"), "saved before the original allocation was lost\n");
const saved = await saveRemoteWorkspace({ db, storage, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, assertOwned: async () => undefined });
await fs.rm(path.dirname(prepared.remoteRoot), { recursive: true, force: true });
const nextRun = randomUUID(), nextLease = randomUUID(), providerLeaseId = `allocation-${nextLease}`;
await db.insert(heartbeatRuns).values({ id: nextRun, companyId: ids.company, agentId: ids.agent,
nativeIssueId: ids.issue, runtimeMode: "native", status: "running" });
await db.insert(environmentLeases).values({ id: nextLease, companyId: ids.company, environmentId: ids.environment,
heartbeatRunId: nextRun, issueId: ids.issue, provider: "daytona", providerLeaseId, status: "active" });
const nextWorkspace = await reserveRemoteWorkspace({ db, storage, companyId: ids.company, issueId: ids.issue,
runId: nextRun, agentId: ids.agent, environmentId: ids.environment, projectId: null, projectWorkspaceId: null,
existingWorkspaceId: reserved.id, source: { kind: "empty" } });
const nextTarget = await target("restore-cleanup-destination");
const sandbox = nextTarget as Extract<AdapterExecutionTarget, { transport: "sandbox" }>;
const expectedRemoteRoot = path.join(sandbox.remoteCwd, ".paperclip-workspaces", reserved.id);
const execute = sandbox.runner!.execute.bind(sandbox.runner!);
let failCleanup = true, cleanupAttempts = 0;
sandbox.runner!.execute = async input => {
const result = await execute(input);
if (input.args?.[1]?.includes("remote_workspace_export_cleanup_failed") && result.exitCode === 0) {
cleanupAttempts++;
if (failCleanup) throw new Error("lost restore cleanup reply");
}
return result;
};
const nextLeaseRow = (await db.select().from(environmentLeases).where(eq(environmentLeases.id, nextLease)))[0]! as EnvironmentLease;
const restored = await prepareRemoteWorkspace({ db, storage, workspace: nextWorkspace, runId: nextRun,
lease: nextLeaseRow, target: nextTarget, assertOwned: async () => undefined });
expect(restored.remoteRoot).toBe(expectedRemoteRoot);
const location = { environmentId: ids.environment, leaseId: nextLease, providerLeaseId, remoteCwd: restored.remoteRoot };
expect(cleanupAttempts).toBeGreaterThan(0);
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)).toMatchObject({
location, snapshotId: saved.snapshotId, writerRunId: nextRun, dirty: true,
});
expect((await db.select().from(environmentLeases).where(eq(environmentLeases.id, nextLease)))[0]?.metadata?.remoteCwd).toBe(restored.remoteRoot);
expect((await db.select().from(heartbeatRuns).where(eq(heartbeatRuns.id, nextRun)))[0]?.runnerProfileJson?.remoteWorkspace)
.toMatchObject({ workspaceId: reserved.id, leaseId: nextLease, providerLeaseId,
remoteCwd: restored.remoteRoot, state: "prepared", snapshotId: saved.snapshotId });
expect(await fs.readFile(path.join(restored.remoteRoot, "saved.txt"), "utf8"))
.toBe("saved before the original allocation was lost\n");
const [operation] = await db.select().from(workspaceOperations).where(and(eq(workspaceOperations.companyId, ids.company),
eq(workspaceOperations.heartbeatRunId, nextRun), eq(workspaceOperations.phase, "remote_workspace_restore")));
expect(operation).toMatchObject({ status: "succeeded", metadata: { exportCleanup: { ...location, state: "pending" } } });
await fs.writeFile(path.join(restored.remoteRoot, "saved.txt"), "later agent edits\n");
await fs.writeFile(path.join(restored.remoteRoot, "newer.txt"), "keep untracked work\n");
failCleanup = false;
const transfer = vi.spyOn(sandbox.runner!, "syncIn");
const upload = vi.spyOn(storage, "putFile");
await prepareRemoteWorkspace({ db, storage, workspace: await workspace(reserved.id), runId: nextRun,
lease: restored.lease, target: nextTarget, assertOwned: async () => undefined });
expect((await db.select().from(workspaceOperations).where(eq(workspaceOperations.id, operation!.id)))[0])
.toMatchObject({ status: "succeeded", metadata: { exportCleanup: { ...location, state: "cleaned" } } });
expect(await fs.readFile(path.join(restored.remoteRoot, "saved.txt"), "utf8")).toBe("later agent edits\n");
expect(await fs.readFile(path.join(restored.remoteRoot, "newer.txt"), "utf8")).toBe("keep untracked work\n");
expect(transfer).not.toHaveBeenCalled();
expect(upload).not.toHaveBeenCalled();
}, 60_000);
it.each([
{ mode: "shared_workspace", inherited: false },
{ mode: "shared_workspace", inherited: true },
{ mode: "isolated_workspace", inherited: true },
{ mode: "operator_branch", inherited: true },
])("continues saved $mode files while fencing a second writer (inherited=$inherited)", async ({ mode, inherited }) => {
await instanceSettingsService(db).updateExperimental({ enableIsolatedWorkspaces: true });
const projectId = randomUUID(), sourceId = randomUUID();
await db.insert(projects).values({ id: projectId, companyId: ids.company, name: "Synthetic shared project" });
await db.insert(projectWorkspaces).values({ id: sourceId, companyId: ids.company, projectId,
name: "Shared files", sourceType: "empty", sharedWorkspaceKey: "synthetic-shared" });
await db.update(issues).set({ projectId, projectWorkspaceId: sourceId }).where(eq(issues.id, ids.issue));
const input = { db, storage, companyId: ids.company, issueId: ids.issue, runId: ids.run,
agentId: ids.agent, environmentId: ids.environment, projectId, projectWorkspaceId: sourceId,
existingWorkspaceId: null, source: { kind: "empty" as const }, mode };
const first = await target("shared-sandbox"), reserved = await reserveRemoteWorkspace(input);
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run,
lease: await lease(), target: first });
await fs.writeFile(path.join(prepared.remoteRoot, "shared-result.txt"), "from the first task\n");
const childInput = { title: "Continue saved work", status: "in_progress" as const, assigneeAgentId: ids.agent };
const child = inherited ? await issueService(db).create(ids.company, { ...childInput, parentId: ids.issue })
: (await db.insert(issues).values({ ...childInput, companyId: ids.company, projectId, projectWorkspaceId: sourceId }).returning())[0]!;
if (inherited) expect(child.executionWorkspaceId).toBe(reserved.id);
const secondIssue = child.id, secondRun = randomUUID(), secondLease = randomUUID();
await db.insert(heartbeatRuns).values({ id: secondRun, companyId: ids.company, agentId: ids.agent,
nativeIssueId: secondIssue, runtimeMode: "native", status: "running" });
const next = { ...input, issueId: secondIssue, runId: secondRun,
existingWorkspaceId: mode === "shared_workspace" ? null : child.executionWorkspaceId };
await expect(reserveRemoteWorkspace(next)).rejects.toThrow("unfinished writer");
await saveRemoteWorkspace({ db, storage, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, assertOwned: async () => undefined });
await db.update(heartbeatRuns).set({ status: "succeeded" }).where(eq(heartbeatRuns.id, ids.run));
if (inherited) await fs.rm(path.dirname(prepared.remoteRoot), { recursive: true, force: true });
const reused = await reserveRemoteWorkspace(next);
expect(reused.id).toBe(reserved.id);
expect(readRemoteWorkspaceAuthority(reused.metadata)).toMatchObject({ epoch: 2, writerRunId: secondRun });
await db.insert(environmentLeases).values({ id: secondLease, companyId: ids.company, environmentId: ids.environment,
heartbeatRunId: secondRun, issueId: secondIssue, provider: "daytona",
providerLeaseId: `allocation-${inherited ? secondLease : ids.lease}`, status: "active" });
const newLease = (await db.select().from(environmentLeases).where(eq(environmentLeases.id, secondLease)))[0]! as EnvironmentLease;
const nextTarget = inherited ? { ...await target("child-sandbox"), leaseId: secondLease,
sandboxId: newLease.providerLeaseId! } : first;
const continued = await prepareRemoteWorkspace({ db, storage, workspace: reused, runId: secondRun, lease: newLease, target: nextTarget });
expect(await fs.readFile(path.join(continued.remoteRoot, "shared-result.txt"), "utf8")).toBe("from the first task\n");
await fs.appendFile(path.join(continued.remoteRoot, "shared-result.txt"), "from the child task\n");
const childSaved = await saveRemoteWorkspace({ db, storage, workspace: continued.workspace, runId: secondRun,
lease: continued.lease, target: nextTarget, assertOwned: async () => undefined });
const loaded = await createSavedWorkspaceLoader(db, storage)({ companyId: ids.company, workspaceId: reserved.id,
snapshotId: childSaved.snapshotId });
try { expect(await fs.readFile(path.join(loaded.root, "shared-result.txt"), "utf8")).toBe("from the first task\nfrom the child task\n"); }
finally { await loaded.cleanup(); }
const [operation] = await db.select().from(workspaceOperations).where(and(eq(workspaceOperations.heartbeatRunId, secondRun),
eq(workspaceOperations.phase, "remote_workspace_snapshot")));
expect(operation?.issueId).toBe(secondIssue);
}, 60_000);
it("retains the writer and previous snapshot when object storage fails", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("outage-sandbox");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
await fs.writeFile(path.join(prepared.remoteRoot, "unpublished.txt"), "retain this source");
const failing: StorageService = { ...storage, putFile: async () => { throw new Error("storage offline"); } };
await expect(saveRemoteWorkspace({ db, storage: failing, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, assertOwned: async () => undefined })).rejects.toThrow("storage offline");
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)).toMatchObject({ dirty: true, writerRunId: ids.run,
snapshotId: readRemoteWorkspaceAuthority(prepared.workspace.metadata)!.snapshotId });
expect((await fs.readdir(path.join(prepared.remoteRoot, ".paperclip-runtime", "workspace-snapshots"))).length).toBe(1);
const saved = await saveRemoteWorkspace({ db, storage, workspace: await workspace(reserved.id), runId: ids.run,
lease: prepared.lease, target: first, assertOwned: async () => undefined });
expect(saved.generation).toBe(2);
expect(await fs.readdir(path.join(prepared.remoteRoot, ".paperclip-runtime", "workspace-snapshots"))).toEqual([]);
}, 60_000);
it.each(["initial", "repository:additional"])("saves current files through a different repair boundary after a failed %s upload", async boundary => {
if (boundary === "initial") await db.update(heartbeatRuns).set({ runtimeMode: "legacy", nativeIssueId: null,
issueId: null, contextSnapshot: { issueId: ids.issue } }).where(eq(heartbeatRuns.id, ids.run));
const reserved = await reserve({ kind: "empty" }), first = await target("failed-boundary");
const failing: StorageService = { ...storage, putFile: async upload => {
await storage.putFile(upload);
throw new Error("boundary storage offline");
} };
if (boundary === "initial") {
await expect(prepareRemoteWorkspace({ db, storage: failing, workspace: reserved, runId: ids.run,
lease: await lease(), target: first, assertOwned: async () => undefined,
provisionCommand: "printf 'one preparation effect\\n' > prepared.txt" })).rejects.toThrow("boundary storage offline");
} else {
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
await fs.writeFile(path.join(prepared.remoteRoot, "prepared.txt"), "one preparation effect\n");
await expect(saveRemoteWorkspace({ db, storage: failing, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, boundary, assertOwned: async () => undefined })).rejects.toThrow("boundary storage offline");
}
const before = await workspace(reserved.id), authority = readRemoteWorkspaceAuthority(before.metadata)!;
const [pending] = await db.select().from(executionWorkspaceSnapshots).where(and(
eq(executionWorkspaceSnapshots.executionWorkspaceId, reserved.id), eq(executionWorkspaceSnapshots.status, "pending")));
expect(pending).toBeTruthy();
expect(authority.snapshotId).toBe(pending!.parentSnapshotId);
await fs.writeFile(path.join(authority.location!.remoteCwd, "after-failed-save.txt"), "newer live files must survive\n");
await db.update(heartbeatRuns).set({ status: "failed" }).where(eq(heartbeatRuns.id, ids.run));
const saved = await saveRemoteWorkspace({ db, storage, workspace: before, runId: ids.run,
lease: await lease(), target: first, assertOwned: async () => undefined });
expect(saved.generation).toBe(pending!.generation + 1);
const [committed] = await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.id, saved.snapshotId));
expect(committed).toMatchObject({ status: "committed", parentSnapshotId: authority.snapshotId });
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)).toMatchObject({
dirty: false, writerRunId: null, snapshotId: saved.snapshotId,
});
const [retired] = await db.select().from(workspaceOperations).where(eq(workspaceOperations.id, pending!.sourceOperationId));
expect(retired).toMatchObject({ status: "failed", metadata: { generation: pending!.generation,
exportCleanup: { state: "cleaned" } } });
expect(await fs.readdir(path.join(authority.location!.remoteCwd, ".paperclip-runtime", "workspace-snapshots"))).toEqual([]);
const upload = vi.spyOn(storage, "putFile"), execute = vi.spyOn((first as Extract<AdapterExecutionTarget, { transport: "sandbox" }>).runner!, "execute");
try {
await expect(saveRemoteWorkspace({ db, storage, workspace: before, runId: ids.run,
lease: await lease(), target: first, boundary, assertOwned: async () => undefined })).rejects.toThrow("remote_workspace_snapshot_retired");
expect(upload).not.toHaveBeenCalled(); expect(execute).not.toHaveBeenCalled();
} finally { upload.mockRestore(); execute.mockRestore(); }
expect(await fs.readdir(path.join(authority.location!.remoteCwd, ".paperclip-runtime", "workspace-snapshots"))).toEqual([]);
const abandonedUploads = pending!.metadata!.uploads as Array<{ objectKey: string }>;
expect(abandonedUploads).toHaveLength(1);
expect((await storage.headObject(ids.company, abandonedUploads[0]!.objectKey)).exists).toBe(true);
const retention = remoteWorkspaceSnapshotRetentionService(db, { storage,
now: () => new Date(Date.now() + 8 * 86_400_000) });
await retention.tick();
expect((await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.id, pending!.id)))[0]?.status)
.toBe("deleted");
expect((await storage.headObject(ids.company, abandonedUploads[0]!.objectKey)).exists).toBe(false);
expect((await storage.headObject(ids.company, committed!.objectKey!)).exists).toBe(true);
const extracted = await createSavedWorkspaceLoader(db, storage)({ companyId: ids.company, workspaceId: reserved.id, snapshotId: saved.snapshotId });
try {
expect(await fs.readFile(path.join(extracted.root, "prepared.txt"), "utf8")).toBe("one preparation effect\n");
expect(await fs.readFile(path.join(extracted.root, "after-failed-save.txt"), "utf8")).toBe("newer live files must survive\n");
} finally { await extracted.cleanup(); }
}, 60_000);
it.each(["journal", "ledger"])("respects historical %s generation reservations without changing the committed parent", async highest => {
const reserved = await reserve({ kind: "empty" }), first = await target("reserved-generations");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
const parent = readRemoteWorkspaceAuthority(prepared.workspace.metadata)!.snapshotId;
// A crash after journaling can leave no ledger row; retention can leave a
// deleted ledger after the source operation is gone. Both remain reserved.
await db.insert(workspaceOperations).values({ companyId: ids.company, executionWorkspaceId: reserved.id,
heartbeatRunId: ids.run, issueId: ids.issue, phase: "remote_workspace_snapshot", status: "running",
metadata: { boundary: "interrupted-before-ledger", epoch: 0, generation: highest === "journal" ? 5 : 3 } });
await db.insert(executionWorkspaceSnapshots).values({ companyId: ids.company, executionWorkspaceId: reserved.id,
sourceOperationId: randomUUID(), sourceRunId: ids.run, parentSnapshotId: null,
generation: highest === "ledger" ? 5 : 3, epoch: 0, status: "deleted" });
const saved = await saveRemoteWorkspace({ db, storage, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, assertOwned: async () => undefined });
expect(saved.generation).toBe(6);
expect((await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.id, saved.snapshotId)))[0])
.toMatchObject({ status: "committed", parentSnapshotId: parent });
}, 60_000);
it("holds an already-poisoned pre-release reservation without rewriting its identity or uploading", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("old-poisoned-reservation");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
const authority = readRemoteWorkspaceAuthority(prepared.workspace.metadata)!;
await fs.writeFile(path.join(prepared.remoteRoot, "held-work.txt"), "retain exact existing files\n");
const failing: StorageService = { ...storage, putFile: async () => { throw new Error("old upload failed"); } };
await expect(saveRemoteWorkspace({ db, storage: failing, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, boundary: "repository:old", assertOwned: async () => undefined }))
.rejects.toThrow("old upload failed");
const [pending] = await db.select().from(executionWorkspaceSnapshots).where(and(
eq(executionWorkspaceSnapshots.executionWorkspaceId, reserved.id), eq(executionWorkspaceSnapshots.status, "pending")));
// Old pre-release code could journal a conflicting final operation before
// beginWorkspaceSnapshot rejected it. Its identity must not be repurposed.
const [poisoned] = await db.insert(workspaceOperations).values({ companyId: ids.company, executionWorkspaceId: reserved.id,
heartbeatRunId: ids.run, issueId: ids.issue, phase: "remote_workspace_snapshot", status: "running",
metadata: { boundary: "final", epoch: authority.epoch, generation: pending!.generation,
parentSnapshotId: authority.snapshotId, exportCleanup: { ...authority.location, state: "pending" } } }).returning();
const upload = vi.spyOn(storage, "putFile");
await expect(saveRemoteWorkspace({ db, storage, workspace: prepared.workspace, runId: ids.run,
lease: prepared.lease, target: first, assertOwned: async () => undefined }))
.rejects.toThrow("remote_workspace_snapshot_operation_binding_changed");
expect(upload).not.toHaveBeenCalled();
const [held] = await db.select().from(workspaceOperations).where(eq(workspaceOperations.id, poisoned!.id));
const { saveWork, ...originalMetadata } = held!.metadata!;
expect(originalMetadata).toEqual(poisoned!.metadata);
expect(saveWork).toMatchObject({ activeIds: [], unknown: true, quiescedAt: expect.any(String) });
expect(Number.isFinite(Date.parse((saveWork as { quiescedAt: string }).quiescedAt))).toBe(true);
expect(await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.sourceOperationId, poisoned!.id)))
.toHaveLength(0);
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)).toMatchObject({
dirty: true, writerRunId: ids.run, snapshotId: authority.snapshotId,
});
expect(await fs.readFile(path.join(prepared.remoteRoot, "held-work.txt"), "utf8")).toBe("retain exact existing files\n");
}, 60_000);
it("reserves distinct generations for competing boundaries and fences the losing publication", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("competing-boundaries");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
const parent = readRemoteWorkspaceAuthority(prepared.workspace.metadata)!.snapshotId;
let arrivals = 0, release!: () => void;
const gate = new Promise<void>(resolve => { release = resolve; });
const timeout = setTimeout(release, 10_000);
const competingStorage: StorageService = { ...storage, putFile: async upload => {
if (++arrivals === 2) release();
await gate;
return storage.putFile(upload);
} };
const input = { db, storage: competingStorage, workspace: prepared.workspace, runId: ids.run, lease: prepared.lease,
target: first, assertOwned: async () => undefined };
const boundaries = ["repository:one", "repository:two"];
const results = await Promise.allSettled(boundaries.map(boundary => saveRemoteWorkspace({ ...input, boundary })))
.finally(() => { clearTimeout(timeout); release(); });
expect(arrivals).toBe(2);
expect(results.filter(result => result.status === "fulfilled")).toHaveLength(1);
const failed = results.find(result => result.status === "rejected") as PromiseRejectedResult;
expect(failed.reason).toMatchObject({ message: "remote_workspace_publication_fenced" });
const rows = (await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.executionWorkspaceId, reserved.id)))
.filter(row => row.id !== parent).sort((a, b) => a.generation - b.generation);
expect(rows.map(row => row.generation)).toEqual([2, 3]);
expect(rows.map(row => row.parentSnapshotId)).toEqual([parent, parent]);
expect(new Set(rows.map(row => row.objectKey)).size).toBe(2);
const winning = results.findIndex(result => result.status === "fulfilled");
const upload = vi.spyOn(competingStorage, "putFile");
const replay = await saveRemoteWorkspace({ ...input, boundary: boundaries[winning]! });
expect(upload).not.toHaveBeenCalled();
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)?.snapshotId).toBe(replay.snapshotId);
await expect(saveRemoteWorkspace({ ...input, boundary: boundaries[1 - winning]! }))
.rejects.toThrow("remote_workspace_publication_fenced");
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)?.snapshotId).toBe(replay.snapshotId);
}, 60_000);
it.each(["failed", "succeeded"])("protects an active duplicate after its peer %s and cleans it only after the last invocation settles", async peer => {
const reserved = await reserve({ kind: "empty" }), first = await target("active-duplicate");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
let release!: () => void, entered!: () => void, releaseOwnership!: () => void, postUpload!: () => void, uploads = 0, checks = 0;
const blocked = new Promise<void>(resolve => { release = resolve; });
const started = new Promise<void>(resolve => { entered = resolve; });
const ownershipGate = new Promise<void>(resolve => { releaseOwnership = resolve; });
const afterUpload = new Promise<void>(resolve => { postUpload = resolve; });
const delayed: StorageService = { ...storage, putFile: async upload => {
if (++uploads === 1) { entered(); await blocked; }
else if (uploads === 2 && peer === "failed") throw new Error("duplicate upload failed");
return storage.putFile(upload);
} };
const input = { db, storage: delayed, workspace: prepared.workspace, runId: ids.run, lease: prepared.lease,
target: first, assertOwned: async () => undefined, boundary: "repository:shared" };
const late = saveRemoteWorkspace({ ...input, assertOwned: async () => {
if (++checks === 3) { postUpload(); await ownershipGate; }
} }).then(value => ({ value, error: null }), error => ({ value: null, error }));
let worker: ReturnType<typeof registerRemoteWorkspaceSnapshotRetentionWork> | undefined;
let coordinator: ReturnType<typeof createDeliveryWorkCoordinator> | undefined;
try {
await Promise.race([started, late.then(result => { throw result.error ?? new Error("Upload did not reach its barrier"); })]);
if (peer === "failed") await expect(saveRemoteWorkspace(input)).rejects.toThrow("duplicate upload failed");
else await saveRemoteWorkspace(input);
const [older] = await db.select().from(executionWorkspaceSnapshots).where(and(
eq(executionWorkspaceSnapshots.executionWorkspaceId, reserved.id), eq(executionWorkspaceSnapshots.generation, 2)));
const [olderOperation] = await db.select().from(workspaceOperations).where(eq(workspaceOperations.id, older!.sourceOperationId));
await fs.writeFile(path.join(prepared.remoteRoot, "after-duplicate.txt"), "the final save contains newer work\n");
const final = await saveRemoteWorkspace({ ...input, workspace: await workspace(reserved.id), boundary: "final" });
expect(final.generation).toBe(3);
const staging = path.join(prepared.remoteRoot, ".paperclip-runtime", "workspace-snapshots");
expect(await fs.readdir(staging)).toContain(olderOperation!.id);
const retention = remoteWorkspaceSnapshotRetentionService(db, { storage,
now: () => new Date(Date.now() + 8 * 86_400_000) });
const tick = vi.spyOn(retention, "tick");
coordinator = createDeliveryWorkCoordinator({ owner: db, canRun: () => true, onError: error => { throw error; } });
worker = registerRemoteWorkspaceSnapshotRetentionWork(coordinator, retention, () => {});
await vi.waitFor(() => expect(tick).toHaveBeenCalled(), { timeout: 4000, interval: 20 });
await vi.waitFor(async () => expect(await retention.nextDeadlineAt()).toBeNull(), { timeout: 4000, interval: 20 });
expect((await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.id, older!.id)))[0]?.status)
.toBe(peer === "failed" ? "pending" : "superseded");
expect(await fs.readdir(staging)).toContain(olderOperation!.id);
const heldTicks = tick.mock.calls.length;
release();
await Promise.race([afterUpload, late.then(result => { throw result.error ?? new Error("Upload did not reach ownership check"); })]);
// Consume the upload's own notification while its invocation still pins
// the row. Only the last-token settlement can wake the quiet worker next.
await vi.waitFor(() => expect(tick.mock.calls.length).toBeGreaterThan(heldTicks), { timeout: 4000, interval: 20 });
await vi.waitFor(async () => expect(await retention.nextDeadlineAt()).toBeNull(), { timeout: 4000, interval: 20 });
const postUploadTicks = tick.mock.calls.length;
releaseOwnership();
expect((await late).error).toMatchObject({ message: "remote_workspace_publication_fenced" });
await vi.waitFor(async () => expect((await db.select().from(executionWorkspaceSnapshots)
.where(eq(executionWorkspaceSnapshots.id, older!.id)))[0]?.status).toBe("deleted"), { timeout: 4000, interval: 20 });
expect(tick.mock.calls.length).toBeGreaterThan(postUploadTicks);
const [settled] = await db.select().from(workspaceOperations).where(eq(workspaceOperations.id, olderOperation!.id));
expect(settled!.status).toBe(peer === "failed" ? "failed" : "succeeded");
expect(settled!.metadata?.exportCleanup).toMatchObject({ state: "cleaned" });
expect(await fs.readdir(staging)).toEqual([]);
const keys = older!.metadata!.uploads as Array<{ objectKey: string }>;
for (const item of keys) expect((await storage.headObject(ids.company, item.objectKey)).exists).toBe(false);
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)?.snapshotId).toBe(final.snapshotId);
const saved = await createSavedWorkspaceLoader(db, storage)({ companyId: ids.company, workspaceId: reserved.id, snapshotId: final.snapshotId });
try { expect(await fs.readFile(path.join(saved.root, "after-duplicate.txt"), "utf8")).toBe("the final save contains newer work\n"); }
finally { await saved.cleanup(); }
} finally { release(); releaseOwnership(); await late; await worker?.stop(); await coordinator?.stop(); }
}, 60_000);
it.each(["untracked", "malformed-owner", "malformed-active"])("keeps adopted %s work pinned after a newer final save", async marker => {
const reserved = await reserve({ kind: "empty" }), first = await target("unknown-save-work");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
const input = { db, storage, workspace: prepared.workspace, runId: ids.run, lease: prepared.lease,
target: first, assertOwned: async () => undefined, boundary: "repository:legacy" };
const failed: StorageService = { ...storage, putFile: async () => { throw new Error("old upload failed"); } };
await expect(saveRemoteWorkspace({ ...input, storage: failed })).rejects.toThrow("old upload failed");
const [old] = await db.select().from(executionWorkspaceSnapshots).where(and(
eq(executionWorkspaceSnapshots.executionWorkspaceId, reserved.id), eq(executionWorkspaceSnapshots.generation, 2)));
// Older/crashed callers supplied no per-invocation completion evidence.
await db.update(workspaceOperations).set({ metadata: sql`${workspaceOperations.metadata} - 'saveWork'` })
.where(eq(workspaceOperations.id, old!.sourceOperationId));
await saveRemoteWorkspace(input);
if (marker === "malformed-owner") await db.update(workspaceOperations).set({ metadata: sql`jsonb_set(${workspaceOperations.metadata},
'{saveWork,unknown}', '"false"'::jsonb)` }).where(eq(workspaceOperations.id, old!.sourceOperationId));
if (marker === "malformed-active") await db.update(workspaceOperations).set({ metadata: sql`jsonb_set(jsonb_set(${workspaceOperations.metadata},
'{saveWork,unknown}', 'false'::jsonb), '{saveWork,activeIds}', '{"unfinished":"unknown"}'::jsonb)` })
.where(eq(workspaceOperations.id, old!.sourceOperationId));
const final = await saveRemoteWorkspace({ ...input, workspace: await workspace(reserved.id), boundary: "final" });
const [held] = await db.select().from(workspaceOperations).where(eq(workspaceOperations.id, old!.sourceOperationId));
expect(held).toMatchObject({ status: "succeeded", metadata: { exportCleanup: { state: "pending" } } });
if (marker === "untracked") expect(held!.metadata?.saveWork).toMatchObject({ activeIds: [], unknown: true });
const retention = remoteWorkspaceSnapshotRetentionService(db, { storage, now: () => new Date(Date.now() + 8 * 86_400_000) });
await retention.tick();
expect((await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.id, old!.id)))[0]?.status).toBe("superseded");
expect(await fs.readdir(path.join(prepared.remoteRoot, ".paperclip-runtime", "workspace-snapshots"))).toContain(old!.sourceOperationId);
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)?.snapshotId).toBe(final.snapshotId);
}, 60_000);
it.each(["issue_column", "context_only"])("retains pre-native preparation files and the exact repair obligation when the first upload fails: %s", async identity => {
await db.update(heartbeatRuns).set({ ...legacyControllerClaim("legacy"), runtimeMode: "legacy", nativeIssueId: null,
issueId: identity === "issue_column" ? ids.issue : null, contextSnapshot: { issueId: ids.issue } })
.where(eq(heartbeatRuns.id, ids.run));
const [claimed] = await db.select().from(heartbeatRuns).where(eq(heartbeatRuns.id, ids.run));
// The production preparer's ownership callback renews on another pool.
// Bound it so a row-lock inversion fails rather than hanging this test.
const assertOwned = async () => livenessDb(db).transaction(async tx => {
await tx.execute(sql`select set_config('statement_timeout', '500ms', true)`);
if (!await renewLegacyControllerLease(tx as unknown as typeof db, claimed!)) throw new Error("controller lease lost");
});
const reserved = await reserve({ kind: "empty" }), first = await target("first-save-outage");
const failing: StorageService = { ...storage, putFile: async () => { throw new Error("initial storage offline"); } };
await expect(prepareRemoteWorkspace({ db, storage: failing, workspace: reserved, runId: ids.run,
lease: await lease(), target: first, assertOwned,
provisionCommand: "printf 'one remote effect\\n' >> setup-result.txt" })).rejects.toThrow("initial storage offline");
const [beforeFailure] = await db.select().from(heartbeatRuns).where(eq(heartbeatRuns.id, ids.run));
await terminalizeLegacyExecution({ db, run: beforeFailure!, status: "failed", patch: {
errorCode: "setup_failed", resultJson: { executionRecovery: { kind: "bootstrap", providerWorkStarted: false } },
} });
const [failed] = await db.select().from(heartbeatRuns).where(eq(heartbeatRuns.id, ids.run));
expect(failed).toMatchObject({ runtimeMode: "legacy", status: "failed", runnerProfileJson: {
remoteWorkspace: { state: "prepared", snapshotId: null, workspaceId: reserved.id },
}, resultJson: { workspaceRestoreFailure: "restore_failed", workspaceRestoreRecovery: {
schema: "paperclip.workspace-restore-recovery.v1", leaseIds: [ids.lease],
} } });
expect(failed?.runnerProfileJson).not.toHaveProperty("nativeExecutionInput");
expect(await db.select().from(nativeRunFinalizations).where(eq(nativeRunFinalizations.runId, ids.run))).toHaveLength(0);
const source = await lease();
expect(await nativeWorkspaceExportPendingForLease(db, source)).toBe(true);
expect(source).toMatchObject({ status: "pending_cleanup", leasePolicy: "retain_on_failure" });
const runtime = environmentRuntimeService(db);
const [environment] = await db.select().from(environments).where(eq(environments.id, ids.environment));
expect(await runtime.destroyRunLease({ environment: environment! as Environment, lease: source })).toBeNull();
const retainedAuthority = readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)!;
expect(retainedAuthority).toMatchObject({
dirty: true, writerRunId: ids.run, snapshotId: null, location: { leaseId: ids.lease },
});
expect(await fs.readFile(path.join(retainedAuthority.location!.remoteCwd, "setup-result.txt"), "utf8")).toBe("one remote effect\n");
const actions = await db.select().from(issueRecoveryActions).where(eq(issueRecoveryActions.companyId, ids.company));
expect(actions).toHaveLength(1);
expect(actions[0]?.evidence).toMatchObject({ runId: ids.run, workspaceRestoreRecovery: { leaseIds: [ids.lease] } });
}, 60_000);
it("reconstructs a stopped pre-native file obligation only for its exact current authority", async () => {
await db.update(heartbeatRuns).set({ runtimeMode: "legacy", nativeIssueId: null, issueId: null,
contextSnapshot: { issueId: ids.issue } }).where(eq(heartbeatRuns.id, ids.run));
const reserved = await reserve({ kind: "empty" }), first = await target("orphan-preparation");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run,
lease: await lease(), target: first });
await db.update(heartbeatRuns).set({ status: "failed" }).where(eq(heartbeatRuns.id, ids.run));
const current = await workspace(reserved.id), authority = readRemoteWorkspaceAuthority(current.metadata)!;
for (const invalid of [
{ ...authority, epoch: authority.epoch + 1 },
{ ...authority, writerRunId: randomUUID() },
{ ...authority, location: { ...authority.location!, leaseId: randomUUID() } },
{ ...authority, location: { ...authority.location!, environmentId: randomUUID() } },
]) {
await db.update(executionWorkspaces).set({ metadata: { ...current.metadata, remoteWorkspace: invalid } })
.where(eq(executionWorkspaces.id, reserved.id));
expect(await nativeWorkspaceExportPendingForLease(db, prepared.lease)).toBe(false);
expect(await preserveRemoteWorkspacePreparationFailure(db, prepared.lease)).toBeNull();
}
await db.update(executionWorkspaces).set({ metadata: current.metadata }).where(eq(executionWorkspaces.id, reserved.id));
expect(await nativeWorkspaceExportPendingForLease(db, { ...prepared.lease, companyId: randomUUID() })).toBe(false);
expect(await preserveRemoteWorkspacePreparationFailure(db, { ...prepared.lease, id: randomUUID() })).toBeNull();
const otherIssueId = randomUUID();
await db.insert(issues).values({ id: otherIssueId, companyId: ids.company, title: "Unrelated task" });
await db.update(executionWorkspaces).set({ sourceIssueId: otherIssueId }).where(eq(executionWorkspaces.id, reserved.id));
expect(await preserveRemoteWorkspacePreparationFailure(db, prepared.lease)).toBeNull();
await db.update(executionWorkspaces).set({ sourceIssueId: ids.issue }).where(eq(executionWorkspaces.id, reserved.id));
await db.update(heartbeatRuns).set({ controllerBootId: randomUUID(), controllerLeaseExpiresAt: new Date(Date.now() + 60_000) })
.where(eq(heartbeatRuns.id, ids.run));
expect(await preserveOrphanedNativeWorkspace(db, prepared.lease)).toBe(false);
expect(await nativeWorkspaceExportPendingForLease(db, prepared.lease)).toBe(true);
expect(await preserveRemoteWorkspacePreparationFailure(db, prepared.lease, { assertOwned: async () => {
await db.update(heartbeatRuns).set({ controllerBootId: randomUUID() }).where(eq(heartbeatRuns.id, ids.run));
} })).toBeNull();
await db.update(heartbeatRuns).set({ controllerBootId: null, controllerLeaseExpiresAt: null }).where(eq(heartbeatRuns.id, ids.run));
expect(await db.select().from(issueRecoveryActions).where(eq(issueRecoveryActions.companyId, ids.company))).toHaveLength(0);
expect(await preserveOrphanedNativeWorkspace(db, prepared.lease)).toBe(true);
expect((await db.select().from(heartbeatRuns).where(eq(heartbeatRuns.id, ids.run)))[0]?.resultJson)
.toMatchObject({ workspaceRestoreRecovery: { leaseIds: [ids.lease] } });
expect(await nativeWorkspaceExportPendingForLease(db, prepared.lease)).toBe(true);
await saveRemoteWorkspace({ db, storage, workspace: await workspace(reserved.id), runId: ids.run,
lease: await lease(), target: first, assertOwned: async () => undefined });
expect(await nativeWorkspaceExportPendingForLease(db, prepared.lease)).toBe(false);
expect(await preserveRemoteWorkspacePreparationFailure(db, prepared.lease)).toBeNull();
}, 60_000);
it("records and retries export cleanup after a lost reply without another upload", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("cleanup-sandbox");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
await fs.writeFile(path.join(prepared.remoteRoot, "saved.txt"), "keep working files\n");
const sandbox = first as Extract<AdapterExecutionTarget, { transport: "sandbox" }>;
const execute = sandbox.runner!.execute.bind(sandbox.runner!);
let lost = false;
sandbox.runner!.execute = async input => {
const result = await execute(input);
if (!lost && input.args?.[1]?.includes("remote_workspace_export_cleanup_failed") && result.exitCode === 0) {
lost = true; throw new Error("lost cleanup reply");
}
return result;
};
const upload = vi.spyOn(storage, "putFile");
const input = { db, storage, workspace: prepared.workspace, runId: ids.run, lease: prepared.lease,
target: first, assertOwned: async () => undefined };
const saved = await saveRemoteWorkspace(input);
const [before] = await db.select().from(workspaceOperations).where(and(eq(workspaceOperations.heartbeatRunId, ids.run),
eq(workspaceOperations.phase, "remote_workspace_snapshot"), eq(workspaceOperations.status, "succeeded"),
eq(workspaceOperations.id, (await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.id, saved.snapshotId)))[0]!.sourceOperationId)));
expect(before?.metadata?.exportCleanup).toMatchObject({ state: "pending", lastError: "remote_workspace_export_cleanup_failed" });
expect(await saveRemoteWorkspace(input)).toMatchObject({ snapshotId: saved.snapshotId, generation: saved.generation });
expect(upload).toHaveBeenCalledOnce();
const [after] = await db.select().from(workspaceOperations).where(eq(workspaceOperations.id, before!.id));
expect(after?.metadata?.exportCleanup).toMatchObject({ state: "cleaned", lastError: null });
expect(await fs.readFile(path.join(prepared.remoteRoot, "saved.txt"), "utf8")).toBe("keep working files\n");
}, 60_000);
it("replays an acknowledged preparation save after a newer boundary without recapture", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("boundary-sandbox");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
const input = { db, storage, workspace: prepared.workspace, runId: ids.run, lease: prepared.lease,
target: first, assertOwned: async () => undefined };
const older = await saveRemoteWorkspace({ ...input, boundary: "repository:one" });
await fs.writeFile(path.join(prepared.remoteRoot, "later.txt"), "later acknowledged work\n");
const newer = await saveRemoteWorkspace({ ...input, boundary: "repository:two" });
const upload = vi.spyOn(storage, "putFile");
expect(await saveRemoteWorkspace({ ...input, boundary: "repository:one" })).toMatchObject({ snapshotId: older.snapshotId });
expect(upload).not.toHaveBeenCalled();
expect(readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)?.snapshotId).toBe(newer.snapshotId);
}, 60_000);
it("retains an uncertain provisioning command and never replays its external effect", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("provision-sandbox");
const sandbox = first as Extract<AdapterExecutionTarget, { transport: "sandbox" }>;
const execute = sandbox.runner!.execute.bind(sandbox.runner!);
let commandCalls = 0;
sandbox.runner!.execute = async input => {
const result = await execute(input);
if (input.command === "bash") { commandCalls++; throw new Error("lost provisioning reply"); }
return result;
};
const input = { db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first,
provisionCommand: "printf 'one effect\\n' >> setup-result.txt" };
await expect(prepareRemoteWorkspace(input)).rejects.toThrow("lost provisioning reply");
const retained = await workspace(reserved.id), authority = readRemoteWorkspaceAuthority(retained.metadata)!;
expect(authority).toMatchObject({ dirty: true, writerRunId: ids.run, snapshotId: null });
expect(authority.location).toBeTruthy();
await expect(prepareRemoteWorkspace({ ...input, workspace: retained, lease: await lease() })).rejects.toThrow("remote_workspace_provision_unverified");
expect(commandCalls).toBe(1);
expect(await fs.readFile(path.join(authority.location!.remoteCwd, "setup-result.txt"), "utf8")).toBe("one effect\n");
const [journal] = await db.select().from(workspaceOperations).where(and(eq(workspaceOperations.companyId, ids.company), eq(workspaceOperations.phase, "remote_workspace_provision")));
expect(journal).toMatchObject({ status: "running", metadata: { uncertain: true } });
}, 60_000);
it("preserves enrolled workspaces after disabling enrollment and rejects a legacy writer", async () => {
const reserved = await reserve({ kind: "empty" });
expect(shouldUseRemoteWorkspaces({ adapterType: "paperclip_runner", environmentDriver: "sandbox", experimentalEnabled: false, existingWorkspace: reserved })).toBe(true);
expect(() => shouldUseRemoteWorkspaces({ adapterType: "codex_local", environmentDriver: "sandbox", experimentalEnabled: false, existingWorkspace: reserved })).toThrow("native sandbox");
});
it("keeps enrollment conditional while enrolled authority fails closed when persistence disappears", async () => {
const candidate = { adapterType: "paperclip_runner", environmentDriver: "sandbox", experimentalEnabled: true };
vi.stubEnv("PAPERCLIP_STORAGE_PROVIDER", "s3");
expect(shouldUseRemoteWorkspaces(candidate)).toBe(true);
expect(shouldUseRemoteWorkspaces({ ...candidate, experimentalEnabled: false })).toBe(false);
expect(shouldUseRemoteWorkspaces({ ...candidate, existingWorkspace: { metadata: {} } })).toBe(false);
const reserved = await reserve({ kind: "empty" });
const before = (await workspace(reserved.id)).metadata;
vi.stubEnv("PAPERCLIP_STORAGE_PROVIDER", "local_disk");
expect(shouldUseRemoteWorkspaces(candidate)).toBe(false);
expect(shouldUseRemoteWorkspaces({ ...candidate, existingWorkspace: reserved })).toBe(true);
const localStorage = createStorageService(createLocalDiskStorageProvider(path.join(root, "local-only")));
await expect(reserveRemoteWorkspace({ db, storage: localStorage, companyId: ids.company,
issueId: ids.issue, runId: ids.run, agentId: ids.agent, environmentId: ids.environment,
projectId: null, projectWorkspaceId: null, existingWorkspaceId: reserved.id, source: { kind: "empty" } }))
.rejects.toMatchObject({ details: { code: "remote_workspace_persistence_unavailable" } });
expect((await workspace(reserved.id)).metadata).toEqual(before);
vi.stubEnv("PAPERCLIP_STORAGE_PROVIDER", "s3");
vi.stubEnv("DATABASE_URL", "");
expect(shouldUseRemoteWorkspaces(candidate)).toBe(false);
expect(shouldUseRemoteWorkspaces({ ...candidate, existingWorkspace: reserved })).toBe(true);
vi.stubEnv("DATABASE_URL", databaseUrl!);
vi.stubEnv("PAPERCLIP_SECRETS_MASTER_KEY", "");
vi.stubEnv("PAPERCLIP_SECRETS_MASTER_KEY_FILE", path.join(root, "missing-stable-key"));
expect(shouldUseRemoteWorkspaces(candidate)).toBe(false);
expect(shouldUseRemoteWorkspaces({ ...candidate, existingWorkspace: reserved })).toBe(true);
});
it("selects Git credentials with the current run's agent, responsible user, and task", async () => {
await db.update(heartbeatRuns).set({ responsibleUserId: "synthetic-current-user" }).where(eq(heartbeatRuns.id, ids.run));
const contexts: unknown[] = [];
const create = ((_db, companyId, context) => {
expect(companyId).toBe(ids.company); contexts.push(context); return async () => null;
}) as typeof createGitRemoteAuthProvider;
await createRemoteWorkspaceGitAuth(db, ids.company, ids.run, create);
expect(contexts).toEqual([{ issueId: ids.issue, heartbeatRunId: ids.run, agentId: ids.agent,
responsibleUserId: "synthetic-current-user" }]);
await expect(createRemoteWorkspaceGitAuth(db, randomUUID(), ids.run, create)).rejects.toThrow("remote_workspace_git_run_unavailable");
await db.update(heartbeatRuns).set({ status: "cancelled" }).where(eq(heartbeatRuns.id, ids.run));
await expect(createRemoteWorkspaceGitAuth(db, ids.company, ids.run, create)).rejects.toThrow("remote_workspace_git_run_unavailable");
expect(contexts).toHaveLength(1);
});
it("reclaims an unused reservation after allocation failed without granting a second live writer", async () => {
const reserved = await reserve({ kind: "empty" });
const nextRun = randomUUID();
await db.insert(heartbeatRuns).values({ id: nextRun, companyId: ids.company, agentId: ids.agent, nativeIssueId: ids.issue,
runtimeMode: "native", status: "running" });
const input = { db, storage, companyId: ids.company, issueId: ids.issue, runId: nextRun, agentId: ids.agent,
environmentId: ids.environment, projectId: null, projectWorkspaceId: null, existingWorkspaceId: reserved.id, source: { kind: "empty" as const } };
await expect(reserveRemoteWorkspace(input)).rejects.toThrow("unfinished writer");
await db.delete(environmentLeases).where(eq(environmentLeases.id, ids.lease));
await db.update(heartbeatRuns).set({ status: "failed" }).where(eq(heartbeatRuns.id, ids.run));
const reclaimed = await reserveRemoteWorkspace(input);
expect(readRemoteWorkspaceAuthority(reclaimed.metadata)).toMatchObject({ writerRunId: nextRun, epoch: 2, dirty: false, location: null });
});
it("rejects publication after writer ownership changes, retaining the uploaded recovery obligation", async () => {
const reserved = await reserve({ kind: "empty" }), first = await target("stale-writer");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
await fs.writeFile(path.join(prepared.remoteRoot, "work.txt"), "must not overwrite a newer owner");
let calls = 0;
await expect(saveRemoteWorkspace({ db, storage, workspace: prepared.workspace, runId: ids.run, lease: prepared.lease, target: first,
assertOwned: async () => {
if (++calls !== 3) return;
const row = await workspace(reserved.id), authority = readRemoteWorkspaceAuthority(row.metadata)!;
await db.update(executionWorkspaces).set({ metadata: { ...row.metadata, remoteWorkspace: { ...authority, epoch: authority.epoch + 1 } } })
.where(eq(executionWorkspaces.id, row.id));
} })).rejects.toThrow("remote_workspace_publication_fenced");
const current = readRemoteWorkspaceAuthority((await workspace(reserved.id)).metadata)!;
expect(current.snapshotId).toBe(readRemoteWorkspaceAuthority(prepared.workspace.metadata)!.snapshotId);
expect(current.dirty).toBe(true);
const snapshots = await db.select().from(executionWorkspaceSnapshots).where(eq(executionWorkspaceSnapshots.companyId, ids.company));
expect(snapshots.map(snapshot => snapshot.status).sort()).toEqual(["committed", "uploaded"]);
}, 60_000);
it("saves dirty and unpushed Git work and restores it without contacting the original source", async () => {
const origin = path.join(root, "source-repository"); await fs.mkdir(origin);
const git = (cwd: string, ...args: string[]) => exec("git", ["-C", cwd, "-c", "user.name=Synthetic test", "-c", "user.email=test@example.invalid", ...args]);
await git(origin, "init", "--initial-branch=main");
await fs.writeFile(path.join(origin, "code.txt"), "original\n"); await git(origin, "add", "."); await git(origin, "commit", "-m", "Synthetic baseline");
const reserved = await reserve({ kind: "git", repoUrl: origin, ref: "HEAD", branchName: "task-work" }), first = await target("git-sandbox");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run, lease: await lease(), target: first });
await fs.writeFile(path.join(prepared.remoteRoot, "code.txt"), "unpushed commit\n");
await git(prepared.remoteRoot, "add", "."); await git(prepared.remoteRoot, "commit", "-m", "Synthetic unpushed work");
const head = (await git(prepared.remoteRoot, "rev-parse", "HEAD")).stdout.trim();
await fs.writeFile(path.join(prepared.remoteRoot, "code.txt"), "staged edit\n"); await git(prepared.remoteRoot, "add", "code.txt");
await fs.writeFile(path.join(prepared.remoteRoot, "code.txt"), "unstaged edit\n");
await fs.writeFile(path.join(prepared.remoteRoot, "untracked.txt"), "untracked work\n");
const status = (await git(prepared.remoteRoot, "status", "--porcelain")).stdout;
const saved = await saveRemoteWorkspace({ db, storage, workspace: prepared.workspace, runId: ids.run, lease: prepared.lease,
target: first, assertOwned: async () => undefined });
await fs.rm(origin, { recursive: true, force: true }); await fs.rm(prepared.remoteRoot, { recursive: true, force: true });
const recovered = await createSavedWorkspaceLoader(db, storage)({ companyId: ids.company, workspaceId: reserved.id, snapshotId: saved.snapshotId });
try {
expect((await git(recovered.root, "rev-parse", "HEAD")).stdout.trim()).toBe(head);
expect((await git(recovered.root, "status", "--porcelain")).stdout).toBe(status);
expect((await git(recovered.root, "show", ":code.txt")).stdout).toBe("staged edit\n");
expect(await fs.readFile(path.join(recovered.root, "code.txt"), "utf8")).toBe("unstaged edit\n");
} finally { await recovered.cleanup(); }
}, 60_000);
it.each(["saved", "dirty", "unsaved", "foreign_snapshot", "delete_requested", "deletion_race", "controller_claim_race", "stale_epoch", "unconfirmed_stop", "unknown_action"] as const)(
"checks durable remote work at the native safe-replacement decision (%s)", async scenario => {
const reserved = await reserve({ kind: "empty" }), first = await target("native-replacement-sandbox");
const prepared = await prepareRemoteWorkspace({ db, storage, workspace: reserved, runId: ids.run,
lease: await lease(), target: first, assertOwned: async () => undefined });
await fs.writeFile(path.join(prepared.remoteRoot, "saved.txt"), "work survives a failed provider session\n");
if (scenario !== "unsaved") await saveRemoteWorkspace({ db, storage, workspace: prepared.workspace,
runId: ids.run, lease: prepared.lease, target: first, assertOwned: async () => undefined });
const current = await workspace(reserved.id), authority = readRemoteWorkspaceAuthority(current.metadata)!;
if (scenario === "dirty" || scenario === "stale_epoch") await db.update(executionWorkspaces).set({ metadata: {
...current.metadata, remoteWorkspace: { ...authority, ...(scenario === "dirty" ? { dirty: true, writerRunId: ids.run }
: { epoch: authority.epoch + 1 }) },
} }).where(eq(executionWorkspaces.id, reserved.id));
if (scenario === "foreign_snapshot") await db.update(executionWorkspaceSnapshots).set({ sourceRunId: randomUUID() })
.where(eq(executionWorkspaceSnapshots.id, authority.snapshotId!));
if (scenario === "delete_requested") await db.update(executionWorkspaceSnapshots).set({ status: "delete_requested" })
.where(eq(executionWorkspaceSnapshots.id, authority.snapshotId!));
const stopped = (await db.update(environmentLeases).set({ status: "released", releasedAt: new Date(), cleanupStatus: "success",
metadata: { ...prepared.lease.metadata, ...(scenario !== "unconfirmed_stop" ? {
remoteExecutionTermination: remoteTerminationReceipt(prepared.lease, {
providerLeaseId: prepared.lease.providerLeaseId, state: "destroyed",
}),
} : {}) },
}).where(eq(environmentLeases.id, ids.lease)).returning())[0]! as EnvironmentLease;
if (scenario === "saved") {
await db.transaction(tx => clearRemoteWorkspaceLocationForReleasedLease({ db: tx, lease: stopped }));
await fs.rm(prepared.remoteRoot, { recursive: true, force: true });
await expect(fs.stat(prepared.remoteRoot)).rejects.toThrow();
}
const [source] = await db.select().from(heartbeatRuns).where(eq(heartbeatRuns.id, ids.run));
await db.update(heartbeatRuns).set({ status: "failed", finishedAt: new Date(), runnerProfileJson: {
...source!.runnerProfileJson, recoveryEventInventoryVersion: 1,
nativeExecutionInput: { provider: { kind: "codex" }, workspace: { cwd: prepared.remoteRoot } },
} }).where(eq(heartbeatRuns.id, ids.run));
await db.insert(nativeRunFinalizations).values({ runId: ids.run, companyId: ids.company, issueId: ids.issue,
phase: "terminal_failure", attempt: 1, failureCode: "native_provider_terminal_failed",
failureDetail: { originalFailureCode: "fixture_checkpoint_unusable" } });
if (scenario === "unknown_action") await appendHeartbeatRunEvent(db, { companyId: ids.company, runId: ids.run,
agentId: ids.agent, eventType: "tool.execution.started", stream: "system",
payload: { name: "send_email", executionId: "unconfirmed-external-action", transport: "process" } });
let replacement;
if (scenario === "deletion_race" || scenario === "controller_claim_race") {
let release!: () => void, announce!: () => void;
let blockingPid = 0;
const released = new Promise<void>(resolve => { release = resolve; });
const locked = new Promise<void>(resolve => { announce = resolve; });
const deletion = db.transaction(async tx => {
await tx.select({ id: issues.id }).from(issues).where(eq(issues.id, ids.issue)).for("update");
const [session] = await tx.execute(sql`select pg_backend_pid() as pid`);
blockingPid = Number(session?.pid);
announce();
await released;
if (scenario === "deletion_race") await tx.update(executionWorkspaceSnapshots).set({ status: "delete_requested" })
.where(eq(executionWorkspaceSnapshots.id, authority.snapshotId!));
else await tx.update(nativeRunFinalizations).set({ leaseOwner: "another-controller",
leaseExpiresAt: new Date(Date.now() + 60_000) }).where(eq(nativeRunFinalizations.runId, ids.run));
});
await locked;
const pending = reconcileSafeNativeReplacements(db);
try {
const deadline = performance.now() + 5_000;
let blocked = false;
while (!blocked && performance.now() < deadline) {
const waiting = await db.execute(sql`select exists(select 1 from pg_stat_activity
where datname = current_database() and ${blockingPid} = any(pg_blocking_pids(pid))) as blocked`);
blocked = waiting[0]?.blocked === true;
if (!blocked) await new Promise(resolve => setTimeout(resolve, 10));
}
expect(blocked).toBe(true);
} finally { release(); await deletion; replacement = await pending; }
} else replacement = await reconcileSafeNativeReplacements(db);
expect(replacement).toMatchObject({ scheduled: scenario === "saved" ? 1 : 0 });
const successors = await db.select().from(heartbeatRuns).where(eq(heartbeatRuns.retryOfRunId, ids.run));
expect(successors).toHaveLength(scenario === "saved" ? 1 : 0);
if (scenario === "saved") expect(successors[0]).toMatchObject({ status: "scheduled_retry",
contextSnapshot: { retryOfRunId: ids.run, forceFreshSession: true } });
else expect(await fs.readFile(path.join(prepared.remoteRoot, "saved.txt"), "utf8"))
.toBe("work survives a failed provider session\n");
if (scenario === "unknown_action") {
const [decision] = await db.select().from(nativeRunFinalizations).where(eq(nativeRunFinalizations.runId, ids.run));
expect(decision?.failureDetail?.replacementDenied).toBe("uncertain_provider_action");
}
}, 60_000,
);
});