mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 08:22:20 +02:00
## Thinking Path > - Paperclip is the open source control plane people use to supervise AI-agent companies. > - Operators need task execution state to be visible where they read, reply to, and manage an issue. > - Scheduled monitor state was easy to miss because it lived in a description-area card and used inconsistent, mostly static time copy. > - The task page, composer, retry card, and properties panel therefore needed one shared monitor-state and countdown language. > - This pull request adds shared live-ticking time utilities, moves monitor status into a top-of-page banner and composer strip, and redesigns the properties row with complete read-only details. > - The benefit is that operators can immediately understand when an agent resumes, why it is waiting, and how to act without hunting across the page. ## Linked Issues or Issue Description Issue monitors can schedule a future agent check, retry, or wake, but the UI did not present that state consistently or prominently. The existing description-area activity card competed with issue content, the composer did not explain that replying wakes the agent early, compact properties copy truncated important details, and relative times did not share a live two-unit formatter. This change makes scheduled monitor state visible and consistent across the issue header, reply composer, properties panel, and scheduled-retry card. Related prior server-side recovery visibility work: #9629 (distinct scope). ## What Changed - Added shared two-unit monitor ETA/offset formatters and a live-ticking countdown hook, including compact absolute-time rules for Today, weekday, and cross-year dates. - Replaced the description-area monitor activity card with a top-of-page status banner and added an inline composer strip that explains replies wake the agent before the scheduled check. - Redesigned the properties Monitor row as readable two-line copy with attempt state, due/overdue/cleared wording, click-to-edit behavior, and a hover/tap details tooltip. - Adopted the shared two-unit formatting in the scheduled-retry card and added focused coverage for monitor formatting, state transitions, visibility, and controls. - Added the approved wireframe package and published reference: https://pages.paperclip.ing/pap-14557-monitor-visibility/ ## Verification - `pnpm vitest run ui/src/lib/issue-monitor.test.tsx ui/src/components/IssueMonitorBanner.test.tsx ui/src/components/IssueProperties.test.tsx` — 3 files, 74 tests passed. - `pnpm -r typecheck` — passed. - `pnpm build` — passed with existing Vite optimization/chunk-size warnings. - UX review approved the rendered real components across desktop/mobile, light/dark, and the scheduled/retrying/due/overdue/cleared/none state matrix. - QA passed 6/6 criteria in Chromium, including a live countdown transition without refresh. Review evidence included the P2 banner state-matrix screenshot and the P3 properties-row and details-tooltip screenshots, plus a dark-mode capture. - `pnpm check:token-gates` currently reports five pre-existing `#9627` comment literals on `origin/master`; this branch introduces none of those literals or any new token violation. ## Risks - Low-to-moderate UI behavior risk: monitor copy and placement change across several issue surfaces, but all derive from one shared state builder and focused tests cover the state matrix. - Countdown rendering wakes once per minute while a visible monitor is scheduled; the hook is limited to active monitor surfaces and stops when hidden. - No database, API contract, migration, telemetry, or authorization behavior changes. > 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.6-sol`; context-window metadata was unavailable in this runtime; reasoning, repository tool use, command execution, and test execution enabled. Earlier implementation commits were assisted by Claude Fable 5 and Claude Opus 4.8 (1M context), as credited in their commit trailers. ## 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: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
212 lines
7.0 KiB
TypeScript
212 lines
7.0 KiB
TypeScript
import { useMemo } from "react";
|
|
import { Clock } from "lucide-react";
|
|
import type { Issue } from "@paperclipai/shared";
|
|
|
|
import { Button } from "@/components/ui/button";
|
|
import { InlineBanner } from "@/components/InlineBanner";
|
|
import { cn } from "@/lib/utils";
|
|
import {
|
|
deriveMonitorState,
|
|
formatMonitorAbsolute,
|
|
formatMonitorEta,
|
|
useMonitorCountdown,
|
|
type DerivedMonitorState,
|
|
type MonitorDisplayState,
|
|
} from "@/lib/issue-monitor";
|
|
|
|
/** Matches the `Date | string` inputs accepted by the issue-monitor helpers. */
|
|
type MonitorDate = Date | string;
|
|
|
|
/**
|
|
* States in which the waiting-monitor surfaces (top banner + composer strip)
|
|
* are shown. `cleared` and `none` hide both surfaces entirely — see
|
|
* wireframe 04 (PAP-14557).
|
|
*/
|
|
const WAITING_STATES: readonly MonitorDisplayState[] = [
|
|
"scheduled",
|
|
"retrying",
|
|
"due-now",
|
|
"overdue",
|
|
];
|
|
|
|
export function isWaitingMonitorState(state: MonitorDisplayState): boolean {
|
|
return WAITING_STATES.includes(state);
|
|
}
|
|
|
|
export function hasVisibleMonitorSurface(issue: Issue): boolean {
|
|
const derived = deriveMonitorState(issue);
|
|
return isWaitingMonitorState(derived.state) && derived.nextCheckAt !== null;
|
|
}
|
|
|
|
export interface MonitorSurfaceCopy {
|
|
/** Prominent lead for the top banner, e.g. "Waiting on monitor — resumes in 2h 12m". */
|
|
bannerTitle: string;
|
|
/** Prominent lead for the composer strip, e.g. "Resumes in 2h 12m". */
|
|
stripTitle: string;
|
|
/** Muted detail line for the banner (absolute time carries a "(your time)" hint). */
|
|
bannerMeta: string[];
|
|
/** Muted detail line for the composer strip. */
|
|
stripMeta: string[];
|
|
/** `warning` (amber) once overdue, `info` (blue) while still on schedule. */
|
|
tone: "info" | "warning";
|
|
}
|
|
|
|
function capitalize(value: string): string {
|
|
return value.length === 0 ? value : `${value.charAt(0).toUpperCase()}${value.slice(1)}`;
|
|
}
|
|
|
|
/**
|
|
* Pure copy builder shared by the banner and the composer strip so both
|
|
* surfaces render one consistent copy system (see wireframe 04). Kept free of
|
|
* hooks/`Date.now()` so it is deterministic under test.
|
|
*/
|
|
export function buildMonitorSurfaceCopy(
|
|
derived: DerivedMonitorState,
|
|
now: MonitorDate,
|
|
): MonitorSurfaceCopy | null {
|
|
if (!isWaitingMonitorState(derived.state) || !derived.nextCheckAt) return null;
|
|
|
|
const eta = formatMonitorEta(derived.nextCheckAt, now); // "in 2h 12m" | "due now" | "overdue by 18m"
|
|
const absolute = formatMonitorAbsolute(derived.nextCheckAt, {}, now); // local time, e.g. "Today, 4:08 PM"
|
|
const isScheduledRetryOnly = derived.source === "scheduled-retry";
|
|
|
|
let bannerTitle: string;
|
|
let stripTitle: string;
|
|
let statusHint: string | null = null;
|
|
switch (derived.state) {
|
|
case "scheduled":
|
|
case "retrying":
|
|
bannerTitle = isScheduledRetryOnly ? `Agent resumes ${eta}` : `Waiting on monitor — resumes ${eta}`;
|
|
stripTitle = `Resumes ${eta}`;
|
|
break;
|
|
case "due-now":
|
|
bannerTitle = isScheduledRetryOnly ? "Agent retry due now" : "Waiting on monitor — due now";
|
|
stripTitle = "Due now";
|
|
statusHint = "Checking momentarily…";
|
|
break;
|
|
case "overdue":
|
|
default:
|
|
bannerTitle = isScheduledRetryOnly ? `Agent retry ${eta}` : `Waiting on monitor — ${eta}`;
|
|
stripTitle = capitalize(eta);
|
|
statusHint = "Fires on next tick";
|
|
break;
|
|
}
|
|
|
|
const attemptLabel = derived.attemptCount >= 1 ? `Attempt ${derived.attemptCount}` : null;
|
|
const serviceLabel = derived.serviceName ? `Watching: ${derived.serviceName}` : null;
|
|
|
|
const bannerMeta = [statusHint, `${absolute} (your time)`, attemptLabel, serviceLabel].filter(
|
|
(piece): piece is string => Boolean(piece),
|
|
);
|
|
const stripMeta = [statusHint, absolute, attemptLabel, serviceLabel].filter(
|
|
(piece): piece is string => Boolean(piece),
|
|
);
|
|
|
|
return {
|
|
bannerTitle,
|
|
stripTitle,
|
|
bannerMeta,
|
|
stripMeta,
|
|
tone: derived.state === "overdue" ? "warning" : "info",
|
|
};
|
|
}
|
|
|
|
function useMonitorSurfaceCopy(issue: Issue): MonitorSurfaceCopy | null {
|
|
// `nextCheckAt` is stable for a given issue; derive once to seed the ticking
|
|
// countdown cadence, then re-derive against the live clock so the surfaces
|
|
// roll scheduled → due → overdue on their own.
|
|
const nextCheckAt = useMemo(() => deriveMonitorState(issue).nextCheckAt, [issue]);
|
|
const now = useMonitorCountdown(nextCheckAt);
|
|
return useMemo(() => buildMonitorSurfaceCopy(deriveMonitorState(issue, now), now), [issue, now]);
|
|
}
|
|
|
|
function CheckNowButton({
|
|
onCheckNow,
|
|
checkingNow,
|
|
}: {
|
|
onCheckNow: () => void;
|
|
checkingNow: boolean;
|
|
}) {
|
|
return (
|
|
<Button
|
|
type="button"
|
|
variant="outline"
|
|
size="sm"
|
|
className="shrink-0 shadow-none"
|
|
onClick={onCheckNow}
|
|
disabled={checkingNow}
|
|
>
|
|
{checkingNow ? "Checking…" : "Check now"}
|
|
</Button>
|
|
);
|
|
}
|
|
|
|
export interface IssueMonitorSurfaceProps {
|
|
issue: Issue;
|
|
onCheckNow?: (() => void) | null;
|
|
checkingNow?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Pinned banner rendered between the issue title and description while a
|
|
* monitor is waiting. Replaces the description-area "Monitor scheduled" card
|
|
* for the waiting state (PAP-14557 decision 1) — the two never render at once.
|
|
*/
|
|
export function IssueMonitorBanner({
|
|
issue,
|
|
onCheckNow = null,
|
|
checkingNow = false,
|
|
}: IssueMonitorSurfaceProps) {
|
|
const copy = useMonitorSurfaceCopy(issue);
|
|
if (!copy) return null;
|
|
|
|
return (
|
|
<InlineBanner
|
|
tone={copy.tone}
|
|
icon={Clock}
|
|
title={copy.bannerTitle}
|
|
className="my-3"
|
|
actions={onCheckNow ? <CheckNowButton onCheckNow={onCheckNow} checkingNow={checkingNow} /> : null}
|
|
>
|
|
<span>{copy.bannerMeta.join(" · ")}</span>
|
|
</InlineBanner>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Slim, inline (not sticky) strip anchored directly above the reply composer.
|
|
* Mirrors the banner's monitor state and reminds the reader that replying wakes
|
|
* the agent early (PAP-14557 decisions 2 + wireframe 02).
|
|
*/
|
|
export function IssueMonitorComposerStrip({
|
|
issue,
|
|
onCheckNow = null,
|
|
checkingNow = false,
|
|
className,
|
|
}: IssueMonitorSurfaceProps & { className?: string }) {
|
|
const copy = useMonitorSurfaceCopy(issue);
|
|
if (!copy) return null;
|
|
|
|
return (
|
|
<div
|
|
role="note"
|
|
data-testid="issue-monitor-composer-strip"
|
|
className={cn("rounded-lg border border-border bg-muted/30 px-3 py-2", className)}
|
|
>
|
|
<div className="flex flex-col gap-2 sm:flex-row sm:items-center sm:justify-between">
|
|
<div className="flex min-w-0 items-start gap-2">
|
|
<Clock className="mt-0.5 h-4 w-4 shrink-0 text-muted-foreground" aria-hidden="true" />
|
|
<div className="min-w-0">
|
|
<div className="text-sm font-medium text-foreground">{copy.stripTitle}</div>
|
|
<div className="text-xs text-muted-foreground">{copy.stripMeta.join(" · ")}</div>
|
|
</div>
|
|
</div>
|
|
{onCheckNow ? <CheckNowButton onCheckNow={onCheckNow} checkingNow={checkingNow} /> : null}
|
|
</div>
|
|
<p className="mt-1.5 text-xs text-muted-foreground">
|
|
Sending a reply wakes the agent now — before the scheduled check.
|
|
</p>
|
|
</div>
|
|
);
|
|
}
|