paperclip/ui/storybook/stories/monitor-surfaces.stories.tsx
Dotta 57229d0f24
[codex] Add issue monitor liveness controls (#4988)
## Thinking Path

> - Paperclip is a control plane for autonomous AI companies where work
must stay observable, governable, and recoverable.
> - The task/heartbeat subsystem owns agent execution continuity, issue
state transitions, and visible recovery behavior.
> - Waiting on an external service is not the same as being blocked when
the assignee still owns a future check.
> - The gap was that agents had no first-class one-shot monitor state
for external-service waits, so recovery could look stalled or require ad
hoc comments.
> - This pull request adds bounded issue monitors that can wake the
owner, clear exhausted waits, and produce explicit recovery behavior.
> - It also surfaces monitor status in the board UI and documents when
to use monitors versus `blocked`.
> - The benefit is clearer liveness semantics for asynchronous waits
without weakening single-assignee task ownership.

## What Changed

- Added issue monitor fields, shared types, validators, constants, and
an idempotent `0075` migration for scheduled monitor state.
- Added server-side monitor scheduling, dispatch, recovery bounds,
activity logging, and external-ref redaction.
- Added board/agent route coverage for monitor permissions and child
monitor scheduling.
- Added issue detail/property UI for monitor state, a monitor activity
card, and Storybook stories for review surfaces.
- Documented monitor semantics and recovery policy behavior in
`doc/execution-semantics.md`.
- Addressed Greptile review feedback by preserving monitor state in
skipped-stage builders and making board monitor saves send `scheduledBy:
"board"`.

## Verification

- `pnpm install --frozen-lockfile`
- `pnpm run preflight:workspace-links && pnpm exec vitest run
server/src/__tests__/issue-execution-policy-routes.test.ts
server/src/__tests__/issue-execution-policy.test.ts
server/src/__tests__/issue-monitor-scheduler.test.ts
server/src/__tests__/recovery-classifiers.test.ts
ui/src/components/IssueMonitorActivityCard.test.tsx
ui/src/components/IssueProperties.test.tsx
ui/src/lib/activity-format.test.ts`
- First run passed 5 files and failed to collect 2 server suites because
the worktree was missing the optional `acpx/runtime` dependency.
- After `pnpm install --frozen-lockfile`, reran the 2 failed suites
successfully.
- `pnpm exec vitest run
server/src/__tests__/issue-monitor-scheduler.test.ts
server/src/__tests__/recovery-classifiers.test.ts`
- `pnpm --filter @paperclipai/shared typecheck && pnpm --filter
@paperclipai/db typecheck && pnpm --filter @paperclipai/server typecheck
&& pnpm --filter @paperclipai/ui typecheck`
- `pnpm exec vitest run
server/src/__tests__/issue-execution-policy.test.ts
ui/src/components/IssueProperties.test.tsx`
- `pnpm --filter @paperclipai/server typecheck && pnpm --filter
@paperclipai/ui typecheck`
- `pnpm exec vitest run
ui/src/components/IssueMonitorActivityCard.test.tsx
ui/src/components/IssueProperties.test.tsx`
- `pnpm --filter @paperclipai/ui typecheck`
- Storybook screenshot captured from
`http://127.0.0.1:6006/iframe.html?viewMode=story&id=product-issue-monitor-surfaces--monitor-surfaces`
with Playwright.

## Screenshots

![Issue monitor Storybook
surfaces](https://raw.githubusercontent.com/paperclipai/paperclip/PAP-2945-when-a-task-is-waiting-for-an-_external-service_-what-state-should-it-be-in-and-what-recovery-method-could-it-h/docs/pr-screenshots/pap-2945/monitor-surfaces.png)

## Risks

- Medium: this changes heartbeat recovery behavior for scheduled
external-service waits, so regressions could affect wake timing or
recovery issue creation.
- Migration risk is reduced by using `IF NOT EXISTS` for the new issue
monitor columns and index.
- External monitor references are treated as secret-adjacent and are
intentionally omitted from visible activity/wake payloads.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.

## Model Used

- OpenAI Codex, GPT-5 coding agent with repository tool use and terminal
execution.

## 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 run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots or Storybook review surfaces
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-05-03 08:58:53 -05:00

235 lines
7.3 KiB
TypeScript

import type { Meta, StoryObj } from "@storybook/react-vite";
import type { Issue } from "@paperclipai/shared";
import { IssueMonitorActivityCard } from "@/components/IssueMonitorActivityCard";
import { IssueProperties } from "@/components/IssueProperties";
import {
storybookExecutionWorkspaces,
storybookIssueDocuments,
storybookIssues,
} from "../fixtures/paperclipData";
const issueDocumentSummaries = storybookIssueDocuments.map(({ body: _body, ...summary }) => summary);
const baseIssue: Issue = {
...storybookIssues[0]!,
planDocument: storybookIssueDocuments.find((document) => document.key === "plan") ?? null,
documentSummaries: issueDocumentSummaries,
currentExecutionWorkspace: storybookExecutionWorkspaces[0]!,
};
const inFiveMinutes = () => new Date(Date.now() + 5 * 60_000);
const inTwoHours = () => new Date(Date.now() + 2 * 60 * 60_000);
const monitoredIssue: Issue = {
...baseIssue,
monitorNextCheckAt: inFiveMinutes(),
monitorNotes: "Polling Greptile for completed analysis.",
monitorAttemptCount: 2,
executionPolicy: {
...(baseIssue.executionPolicy ?? { mode: "normal", commentRequired: true, stages: [] }),
monitor: {
nextCheckAt: inFiveMinutes().toISOString(),
notes: "Polling Greptile for completed analysis.",
kind: "external_service",
scheduledBy: "assignee",
serviceName: "Greptile",
externalRef: "https://app.greptile.com/runs/abc123",
},
},
};
const longerWaitIssue: Issue = {
...baseIssue,
monitorNextCheckAt: inTwoHours(),
monitorNotes: null,
monitorAttemptCount: 0,
executionPolicy: {
...(baseIssue.executionPolicy ?? { mode: "normal", commentRequired: true, stages: [] }),
monitor: {
nextCheckAt: inTwoHours().toISOString(),
notes: null,
kind: null,
scheduledBy: "assignee",
serviceName: null,
externalRef: null,
},
},
};
const triggeredIssue: Issue = {
...baseIssue,
monitorNextCheckAt: null,
monitorLastTriggeredAt: new Date(Date.now() - 3 * 60_000),
monitorAttemptCount: 3,
monitorNotes: "Greptile review was checked and needs another pass.",
executionPolicy: {
...(baseIssue.executionPolicy ?? { mode: "normal", commentRequired: true, stages: [] }),
},
executionState: {
...(baseIssue.executionState ?? {
status: "pending",
currentStageId: null,
currentStageIndex: null,
currentStageType: null,
currentParticipant: null,
returnAssignee: null,
reviewRequest: null,
completedStageIds: [],
lastDecisionId: null,
lastDecisionOutcome: null,
}),
monitor: null,
},
};
const clearedIssue: Issue = {
...baseIssue,
monitorNextCheckAt: null,
monitorLastTriggeredAt: null,
monitorAttemptCount: 0,
monitorNotes: null,
executionPolicy: {
...(baseIssue.executionPolicy ?? { mode: "normal", commentRequired: true, stages: [] }),
},
executionState: {
...(baseIssue.executionState ?? {
status: "pending",
currentStageId: null,
currentStageIndex: null,
currentStageType: null,
currentParticipant: null,
returnAssignee: null,
reviewRequest: null,
completedStageIds: [],
lastDecisionId: null,
lastDecisionOutcome: null,
}),
monitor: {
status: "cleared",
nextCheckAt: null,
lastTriggeredAt: null,
attemptCount: 0,
notes: null,
scheduledBy: "board",
kind: null,
serviceName: null,
externalRef: null,
timeoutAt: null,
maxAttempts: null,
recoveryPolicy: null,
clearedAt: new Date(Date.now() - 60_000).toISOString(),
clearReason: "manual",
},
},
};
function MonitorSurfaceStories() {
return (
<div className="space-y-8 p-6">
<section className="space-y-2">
<div className="text-xs uppercase tracking-wide text-muted-foreground">
IssueMonitorActivityCard - external service (Greptile)
</div>
<IssueMonitorActivityCard
issue={monitoredIssue}
onCheckNow={() => undefined}
checkingNow={false}
/>
</section>
<section className="space-y-2">
<div className="text-xs uppercase tracking-wide text-muted-foreground">
IssueMonitorActivityCard - generic 2h wait, no service metadata
</div>
<IssueMonitorActivityCard
issue={longerWaitIssue}
onCheckNow={() => undefined}
checkingNow={false}
/>
</section>
<section className="space-y-2">
<div className="text-xs uppercase tracking-wide text-muted-foreground">
IssueMonitorActivityCard - returns null when no monitor is set
</div>
<div className="rounded-lg border border-dashed border-border px-3 py-2 text-xs text-muted-foreground">
(intentionally renders nothing for issues without a scheduled monitor)
</div>
<IssueMonitorActivityCard issue={baseIssue} onCheckNow={() => undefined} />
</section>
<div className="grid gap-6 lg:grid-cols-2">
<section className="space-y-2">
<div className="text-xs uppercase tracking-wide text-muted-foreground">
IssueProperties Monitor row - Not scheduled (default state)
</div>
<div className="rounded-lg border border-border bg-background/70 p-4">
<IssueProperties
issue={baseIssue}
onUpdate={() => undefined}
inline
/>
</div>
</section>
<section className="space-y-2">
<div className="text-xs uppercase tracking-wide text-muted-foreground">
IssueProperties Monitor row - Scheduled (Greptile, in 5m)
</div>
<div className="rounded-lg border border-border bg-background/70 p-4">
<IssueProperties
issue={monitoredIssue}
onUpdate={() => undefined}
inline
/>
</div>
</section>
<section className="space-y-2">
<div className="text-xs uppercase tracking-wide text-muted-foreground">
IssueProperties Monitor row - Triggered recently
</div>
<div className="rounded-lg border border-border bg-background/70 p-4">
<IssueProperties
issue={triggeredIssue}
onUpdate={() => undefined}
inline
/>
</div>
</section>
<section className="space-y-2">
<div className="text-xs uppercase tracking-wide text-muted-foreground">
IssueProperties Monitor row - Cleared
</div>
<div className="rounded-lg border border-border bg-background/70 p-4">
<IssueProperties
issue={clearedIssue}
onUpdate={() => undefined}
inline
/>
</div>
</section>
</div>
</div>
);
}
const meta = {
title: "Product/Issue Monitor surfaces",
component: MonitorSurfaceStories,
parameters: {
docs: {
description: {
component:
"Surfaces the IssueMonitorActivityCard and IssueProperties Monitor row in scheduled / not-scheduled / external-service variants for UX review.",
},
},
},
} satisfies Meta<typeof MonitorSurfaceStories>;
export default meta;
type Story = StoryObj<typeof meta>;
export const MonitorSurfaces: Story = {};