Files
PaperClipAI/ui/src/pages/IssueChatLongThreadPerf.tsx
T
c07e650cd7 feat(ui): single-source design tokens, visual regression suite, and theme retune (#9134)
## 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>
2026-07-07 16:22:16 -05:00

214 lines
8.8 KiB
TypeScript

import { Profiler, useEffect, useLayoutEffect, useMemo, useRef, useState, type ProfilerOnRenderCallback } from "react";
import { Badge } from "@/components/ui/badge";
import { Card, CardContent, CardHeader, CardTitle } from "@/components/ui/card";
import { IssueChatThread } from "../components/IssueChatThread";
import {
issueChatLongThreadAgentMap,
issueChatLongThreadComments,
issueChatLongThreadEvents,
issueChatLongThreadFixtureContext,
issueChatLongThreadLinkedRuns,
issueChatLongThreadLiveRuns,
issueChatLongThreadMarkdownCommentIds,
issueChatLongThreadTranscriptsByRunId,
LONG_THREAD_COMMENT_COUNT,
LONG_THREAD_MARKDOWN_COMMENT_COUNT,
} from "../fixtures/issueChatLongThreadFixture";
const noop = async () => {};
type RenderMetrics = {
commitCount: number;
mountActualDuration: number | null;
latestActualDuration: number | null;
maxActualDuration: number;
totalActualDuration: number;
};
const initialMetrics: RenderMetrics = {
commitCount: 0,
mountActualDuration: null,
latestActualDuration: null,
maxActualDuration: 0,
totalActualDuration: 0,
};
function formatMs(value: number | null) {
if (value === null || !Number.isFinite(value)) return "pending";
return `${value.toFixed(1)} ms`;
}
function MetricTile({ label, value, testId }: { label: string; value: string; testId: string }) {
return (
<div className="rounded-md border border-border bg-background px-3 py-2">
<div className="text-(length:--text-micro) font-medium uppercase tracking-(--tracking-eyebrow) text-muted-foreground">
{label}
</div>
<div data-testid={testId} className="mt-1 font-mono text-sm text-foreground">
{value}
</div>
</div>
);
}
export function IssueChatLongThreadPerf() {
const [metrics, setMetrics] = useState<RenderMetrics>(initialMetrics);
const metricsRef = useRef<RenderMetrics>(initialMetrics);
const renderStartedAtRef = useRef(performance.now());
const publishTimerRef = useRef<number | null>(null);
const publishedRef = useRef(false);
const fixture = issueChatLongThreadFixtureContext;
const rowTarget = useMemo(
() => LONG_THREAD_COMMENT_COUNT + issueChatLongThreadEvents.length + issueChatLongThreadLinkedRuns.length,
[],
);
useEffect(() => () => {
if (publishTimerRef.current !== null) {
window.clearTimeout(publishTimerRef.current);
}
}, []);
useLayoutEffect(() => {
if (publishedRef.current || metricsRef.current.commitCount > 0) return;
const mountDuration = performance.now() - renderStartedAtRef.current;
const next = {
commitCount: 1,
mountActualDuration: mountDuration,
latestActualDuration: mountDuration,
maxActualDuration: mountDuration,
totalActualDuration: mountDuration,
};
metricsRef.current = next;
publishedRef.current = true;
setMetrics(next);
}, []);
const handleRender: ProfilerOnRenderCallback = (_id, phase, actualDuration) => {
const current = metricsRef.current;
metricsRef.current = {
commitCount: current.commitCount + 1,
mountActualDuration: phase === "mount" && current.mountActualDuration === null
? actualDuration
: current.mountActualDuration,
latestActualDuration: actualDuration,
maxActualDuration: Math.max(current.maxActualDuration, actualDuration),
totalActualDuration: current.totalActualDuration + actualDuration,
};
if (publishedRef.current || publishTimerRef.current !== null) return;
publishTimerRef.current = window.setTimeout(() => {
publishTimerRef.current = null;
publishedRef.current = true;
setMetrics(metricsRef.current);
}, 0);
};
return (
<div data-testid="issue-chat-long-thread-perf" className="space-y-5">
<div className="flex flex-col gap-3 border-b border-border pb-5 lg:flex-row lg:items-end lg:justify-between">
<div className="min-w-0">
<div className="flex flex-wrap items-center gap-2">
<Badge variant="outline" className="font-mono text-(length:--text-micro)">
{fixture.issue.identifier}
</Badge>
<Badge variant="secondary">{fixture.issue.status.replace(/_/g, " ")}</Badge>
<Badge variant="outline">{fixture.issue.projectName}</Badge>
</div>
<h1 className="mt-3 text-2xl font-semibold tracking-tight">{fixture.issue.title}</h1>
<p className="mt-2 max-w-3xl text-sm leading-6 text-muted-foreground">
Deterministic local fixture for measuring the current direct-render issue chat path with
hundreds of merged thread rows, markdown-heavy assistant bodies, linked runs, documents,
sub-issues, and sidebar context.
</p>
</div>
<div className="grid min-w-(--sz-280px) grid-cols-2 gap-2">
<MetricTile label="Fixture rows" value={String(rowTarget)} testId="perf-fixture-row-target" />
<MetricTile label="Markdown rows" value={String(LONG_THREAD_MARKDOWN_COMMENT_COUNT)} testId="perf-fixture-markdown-rows" />
</div>
</div>
<div className="grid gap-4 xl:grid-cols-(--gtc-40)">
<main className="min-w-0 space-y-4">
<Card className="border-border/70">
<CardHeader className="pb-2">
<CardTitle className="text-base">Issue documents</CardTitle>
</CardHeader>
<CardContent className="grid gap-2 sm:grid-cols-2">
{fixture.documents.map((document) => (
<div key={document} className="rounded-md border border-border bg-muted/30 px-3 py-2 text-sm">
{document}
</div>
))}
</CardContent>
</Card>
<Card className="border-border/70">
<CardHeader className="pb-2">
<CardTitle className="text-base">Sub-issues</CardTitle>
</CardHeader>
<CardContent className="space-y-2">
{fixture.subIssues.map((subIssue, index) => (
<div key={subIssue} className="flex items-center gap-3 rounded-md border border-border bg-background px-3 py-2 text-sm">
<span className="font-mono text-xs text-muted-foreground">#{index + 1}</span>
<span>{subIssue}</span>
</div>
))}
</CardContent>
</Card>
<Profiler id="issue-chat-long-thread" onRender={handleRender}>
<IssueChatThread
comments={issueChatLongThreadComments}
linkedRuns={issueChatLongThreadLinkedRuns}
timelineEvents={issueChatLongThreadEvents}
liveRuns={issueChatLongThreadLiveRuns}
issueStatus="in_progress"
agentMap={issueChatLongThreadAgentMap}
currentUserId="user-board"
onAdd={noop}
showComposer={false}
showJumpToLatest={false}
enableLiveTranscriptPolling={false}
transcriptsByRunId={issueChatLongThreadTranscriptsByRunId}
hasOutputForRun={(runId) => issueChatLongThreadTranscriptsByRunId.has(runId)}
/>
</Profiler>
</main>
<aside className="space-y-4 xl:sticky xl:top-4 xl:self-start">
<Card className="border-border/70">
<CardHeader className="pb-2">
<CardTitle className="text-base">Baseline metrics</CardTitle>
</CardHeader>
<CardContent className="grid gap-2">
<MetricTile label="Profiler commits" value={String(metrics.commitCount)} testId="perf-commit-count" />
<MetricTile label="Mount duration" value={formatMs(metrics.mountActualDuration)} testId="perf-mount-duration" />
<MetricTile label="Latest duration" value={formatMs(metrics.latestActualDuration)} testId="perf-latest-duration" />
<MetricTile label="Max duration" value={formatMs(metrics.maxActualDuration)} testId="perf-max-duration" />
<MetricTile label="Total duration" value={formatMs(metrics.totalActualDuration)} testId="perf-total-duration" />
</CardContent>
</Card>
<Card className="border-border/70">
<CardHeader className="pb-2">
<CardTitle className="text-base">Fixture shape</CardTitle>
</CardHeader>
<CardContent className="space-y-2">
{fixture.sidebarStats.map(([label, value]) => (
<div key={label} className="flex items-center justify-between gap-3 text-sm">
<span className="text-muted-foreground">{label}</span>
<span className="font-mono">{value}</span>
</div>
))}
<div className="hidden" data-testid="perf-markdown-comment-id-sample">
{[...issueChatLongThreadMarkdownCommentIds].slice(0, 3).join(",")}
</div>
</CardContent>
</Card>
</aside>
</div>
</div>
);
}