Files
PaperClipAI/ui/src/components/FileViewerSheet.test.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

171 lines
5.6 KiB
TypeScript

import { describe, expect, it } from "vitest";
import { renderToStaticMarkup } from "react-dom/server";
import type { WorkspaceFileContent } from "@paperclipai/shared";
import type { FileViewerUrlState } from "@/context/FileViewerContext";
import { ThemeProvider } from "@/context/ThemeContext";
import { describeDenial, FileContentViewer, FileViewerMetadataRow } from "./FileViewerSheet";
describe("describeDenial", () => {
it("returns the curated body for too_large regardless of fallback", () => {
expect(describeDenial("too_large", "").body).toBe(
"This file exceeds the supported preview size.",
);
expect(describeDenial("too_large", "ignored fallback").body).toBe(
"This file exceeds the supported preview size.",
);
});
it("does not leak the raw denial code as body when fallback is empty", () => {
for (const code of [
"denied_by_policy_sensitive",
"outside_workspace_root",
"workspace_archived",
"binary_unsupported",
"remote_preview_unsupported",
]) {
const { body } = describeDenial(code, "");
expect(body).not.toBe(code);
expect(body).not.toMatch(/^[a-z_]+$/);
}
});
it("describes unsupported previews in terms of text, image, and video", () => {
expect(describeDenial("unsupported_content", "").body).toBe(
"This file does not have a text, image, or video preview available.",
);
});
it("falls back to the generic message for unknown codes with empty fallback", () => {
const { body, title } = describeDenial("", "");
expect(title).toBe("Can't preview this file");
expect(body).toBe("The viewer was unable to load this file.");
});
it("prefers a human-readable server message for unknown codes", () => {
const { body } = describeDenial("unknown_code", "Server refused the request.");
expect(body).toBe("Server refused the request.");
});
});
describe("FileContentViewer", () => {
function content(overrides: Partial<WorkspaceFileContent> = {}): WorkspaceFileContent {
return {
resource: {
kind: "file",
provider: "local_fs",
title: "notes.txt",
displayPath: "notes.txt",
workspaceLabel: "Workspace",
workspaceKind: "project_workspace",
workspaceId: "11111111-1111-4111-8111-111111111111",
contentType: "text/plain; charset=utf-8",
byteSize: 18,
previewKind: "text",
capabilities: { preview: true, download: true, listChildren: false },
},
content: {
encoding: "utf8",
data: "one very long line",
},
...overrides,
};
}
it("wraps text content instead of forcing horizontal preformatted scrolling", () => {
const markup = renderToStaticMarkup(<FileContentViewer content={content()} highlightedLine={null} />);
expect(markup).toContain("whitespace-pre-wrap");
expect(markup).toContain("break-words");
});
it("reserves code gutter space for at least four digit line numbers", () => {
const markup = renderToStaticMarkup(
<FileContentViewer
content={content({
content: {
encoding: "utf8",
data: "one\ntwo\nthree",
},
})}
highlightedLine={null}
/>,
);
expect(markup).toContain("calc(4ch + 2rem)");
});
it("renders video previews with native controls", () => {
const markup = renderToStaticMarkup(
<FileContentViewer
content={content({
resource: {
...content().resource,
title: "demo.mp4",
displayPath: "demo.mp4",
contentType: "video/mp4",
previewKind: "video",
},
content: {
encoding: "base64",
data: "AAAA",
},
})}
highlightedLine={null}
/>,
);
expect(markup).toContain("<video");
expect(markup).toContain("controls");
expect(markup).toContain("data:video/mp4;base64,AAAA");
});
it("shows an icon toggle for Markdown files and defaults to rendered Markdown", () => {
const markup = renderToStaticMarkup(
<ThemeProvider>
<FileContentViewer
content={content({
resource: {
...content().resource,
title: "README.md",
displayPath: "docs/README.md",
contentType: "text/markdown; charset=utf-8",
},
content: {
encoding: "utf8",
data: "# Heading\n\nBody",
},
})}
highlightedLine={null}
/>
</ThemeProvider>,
);
expect(markup).toContain("Markdown preview mode");
expect(markup).toContain("Show rendered Markdown");
expect(markup).toContain("Show raw Markdown");
expect(markup).toContain("README.md rendered Markdown");
expect(markup).not.toContain("README.md source");
});
it("does not show the Markdown toggle for non-Markdown text files", () => {
const markup = renderToStaticMarkup(<FileContentViewer content={content()} highlightedLine={null} />);
expect(markup).not.toContain("Markdown preview mode");
expect(markup).toContain("notes.txt source");
});
});
describe("FileViewerMetadataRow", () => {
const state: FileViewerUrlState = {
path: "videos/90-days-paperclip/tweet.md",
workspace: "auto",
line: null,
column: null,
projectId: null,
workspaceId: null,
};
it("reserves metadata row height while file details load", () => {
const markup = renderToStaticMarkup(<FileViewerMetadataRow state={state} />);
expect(markup).toContain("min-h-(--sz-18px)");
expect(markup).toContain("Loading file details");
});
});