Files
PaperClipAI/server/src/services/workspace-operations.ts
T
Nicky LeachandPaperclip aab87ce707 Prove workspace delivery before inspecting cleanup candidates (#18493)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Completed tasks leave workspaces that need safe cleanup.
> - Providers without ancestry inspection currently need a recorded
merged PR before cleanup can start.
> - A squash merge changes commit identity, so direct ancestry cannot
prove that delivery.
> - This change proves delivery from the finalized HEAD and captured
destination before storage inspection.
> - Fresh storage checks and a second delivery check still protect
removal.
> - This reuses the existing worker and receipts. It adds no table or
timer.

## Linked Issues or Issue Description

Refs #18410. Related: #13400 addresses workspace identity during
inspection; this change adds destination-aware delivery discovery.

## What Changed

- Resolve direct ancestry or discover an associated merged GitHub PR
without a recorded work product. Require exact HEAD, destination
repository and branch, and a reachable integration commit.
- Use the latest settled finalization receipt as a candidate. Reject
missing, failed, pending, conflicting, or changed evidence.
- Inspect storage only after positive remote proof for providers that
disable ancestry inspection. Recheck HEAD, branch, source identity and
delivery before removal intent.
- Add an optional provider capability for a specific PR recovery hint
and an optional prepared destination receipt. Older providers keep their
existing protocol.
- Wake cleanup when finalization writes settle or gain a workspace
binding. Keep remote-only retries for concrete unresolved delivery. Park
missing or unsupported candidate identity.
- Reuse the source project's explicit GitHub consent for delivery checks
through the existing authorization service. Revalidate the bound
repository and consent before removal; missing or revoked consent
retains storage without switching identities. Public sources remain
anonymous.
- Update the contracts, documentation, access map, and targeted
regressions.

## Verification

- Initial-head GitHub CI passed at
`5acd4c818be6f1764f8319f42891f9956c357c26`, including full build and
typecheck. Standard Greptile is 5/5 with no open threads. The first Apex
review scored 3/5 and found startup latency from remote proof lookups
and removal retry identity changes across provider capability changes.
Both corrections are pushed in `9d1a38df3d`, with the qualified
destination-ref length fix. Red regressions reproduced each issue.
Latest targeted checks passed: cleanup/worker 26, provider integration
41, SDK contract 8. Head `9d1a38df3d` passed standard and Apex reviews
at 5/5 with no open threads, plus all CI including full build/typecheck.
Canary Dry Run initially failed on an npm 404 fetching
`rollup-4.67.3.tgz`; the exact tarball subsequently returned HTTP 200,
and one targeted retry passed without source changes. Aggregate
verification also passed. After #18403 merged, master introduced
conflicts in shared workspace cleanup and metadata handling. Resolved
them in `7700832536`, preserving remote snapshot cleanup and Git
delivery-proof cleanup. Targeted merge verification: 93 tests passed in
the first run (59 opt-in skips), then all 16 remote lifecycle tests
passed with explicit database opt-in; map checks passed. The isolated
database is stopped. The merge head received standard review 5/5. Its CI
found two failures in unchanged test cleanup paths: native runtime
temporary-directory ENOTEMPTY and agent-chat cancellation lock timeout.
Those failures remain recorded and require successful final-head
verification. The subsequent project-consent change has targeted
coverage: authorization36, resolver33 and cleanup19 tests passed,
including revoked consent, anonymous public access and source-binding
races. The positive consent test failed before the fix. Current head
`c772679e05` has green GitHub CI, including full build/typecheck and
both previously failing test jobs, plus standard Greptile 5/5 with no
open threads. Neither cleanup failure required changes to its test path.
Apex also completed at 5/5 on this exact head (check `124651548532`,
summary updated 2026-10-31 20:45 UTC), with no open review threads. The
PR remains draft. Earlier failures remain recorded above.

- Final focused run on the rebased branch: **182 tests passed across six
files**, covering the resolver, delivery cleanup, provider bridge,
finalization notifications, existing workspace service and SDK
contracts. The disposable test database was stopped afterward.
- Targeted resolver tests: 33 passed. These cover ancestry, discovered
squash PRs, wrong HEAD/base/repository, removed integration commits,
bounded responses, cancellation and credential isolation.
- Targeted cleanup integration tests: 17 passed. Provider bridge
integration: 36 passed. SDK contract tests: 7 passed. Finalization
notification tests: 9 passed.
- A negative control that removed the final delivery check failed the
race regression as expected. The check was restored.
- Read-only live GitHub probe: the new resolver discovered PR #18410
from HEAD `3f5ade4cd42b707040e9a82fdaed343e3d736a09`, without PR hints.
It proved integration commit `6484f96c28bfb11a793ce4be6cc5ac15643a5a02`
reachable from observed master
`5bc029bf6c1db6647e96acea323f3723fd1d3eba`. GitHub also advertised the
exact original HEAD at `refs/pull/18410/head`.
- `node scripts/check-maps.mjs` passed. Structural checks do not prove
deployment behavior.
- Local tests are targeted by user request. Full build, typecheck and
test suite run in GitHub CI. A standalone server typecheck could not
complete because local Runner build declarations were absent; no
changed-file diagnostics were reported.
- Initial local execution hit a stalled pnpm wrapper, sandbox socket
denial and stale generated SDK declarations. Direct installed binaries,
the authorized isolated test database and rebuilt SDK resolved those
setup failures. No deployment was performed.

## Risks

- Destructive cleanup still requires fresh storage safety and lifecycle
checks. Remote proof alone never authorizes removal. A persisted removal
intent preserves existing recovery semantics.
- Legacy workspaces without an unambiguous destination or completion
HEAD remain retained. This does not guess the original default branch.
- Private repositories use the explicit standing GitHub consent on the
bound source project, with current membership, grant, repository access
and trust checks. No separate company token is required when that
consent is valid. Missing or revoked consent and unavailable or
rate-limited access retain storage; the worker does not borrow a task or
agent identity.
- A known undelivered commit keeps the existing five-minute retry
because external GitHub changes have no guaranteed ingress to this lane.
This can keep cleanup scheduled. Missing evidence parks instead.
- Providers need the new recovery capability to clean a squash merge
whose original HEAD is reachable only through its PR ref. Providers
without it remain conservative.
- The resolver currently supports GitHub.com. Existing local and
other-provider ancestry paths stay in place.

## Model Used

OpenAI Codex, GPT-6 family, with reasoning, repository tools and
parallel code agents. The exact runtime model ID and context-window size
were not exposed to this session.

## 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
- [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 07:59:17 -08:00

797 lines
34 KiB
TypeScript

import { notifyAttentionRetentionWork, notifyIssueAttentionRetentionWork } from "./retention-work-notifications.js";
import { notifyNativeResultCommit } from "./native-result-commit-notifications.js";
import { notifyNativeWorkspaceFinalization } from "./native-workspace-finalization-notifications.js";
import { notifyNativeStatusReassessment } from "./native-status-reassessment-notifications.js";
import { notifyTerminalWorkspaceWork } from "./terminal-workspace-work.js";
import { randomUUID } from "node:crypto";
import type { Db } from "@paperclipai/db";
import { workspaceOperations } from "@paperclipai/db";
import type { WorkspaceOperation, WorkspaceOperationPhase, WorkspaceOperationStatus } from "@paperclipai/shared";
import { asc, desc, eq, gte, inArray, isNull, lt, or, and } from "drizzle-orm";
import { conflict, notFound } from "../errors.js";
import { redactCurrentUserText, redactCurrentUserValue } from "../log-redaction.js";
import { instanceSettingsService } from "./instance-settings.js";
import { getWorkspaceOperationLogStore } from "./workspace-operation-log-store.js";
type WorkspaceOperationRow = typeof workspaceOperations.$inferSelect;
/**
* Managed runtime control actions. Every one of these mutates the runtime rows and
* local listeners of a single execution workspace, so only one may be live at a time.
*/
const RUNTIME_CONTROL_ACTIONS = new Set(["start", "stop", "restart", "repair", "run"]);
/**
* Identity of this server process. A `running` runtime-control operation stamped with a
* different owner id can only have been left behind by another (now gone) process, which
* is what makes bounded recovery safe: we never guess about our own live operations.
*/
const RUNTIME_CONTROL_OWNER_ID = randomUUID();
/** How often a live operation refreshes its ownership stamp. */
export const RUNTIME_CONTROL_HEARTBEAT_MS = 10_000;
/**
* How long an operation may go without a heartbeat before another owner may terminalize
* it. Deliberately several heartbeat intervals so a slow-but-live start is never stolen.
*/
export const RUNTIME_CONTROL_STALE_AFTER_MS = 60_000;
/**
* Last-resort ceiling for a managed runtime lifecycle control. Past this the operation is
* failed by its own owner so it always reaches a terminal state, even when the underlying
* start hangs on an unresponsive process or provider that keeps the owner alive. Generous
* enough to cover a cold runtime provision (a full dependency install) on a large repo.
*/
export const RUNTIME_CONTROL_MAX_DURATION_MS = 30 * 60_000;
/**
* Workspace jobs are operator-authored commands (builds, migrations, test suites) that can
* legitimately run far longer than a lifecycle control, so they get a much wider ceiling —
* still finite, so a wedged job cannot hold the workspace forever.
*/
export const WORKSPACE_JOB_MAX_DURATION_MS = 4 * 60 * 60_000;
function defaultRuntimeControlTimeoutMs(action: string | null) {
if (!action) return null;
return action === "run" ? WORKSPACE_JOB_MAX_DURATION_MS : RUNTIME_CONTROL_MAX_DURATION_MS;
}
export class WorkspaceOperationTimeoutError extends Error {
constructor(public readonly timeoutMs: number, action: string | null) {
super(
`Managed workspace ${action ?? "runtime"} operation exceeded its ${Math.round(timeoutMs / 1000)}s time budget and was failed so it can be retried or stopped.`,
);
this.name = "WorkspaceOperationTimeoutError";
}
}
type RuntimeControlOwnerStamp = {
ownerId: string;
pid: number;
action: string;
heartbeatAt: string;
};
function readRuntimeControlAction(metadata: unknown): string | null {
if (!metadata || typeof metadata !== "object") return null;
const action = (metadata as Record<string, unknown>).action;
if (typeof action !== "string" || !RUNTIME_CONTROL_ACTIONS.has(action)) return null;
return action;
}
function readRuntimeControlOwner(metadata: unknown): RuntimeControlOwnerStamp | null {
if (!metadata || typeof metadata !== "object") return null;
const owner = (metadata as Record<string, unknown>).runtimeControlOwner;
if (!owner || typeof owner !== "object") return null;
const record = owner as Record<string, unknown>;
if (typeof record.ownerId !== "string") return null;
return {
ownerId: record.ownerId,
pid: typeof record.pid === "number" ? record.pid : 0,
action: typeof record.action === "string" ? record.action : "start",
heartbeatAt: typeof record.heartbeatAt === "string" ? record.heartbeatAt : new Date(0).toISOString(),
};
}
/**
* Operation ids this process is actively driving. An operation owned by this process but
* missing from this set can only be a leftover from a request that died without unwinding,
* so it is safe to terminalize immediately instead of waiting out the staleness window.
*/
const liveRuntimeControlOperationIds = new Set<string>();
type NativeFinalizationActivityScope = {
operationId: string;
companyId: string;
runId: string;
issueId: string;
};
// Presentation-only positive proof. Persisted running rows can outlive a crash;
// this registry only exists while this process awaits the actual export callback.
const liveNativeFinalizationOperations = new Map<string, NativeFinalizationActivityScope>();
export function isNativeWorkspaceFinalizationOperationActive(scope: NativeFinalizationActivityScope): boolean {
const active = liveNativeFinalizationOperations.get(scope.operationId);
return Boolean(active && active.companyId === scope.companyId
&& active.runId === scope.runId && active.issueId === scope.issueId);
}
/**
* Whether the process that stamped an operation is still alive on this host. A dead owner can
* never heartbeat again, so its operation is recoverable immediately instead of after the
* staleness window — which is what makes recovery after a crash or restart prompt. Signal 0
* only probes; it never touches the process.
*/
function ownerProcessIsAlive(pid: number): boolean {
if (!Number.isInteger(pid) || pid <= 0) return false;
try {
process.kill(pid, 0);
return true;
} catch (error) {
// EPERM means the pid exists but belongs to another user: treat it as alive.
return (error as NodeJS.ErrnoException)?.code === "EPERM";
}
}
/**
* Compare-and-swap predicate for an operation's `updated_at`.
*
* Postgres stores `timestamptz` at microsecond precision but the driver hands JS a
* millisecond-precision `Date`, so an `=` against the value we just read never matches a row
* whose timestamp came from the column's `defaultNow()` — which is exactly the shape of every
* row a pre-recovery build left behind, i.e. the stranded operations this sweep exists to
* clear. Matching the millisecond bucket instead is still a true CAS: a concurrent heartbeat
* writes a `Date` in a different millisecond, so it still wins the row.
*/
function updatedAtUnchanged(updatedAt: Date) {
return and(
gte(workspaceOperations.updatedAt, updatedAt),
lt(workspaceOperations.updatedAt, new Date(updatedAt.getTime() + 1)),
);
}
export function resetWorkspaceRuntimeControlStateForTests() {
liveRuntimeControlOperationIds.clear();
}
export function workspaceRuntimeControlOwnerIdForTests() {
return RUNTIME_CONTROL_OWNER_ID;
}
/**
* Same-process serialization of managed runtime controls. The durable sweep below is what
* recovers stranded operations across processes; this in-memory claim is the cheaper first
* line of defense that rejects an overlapping control in this process before any row is
* written. Kept from the runtime-lease chain (PAP-17205) and composed with the ownership
* machinery above: the claim is taken before the operation row exists, so a recovery sweep
* can never see a live control it is not yet tracking.
*/
const activeRuntimeControls = new Map<string, { action: string; startedAt: Date }>();
export async function runExclusiveWorkspaceRuntimeControl<T>(input: {
executionWorkspaceId: string;
action: string;
run: () => Promise<T>;
}): Promise<T> {
const active = activeRuntimeControls.get(input.executionWorkspaceId);
if (active) {
throw conflict("A managed runtime control operation is already in progress for this execution workspace.", {
code: "workspace_runtime_control_in_progress",
executionWorkspaceId: input.executionWorkspaceId,
activeAction: active.action,
requestedAction: input.action,
startedAt: active.startedAt.toISOString(),
remediation: "Wait for the active operation to reach a terminal state before retrying.",
});
}
const claim = { action: input.action, startedAt: new Date() };
activeRuntimeControls.set(input.executionWorkspaceId, claim);
try {
return await input.run();
} finally {
if (activeRuntimeControls.get(input.executionWorkspaceId) === claim) {
activeRuntimeControls.delete(input.executionWorkspaceId);
}
}
}
export function resetWorkspaceRuntimeControlLocksForTests() {
activeRuntimeControls.clear();
}
function toWorkspaceOperation(row: WorkspaceOperationRow): WorkspaceOperation {
return {
id: row.id,
companyId: row.companyId,
executionWorkspaceId: row.executionWorkspaceId ?? null,
heartbeatRunId: row.heartbeatRunId ?? null,
issueId: row.issueId ?? null,
phase: row.phase as WorkspaceOperationPhase,
command: row.command ?? null,
cwd: row.cwd ?? null,
status: row.status as WorkspaceOperationStatus,
exitCode: row.exitCode ?? null,
logStore: row.logStore ?? null,
logRef: row.logRef ?? null,
logBytes: row.logBytes ?? null,
logSha256: row.logSha256 ?? null,
logCompressed: row.logCompressed,
stdoutExcerpt: row.stdoutExcerpt ?? null,
stderrExcerpt: row.stderrExcerpt ?? null,
metadata: (row.metadata as Record<string, unknown> | null) ?? null,
startedAt: row.startedAt,
finishedAt: row.finishedAt ?? null,
createdAt: row.createdAt,
updatedAt: row.updatedAt,
};
}
function appendExcerpt(current: string, chunk: string) {
return `${current}${chunk}`.slice(-4096);
}
function combineMetadata(
base: Record<string, unknown> | null | undefined,
patch: Record<string, unknown> | null | undefined,
) {
if (!base && !patch) return null;
return {
...(base ?? {}),
...(patch ?? {}),
};
}
export interface WorkspaceOperationRecorder {
attachExecutionWorkspaceId(executionWorkspaceId: string | null): Promise<void>;
recordOperation(input: {
phase: WorkspaceOperationPhase;
command?: string | null;
cwd?: string | null;
metadata?: Record<string, unknown> | null;
/**
* Wall-clock ceiling for `run`. On expiry the operation is failed (terminal) and the
* timeout error is rethrown, so a hung provider can never leave an active operation.
*/
timeoutMs?: number | null;
/** Publish the running row under a caller-owned admission fence before run starts. */
admit?: (publish: () => Promise<void>) => Promise<void>;
run: (reportProgress: (input: {
metadata?: Record<string, unknown> | null;
system?: string | null;
}) => Promise<void>) => Promise<{
status?: WorkspaceOperationStatus;
exitCode?: number | null;
stdout?: string | null;
stderr?: string | null;
system?: string | null;
metadata?: Record<string, unknown> | null;
}>;
}): Promise<WorkspaceOperation>;
}
export function workspaceOperationService(db: Db) {
const instanceSettings = instanceSettingsService(db);
const logStore = getWorkspaceOperationLogStore();
async function getById(id: string) {
const row = await db
.select()
.from(workspaceOperations)
.where(eq(workspaceOperations.id, id))
.then((rows) => rows[0] ?? null);
return row ? toWorkspaceOperation(row) : null;
}
/**
* Terminalize `running` managed runtime-control operations that no live owner can still
* be driving, and return the ones that are genuinely still live.
*
* Recovery is bounded on both axes: an operation owned by another server process is only
* reclaimed after {@link RUNTIME_CONTROL_STALE_AFTER_MS} without a heartbeat, and the
* terminalizing UPDATE is a compare-and-swap on `updated_at`, so an owner that heartbeats
* concurrently keeps its operation. Only this process's own abandoned operations (owned
* by us but no longer tracked in-process) are reclaimed without waiting.
*/
async function sweepRuntimeControlOperations(
executionWorkspaceId: string | null | undefined,
options?: { now?: Date; staleAfterMs?: number },
) {
const now = options?.now ?? new Date();
const staleAfterMs = options?.staleAfterMs ?? RUNTIME_CONTROL_STALE_AFTER_MS;
const candidates = await db
.select()
.from(workspaceOperations)
.where(
executionWorkspaceId
? and(
eq(workspaceOperations.executionWorkspaceId, executionWorkspaceId),
eq(workspaceOperations.status, "running"),
)
: eq(workspaceOperations.status, "running"),
);
const reconciledIds: string[] = [];
const live: WorkspaceOperation[] = [];
for (const candidate of candidates) {
// Migration owns the workspace until its explicit publication/repair. It
// has no runtime-control action stamp and must never be swept as abandoned.
if (candidate.phase === "remote_workspace_migration") {
live.push(toWorkspaceOperation(candidate));
continue;
}
const action = readRuntimeControlAction(candidate.metadata);
if (!action) continue;
const owner = readRuntimeControlOwner(candidate.metadata);
const lastSignalAt = owner
? new Date(owner.heartbeatAt)
: (candidate.updatedAt ?? candidate.startedAt ?? new Date(0));
const silentForMs = now.getTime() - lastSignalAt.getTime();
const ownedByThisProcess = owner?.ownerId === RUNTIME_CONTROL_OWNER_ID;
const abandonedByThisProcess = ownedByThisProcess && !liveRuntimeControlOperationIds.has(candidate.id);
const ownedHereAndLive = ownedByThisProcess && liveRuntimeControlOperationIds.has(candidate.id);
// A previous server process that no longer exists cannot heartbeat again, so its
// operations are recoverable at once instead of after the staleness window.
const ownerProcessGone = owner !== null && !ownedByThisProcess && !ownerProcessIsAlive(owner.pid);
if (ownedHereAndLive) {
// This process is driving it right now; its own time budget is what terminalizes it.
live.push(toWorkspaceOperation(candidate));
continue;
}
if (!abandonedByThisProcess && !ownerProcessGone && silentForMs < staleAfterMs) {
live.push(toWorkspaceOperation(candidate));
continue;
}
const finishedAt = new Date();
const reconciliationMessage =
`Reconciled stale managed runtime ${action} operation: ${
ownerProcessGone
? `the owning server process (pid ${owner?.pid}) is gone`
: abandonedByThisProcess
? "the owning request no longer exists"
: `no live owner has reported progress for ${Math.round(silentForMs / 1000)}s`
}, so the operation was failed to release the execution workspace for retry or stop.\n`;
// Compare-and-swap on `updated_at`: a live owner that heartbeats between the read and
// this write moves the column and keeps its operation.
const claimed = await db
.update(workspaceOperations)
.set({
status: "failed",
stderrExcerpt: appendExcerpt(candidate.stderrExcerpt ?? "", reconciliationMessage),
metadata: combineMetadata(candidate.metadata as Record<string, unknown> | null, {
reconciled: true,
reconciliationReason: abandonedByThisProcess
? "abandoned_runtime_control"
: "orphaned_runtime_control",
reconciledAt: finishedAt.toISOString(),
}),
finishedAt,
updatedAt: finishedAt,
})
.where(
and(
eq(workspaceOperations.id, candidate.id),
eq(workspaceOperations.status, "running"),
candidate.updatedAt
? updatedAtUnchanged(candidate.updatedAt)
: isNull(workspaceOperations.updatedAt),
),
)
.returning({ id: workspaceOperations.id })
.then((rows) => rows[0] ?? null);
if (!claimed) {
// Someone else moved the row; re-read so callers see the current truth.
const refreshed = await getById(candidate.id);
if (refreshed?.status === "running") live.push(refreshed);
continue;
}
liveRuntimeControlOperationIds.delete(candidate.id);
reconciledIds.push(candidate.id);
if (candidate.logStore && candidate.logRef) {
const handle = {
store: candidate.logStore as "local_file",
logRef: candidate.logRef,
};
try {
await logStore.append(handle, {
stream: "stderr",
chunk: reconciliationMessage,
ts: finishedAt.toISOString(),
});
const finalized = await logStore.finalize(handle);
await db
.update(workspaceOperations)
.set({
logBytes: finalized.bytes,
logSha256: finalized.sha256,
logCompressed: finalized.compressed,
updatedAt: new Date(),
})
.where(eq(workspaceOperations.id, candidate.id));
} catch {
// The terminal row and stderr excerpt stay inspectable even when the external log
// file from the previous process is gone.
}
}
}
return { reconciled: reconciledIds.length, operationIds: reconciledIds, live };
}
return {
getById,
/**
* Bounded recovery entrypoint. Safe to call on startup and before every managed control.
*/
async reconcileStaleRuntimeControlOperations(
executionWorkspaceId?: string | null,
options?: { now?: Date; staleAfterMs?: number },
) {
const result = await sweepRuntimeControlOperations(executionWorkspaceId, options);
return { reconciled: result.reconciled, operationIds: result.operationIds };
},
/**
* Refuse a managed runtime control while another one is genuinely live for the same
* execution workspace. Stale operations are recovered first, so a workspace stranded by
* a dead request or a previous server process becomes controllable again on its own.
*/
async assertRuntimeControlAvailable(input: {
executionWorkspaceId: string;
action: string;
options?: { now?: Date; staleAfterMs?: number };
}) {
const { live } = await sweepRuntimeControlOperations(input.executionWorkspaceId, input.options);
const blocking = live[0];
if (!blocking) return;
const owner = readRuntimeControlOwner(blocking.metadata);
throw conflict("A managed runtime control operation is already in progress for this execution workspace.", {
code: "workspace_runtime_control_in_progress",
executionWorkspaceId: input.executionWorkspaceId,
activeAction: readRuntimeControlAction(blocking.metadata) ?? owner?.action ?? null,
requestedAction: input.action,
activeOperationId: blocking.id,
startedAt: blocking.startedAt instanceof Date ? blocking.startedAt.toISOString() : blocking.startedAt,
remediation:
"Wait for the active operation to reach a terminal state before retrying; abandoned operations are recovered automatically.",
});
},
createRecorder(input: {
companyId: string;
heartbeatRunId?: string | null;
executionWorkspaceId?: string | null;
issueId?: string | null;
}): WorkspaceOperationRecorder {
let executionWorkspaceId = input.executionWorkspaceId ?? null;
const createdIds: string[] = [];
let hasFinalization = false;
return {
async attachExecutionWorkspaceId(nextExecutionWorkspaceId) {
executionWorkspaceId = nextExecutionWorkspaceId ?? null;
if (!executionWorkspaceId || createdIds.length === 0) return;
await db.transaction(async tx => {
if (hasFinalization) await notifyTerminalWorkspaceWork(tx, `workspace:${executionWorkspaceId}`);
await tx
.update(workspaceOperations)
.set({ executionWorkspaceId, updatedAt: new Date() })
.where(and(eq(workspaceOperations.companyId, input.companyId), inArray(workspaceOperations.id, createdIds)));
});
},
async recordOperation(recordInput) {
async function writeState<T>(write: (database: Db) => Promise<T>): Promise<T> {
if (recordInput.phase !== "workspace_finalize" || (!input.heartbeatRunId && !executionWorkspaceId && !input.issueId)) return write(db);
return db.transaction(async tx => {
if (executionWorkspaceId) await notifyTerminalWorkspaceWork(tx, `workspace:${executionWorkspaceId}`);
else if (input.issueId) await notifyTerminalWorkspaceWork(tx, `issue:${input.issueId}`);
if (!input.heartbeatRunId) {
// An export clears barriers for every issue sharing this workspace.
if (executionWorkspaceId) await notifyAttentionRetentionWork(tx, { companyId: input.companyId, sourceKind: "blocker_attention" });
else await notifyIssueAttentionRetentionWork(tx, { companyId: input.companyId, issueId: input.issueId ?? undefined });
return write(tx as unknown as Db);
}
await notifyNativeResultCommit(tx, { companyId: input.companyId,
runId: input.heartbeatRunId!, issueId: input.issueId ?? undefined });
await notifyNativeWorkspaceFinalization(tx, { companyId: input.companyId,
runId: input.heartbeatRunId!, issueId: input.issueId ?? undefined });
await notifyNativeStatusReassessment(tx, { companyId: input.companyId,
runId: input.heartbeatRunId!, issueId: input.issueId ?? undefined });
return write(tx as unknown as Db);
});
}
const currentUserRedactionOptions = {
enabled: (await instanceSettings.getGeneral()).censorUsernameInLogs,
};
const startedAt = new Date();
const id = randomUUID();
const handle = await logStore.begin({
companyId: input.companyId,
operationId: id,
});
let stdoutExcerpt = "";
let stderrExcerpt = "";
const append = async (stream: "stdout" | "stderr" | "system", chunk: string | null | undefined) => {
if (!chunk) return;
const sanitizedChunk = redactCurrentUserText(chunk, currentUserRedactionOptions);
if (stream === "stdout") stdoutExcerpt = appendExcerpt(stdoutExcerpt, sanitizedChunk);
if (stream === "stderr") stderrExcerpt = appendExcerpt(stderrExcerpt, sanitizedChunk);
await logStore.append(handle, {
stream,
chunk: sanitizedChunk,
ts: new Date().toISOString(),
});
};
// Managed runtime controls get an ownership stamp so bounded recovery can tell a
// slow-but-live operation from one abandoned by a dead request or server process.
const runtimeControlAction = readRuntimeControlAction(recordInput.metadata);
let currentMetadata = runtimeControlAction
? {
...(recordInput.metadata ?? {}),
runtimeControlOwner: {
ownerId: RUNTIME_CONTROL_OWNER_ID,
pid: process.pid,
action: runtimeControlAction,
heartbeatAt: startedAt.toISOString(),
} satisfies RuntimeControlOwnerStamp,
}
: recordInput.metadata ?? null;
// Claim in-process before the row exists, so there is no ordering in which a recovery
// sweep can observe an operation stamped by this process but not yet tracked by it —
// which is the one state that would let recovery terminalize a genuinely live start.
if (runtimeControlAction) liveRuntimeControlOperationIds.add(id);
try {
let published = false;
const publish = async () => { await writeState(database => database.insert(workspaceOperations).values({
id,
companyId: input.companyId,
executionWorkspaceId,
heartbeatRunId: input.heartbeatRunId ?? null,
issueId: input.issueId ?? null,
phase: recordInput.phase,
command: recordInput.command ?? null,
cwd: recordInput.cwd ?? null,
status: "running",
logStore: handle.store,
logRef: handle.logRef,
metadata: redactCurrentUserValue(
currentMetadata,
currentUserRedactionOptions,
) as Record<string, unknown> | null,
startedAt,
updatedAt: startedAt,
})); published = true; };
if (recordInput.admit) await recordInput.admit(publish);
else await publish();
if (!published) throw new Error("Workspace operation admission did not publish its running row");
} catch (insertError) {
liveRuntimeControlOperationIds.delete(id);
throw insertError;
}
createdIds.push(id);
if (recordInput.phase === "workspace_finalize") hasFinalization = true;
let heartbeatTimer: NodeJS.Timeout | null = null;
let timeoutTimer: NodeJS.Timeout | null = null;
if (runtimeControlAction) {
heartbeatTimer = setInterval(() => {
const heartbeatAt = new Date();
currentMetadata = combineMetadata(currentMetadata, {
runtimeControlOwner: {
ownerId: RUNTIME_CONTROL_OWNER_ID,
pid: process.pid,
action: runtimeControlAction,
heartbeatAt: heartbeatAt.toISOString(),
} satisfies RuntimeControlOwnerStamp,
});
void db
.update(workspaceOperations)
.set({
metadata: redactCurrentUserValue(
currentMetadata,
currentUserRedactionOptions,
) as Record<string, unknown> | null,
updatedAt: heartbeatAt,
})
.where(and(eq(workspaceOperations.id, id), eq(workspaceOperations.status, "running")))
.catch(() => undefined);
}, RUNTIME_CONTROL_HEARTBEAT_MS);
heartbeatTimer.unref?.();
}
const reportProgress = async (progress: {
metadata?: Record<string, unknown> | null;
system?: string | null;
}) => {
await append("system", progress.system ?? null);
currentMetadata = combineMetadata(currentMetadata, progress.metadata);
await db
.update(workspaceOperations)
.set({
metadata: redactCurrentUserValue(
currentMetadata,
currentUserRedactionOptions,
) as Record<string, unknown> | null,
stdoutExcerpt: stdoutExcerpt || null,
stderrExcerpt: stderrExcerpt || null,
updatedAt: new Date(),
})
.where(and(eq(workspaceOperations.id, id), eq(workspaceOperations.status, "running")));
};
const timeoutMs = recordInput.timeoutMs ?? defaultRuntimeControlTimeoutMs(runtimeControlAction);
const runWithActivity = async () => {
const nativeFinalization = recordInput.phase === "workspace_finalize"
&& recordInput.metadata?.owningService === "native_workspace_finalizer"
&& input.heartbeatRunId && input.issueId;
if (nativeFinalization) liveNativeFinalizationOperations.set(id, {
operationId: id, companyId: input.companyId,
runId: input.heartbeatRunId!, issueId: input.issueId!,
});
try {
return await recordInput.run(reportProgress);
} finally {
// Join the underlying callback, even if the recorder's timeout
// already fired. A deadline cannot prove physical export stopped.
liveNativeFinalizationOperations.delete(id);
}
};
const settle = async () => {
if (!timeoutMs || timeoutMs <= 0) return await runWithActivity();
const timeout = new Promise<never>((_resolve, reject) => {
timeoutTimer = setTimeout(
() => reject(new WorkspaceOperationTimeoutError(timeoutMs, runtimeControlAction)),
timeoutMs,
);
timeoutTimer.unref?.();
});
return await Promise.race([runWithActivity(), timeout]);
};
try {
const result = await settle();
await append("system", result.system ?? null);
await append("stdout", result.stdout ?? null);
await append("stderr", result.stderr ?? null);
const finalized = await logStore.finalize(handle);
const finishedAt = new Date();
const row = await writeState(database => database
.update(workspaceOperations)
.set({
executionWorkspaceId,
status: result.status ?? "succeeded",
exitCode: result.exitCode ?? null,
stdoutExcerpt: stdoutExcerpt || null,
stderrExcerpt: stderrExcerpt || null,
logBytes: finalized.bytes,
logSha256: finalized.sha256,
logCompressed: finalized.compressed,
metadata: redactCurrentUserValue(
combineMetadata(currentMetadata, result.metadata),
currentUserRedactionOptions,
) as Record<string, unknown> | null,
finishedAt,
updatedAt: finishedAt,
})
.where(eq(workspaceOperations.id, id))
.returning()
.then((rows) => rows[0] ?? null));
if (!row) throw notFound("Workspace operation not found");
return toWorkspaceOperation(row);
} catch (error) {
// The log file is best-effort once the operation has failed: a log write error (for
// example ENOSPC on a full disk) must neither strand this row in `running` nor replace
// the operation's own error. The excerpt still records the message.
await append("stderr", error instanceof Error ? error.message : String(error)).catch(() => undefined);
const finalized = await logStore.finalize(handle).catch(() => null);
const finishedAt = new Date();
await writeState(database => database
.update(workspaceOperations)
.set({
executionWorkspaceId,
status: "failed",
stdoutExcerpt: stdoutExcerpt || null,
stderrExcerpt: stderrExcerpt || null,
logBytes: finalized?.bytes ?? null,
logSha256: finalized?.sha256 ?? null,
logCompressed: finalized?.compressed ?? false,
// Only managed controls carry a failure reason; other phases keep the metadata
// they were recorded with.
...(runtimeControlAction
? {
metadata: redactCurrentUserValue(
combineMetadata(currentMetadata, {
failureReason: error instanceof WorkspaceOperationTimeoutError
? "runtime_control_timeout"
: "runtime_control_error",
}),
currentUserRedactionOptions,
) as Record<string, unknown> | null,
}
: {}),
finishedAt,
updatedAt: finishedAt,
})
.where(eq(workspaceOperations.id, id)));
throw error;
} finally {
// Releasing the in-process claim before the request unwinds is what lets the very
// next control call proceed, and lets recovery treat a leftover row as abandoned.
if (heartbeatTimer) clearInterval(heartbeatTimer);
if (timeoutTimer) clearTimeout(timeoutTimer);
liveRuntimeControlOperationIds.delete(id);
}
},
};
},
listForRun: async (runId: string, executionWorkspaceId?: string | null) => {
const conditions = [eq(workspaceOperations.heartbeatRunId, runId)];
if (executionWorkspaceId) {
const cleanupCondition = and(
eq(workspaceOperations.executionWorkspaceId, executionWorkspaceId)!,
isNull(workspaceOperations.heartbeatRunId),
)!;
if (cleanupCondition) conditions.push(cleanupCondition);
}
const rows = await db
.select()
.from(workspaceOperations)
.where(conditions.length === 1 ? conditions[0]! : or(...conditions)!)
.orderBy(asc(workspaceOperations.startedAt), asc(workspaceOperations.createdAt), asc(workspaceOperations.id));
return rows.map(toWorkspaceOperation);
},
listForExecutionWorkspace: async (executionWorkspaceId: string) => {
const rows = await db
.select()
.from(workspaceOperations)
.where(eq(workspaceOperations.executionWorkspaceId, executionWorkspaceId))
.orderBy(desc(workspaceOperations.startedAt), desc(workspaceOperations.createdAt));
return rows.map(toWorkspaceOperation);
},
readLog: async (operationId: string, opts?: { offset?: number; limitBytes?: number }) => {
const operation = await getById(operationId);
if (!operation) throw notFound("Workspace operation not found");
if (!operation.logStore || !operation.logRef) throw notFound("Workspace operation log not found");
const result = await logStore.read(
{
store: operation.logStore as "local_file",
logRef: operation.logRef,
},
opts,
);
return {
operationId,
store: operation.logStore,
logRef: operation.logRef,
...result,
// Workspace-operation log chunks are sanitized before append-time storage.
// Returning the stored chunk avoids another whole-string rewrite per poll.
content: result.content,
};
},
};
}
export { toWorkspaceOperation };