mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-07 07:23:08 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Agents execute on isolated workspaces (git worktrees), each pinned to a specific branch and commit at checkout time > - When an agent's live checkout diverges from the recorded workspace branch — either through a branch rename, a stale worktree, or a concurrent git operation — Paperclip detects the mismatch and surfaces a recovery card to the operator > - But the existing recovery card showed a generic error with no diagnostic context: it didn't display *which* branch was expected vs. which was checked out, the commit SHAs involved, or whether the branches share ancestry > - Without that information operators cannot diagnose the root cause, and the only recovery path was fully manual re-issue > - This pull request extends `IssueRecoveryActionCard` for `workspace_validation` / `git_worktree_branch_incoherence` recovery kinds to render a divergence-diagnosis panel (expected branch, live branch, short SHAs, ancestry-verdict badge, plain-language reason) and adds a confirm-gated "Re-issue on isolated workspace" action that creates a new task with `executionWorkspacePreference: isolated_workspace` so the re-issued run cannot trip the same branch-mismatch gate > - The benefit is that operators can immediately see *why* a workspace was declined and recover with a single click instead of having to manually reconstruct the task ## Linked Issues or Issue Description Refs #4757 (heartbeat re-wake doesn't reconcile working-tree HEAD against ticket's expected branch — this PR surfaces the resulting divergence to the operator and provides a one-click isolated re-issue path) Refs #8460 (workspace_validation_failed local-only project workspaces — this PR extends the recovery card UI for this case) **Subsystem affected:** ui/ — React + Vite board UI **Problem or motivation:** When Paperclip records a workspace branch for an agent run and the live checkout disagrees (diverged HEAD, renamed branch, stale worktree), the issue recovery card surfaces a generic `workspace_validation` error. The operator sees "run declined" but has no visibility into the expected vs. actual branch, the relevant commit SHAs, or whether the branches even share ancestry. There is no one-click path to re-issue the task on a clean isolated workspace — the operator must manually reconstruct the task from scratch. **Proposed solution:** Extend `IssueRecoveryActionCard` to: 1. Render a divergence-diagnosis panel from the `recoveryEvidence` field: expected branch, live branch, short SHAs for both, an ancestry-verdict badge (`forward-only` / `diverged` / `ancestry unknown`), and the server's `plainLanguageReason`. 2. Add Action 3 "Re-issue on isolated workspace" — a confirm-gated button that calls `issuesApi.create` with `executionWorkspacePreference: isolated_workspace` and `workspaceStrategy.baseRef` set to the live branch (SHA fallback when detached). The current workspace is never mutated. 3. Wire `onReissueIsolated` / `reissuePending` through `IssueChatThread` → `IssueDetail` so the operator sees an immediate success toast and is navigated to the new task. **Alternatives considered:** Showing divergence details only in a tooltip (rejected — too easy to miss). Providing a "force-reset the workspace" action (rejected — destructive, no audit trail, doesn't fix stale-branch root cause). Isolated re-issue via isolated workspace was the clearest safe path. ## What Changed - `IssueRecoveryActionCard.tsx` — Added `DiagnosisPanel` sub-component rendered for `workspace_validation` / `git_worktree_branch_incoherence` recovery kinds: displays expected vs. live branch, short SHAs, ancestry-verdict badge, and plain-language reason. Added Action 3 confirm-popover with `onReissueIsolated` callback and `reissuePending` loading state. Kept existing Action 1 and Action 2 unchanged. - `IssueChatThread.tsx` — Threaded `onReissueIsolated` and `reissuePending` props down to `IssueRecoveryActionCard`. - `IssueDetail.tsx` — Implemented `handleReissueIsolated`: calls `issuesApi.create` with `executionWorkspacePreference: isolated_workspace` + `workspaceStrategy.baseRef` derived from live branch / SHA; shows a success toast and navigates to the new task on completion. - `IssueRecoveryActionCard.test.tsx` — Added 19 unit tests covering diagnosis-panel rendering, verdict label rendering, base-ref derivation (branch-first then detached-HEAD SHA fallback), and action gating. ## Verification ```bash # Unit tests — 19/19 pass pnpm vitest run ui/src/components/IssueRecoveryActionCard.test.tsx # Typecheck — 0 new errors pnpm typecheck ``` Manual browser validation deferred to QA — see Risks. ## Risks - **Re-issue creates a new task** — the original task remains unchanged. This is intentional (safe default), but operators should be aware both tasks exist after re-issue. - **Base-ref derivation falls back to the live HEAD SHA when detached.** SHA-based worktrees are valid for isolated re-issue but may surprise operators expecting a branch name. - **Browser-level end-to-end validation not included here.** Toast, navigation, and full create-flow are covered by integration QA in a follow-up pass. - **Low overall risk** — no new endpoints, no data mutations on existing records, no PII or telemetry changes. Composes the existing `issuesApi.create` endpoint; all new behavior is additive. ## Model Used Claude Sonnet 4.6 (`claude-sonnet-4-6`) — Anthropic. 200k context window, tool use, code execution. Extended thinking not 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 - [x] I have added or updated tests where applicable - [ ] 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 - [ ] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
381 lines
14 KiB
TypeScript
381 lines
14 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { createRoot } from "react-dom/client";
|
|
import { flushSync } from "react-dom";
|
|
import type { AnchorHTMLAttributes, ReactElement } from "react";
|
|
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
import type { Agent, IssueRecoveryAction } from "@paperclipai/shared";
|
|
import { IssueRecoveryActionCard, deriveRecoveryCardState } from "./IssueRecoveryActionCard";
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Link: ({ children, to, ...props }: AnchorHTMLAttributes<HTMLAnchorElement> & { to: string }) => (
|
|
<a href={to} {...props}>{children}</a>
|
|
),
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
function act<T>(callback: () => T): T {
|
|
let result: T | undefined;
|
|
flushSync(() => {
|
|
result = callback();
|
|
});
|
|
const maybePromise = result as unknown as PromiseLike<unknown>;
|
|
if (result && typeof maybePromise.then === "function") {
|
|
throw new TypeError("This test act shim only supports synchronous callbacks.");
|
|
}
|
|
return result as T;
|
|
}
|
|
|
|
let root: ReturnType<typeof createRoot> | null = null;
|
|
let container: HTMLDivElement | null = null;
|
|
|
|
afterEach(() => {
|
|
if (root) {
|
|
act(() => root?.unmount());
|
|
}
|
|
root = null;
|
|
container?.remove();
|
|
container = null;
|
|
});
|
|
|
|
function render(element: ReactElement) {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = createRoot(container);
|
|
act(() => root?.render(element));
|
|
return container;
|
|
}
|
|
|
|
function click(element: Element | null) {
|
|
if (!element) throw new Error("Expected element to exist");
|
|
act(() => {
|
|
element.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
}
|
|
|
|
const ownerAgent: Agent = {
|
|
id: "11111111-1111-1111-1111-111111111111",
|
|
companyId: "company-1",
|
|
name: "ClaudeCoder",
|
|
role: "engineer",
|
|
status: "idle",
|
|
adapterType: "claude_local",
|
|
adapterConfig: {},
|
|
runtimeConfig: {},
|
|
permissions: {},
|
|
urlKey: "claudecoder",
|
|
} as unknown as Agent;
|
|
|
|
const returnAgent: Agent = {
|
|
...ownerAgent,
|
|
id: "22222222-2222-2222-2222-222222222222",
|
|
name: "CodexCoder",
|
|
urlKey: "codexcoder",
|
|
} as Agent;
|
|
|
|
function buildAction(overrides: Partial<IssueRecoveryAction> = {}): IssueRecoveryAction {
|
|
return {
|
|
id: "00000000-0000-0000-0000-0000000000aa",
|
|
companyId: "company-1",
|
|
sourceIssueId: "00000000-0000-0000-0000-0000000000ff",
|
|
recoveryIssueId: null,
|
|
kind: "missing_disposition",
|
|
status: "active",
|
|
ownerType: "agent",
|
|
ownerAgentId: ownerAgent.id,
|
|
ownerUserId: null,
|
|
previousOwnerAgentId: returnAgent.id,
|
|
returnOwnerAgentId: returnAgent.id,
|
|
cause: "missing_disposition",
|
|
fingerprint: "fp",
|
|
evidence: {
|
|
summary: "Run finished but no disposition was chosen.",
|
|
sourceRunId: "7accd7a4-c9ca-4db2-9233-3228a037cc09",
|
|
},
|
|
nextAction: "Choose and record a valid issue disposition.",
|
|
wakePolicy: { type: "wake_owner" },
|
|
monitorPolicy: null,
|
|
attemptCount: 1,
|
|
maxAttempts: 3,
|
|
timeoutAt: null,
|
|
lastAttemptAt: "2026-05-09T19:30:00.000Z",
|
|
outcome: null,
|
|
resolutionNote: null,
|
|
resolvedAt: null,
|
|
createdAt: "2026-05-09T19:30:00.000Z",
|
|
updatedAt: "2026-05-09T19:30:00.000Z",
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
describe("deriveRecoveryCardState", () => {
|
|
it("maps active missing_disposition to needed", () => {
|
|
expect(deriveRecoveryCardState(buildAction())).toBe("needed");
|
|
});
|
|
|
|
it("maps active_run_watchdog to observe_only", () => {
|
|
expect(deriveRecoveryCardState(buildAction({ kind: "active_run_watchdog" }))).toBe("observe_only");
|
|
});
|
|
|
|
it("maps escalated status to escalated", () => {
|
|
expect(deriveRecoveryCardState(buildAction({ status: "escalated" }))).toBe("escalated");
|
|
});
|
|
|
|
it("maps resolved/cancelled to resolved", () => {
|
|
expect(deriveRecoveryCardState(buildAction({ status: "resolved" }))).toBe("resolved");
|
|
expect(deriveRecoveryCardState(buildAction({ status: "cancelled" }))).toBe("resolved");
|
|
});
|
|
});
|
|
|
|
describe("IssueRecoveryActionCard", () => {
|
|
it("renders required fields and an aria-label naming the state", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard
|
|
action={buildAction()}
|
|
agentMap={new Map([
|
|
[ownerAgent.id, ownerAgent],
|
|
[returnAgent.id, returnAgent],
|
|
])}
|
|
onResolve={() => {}}
|
|
/>,
|
|
);
|
|
const section = node.querySelector("section[aria-label]");
|
|
expect(section?.getAttribute("aria-label")).toBe("Recovery action: needed");
|
|
expect(node.textContent).toContain("RECOVERY NEEDED");
|
|
expect(node.textContent).toContain("Missing Disposition");
|
|
expect(node.textContent).not.toContain("missing_disposition");
|
|
expect(node.textContent).toContain("This task's run finished, but no next step was chosen.");
|
|
expect(node.textContent).toContain("ClaudeCoder");
|
|
expect(node.textContent).toContain("CodexCoder");
|
|
expect(node.textContent).toContain("Choose and record a valid issue disposition.");
|
|
expect(node.textContent).toContain("Corrective wake queued");
|
|
});
|
|
|
|
it("falls back to em dash when wake policy is absent", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard action={buildAction({ wakePolicy: null })} />,
|
|
);
|
|
expect(node.textContent).toContain("—");
|
|
});
|
|
|
|
it("renders observe_only tone for active_run_watchdog", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard action={buildAction({ kind: "active_run_watchdog" })} />,
|
|
);
|
|
const section = node.querySelector("section[aria-label]");
|
|
expect(section?.getAttribute("aria-label")).toBe("Recovery action: observing active run");
|
|
expect(node.textContent).toContain("OBSERVING ACTIVE RUN");
|
|
});
|
|
|
|
it("renders a workspace-specific label and headline for workspace_validation", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard
|
|
action={buildAction({
|
|
kind: "workspace_validation",
|
|
cause: "workspace_validation_failed",
|
|
nextAction:
|
|
"Repair the source issue workspace link, project workspace cwd, or git checkout before resuming adapter execution.",
|
|
wakePolicy: { type: "manual_repair_required" },
|
|
evidence: {
|
|
recoveryCause: "workspace_validation_failed",
|
|
latestRunErrorCode: "workspace_validation_failed",
|
|
},
|
|
})}
|
|
/>,
|
|
);
|
|
const section = node.querySelector("section[aria-label]");
|
|
expect(section?.getAttribute("data-recovery-kind")).toBe("workspace_validation");
|
|
expect(node.textContent).toContain("Workspace Validation");
|
|
expect(node.textContent).not.toContain("workspace_validation\n");
|
|
expect(node.textContent).toContain(
|
|
"Paperclip stopped this run because the task's git workspace could not be validated.",
|
|
);
|
|
expect(node.textContent).toContain("Repair the source issue workspace link");
|
|
expect(node.textContent).toContain("Manual repair required");
|
|
});
|
|
|
|
it("renders the resolved label and outcome when resolved", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard action={buildAction({ status: "resolved", outcome: "restored", resolvedAt: "2026-05-09T19:35:00.000Z" })} />,
|
|
);
|
|
expect(node.textContent).toContain("RECOVERY RESOLVED");
|
|
expect(node.textContent).toContain("Resolved as restored");
|
|
});
|
|
|
|
it("calls resolve with todo and does not offer delegated recovery", () => {
|
|
const onResolve = vi.fn();
|
|
const node = render(
|
|
<IssueRecoveryActionCard action={buildAction()} onResolve={onResolve} />,
|
|
);
|
|
click(node.querySelector("[data-testid='recovery-action-resolve-trigger']"));
|
|
|
|
expect(document.body.textContent).toContain("Try again");
|
|
expect(document.body.textContent).toContain("Mark task done");
|
|
expect(document.body.textContent).not.toContain("Mark blocked");
|
|
expect(document.body.textContent).not.toContain("Delegate follow-up issue");
|
|
click([...document.body.querySelectorAll("button")].find((button) => button.textContent?.includes("Try again")) ?? null);
|
|
|
|
expect(onResolve).toHaveBeenCalledWith("todo");
|
|
});
|
|
|
|
it("does not offer blocked recovery resolution without a blocker selection flow", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard action={buildAction()} onResolve={() => {}} canFalsePositive />,
|
|
);
|
|
click(node.querySelector("[data-testid='recovery-action-resolve-trigger']"));
|
|
|
|
expect(document.body.textContent).toContain("Try again");
|
|
expect(document.body.textContent).toContain("Mark task done");
|
|
expect(document.body.textContent).toContain("Send for review");
|
|
expect(document.body.textContent).toContain("False positive, done");
|
|
expect(document.body.textContent).toContain("False positive, review");
|
|
expect(document.body.textContent).not.toContain("Mark blocked");
|
|
});
|
|
|
|
it("hides false-positive options unless canFalsePositive is set", () => {
|
|
const first = render(
|
|
<IssueRecoveryActionCard action={buildAction()} onResolve={() => {}} />,
|
|
);
|
|
click(first.querySelector("[data-testid='recovery-action-resolve-trigger']"));
|
|
expect(document.body.textContent).not.toContain("False positive");
|
|
|
|
act(() => root?.unmount());
|
|
root = null;
|
|
container?.remove();
|
|
container = null;
|
|
|
|
const onResolve = vi.fn();
|
|
const second = render(
|
|
<IssueRecoveryActionCard action={buildAction()} onResolve={onResolve} canFalsePositive />,
|
|
);
|
|
click(second.querySelector("[data-testid='recovery-action-resolve-trigger']"));
|
|
expect(document.body.textContent).toContain("False positive, done");
|
|
expect(document.body.textContent).toContain("False positive, review");
|
|
click([...document.body.querySelectorAll("button")].find((button) => button.textContent?.includes("False positive, done")) ?? null);
|
|
expect(onResolve).toHaveBeenCalledWith("false_positive_done");
|
|
});
|
|
});
|
|
|
|
function buildWorkspaceValidationAction(
|
|
overrides: {
|
|
action?: Partial<IssueRecoveryAction>;
|
|
provenance?: Record<string, unknown>;
|
|
workspaceValidation?: Record<string, unknown>;
|
|
} = {},
|
|
): IssueRecoveryAction {
|
|
const provenance = {
|
|
expectedHeadSha: "aaaaaaaaaaaa11112222",
|
|
actualHeadSha: "bbbbbbbbbbbb33334444",
|
|
ancestryVerdict: "diverged",
|
|
plainLanguageReason:
|
|
'The recorded branch "PAP-522-recorded" is not an ancestor of the checked-out branch "nleach/PAP-1405-live", so Paperclip cannot prove a forward-only reconciliation.',
|
|
...overrides.provenance,
|
|
};
|
|
return buildAction({
|
|
kind: "workspace_validation",
|
|
cause: "workspace_validation_failed",
|
|
evidence: {
|
|
workspaceValidation: {
|
|
reason: "git_worktree_branch_incoherence",
|
|
expectedBranch: "PAP-522-recorded",
|
|
actualBranch: "nleach/PAP-1405-live",
|
|
cleanliness: "clean",
|
|
provenance,
|
|
...overrides.workspaceValidation,
|
|
},
|
|
},
|
|
...overrides.action,
|
|
});
|
|
}
|
|
|
|
describe("IssueRecoveryActionCard workspace_validation divergence", () => {
|
|
it("renders the divergence diagnosis with branches, shas, verdict and plain-language reason", () => {
|
|
const node = render(<IssueRecoveryActionCard action={buildWorkspaceValidationAction()} />);
|
|
const diagnosis = node.querySelector("[data-testid='recovery-divergence-diagnosis']");
|
|
expect(diagnosis).not.toBeNull();
|
|
const text = diagnosis?.textContent ?? "";
|
|
expect(text).toContain("PAP-522-recorded");
|
|
expect(text).toContain("nleach/PAP-1405-live");
|
|
// shortened shas (10 chars)
|
|
expect(text).toContain("aaaaaaaaaa");
|
|
expect(text).toContain("bbbbbbbbbb");
|
|
expect(text).toContain("cannot prove a forward-only reconciliation");
|
|
expect(node.querySelector("[data-testid='recovery-ancestry-verdict']")?.textContent).toContain("Diverged");
|
|
});
|
|
|
|
it("labels an ancestor verdict as forward-only", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard
|
|
action={buildWorkspaceValidationAction({ provenance: { ancestryVerdict: "ancestor" } })}
|
|
/>,
|
|
);
|
|
expect(node.querySelector("[data-testid='recovery-ancestry-verdict']")?.textContent).toContain("Forward-only");
|
|
});
|
|
|
|
it("does not render a divergence diagnosis for non-incoherence workspace failures", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard
|
|
action={buildWorkspaceValidationAction({
|
|
workspaceValidation: { reason: "workspace_link_missing", provenance: undefined },
|
|
})}
|
|
/>,
|
|
);
|
|
expect(node.querySelector("[data-testid='recovery-divergence-diagnosis']")).toBeNull();
|
|
});
|
|
|
|
it("offers the re-issue action and passes the live branch as the base ref", () => {
|
|
const onReissueIsolated = vi.fn();
|
|
const node = render(
|
|
<IssueRecoveryActionCard
|
|
action={buildWorkspaceValidationAction()}
|
|
onReissueIsolated={onReissueIsolated}
|
|
/>,
|
|
);
|
|
click(node.querySelector("[data-testid='recovery-action-reissue-trigger']"));
|
|
expect(document.body.textContent).toContain("Re-issue on isolated workspace");
|
|
click(document.body.querySelector("[data-testid='recovery-action-reissue-confirm']"));
|
|
expect(onReissueIsolated).toHaveBeenCalledWith({
|
|
baseRef: "nleach/PAP-1405-live",
|
|
liveBranch: "nleach/PAP-1405-live",
|
|
liveHeadSha: "bbbbbbbbbbbb33334444",
|
|
expectedBranch: "PAP-522-recorded",
|
|
});
|
|
});
|
|
|
|
it("falls back to the live HEAD sha as base ref when the branch is detached", () => {
|
|
const onReissueIsolated = vi.fn();
|
|
const node = render(
|
|
<IssueRecoveryActionCard
|
|
action={buildWorkspaceValidationAction({ workspaceValidation: { actualBranch: null } })}
|
|
onReissueIsolated={onReissueIsolated}
|
|
/>,
|
|
);
|
|
click(node.querySelector("[data-testid='recovery-action-reissue-trigger']"));
|
|
click(document.body.querySelector("[data-testid='recovery-action-reissue-confirm']"));
|
|
expect(onReissueIsolated).toHaveBeenCalledWith(
|
|
expect.objectContaining({ baseRef: "bbbbbbbbbbbb33334444", liveBranch: null }),
|
|
);
|
|
});
|
|
|
|
it("does not offer the re-issue action for non-workspace kinds", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard action={buildAction()} onReissueIsolated={() => {}} />,
|
|
);
|
|
expect(node.querySelector("[data-testid='recovery-action-reissue-trigger']")).toBeNull();
|
|
});
|
|
|
|
it("disables the re-issue action while a re-issue is pending", () => {
|
|
const node = render(
|
|
<IssueRecoveryActionCard
|
|
action={buildWorkspaceValidationAction()}
|
|
onReissueIsolated={() => {}}
|
|
reissuePending
|
|
/>,
|
|
);
|
|
const trigger = node.querySelector<HTMLButtonElement>("[data-testid='recovery-action-reissue-trigger']");
|
|
expect(trigger?.disabled).toBe(true);
|
|
});
|
|
});
|