mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-14 08:26:46 +02: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>
178 lines
6.8 KiB
TypeScript
178 lines
6.8 KiB
TypeScript
import { Sparkles } from "lucide-react";
|
|
import { Link } from "@/lib/router";
|
|
import { cn, relativeTime } from "@/lib/utils";
|
|
import {
|
|
type SourceResolvedWatchdogFold,
|
|
formatCleanupOutcome,
|
|
formatSilenceAgeMs,
|
|
shortenEvidenceId,
|
|
} from "@/lib/source-resolved-watchdog-fold";
|
|
|
|
export interface SourceResolvedFoldCalloutProps {
|
|
fold: SourceResolvedWatchdogFold;
|
|
/** Time the run was finalized — used for the "system audit · {when}" header chip. */
|
|
finalizedAt?: string | Date | null;
|
|
className?: string;
|
|
}
|
|
|
|
function isoOrLocaleString(value: string | null | undefined): string | null {
|
|
if (!value) return null;
|
|
const date = new Date(value);
|
|
if (Number.isNaN(date.getTime())) return value;
|
|
return date.toLocaleString();
|
|
}
|
|
|
|
function issueLink(id: string, identifier: string | null) {
|
|
return `/issues/${identifier ?? id}`;
|
|
}
|
|
|
|
function MetaRow({
|
|
label,
|
|
children,
|
|
}: {
|
|
label: string;
|
|
children: React.ReactNode;
|
|
}) {
|
|
return (
|
|
<div className="grid grid-cols-(--gtc-10) gap-x-3 gap-y-0 py-1 text-xs sm:grid-cols-(--gtc-11)">
|
|
<dt className="truncate text-(length:--text-micro) font-medium uppercase tracking-(--tracking-label) text-emerald-900/70 dark:text-emerald-200/70">
|
|
{label}
|
|
</dt>
|
|
<dd className="min-w-0 break-words text-emerald-950 dark:text-emerald-100">{children}</dd>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export function SourceResolvedFoldCallout({
|
|
fold,
|
|
finalizedAt,
|
|
className,
|
|
}: SourceResolvedFoldCalloutProps) {
|
|
const sourceLabel = fold.sourceIssueIdentifier ?? fold.sourceIssueId.slice(0, 8);
|
|
const evidenceShort = shortenEvidenceId(fold.sameRunEvidenceId);
|
|
const evidenceAt = isoOrLocaleString(fold.sameRunEvidenceAt);
|
|
const silenceAgeLabel = formatSilenceAgeMs(fold.silenceAgeMs);
|
|
const silenceStartedLabel = isoOrLocaleString(fold.silenceStartedAt);
|
|
const cleanupLabel = formatCleanupOutcome(fold.cleanup.outcome);
|
|
const finalizedRelative = finalizedAt ? relativeTime(finalizedAt) : null;
|
|
const evaluationLabel = fold.evaluationIssueIdentifier ?? fold.evaluationIssueId?.slice(0, 8);
|
|
|
|
return (
|
|
<section
|
|
role="status"
|
|
aria-label="Source-resolved watchdog fold"
|
|
data-source-resolved-fold
|
|
className={cn(
|
|
"relative w-full overflow-hidden rounded-lg border text-sm shadow-(--shadow-extract-8)",
|
|
"border-emerald-300/70 bg-emerald-50/80 text-emerald-950",
|
|
"dark:border-emerald-500/40 dark:bg-emerald-500/10 dark:text-emerald-100",
|
|
className,
|
|
)}
|
|
>
|
|
<header className="flex items-start gap-3 px-3 py-2.5 sm:px-4">
|
|
<span
|
|
className={cn(
|
|
"mt-0.5 flex h-7 w-7 shrink-0 items-center justify-center rounded-md",
|
|
"bg-emerald-100 text-emerald-800 dark:bg-emerald-500/20 dark:text-emerald-200",
|
|
)}
|
|
aria-hidden
|
|
>
|
|
<Sparkles className="h-4 w-4 text-emerald-700 dark:text-emerald-300" />
|
|
</span>
|
|
<div className="min-w-0 flex-1">
|
|
<div className="flex flex-wrap items-center gap-x-2 gap-y-0.5 text-(length:--text-micro) font-semibold uppercase tracking-(--tracking-eyebrow)">
|
|
<span className="text-emerald-900 dark:text-emerald-200">SOURCE-RESOLVED FOLD</span>
|
|
<span className="text-muted-foreground/60" aria-hidden>·</span>
|
|
<span className="font-medium normal-case tracking-normal text-muted-foreground">
|
|
system audit
|
|
</span>
|
|
{finalizedRelative ? (
|
|
<>
|
|
<span className="text-muted-foreground/60" aria-hidden>·</span>
|
|
<span className="font-medium normal-case tracking-normal text-muted-foreground">
|
|
{finalizedRelative}
|
|
</span>
|
|
</>
|
|
) : null}
|
|
</div>
|
|
<p className="mt-1 text-sm leading-6">
|
|
This run was folded as a source-resolved false positive.
|
|
</p>
|
|
</div>
|
|
</header>
|
|
<dl
|
|
className={cn(
|
|
"divide-y border-t bg-background/40 px-3 py-2 sm:px-4 dark:bg-background/20",
|
|
"border-emerald-300/60 dark:border-emerald-500/30",
|
|
"[&>*]:border-emerald-300/40 dark:[&>*]:border-emerald-500/20",
|
|
)}
|
|
>
|
|
<MetaRow label="Source task">
|
|
<span className="inline-flex flex-wrap items-center gap-1.5">
|
|
<Link
|
|
to={issueLink(fold.sourceIssueId, fold.sourceIssueIdentifier)}
|
|
className="rounded-sm font-medium underline-offset-2 hover:underline"
|
|
>
|
|
{sourceLabel}
|
|
</Link>
|
|
<span className="rounded-md border border-emerald-300/60 bg-background/60 px-1.5 py-0.5 text-(length:--text-micro) font-medium text-emerald-900 dark:border-emerald-500/30 dark:text-emerald-200">
|
|
{fold.sourceIssueStatus}
|
|
</span>
|
|
</span>
|
|
</MetaRow>
|
|
<MetaRow label="Same-run evidence">
|
|
<span className="inline-flex flex-wrap items-baseline gap-1.5">
|
|
<span className="rounded bg-background/70 px-1.5 py-0.5 font-mono text-(length:--text-micro) text-emerald-900 dark:bg-background/40 dark:text-emerald-100">
|
|
{fold.sameRunEvidenceKind}
|
|
</span>
|
|
<code
|
|
className="rounded bg-background/70 px-1.5 py-0.5 font-mono text-(length:--text-micro) text-emerald-900 dark:bg-background/40 dark:text-emerald-100"
|
|
title={fold.sameRunEvidenceId}
|
|
>
|
|
{evidenceShort}
|
|
</code>
|
|
{evidenceAt ? (
|
|
<span className="text-(length:--text-micro) text-muted-foreground">at {evidenceAt}</span>
|
|
) : null}
|
|
</span>
|
|
</MetaRow>
|
|
<MetaRow label="Silence age before fold">
|
|
{silenceAgeLabel ? (
|
|
<span>
|
|
{silenceAgeLabel}
|
|
{silenceStartedLabel ? (
|
|
<span className="text-muted-foreground"> (silence started {silenceStartedLabel})</span>
|
|
) : null}
|
|
</span>
|
|
) : (
|
|
<span className="text-muted-foreground">unknown</span>
|
|
)}
|
|
</MetaRow>
|
|
<MetaRow label="Process cleanup">
|
|
<span
|
|
className="inline-flex flex-wrap items-baseline gap-1.5"
|
|
title={fold.cleanup.outcome}
|
|
>
|
|
<span>{cleanupLabel}</span>
|
|
{fold.cleanup.error ? (
|
|
<span className="text-muted-foreground">— {fold.cleanup.error}</span>
|
|
) : null}
|
|
</span>
|
|
</MetaRow>
|
|
{fold.evaluationIssueId ? (
|
|
<MetaRow label="Evaluation task">
|
|
<Link
|
|
to={issueLink(fold.evaluationIssueId, fold.evaluationIssueIdentifier)}
|
|
className="rounded-sm font-medium underline-offset-2 hover:underline"
|
|
>
|
|
{evaluationLabel}
|
|
</Link>
|
|
</MetaRow>
|
|
) : null}
|
|
</dl>
|
|
</section>
|
|
);
|
|
}
|
|
|
|
export default SourceResolvedFoldCallout;
|