mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-08 01:57:31 +01:00
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work.
> - #19260 shows the saved-work recovery step on a task, and records why
a recovery attempt failed.
> - The review of #19260 found three gaps after the PR merged.
> - A scheduled recovery offered Retry while a Retry preparation was
already pending.
> - Classified failures could get a misleading `provider_error` cause.
> - The new cause text in the board handoff had no test.
> - This pull request closes these gaps.
> - The benefit is a Retry button that matches what is allowed, and
causes that name the correct subsystem.
## Linked Issues or Issue Description
Refs #19260
**What happened?**
After #19260, a task with a scheduled recovery and a pending (`issued`
or `processing`) Retry preparation showed an active Retry button. The
server only coalesces the second request. Also, a failure that recovery
classified as `archive_unsafe`, `source_unavailable` or
`snapshot_verification_failed` still recorded a provider cause. The
handoff text could then read "last failure: archive_unsafe, cause:
provider_error".
**Expected behavior**
Retry is not offered while a Retry preparation is pending. Only the
generic transient fallback records a provider cause.
**Steps to reproduce**
1. Request a chat Retry on a task while its saved-work recovery is
scheduled.
2. The task projection returns `retry_scheduled` with `canRetry: true`.
**Paperclip version or commit**
master at b1d00eec.
**Deployment mode**
Authenticated cloud deployment (staging).
## What Changed
- `task-interruption-presentation.ts`: a scheduled recovery returns
`canRetry: false` when a Retry preparation for the same run is pending
with a valid deadline.
- `workspace-recovery.ts`: a cause is recorded only for the generic
transient fallback (`provider_unavailable` or `export_interrupted` from
an unclassified error).
- Tests: presentation `canRetry` with and without a pending preparation;
the board handoff text with and without a cause.
## Verification
- `task-interruption-presentation.test.ts`,
`system-recovery-state.test.ts` and `workspace-recovery.test.ts` pass
(419 tests). One workspace-recovery case failed once under full-suite
load. It passes when it runs alone.
- Server typecheck passes.
## Risks
- Low risk. This change affects presentation and diagnostic labels only.
Retry admission still checks all gates on the server.
## Model Used
- Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, with tool use and code
execution in Claude Code.
## 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
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
221 lines
15 KiB
TypeScript
221 lines
15 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import { projectTaskInterruption } from "./task-interruption-presentation.js";
|
|
|
|
const issue = { id: "task", companyId: "11111111-1111-4111-8111-111111111111", status: "blocked", assigneeAgentId: "agent", projectId: "22222222-2222-4222-8222-222222222222" };
|
|
const run = { id: "run", agentId: "agent", status: "failed", scheduledRetryAt: null,
|
|
errorCode: "project_access_denied", error: null, livenessState: null,
|
|
resultJson: { projectAccessDenied: { projectId: "22222222-2222-4222-8222-222222222222" } } };
|
|
const agent = { status: "idle", pauseReason: null };
|
|
|
|
describe("unadmitted chat Retry presentation", () => {
|
|
const now = Date.parse("2026-01-01T12:00:00Z");
|
|
const failed = { ...run, errorCode: "native_provider_terminal_failed", resultJson: null };
|
|
const wait = { id: "retry", requestedAt: new Date(now), sourceRunId: run.id,
|
|
preparationStatus: "issued", preparationRetryAt: now + 250 };
|
|
const input = { run: failed, agent, wait, paused: false, approval: false };
|
|
|
|
it.each(["issued", "processing"])("uses the persisted %s outbox deadline without implying provider work", status => {
|
|
for (const offset of [0, 20_000]) expect(projectTaskInterruption(issue, {
|
|
...input, wait: { ...wait, preparationStatus: status },
|
|
}, now + offset)).toMatchObject({ state: "retry_scheduled", canRetry: false,
|
|
nextRetryAt: new Date(wait.preparationRetryAt).toISOString() });
|
|
});
|
|
|
|
it.each(["failed", "cancelled"])("keeps terminal %s preparation out of the working state", status => {
|
|
expect(projectTaskInterruption(issue, { ...input, wait: { ...wait, preparationStatus: status,
|
|
preparationRetryAt: null } }, now)).toMatchObject({ state: "failed", nextRetryAt: null });
|
|
});
|
|
|
|
it("keeps current gates and admitted execution authoritative", () => {
|
|
expect(projectTaskInterruption(issue, { ...input, paused: true }, now))
|
|
.toMatchObject({ state: "waiting_for_user", userAction: "resume" });
|
|
expect(projectTaskInterruption(issue, { ...input, approval: true }, now))
|
|
.toMatchObject({ state: "waiting_for_user", userAction: "approval" });
|
|
for (const status of ["queued", "running"]) expect(projectTaskInterruption(issue, {
|
|
...input, run: { ...failed, id: "successor", status },
|
|
}, now)).toMatchObject({ state: "working", nextRetryAt: null });
|
|
expect(projectTaskInterruption(issue, { ...input, wait: { ...wait, sourceRunId: "old-run" } }, now))
|
|
.toMatchObject({ state: "working", nextRetryAt: null });
|
|
});
|
|
});
|
|
|
|
it("explains a persisted Retry wait without exposing the saved payload", () => {
|
|
const failed = { ...run, errorCode: "native_provider_terminal_failed", resultJson: null };
|
|
const wait = { id: "retry", requestedAt: new Date(), sourceRunId: failed.id,
|
|
executionWaitReason: "workspace_repair_required" };
|
|
const presentation = projectTaskInterruption(issue, { run: failed, agent, wait, paused: false, approval: false });
|
|
expect(presentation).toMatchObject({ state: "failed", canRetry: true,
|
|
retryWait: { reason: "workspace_repair_required", message: "Retry is waiting for Paperclip to recover the saved files. Your message is saved." } });
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, wait: { ...wait, sourceRunId: "another-run" }, paused: false, approval: false }))
|
|
.not.toHaveProperty("retryWait");
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, wait: { ...wait, executionWaitReason: "secret-payload" }, paused: false, approval: false }))
|
|
.toMatchObject({ retryWait: { reason: "execution_recovery", message: "Retry is waiting for execution checks. Your message is saved." } });
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, wait, paused: true, approval: false }))
|
|
.toMatchObject({ state: "waiting_for_user", userAction: "resume" });
|
|
});
|
|
|
|
it.each(["cleanup_quarantined", "cancelled_by_operator"])("does not offer Retry for terminal Retry waits: %s", reason => {
|
|
const failed = { ...run, errorCode: "native_provider_terminal_failed", resultJson: null };
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, paused: false, approval: false,
|
|
wait: { id: "retry", requestedAt: new Date(), sourceRunId: failed.id, executionWaitReason: reason } }))
|
|
.toMatchObject({ state: "failed", canRetry: false, retryWait: { reason } });
|
|
});
|
|
|
|
it("preserves the actual workspace preparation error without changing retry authority", () => {
|
|
const failedRun = { ...run, errorCode: "workspace_validation_failed",
|
|
error: "The selected project has no repository source for a remote workspace.", resultJson: null };
|
|
expect(projectTaskInterruption(issue, { run: failedRun, agent, paused: false, approval: false }))
|
|
.toMatchObject({ state: "failed", canRetry: true, workspaceFailure: { message: failedRun.error } });
|
|
for (const status of ["done", "cancelled"]) expect(projectTaskInterruption({ ...issue, status },
|
|
{ run: failedRun, agent, paused: false, approval: false })).not.toHaveProperty("workspaceFailure");
|
|
expect(projectTaskInterruption(issue, { run: { ...failedRun, errorCode: "unrelated_failure" }, agent, paused: false, approval: false }))
|
|
.not.toHaveProperty("workspaceFailure");
|
|
});
|
|
|
|
function operatorStoppedRun() {
|
|
return { ...run, status: "cancelled", runtimeMode: "native" as const, companyId: issue.companyId,
|
|
nativeIssueId: issue.id, errorCode: "cancelled", resultJson: {
|
|
cancelledByActorType: "user", cancelledByUserId: "board",
|
|
executionCancellation: { state: "requested" },
|
|
nativeCancellation: { schema: "paperclip.native-cancellation.v1", runId: run.id,
|
|
companyId: issue.companyId, issueId: issue.id, scope: "run",
|
|
reasonCode: "cancellation_run_only", dispatched: true, dispatchState: "acknowledged",
|
|
intentAuditId: "intent", acknowledgementAuditId: "ack" },
|
|
} };
|
|
}
|
|
|
|
describe("intentional native Stop presentation", () => {
|
|
const workingIssue = { ...issue, status: "in_progress" };
|
|
it("does not offer a failed-attempt Retry for an audited operator Stop that keeps its task in progress", () => {
|
|
expect(projectTaskInterruption(workingIssue, { run: operatorStoppedRun(), agent, paused: false, approval: false }))
|
|
.toMatchObject({ state: "resolved", canRetry: false, userAction: null });
|
|
expect(workingIssue.status).toBe("in_progress");
|
|
});
|
|
|
|
it.each([{ runId: "foreign" }, { companyId: "foreign" }, { issueId: "foreign" },
|
|
{ dispatchState: "pending" }, { dispatched: false }, { acknowledgementAuditId: undefined },
|
|
{ intentAuditId: 123 }, { acknowledgementAuditId: {} },
|
|
{ scope: "subtree" }])("retains failure presentation without the matching operator receipt %j", change => {
|
|
const stopped = operatorStoppedRun();
|
|
expect(projectTaskInterruption(workingIssue, { run: { ...stopped, resultJson: { ...stopped.resultJson,
|
|
nativeCancellation: { ...stopped.resultJson.nativeCancellation, ...change } } }, agent, paused: false, approval: false }))
|
|
.toMatchObject({ state: "failed", canRetry: true });
|
|
});
|
|
|
|
it("keeps pause, approval, non-user cancellation and new input authoritative", () => {
|
|
const stopped = operatorStoppedRun();
|
|
expect(projectTaskInterruption(workingIssue, { run: stopped, agent, paused: true, approval: false }))
|
|
.toMatchObject({ state: "waiting_for_user", userAction: "resume" });
|
|
expect(projectTaskInterruption(workingIssue, { run: stopped, agent, paused: false, approval: true }))
|
|
.toMatchObject({ state: "waiting_for_user", userAction: "approval" });
|
|
expect(projectTaskInterruption(workingIssue, { run: { ...stopped, resultJson: {
|
|
...stopped.resultJson, cancelledByActorType: "system" } }, agent, paused: false, approval: false }))
|
|
.toMatchObject({ state: "failed", canRetry: true });
|
|
expect(projectTaskInterruption(workingIssue, { run: stopped, agent, paused: false, approval: false,
|
|
wait: { id: "new-input", requestedAt: new Date() } }))
|
|
.toMatchObject({ state: "working", canRetry: false });
|
|
});
|
|
});
|
|
|
|
it("preserves a provider explanation on a failed task without changing retry authority", () => {
|
|
const providerFailure = { schema: "paperclip.provider-failure.v1", provider: "anthropic", phase: "startup",
|
|
category: "rate_limit", message: "API error: 429 This request would exceed your account's rate limit.",
|
|
httpStatus: 429, retryability: "unknown" };
|
|
const failedRun = { ...run, errorCode: "native_session_interrupted", resultJson: { providerFailure } };
|
|
const presentation = projectTaskInterruption(issue, { run: failedRun, agent, paused: false, approval: false });
|
|
expect(presentation).toMatchObject({ state: "failed", canRetry: true, providerFailure });
|
|
expect(projectTaskInterruption({ ...issue, status: "done" }, { run: failedRun, agent, paused: false, approval: false }))
|
|
.not.toHaveProperty("providerFailure");
|
|
});
|
|
|
|
describe("task project-access interruption", () => {
|
|
it("explains a project denial without offering a futile retry", () => {
|
|
expect(projectTaskInterruption(issue, { run, agent, paused: false, approval: false })).toMatchObject({
|
|
state: "waiting_for_user", responsibility: "user", userAction: "project_access", canRetry: false,
|
|
projectAccess: { agentId: "agent", projectId: "22222222-2222-4222-8222-222222222222", ready: false },
|
|
});
|
|
});
|
|
|
|
it("projects the historical setup denial without requiring another failed run", () => {
|
|
expect(projectTaskInterruption(issue, { run: { ...run, errorCode: "setup_failed",
|
|
error: "Project is outside this low-trust boundary.", resultJson: null }, agent, paused: false, approval: false }))
|
|
.toMatchObject({ userAction: "project_access", canRetry: false });
|
|
});
|
|
|
|
it("offers an explicit retry after the project is added, without changing the failed run", () => {
|
|
expect(projectTaskInterruption(issue, { run, agent, projectAccessAllowed: true, paused: false, approval: false }))
|
|
.toMatchObject({ state: "failed", canRetry: true, projectAccess: { ready: true } });
|
|
expect(run.status).toBe("failed");
|
|
});
|
|
|
|
it("shows an accepted retry as working after access is repaired", () => {
|
|
const input = { run, agent, paused: false, approval: false, wait: { id: "request", requestedAt: new Date() } };
|
|
expect(projectTaskInterruption(issue, { ...input, projectAccessAllowed: true }))
|
|
.toMatchObject({ state: "working", canRetry: false });
|
|
expect(projectTaskInterruption(issue, { ...input, projectAccessAllowed: true })).not.toHaveProperty("projectAccess");
|
|
expect(projectTaskInterruption(issue, { ...input, projectAccessAllowed: false }))
|
|
.toMatchObject({ state: "waiting_for_user", userAction: "project_access", canRetry: false });
|
|
});
|
|
|
|
it("does not reinterpret unrelated failures or an old assignee's denial", () => {
|
|
for (const otherRun of [{ ...run, errorCode: "setup_failed", error: "Disk full", resultJson: null },
|
|
{ ...run, agentId: "previous-agent" }]) {
|
|
expect(projectTaskInterruption(issue, { run: otherRun, agent, paused: false, approval: false }))
|
|
.not.toHaveProperty("projectAccess");
|
|
}
|
|
});
|
|
|
|
it("keeps approval, pause, running and completed states authoritative", () => {
|
|
expect(projectTaskInterruption(issue, { run, agent, paused: false, approval: true })).toMatchObject({ userAction: "approval" });
|
|
expect(projectTaskInterruption(issue, { run, agent, paused: true, approval: false })).toMatchObject({ userAction: "resume" });
|
|
expect(projectTaskInterruption(issue, { run: { ...run, status: "running" }, agent, paused: false, approval: false }))
|
|
.toMatchObject({ state: "working" });
|
|
expect(projectTaskInterruption({ ...issue, status: "done" }, { run, agent, paused: false, approval: false }))
|
|
.toMatchObject({ state: "resolved" });
|
|
});
|
|
});
|
|
|
|
describe("saved-work recovery step", () => {
|
|
const now = Date.parse("2026-01-01T12:00:00Z");
|
|
const failed = { ...run, errorCode: "setup_failed", resultJson: null };
|
|
const system = (phase: string, state: string, nextAttemptAt: number | null) => ({
|
|
schema: "paperclip.system-recovery.v1", policyVersion: 1, sourceRunId: "33333333-3333-4333-8333-333333333333", revision: 3,
|
|
generationId: "44444444-4444-4444-8444-444444444444", intentId: null, phase, state, attemptId: null, attempts: 2,
|
|
retriesUsed: 1, firstFailureAt: now - 60_000, nextAttemptAt, deadlineAt: now + 600_000, providerCooldownAt: null,
|
|
failure: null, preservationOperationIds: [], freshAttemptRunId: null });
|
|
const action = (evidence: Record<string, unknown>) => ({ evidence }) as never;
|
|
|
|
it("names the step a scheduled recovery will retry", () => {
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, paused: false, approval: false,
|
|
action: action({ systemRecovery: system("verify_execution", "scheduled", now + 30_000) }) }, now))
|
|
.toMatchObject({ state: "retry_scheduled", recoveryStep: "checking_previous_run" });
|
|
});
|
|
|
|
it("names the step a running recovery is on", () => {
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, paused: false, approval: false,
|
|
action: action({ systemRecovery: system("preserve_files", "running", null), systemRecoveryActiveAt: now - 1_000 }) }, now))
|
|
.toMatchObject({ state: "working", recoveryStep: "saving_previous_files" });
|
|
});
|
|
|
|
it("names recovery over a pending chat preparation and keeps failed preparation authoritative", () => {
|
|
const wait = { id: "retry", requestedAt: new Date(now), sourceRunId: failed.id, preparationStatus: "issued", preparationRetryAt: now + 250 };
|
|
const running = action({ systemRecovery: system("preserve_files", "running", null), systemRecoveryActiveAt: now - 1_000 });
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, wait, paused: false, approval: false, action: running }, now))
|
|
.toMatchObject({ state: "working", recoveryStep: "saving_previous_files" });
|
|
const scheduled = action({ systemRecovery: system("verify_execution", "scheduled", now + 30_000) });
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, wait, paused: false, approval: false, action: scheduled }, now))
|
|
.toMatchObject({ state: "retry_scheduled", recoveryStep: "checking_previous_run", canRetry: false });
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, paused: false, approval: false, action: scheduled }, now))
|
|
.toMatchObject({ state: "retry_scheduled", canRetry: true });
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, wait: { ...wait, preparationStatus: "failed" },
|
|
paused: false, approval: false, action: running }, now)).toMatchObject({ state: "failed" });
|
|
expect(projectTaskInterruption(issue, { run: failed, agent, wait, paused: false, approval: false }, now))
|
|
.toMatchObject({ state: "retry_scheduled", nextRetryAt: new Date(now + 250).toISOString() });
|
|
});
|
|
|
|
it("does not name a step for an ordinary scheduled retry", () => {
|
|
expect(projectTaskInterruption(issue, { run: { ...failed, scheduledRetryAt: new Date(now + 30_000) }, agent,
|
|
paused: false, approval: false }, now)).not.toHaveProperty("recoveryStep");
|
|
});
|
|
});
|