mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-26 18:31:34 +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>
162 lines
5.1 KiB
TypeScript
162 lines
5.1 KiB
TypeScript
import { Play } from "lucide-react";
|
|
import type { IssueWorkProduct } from "@paperclipai/shared";
|
|
import {
|
|
formatBytes,
|
|
getIssueOutputs,
|
|
isImageContentType,
|
|
isVideoLikeOutput,
|
|
outputFilename,
|
|
type IssueOutputItem,
|
|
} from "@/lib/issue-output";
|
|
import { OutputPrimaryCard } from "./OutputPrimaryCard";
|
|
import { OutputRow } from "./OutputRow";
|
|
import { cn, relativeTime } from "@/lib/utils";
|
|
|
|
interface IssueOutputSectionProps {
|
|
workProducts: IssueWorkProduct[] | null | undefined;
|
|
/** Optional resolver for the artifact creator's display name. */
|
|
resolveCreatorName?: (item: IssueOutputItem) => string | null;
|
|
onMediaClick?: (item: IssueOutputItem) => void;
|
|
}
|
|
|
|
function isMediaOutput(item: IssueOutputItem) {
|
|
const meta = item.metadata;
|
|
return Boolean(meta && (
|
|
isImageContentType(meta.contentType) ||
|
|
isVideoLikeOutput(meta.contentType, meta.originalFilename)
|
|
));
|
|
}
|
|
|
|
function OutputMediaPreview({
|
|
item,
|
|
creatorName,
|
|
onMediaClick,
|
|
}: {
|
|
item: IssueOutputItem;
|
|
creatorName?: string | null;
|
|
onMediaClick?: (item: IssueOutputItem) => void;
|
|
}) {
|
|
const meta = item.metadata;
|
|
if (!meta) return null;
|
|
|
|
const filename = outputFilename(item);
|
|
const isVideo = isVideoLikeOutput(meta.contentType, meta.originalFilename);
|
|
const metaBits = [meta.contentType, formatBytes(meta.byteSize)];
|
|
if (creatorName) metaBits.push(creatorName);
|
|
metaBits.push(relativeTime(item.createdAt));
|
|
|
|
const preview = (
|
|
<>
|
|
{isVideo ? (
|
|
<video
|
|
src={meta.contentPath}
|
|
className="h-full w-full object-cover"
|
|
muted
|
|
playsInline
|
|
preload="metadata"
|
|
/>
|
|
) : (
|
|
<img
|
|
src={meta.contentPath}
|
|
alt={filename}
|
|
className="h-full w-full object-cover"
|
|
loading="lazy"
|
|
/>
|
|
)}
|
|
<div className="absolute inset-x-0 bottom-0 bg-black/65 px-2 py-1.5 text-left">
|
|
<p className="truncate text-xs font-medium text-white" title={filename}>{filename}</p>
|
|
<p className="truncate text-(length:--text-nano) text-white/65">{metaBits.join(" · ")}</p>
|
|
</div>
|
|
</>
|
|
);
|
|
|
|
const className = cn(
|
|
"group relative block aspect-square overflow-hidden rounded-md border border-border bg-accent/10",
|
|
"focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring",
|
|
);
|
|
|
|
if (onMediaClick) {
|
|
return (
|
|
<button
|
|
type="button"
|
|
className={className}
|
|
aria-label={`Browse ${filename} in gallery`}
|
|
onClick={() => onMediaClick(item)}
|
|
>
|
|
{preview}
|
|
</button>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<a
|
|
href={meta.openPath}
|
|
target="_blank"
|
|
rel="noreferrer"
|
|
className={className}
|
|
aria-label={`Open ${filename}`}
|
|
>
|
|
{preview}
|
|
</a>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Issue Output surface (PAP-10162 Phase 3).
|
|
*
|
|
* Renders attachment-backed artifact work products as first-class issue
|
|
* outputs: a full-width primary card (video player / image / generic file) with
|
|
* Open + Download, plus compact rows for any additional outputs. The section is
|
|
* omitted entirely when the issue has produced no outputs — we never show a
|
|
* permanent empty card.
|
|
*/
|
|
export function IssueOutputSection({ workProducts, resolveCreatorName, onMediaClick }: IssueOutputSectionProps) {
|
|
const { primary, rest, count } = getIssueOutputs(workProducts);
|
|
|
|
if (!primary) return null;
|
|
|
|
const creatorFor = (item: IssueOutputItem) => resolveCreatorName?.(item) ?? null;
|
|
const mediaRest = rest.filter(isMediaOutput);
|
|
const fileRest = rest.filter((item) => !isMediaOutput(item));
|
|
|
|
return (
|
|
<section className="space-y-3" aria-label="Task outputs">
|
|
<div className="flex items-center gap-2">
|
|
<Play className="h-3.5 w-3.5 text-muted-foreground" aria-hidden="true" />
|
|
<h3 className="text-sm font-medium text-muted-foreground">Output</h3>
|
|
<span className="text-xs text-muted-foreground">{count}</span>
|
|
</div>
|
|
|
|
{/* Stable anchor target so company Artifacts cards can deep-link to a
|
|
specific work product inside its issue context (PAP-10359). */}
|
|
<div id={`work-product-${primary.id}`} className="scroll-mt-20">
|
|
<OutputPrimaryCard item={primary} creatorName={creatorFor(primary)} onMediaClick={onMediaClick} />
|
|
</div>
|
|
|
|
{rest.length > 0 ? (
|
|
<div className="space-y-2">
|
|
<p className="text-(length:--text-micro) font-medium uppercase tracking-wide text-muted-foreground">Also produced</p>
|
|
{mediaRest.length > 0 ? (
|
|
<div className="grid grid-cols-4 gap-2">
|
|
{mediaRest.map((item) => (
|
|
<div key={item.id} id={`work-product-${item.id}`} className="scroll-mt-20">
|
|
<OutputMediaPreview
|
|
item={item}
|
|
creatorName={creatorFor(item)}
|
|
onMediaClick={onMediaClick}
|
|
/>
|
|
</div>
|
|
))}
|
|
</div>
|
|
) : null}
|
|
{fileRest.map((item) => (
|
|
<div key={item.id} id={`work-product-${item.id}`} className="scroll-mt-20">
|
|
<OutputRow item={item} creatorName={creatorFor(item)} />
|
|
</div>
|
|
))}
|
|
</div>
|
|
) : null}
|
|
</section>
|
|
);
|
|
}
|