mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 11:20:42 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Its UI is the operator's daily surface: task lists, boards, budgets, agent status — all built on shadcn components and Tailwind > - Visual values (colors, spacing, type sizes, radii) were hardcoded at ~1,600 call sites: the same "small gray label" was 9/10/11px depending on the file, charts disagreed with chips about status colors, two toggle-switch implementations coexisted in two greens, and there was no visual regression coverage > - This made the UI drift-prone and made any restyle a hundreds-of-files project, which discourages design iteration > - This pull request extracts visual values into a single token layer in `ui/src/index.css`, adds a Storybook visual regression suite backed by external immutable baseline archives, and then applies a deliberate retune reviewed change-by-change on screenshot diffs > - The benefit is that Paperclip's look becomes a config surface: retheming is a token edit reviewed as a snapshot diff, drift is blocked by a token gate, and future UI PRs can prove exactly what changed visually without committing hundreds of PNGs ## Linked Issues or Issue Description No existing public issue covers this work (searched "design tokens", "visual regression", "design system" across issues and PRs). Related in spirit: Refs #8982 (theming a hardcoded panel — a one-off instance of the same problem class this PR addresses systematically). **Problem (feature-request form):** UI visual values are hardcoded per call site with no source of truth and no regression coverage; consistency depends on reviewer memory, and restyling requires mass file edits. **Proposed solution (this PR):** a single token layer + enforcement gate + externally stored visual snapshot suite, then an intentional restyle on top of that foundation. ## What Changed - **Token extraction (zero visual change, machine-verified during development):** committed codemods (`scripts/codemod-*.mjs`) moved ~1,600 hardcoded color/type/spacing/radius/shadow/misc values into named tokens in a non-inline `:root` block of `ui/src/index.css`. - **Visual regression suite:** `pnpm test:storybook-visual` covers 255 stories × light/dark = 510 Playwright screenshots at `maxDiffPixels: 0`, plus new primitive-coverage stories and deterministic-render fixes. - **External visual baselines:** committed PNG snapshots were removed. `tests/storybook-visual/baseline-manifest.json` pins an immutable archive URL/hash/size/count, and `scripts/storybook-visual-baseline.mjs` handles `download`, `verify`, `pack`, and trusted maintainer `upload` flows. - **Opt-in visual CI artifacts:** added a `Storybook Visual` workflow that runs on manual dispatch or PRs labeled `storybook-visual`, downloads/verifies the baseline, runs Playwright, and uploads Playwright report/test-result artifacts for review. Normal PR runs do not mutate baseline objects. - **Token gate:** `pnpm check:token-gates` — zero hex literals, zero arbitrary bracket values, zero raw font-sizes in `ui/src/components/**` and `ui/src/pages/**`, with a documented inline allowlist for legitimate opt-outs. - **Theme retune (intentional, snapshot-reviewed):** new base theme values; radius ladder derived from a single `--radius` knob; micro-type cluster collapsed to a named ladder (`--text-nano/micro/compact` + Tailwind `text-xs`/`text-sm`); letter-spacing collapsed to named steps. - **One status-color vocabulary:** charts, quota/budget bar fills, RUNNING/live chips, and liveness indicators all use the canonical `--status-*` hues. Light-mode legibility fixes for red alert surfaces that used dark-tuned text classes. - **One switch:** `ToggleSwitch` restyled to the registry capsule form, second hand-rolled implementation removed, and all call sites unified. - **Docs:** `DESIGN.md` is the design contract; `doc/design/` holds audit reports, decision logs, and updated guidance for external baseline review/update workflows. - Dead code removed (`agentStatusBadge` duplicate map), byte-identical contrast constants consolidated, semantic renames (`--project-seed`/`--project-none`, `--liveness-blue`). ## Verification - `pnpm check:token-gates` — 3/3 gates CLEAN during the design-system run - `pnpm typecheck` && `pnpm --filter @paperclipai/ui build` — green during the design-system run - `node --test scripts/__tests__/storybook-visual-baseline.test.mjs` — pass after external-baseline rework - `pnpm exec tsc --noEmit --pretty false --module NodeNext --moduleResolution NodeNext --target ES2022 --types node,@playwright/test tests/storybook-visual/playwright.config.ts tests/storybook-visual/storybook-visual.spec.ts` — pass after external-baseline rework - `git diff --check origin/pr/9134..HEAD` — pass after external-baseline rework - `find tests/storybook-visual -type f -name '*.png' -print | wc -l` — `0` - `node scripts/storybook-visual-baseline.mjs verify` — intentionally fails closed until the first trusted maintainer publishes the baseline archive and updates `baseline-manifest.json` ## Risks - **Large but shallow:** the PR still touches many UI files due to mechanical token extraction and retune work, but committed PNG snapshot churn has been removed from the branch. - **Baseline publication required before the visual suite can pass in clean clones:** the manifest currently has placeholder archive metadata. A trusted maintainer must publish the first immutable archive, then update `baseline-manifest.json`. - **Rendering platform variance:** the external baseline should be captured in the documented Linux/Chromium environment. Future CI runs verify against the pinned archive and fail closed on checksum/count mismatch. - **Visual CI is opt-in while stabilizing:** add the `storybook-visual` label or dispatch the workflow manually to produce downloadable Playwright report/test-result artifacts. - **Scheduled follow-ups, deliberately out of scope:** Tailwind palette classes map to semantic tokens in a dedicated pass; card/pill component consolidation; ESLint ratchet. Tracked in `doc/design/DECISION-SHEET.md`. ## Model Used Claude Fable 5 (Anthropic, `claude-fable-5`, Mythos-class tier) with extended thinking, running in Claude Code with tool use; mechanical phases delegated to Claude Sonnet subagents. Follow-up external-baseline rework assisted by OpenAI Codex (`gpt-5` coding agent with repository, terminal, and GitHub tool use). All bulk rewrites executed via deterministic, idempotent scripts committed in `scripts/`; intentional visual changes were human-reviewed on screenshot contact sheets. ## 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 targeted local verification and documented the intentional baseline-publication failure above - [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 *(pending new CI run after this rework)* - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups *(pending review)* - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) and OpenAI Codex --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Dotta <bippadotta@protonmail.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
350 lines
11 KiB
TypeScript
350 lines
11 KiB
TypeScript
import { AlertTriangle, Info, PauseCircle, User, X } from "lucide-react";
|
|
import { cn } from "../../lib/utils";
|
|
import { AgentIcon } from "../AgentIconPicker";
|
|
import {
|
|
classifyAssigneeHandoff,
|
|
resolveRunStatusPresentation,
|
|
type ComposerHandoffPreview,
|
|
type PauseAffectsSummary,
|
|
type PlainAgentNameCandidate,
|
|
type ReassignInterruptCopy,
|
|
type TimelineAssigneeLike,
|
|
} from "../../lib/interrupt-handoff";
|
|
|
|
/**
|
|
* Presentational views for the interrupt-handoff UX clarity surfaces (PAP-10669).
|
|
* All logic lives in `lib/interrupt-handoff.ts`; these components only render it,
|
|
* so they can be exercised in isolation by component tests and Storybook.
|
|
*/
|
|
|
|
export interface HandoffAgentLike {
|
|
name: string;
|
|
icon?: string | null;
|
|
}
|
|
|
|
export interface HandoffChipResolvers {
|
|
agentMap?: ReadonlyMap<string, HandoffAgentLike> | null;
|
|
resolveUserLabel?: (userId: string) => string | null;
|
|
currentUserId?: string | null;
|
|
}
|
|
|
|
function agentName(agentId: string, resolvers: HandoffChipResolvers): string {
|
|
return resolvers.agentMap?.get(agentId)?.name ?? agentId.slice(0, 8);
|
|
}
|
|
|
|
function agentIcon(agentId: string, resolvers: HandoffChipResolvers): string | null {
|
|
return resolvers.agentMap?.get(agentId)?.icon ?? null;
|
|
}
|
|
|
|
function userLabel(userId: string, resolvers: HandoffChipResolvers): string {
|
|
const label = resolvers.resolveUserLabel?.(userId) ?? null;
|
|
const base = label ?? "Board";
|
|
return resolvers.currentUserId && resolvers.currentUserId === userId ? `${base} (you)` : base;
|
|
}
|
|
|
|
const CHIP_CLASS =
|
|
"inline-flex items-center gap-1 rounded-full border border-border bg-muted/40 px-2 py-0.5 text-xs";
|
|
|
|
/** A labelled assignee chip — agent, user, or unassigned — that never lets a
|
|
* user owner read like an agent. */
|
|
export function AssigneeChip({
|
|
assignee,
|
|
resolvers,
|
|
className,
|
|
}: {
|
|
assignee: TimelineAssigneeLike;
|
|
resolvers: HandoffChipResolvers;
|
|
className?: string;
|
|
}) {
|
|
if (assignee.agentId) {
|
|
return (
|
|
<span className={cn(CHIP_CLASS, className)} data-testid="handoff-assignee-chip" data-kind="agent">
|
|
<span className="sr-only">Agent </span>
|
|
<AgentIcon icon={agentIcon(assignee.agentId, resolvers)} className="h-3 w-3 shrink-0 text-muted-foreground" />
|
|
<span className="max-w-(--sz-12rem) truncate">{agentName(assignee.agentId, resolvers)}</span>
|
|
</span>
|
|
);
|
|
}
|
|
if (assignee.userId) {
|
|
return (
|
|
<span className={cn(CHIP_CLASS, className)} data-testid="handoff-assignee-chip" data-kind="user">
|
|
<span className="sr-only">User </span>
|
|
<User className="h-3 w-3 shrink-0 text-muted-foreground" />
|
|
<span className="max-w-(--sz-12rem) truncate">{userLabel(assignee.userId, resolvers)}</span>
|
|
</span>
|
|
);
|
|
}
|
|
return (
|
|
<span
|
|
className={cn("text-xs italic text-muted-foreground", className)}
|
|
data-testid="handoff-assignee-chip"
|
|
data-kind="unassigned"
|
|
>
|
|
<span className="sr-only">No responsible — </span>
|
|
Unassigned
|
|
</span>
|
|
);
|
|
}
|
|
|
|
/** The "Wake" sub-row that makes each handoff state self-describing: a queued
|
|
* agent wake, a board-user handoff with no wake, or no agent selected. */
|
|
export function HandoffWakeRow({
|
|
to,
|
|
resolvers,
|
|
interruptedRunAttached = false,
|
|
}: {
|
|
to: TimelineAssigneeLike;
|
|
resolvers: HandoffChipResolvers;
|
|
interruptedRunAttached?: boolean;
|
|
}) {
|
|
const info = classifyAssigneeHandoff(to, {
|
|
agentName: to.agentId ? agentName(to.agentId, resolvers) : null,
|
|
interruptedRunAttached,
|
|
});
|
|
return (
|
|
<div
|
|
className="flex flex-wrap items-center gap-1.5 text-xs"
|
|
data-testid="handoff-wake-row"
|
|
data-kind={info.kind}
|
|
>
|
|
<span className="text-xs font-medium uppercase tracking-wider text-muted-foreground">Wake</span>
|
|
<span className={cn(info.kind === "agent_wake" ? "text-foreground" : "text-muted-foreground")}>
|
|
{info.wakeText}
|
|
</span>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
/** Run status text that distinguishes an intentional operator interrupt
|
|
* (amber "interrupted") from a generic muted "cancelled". */
|
|
export function RunStatusBadge({
|
|
status,
|
|
operatorInterrupted = false,
|
|
className,
|
|
}: {
|
|
status: string;
|
|
operatorInterrupted?: boolean;
|
|
className?: string;
|
|
}) {
|
|
const p = resolveRunStatusPresentation(status, { operatorInterrupted });
|
|
return (
|
|
<span
|
|
className={cn("font-medium", p.className, className)}
|
|
data-testid="run-status-badge"
|
|
data-interrupted={operatorInterrupted ? "true" : "false"}
|
|
>
|
|
{p.label}
|
|
{p.srHint ? <span className="sr-only"> — {p.srHint}</span> : null}
|
|
</span>
|
|
);
|
|
}
|
|
|
|
function PreviewChip({
|
|
chip,
|
|
resolvers,
|
|
}: {
|
|
chip: NonNullable<ComposerHandoffPreview["chip"]>;
|
|
resolvers: HandoffChipResolvers;
|
|
}) {
|
|
return (
|
|
<AssigneeChip
|
|
assignee={chip.kind === "agent" ? { agentId: chip.id, userId: null } : { agentId: null, userId: chip.id }}
|
|
resolvers={resolvers}
|
|
/>
|
|
);
|
|
}
|
|
|
|
/** One-line interpretation of what submitting the comment will durably do. */
|
|
export function ComposerHandoffPreviewRow({
|
|
preview,
|
|
resolvers,
|
|
}: {
|
|
preview: ComposerHandoffPreview;
|
|
resolvers: HandoffChipResolvers;
|
|
}) {
|
|
if (preview.kind === "none") return null;
|
|
return (
|
|
<div
|
|
className={cn(
|
|
"flex flex-wrap items-center justify-end gap-1.5 text-xs",
|
|
preview.tone === "warn" ? "text-amber-700 dark:text-amber-300" : "text-muted-foreground",
|
|
)}
|
|
data-testid="composer-handoff-preview"
|
|
data-kind={preview.kind}
|
|
role="status"
|
|
aria-live="polite"
|
|
>
|
|
<span>{preview.text}</span>
|
|
{preview.chip ? <PreviewChip chip={preview.chip} resolvers={resolvers} /> : null}
|
|
{preview.suffix ? <span>{preview.suffix}</span> : null}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
/** Inline coach shown when the body contains a plain agent name without a chip,
|
|
* offering a one-click upgrade to a real mention. */
|
|
export function ComposerMentionCoach({
|
|
candidate,
|
|
agentDisplayName,
|
|
onInsert,
|
|
onDismiss,
|
|
}: {
|
|
candidate: PlainAgentNameCandidate;
|
|
agentDisplayName: string;
|
|
onInsert: () => void;
|
|
onDismiss: () => void;
|
|
}) {
|
|
return (
|
|
<div
|
|
className="flex items-center gap-2 rounded-md border border-amber-300/40 bg-amber-50/70 px-2 py-1.5 text-xs text-amber-700 dark:bg-amber-500/10 dark:text-amber-300"
|
|
data-testid="composer-mention-coach"
|
|
role="alert"
|
|
aria-live="polite"
|
|
>
|
|
<Info className="h-3.5 w-3.5 shrink-0" aria-hidden />
|
|
<span className="min-w-0 flex-1">
|
|
Did you mean <span className="font-medium">@{candidate.matchedText}</span>? Plain text won't
|
|
notify or assign an agent.
|
|
</span>
|
|
<button
|
|
type="button"
|
|
onClick={onInsert}
|
|
className="shrink-0 rounded border border-amber-400/50 px-1.5 py-0.5 font-medium hover:bg-amber-100/60 dark:hover:bg-amber-500/20"
|
|
aria-label={`Insert mention for ${agentDisplayName} into your comment`}
|
|
>
|
|
Insert mention
|
|
</button>
|
|
<button
|
|
type="button"
|
|
onClick={onDismiss}
|
|
className="shrink-0 rounded p-0.5 hover:bg-amber-100/60 dark:hover:bg-amber-500/20"
|
|
aria-label="Dismiss suggestion"
|
|
>
|
|
<X className="h-3.5 w-3.5" aria-hidden />
|
|
</button>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
/** Live banner shown at the top of the responsible picker while a run is in flight,
|
|
* warning that reassigning will interrupt it. (design surface 2) */
|
|
export function AssigneeRunningBanner({
|
|
copy,
|
|
className,
|
|
}: {
|
|
copy: ReassignInterruptCopy;
|
|
className?: string;
|
|
}) {
|
|
return (
|
|
<div
|
|
role="status"
|
|
aria-live="polite"
|
|
data-testid="assignee-running-banner"
|
|
className={cn(
|
|
"flex items-start gap-1.5 rounded-md border border-amber-300/40 bg-amber-50/70 px-2 py-1.5 text-xs text-amber-700 dark:bg-amber-500/10 dark:text-amber-300",
|
|
className,
|
|
)}
|
|
>
|
|
<AlertTriangle className="mt-0.5 h-3.5 w-3.5 shrink-0" aria-hidden />
|
|
<span className="min-w-0 flex-1">{copy.banner}</span>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
/** "Interrupt & assign" confirm step shown when an operator picks a different
|
|
* target while a run is live. (design surface 2) */
|
|
export function InterruptAssignConfirm({
|
|
copy,
|
|
to,
|
|
resolvers,
|
|
onConfirm,
|
|
onCancel,
|
|
}: {
|
|
copy: ReassignInterruptCopy;
|
|
/** The target the operator selected. */
|
|
to: TimelineAssigneeLike;
|
|
resolvers: HandoffChipResolvers;
|
|
onConfirm: () => void;
|
|
onCancel: () => void;
|
|
}) {
|
|
return (
|
|
<div
|
|
data-testid="interrupt-assign-confirm"
|
|
className="space-y-2 rounded-md border border-amber-300/40 bg-amber-50/70 p-2 text-xs text-amber-700 dark:bg-amber-500/10 dark:text-amber-300"
|
|
>
|
|
<div className="flex items-start gap-1.5">
|
|
<AlertTriangle className="mt-0.5 h-3.5 w-3.5 shrink-0" aria-hidden />
|
|
<div className="min-w-0 flex-1 space-y-1">
|
|
<p className="font-medium">{copy.confirmTitle}</p>
|
|
<p className="flex flex-wrap items-center gap-1 text-amber-700/90 dark:text-amber-300/90">
|
|
<span>Hand off to</span>
|
|
<AssigneeChip assignee={to} resolvers={resolvers} />
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div className="flex justify-end gap-2">
|
|
<button
|
|
type="button"
|
|
onClick={onCancel}
|
|
className="rounded border border-amber-400/50 px-2 py-0.5 font-medium hover:bg-amber-100/60 dark:hover:bg-amber-500/20"
|
|
>
|
|
{copy.cancelAction}
|
|
</button>
|
|
<button
|
|
type="button"
|
|
onClick={onConfirm}
|
|
data-testid="interrupt-assign-confirm-action"
|
|
className="rounded bg-amber-600 px-2 py-0.5 font-medium text-white hover:bg-amber-700 dark:bg-amber-500 dark:hover:bg-amber-400"
|
|
>
|
|
{copy.confirmAction}
|
|
</button>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
/** "What this affects" bucket summary for the pause/hold dialog. (design surface 4) */
|
|
export function PauseAffectsSummaryView({
|
|
summary,
|
|
className,
|
|
}: {
|
|
summary: PauseAffectsSummary;
|
|
className?: string;
|
|
}) {
|
|
const visibleBuckets = summary.buckets.filter((bucket) => bucket.count > 0);
|
|
return (
|
|
<div
|
|
data-testid="pause-affects-summary"
|
|
className={cn("space-y-2 rounded-md border border-border bg-muted/30 p-3", className)}
|
|
>
|
|
<div className="flex items-center gap-1.5 text-xs font-medium uppercase tracking-wider text-muted-foreground">
|
|
<PauseCircle className="h-3.5 w-3.5" aria-hidden />
|
|
What this affects
|
|
</div>
|
|
{summary.nothingLive ? (
|
|
<p role="status" className="text-xs text-muted-foreground" data-testid="pause-nothing-live">
|
|
Nothing live to pause — no agent run is in flight or queued. This records a hold so new work
|
|
won't start until you resume.
|
|
</p>
|
|
) : null}
|
|
{visibleBuckets.length > 0 ? (
|
|
<ul className="space-y-1">
|
|
{visibleBuckets.map((bucket) => (
|
|
<li
|
|
key={bucket.key}
|
|
data-bucket={bucket.key}
|
|
className="flex flex-wrap items-baseline gap-x-1.5 gap-y-0.5 text-xs"
|
|
>
|
|
<span className="font-medium text-foreground">{bucket.label}:</span>
|
|
<span className="tabular-nums text-foreground">{bucket.count}</span>
|
|
<span className="text-muted-foreground">— {bucket.detail}</span>
|
|
</li>
|
|
))}
|
|
</ul>
|
|
) : (
|
|
<p className="text-xs text-muted-foreground">No tasks are affected.</p>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|