Files
PaperClipAI/ui/src/components/IssueMonitorBanner.test.tsx
T
DottaandPaperclip 5cf90417d6 fix(ui): confirm cancellation from monitor cards (#15735)
## Thinking Path

> - Paperclip helps people manage AI agents and their tasks.
> - A task monitor schedules a later agent check.
> - The monitor card shows when that check will run.
> - The card has no direct control to cancel the monitor.
> - This change adds an X button and a confirmation dialog.
> - The operator can stop the scheduled check from the card.

## Linked Issues or Issue Description

**What existing behavior does this improve?**
The monitor card on the task page.

**Current behavior**
The operator must open task properties to clear a monitor.

**Proposed behavior**
Select the X in the top right of the card. Select Keep monitor to leave
the schedule in place. Select Cancel monitor to remove the scheduled
check.

**Reason and benefit**
The operator can cancel the monitor where its schedule is shown.
Confirmation helps prevent an accidental cancellation.

**Breaking changes**
None. The change uses the existing task update API.

## What Changed

- Add an accessible X button at the top right of the monitor card.
- Confirm cancellation before the task update.
- Keep the dialog open with an error if the update fails.
- Preserve the other execution policy settings and refresh the task
after success.
- Reject stale policy writes under the task row lock with an optional
expectedExecutionPolicy snapshot.
- Document the snapshot field and add a database test for stale
cancellation.
- Restrict snapshot requests to policy-only edits before
execution-control actions.
- Add seven route tests for rejected mixed requests and absent policy
updates.
- Keep automatic retry waits separate from monitor cancellation.
- Add component and task page tests.

## Verification

- `pnpm check:token-gates` passed.
- Monitor banner and task page tests passed: 199 tests. A targeted
database test and seven route tests also passed.
- UI typecheck and production build passed.
- Open a task with a scheduled monitor. Select X, then Keep monitor. The
schedule must remain.
- Select X, then Cancel monitor. The card must disappear after the
update.
- Local full build reached the Rust runner build but could not complete
because Cargo is absent. CI must verify the full build.
- Full repository typecheck, build, test suites, and E2E checks passed
in CI for the final commit. Local full checks were limited by missing
Cargo and workspace memory.

## Risks

- Low risk. Cancellation uses the existing company access checks and
activity log.
- A cancelled monitor no longer wakes the agent. The dialog explains
this effect.

## Model Used

OpenAI Codex, GPT-6. The runtime does not expose a more specific model
ID or context window size. Used code editing, shell commands, and tests.

## 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-10-09 16:38:04 -05:00

334 lines
14 KiB
TypeScript

// @vitest-environment jsdom
import { act } from "react";
import { flushSync } from "react-dom";
import { createRoot } from "react-dom/client";
import type { Issue, IssueWorkProduct } from "@paperclipai/shared";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import {
IssueMonitorBanner,
IssueMonitorComposerStrip,
buildMonitorSurfaceCopy,
hasVisibleMonitorSurface,
} from "./IssueMonitorBanner";
import type { DerivedMonitorState } from "@/lib/issue-monitor";
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
const NOW = new Date("2026-07-17T20:00:00.000Z");
function derived(overrides: Partial<DerivedMonitorState> & { state: DerivedMonitorState["state"] }): DerivedMonitorState {
return {
source: "monitor",
nextCheckAt: null,
attemptCount: 0,
serviceName: null,
...overrides,
};
}
describe("buildMonitorSurfaceCopy", () => {
it.each(["retrying", "due-now", "overdue"] as const)("keeps workspace contention neutral when %s", (state) => {
const copy = buildMonitorSurfaceCopy(derived({
state, source: "scheduled-retry", nextCheckAt: NOW.toISOString(), attemptCount: 4,
}), NOW, "workspace_busy");
expect(copy!.bannerTitle).toBe("Waiting for workspace");
expect(copy!.stripTitle).toBe("Waiting for workspace");
expect(copy!.tone).toBe("info");
expect(copy!.workspaceWait).toBe(true);
expect(copy!.bannerMeta.join(" ")).not.toMatch(/Attempt|overdue|retry/i);
});
it("leads with two-unit relative time while scheduled", () => {
const copy = buildMonitorSurfaceCopy(
derived({
state: "scheduled",
nextCheckAt: new Date(NOW.getTime() + (2 * 60 + 12) * 60_000).toISOString(),
attemptCount: 1,
serviceName: "vercel-deploy",
}),
NOW,
);
expect(copy).not.toBeNull();
expect(copy!.bannerTitle).toBe("Waiting on monitor — resumes in 2h 12m");
expect(copy!.stripTitle).toBe("Resumes in 2h 12m");
expect(copy!.tone).toBe("info");
expect(copy!.bannerMeta).toContain("Attempt 1");
expect(copy!.bannerMeta).toContain("Watching: vercel-deploy");
// Absolute time carries the "(your time)" hint on the banner only.
expect(copy!.bannerMeta.some((piece) => piece.includes("(your time)"))).toBe(true);
expect(copy!.stripMeta.some((piece) => piece.includes("(your time)"))).toBe(false);
});
it("keeps the retrying attempt count visible", () => {
const copy = buildMonitorSurfaceCopy(
derived({
state: "retrying",
nextCheckAt: new Date(NOW.getTime() + 90 * 60_000).toISOString(),
attemptCount: 3,
}),
NOW,
);
expect(copy!.stripTitle).toBe("Resumes in 1h 30m");
expect(copy!.stripMeta).toContain("Attempt 3");
});
it("uses agent copy for scheduled retries without a monitor", () => {
const copy = buildMonitorSurfaceCopy(
derived({
state: "retrying",
source: "scheduled-retry",
nextCheckAt: new Date(NOW.getTime() + 90 * 60_000).toISOString(),
attemptCount: 2,
}),
NOW,
);
expect(copy!.bannerTitle).toBe("Agent resumes in 1h 30m");
expect(copy!.stripTitle).toBe("Resumes in 1h 30m");
});
it("switches copy for due-now and overdue states", () => {
const dueNow = buildMonitorSurfaceCopy(
derived({ state: "due-now", nextCheckAt: NOW.toISOString(), attemptCount: 1 }),
NOW,
);
expect(dueNow!.bannerTitle).toBe("Waiting on monitor — due now");
expect(dueNow!.stripTitle).toBe("Due now");
expect(dueNow!.bannerMeta).toContain("Checking momentarily…");
expect(dueNow!.tone).toBe("info");
const overdue = buildMonitorSurfaceCopy(
derived({
state: "overdue",
nextCheckAt: new Date(NOW.getTime() - 18 * 60_000).toISOString(),
attemptCount: 2,
}),
NOW,
);
expect(overdue!.bannerTitle).toBe("Waiting on monitor — overdue by 18m");
expect(overdue!.stripTitle).toBe("Overdue by 18m");
expect(overdue!.bannerMeta).toContain("Fires on next tick");
expect(overdue!.tone).toBe("warning");
});
it("hides both surfaces when cleared, none, or without a next check", () => {
expect(buildMonitorSurfaceCopy(derived({ state: "cleared", attemptCount: 2 }), NOW)).toBeNull();
expect(buildMonitorSurfaceCopy(derived({ state: "none" }), NOW)).toBeNull();
// A "scheduled" state with no timestamp cannot render an ETA — hide.
expect(buildMonitorSurfaceCopy(derived({ state: "scheduled", nextCheckAt: null }), NOW)).toBeNull();
});
});
describe("IssueMonitorBanner / IssueMonitorComposerStrip rendering", () => {
let container: HTMLDivElement;
beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(NOW);
container = document.createElement("div");
document.body.appendChild(container);
});
afterEach(() => {
vi.useRealTimers();
container.remove();
});
function issueWithMonitor(nextCheckAt: string | null): Issue {
return {
executionState: nextCheckAt
? { monitor: { status: "scheduled", nextCheckAt, attemptCount: 1, serviceName: "vercel-deploy" } }
: null,
scheduledRetry: null,
} as unknown as Issue;
}
it("requires confirmation, keeps the monitor on dismissal, and reports cancellation errors", async () => {
const issue = issueWithMonitor(new Date(NOW.getTime() + 60_000).toISOString());
const onCancel = vi.fn().mockRejectedValueOnce(new Error("Unable to save monitor")).mockResolvedValueOnce(undefined);
const root = createRoot(container);
flushSync(() => root.render(<IssueMonitorBanner issue={issue} onCancelMonitor={onCancel} />));
const open = () => flushSync(() => (container.querySelector('[aria-label="Cancel monitor"]') as HTMLButtonElement).click());
open();
expect(onCancel).not.toHaveBeenCalled();
expect(document.querySelector('[role="alertdialog"]')?.textContent).toContain("no longer resume");
flushSync(() => (Array.from(document.querySelectorAll("button")).find(b => b.textContent === "Keep monitor")!).click());
expect(onCancel).not.toHaveBeenCalled();
open();
await act(async () => { Array.from(document.querySelectorAll("button")).find(b => b.textContent === "Cancel monitor")!.click(); });
expect(document.querySelector('[role="alert"]')?.textContent).toBe("Unable to save monitor");
expect(document.querySelector('[role="alertdialog"]')).not.toBeNull();
await act(async () => { Array.from(document.querySelectorAll("button")).find(b => b.textContent === "Cancel monitor")!.click(); });
expect(onCancel).toHaveBeenCalledTimes(2);
expect(document.querySelector('[role="alertdialog"]')).toBeNull();
flushSync(() => root.unmount());
});
it("does not offer monitor cancellation for automatic retries", () => {
const issue = { scheduledRetry: { status: "scheduled_retry", scheduledRetryAt: NOW.toISOString() } } as Issue;
const root = createRoot(container);
flushSync(() => root.render(<IssueMonitorBanner issue={issue} onCancelMonitor={vi.fn()} />));
expect(container.querySelector('[aria-label="Cancel monitor"]')).toBeNull();
flushSync(() => root.unmount());
});
it("shows the saved PR and a status check above the composer during a GitHub review wait", () => {
const issue = issueWithMonitor(new Date(NOW.getTime() + 6 * 60 * 60_000).toISOString());
issue.executionState!.monitor!.serviceName = "github";
const product = {
id: "pr-1", type: "pull_request", title: "Update runtime probe", url: null,
metadata: { url: "https://github.com/example/private-repo/pull/42" },
status: "ready_for_review", reviewState: "needs_board_review", updatedAt: NOW,
} as unknown as IssueWorkProduct;
const onCheckNow = vi.fn();
const root = createRoot(container);
const render = (products: IssueWorkProduct[], error?: string) => flushSync(() => root.render(
<IssueMonitorComposerStrip issue={issue} workProducts={products} onCheckNow={onCheckNow} checkError={error} />,
));
render([product]);
expect(container.textContent).toContain("Pull request review requested");
expect(container.textContent).toContain("Next check in 6h");
expect(container.textContent).not.toContain("Resumes in");
expect(container.querySelector("a")?.href).toBe("https://github.com/example/private-repo/pull/42");
expect(container.querySelector("a")?.textContent).toBe("example/private-repo#42");
const button = container.querySelector("button")!;
expect(button.textContent).toBe("Check status");
flushSync(() => button.click());
expect(onCheckNow).toHaveBeenCalledTimes(1);
render([product], "GitHub status check could not start");
expect(container.querySelector('[role="alert"]')?.textContent).toContain("could not start");
render([{ ...product, metadata: { ...product.metadata, state: "merged" } }]);
expect(container.textContent).not.toContain("review requested");
expect(container.querySelector("a")).toBeNull();
flushSync(() => root.unmount());
});
it("explains automatic workspace waiting without promising that a reply bypasses the lock", () => {
const issue = {
status: "todo", scheduledRetry: { status: "scheduled_retry", scheduledRetryReason: "workspace_busy", scheduledRetryAt: NOW.toISOString() },
} as Issue;
const root = createRoot(container);
flushSync(() => root.render(<><IssueMonitorBanner issue={issue} onCheckNow={vi.fn()} /><IssueMonitorComposerStrip issue={issue} onCheckNow={vi.fn()} /></>));
expect(container.textContent).toContain("Waiting for workspace");
expect(container.textContent).toContain("You can keep sending instructions while the agent waits.");
expect(container.textContent).not.toContain("wakes the agent now");
expect(container.querySelector("button")).toBeNull();
flushSync(() => root.unmount());
});
it("explains pool exhaustion and retained account affinity on both waiting surfaces", () => {
const issue = {
status: "in_progress", scheduledRetry: { status: "scheduled_retry", scheduledRetryReason: "ai_connection_pool_wait", scheduledRetryAt: new Date(NOW.getTime() + 60_000).toISOString(), scheduledRetryAttempt: 1 },
} as Issue;
const root = createRoot(container);
flushSync(() => root.render(<><IssueMonitorBanner issue={issue} onCheckNow={vi.fn()} /><IssueMonitorComposerStrip issue={issue} onCheckNow={vi.fn()} /></>));
expect(container.textContent).toContain("Pool exhausted");
expect(container.textContent).toContain("Usage recheck in 1m");
expect(container.textContent).toContain("Tasks with a selected account keep it while waiting.");
expect(container.textContent).toContain("Work resumes when usage permits.");
expect(container.textContent).not.toContain("Attempt 1");
expect(container.querySelector("button")).not.toBeNull();
flushSync(() => root.unmount());
});
it("renders the banner with a working Check now button while waiting", () => {
const onCheckNow = vi.fn();
expect(hasVisibleMonitorSurface(issueWithMonitor(new Date(NOW.getTime() + 2 * 60 * 60_000).toISOString()))).toBe(true);
const root = createRoot(container);
flushSync(() => {
root.render(
<IssueMonitorBanner
issue={issueWithMonitor(new Date(NOW.getTime() + 2 * 60 * 60_000).toISOString())}
onCheckNow={onCheckNow}
/>,
);
});
expect(container.textContent).toContain("Waiting on monitor — resumes in 2h");
expect(container.textContent).toContain("Watching: vercel-deploy");
const button = Array.from(container.querySelectorAll("button")).find((b) =>
b.textContent?.includes("Check now"),
);
expect(button).toBeTruthy();
flushSync(() => button?.dispatchEvent(new MouseEvent("click", { bubbles: true })));
expect(onCheckNow).toHaveBeenCalledTimes(1);
flushSync(() => root.unmount());
});
it("hides the banner and strip when there is no monitor", () => {
expect(hasVisibleMonitorSurface(issueWithMonitor(null))).toBe(false);
const root = createRoot(container);
flushSync(() => {
root.render(
<>
<IssueMonitorBanner issue={issueWithMonitor(null)} onCheckNow={vi.fn()} />
<IssueMonitorComposerStrip issue={issueWithMonitor(null)} onCheckNow={vi.fn()} />
</>,
);
});
expect(container.textContent).toBe("");
flushSync(() => root.unmount());
});
it("renders the composer strip with the reply-wakes-agent hint", () => {
const root = createRoot(container);
flushSync(() => {
root.render(
<IssueMonitorComposerStrip
issue={issueWithMonitor(new Date(NOW.getTime() + 2 * 60 * 60_000).toISOString())}
onCheckNow={vi.fn()}
/>,
);
});
expect(container.querySelector("[data-testid='issue-monitor-composer-strip']")).toBeTruthy();
expect(container.textContent).toContain("Resumes in 2h");
expect(container.textContent).toContain("Sending a reply wakes the agent now");
flushSync(() => root.unmount());
});
it("removes both countdowns and Check now when the retry starts, then shows a newly scheduled retry", () => {
const root = createRoot(container);
const issue = {
status: "in_progress",
scheduledRetry: {
status: "scheduled_retry",
scheduledRetryAt: new Date(NOW.getTime() - 2 * 60_000).toISOString(),
scheduledRetryAttempt: 1,
},
} as Issue;
const render = (next: Issue) => flushSync(() => root.render(
<>
<IssueMonitorBanner issue={next} onCheckNow={vi.fn()} />
<IssueMonitorComposerStrip issue={next} onCheckNow={vi.fn()} />
</>,
));
render(issue);
expect(container.textContent).toContain("Overdue by 2m");
for (const status of ["queued", "running"] as const) {
const promoted = { ...issue, scheduledRetry: { ...issue.scheduledRetry!, status } };
render(promoted);
expect(hasVisibleMonitorSurface(promoted)).toBe(false);
expect(container.textContent).toBe("");
expect(container.querySelector("button")).toBeNull();
expect(vi.getTimerCount()).toBe(0);
}
render({ ...issue, scheduledRetry: { ...issue.scheduledRetry!, scheduledRetryAt: new Date(NOW.getTime() + 5 * 60_000).toISOString() } });
expect(container.textContent).toContain("Resumes in 5m");
render({ ...issue, status: "done" });
expect(container.textContent).toBe("");
expect(vi.getTimerCount()).toBe(0);
flushSync(() => root.unmount());
});
});