mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-06 21:05:21 +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>
115 lines
4.0 KiB
JavaScript
115 lines
4.0 KiB
JavaScript
import assert from "node:assert/strict";
|
|
import { createHash } from "node:crypto";
|
|
import {
|
|
mkdirSync,
|
|
mkdtempSync,
|
|
readFileSync,
|
|
rmSync,
|
|
statSync,
|
|
unlinkSync,
|
|
writeFileSync,
|
|
} from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import { join } from "node:path";
|
|
import { spawnSync } from "node:child_process";
|
|
import test from "node:test";
|
|
|
|
const script = new URL("../storybook-visual-baseline.mjs", import.meta.url).pathname;
|
|
|
|
test("downloads and verifies a checksum-pinned local baseline archive", () => {
|
|
const root = mkdtempSync(join(tmpdir(), "storybook-visual-baseline-test-"));
|
|
try {
|
|
const source = join(root, "source");
|
|
const cache = join(root, "cache");
|
|
const snapshots = join(root, "snapshots");
|
|
const manifest = join(root, "manifest.json");
|
|
mkdirSync(source, { recursive: true });
|
|
writeFileSync(join(source, "one.png"), "png-one");
|
|
writeFileSync(join(source, "two.png"), "png-two");
|
|
const archive = join(root, "snapshots.tgz");
|
|
run("tar", ["--sort=name", "--mtime=@0", "--owner=0", "--group=0", "--numeric-owner", "-czf", archive, "-C", source, "."]);
|
|
const sha256 = createHash("sha256").update(readFileSync(archive)).digest("hex");
|
|
const byteSize = statSync(archive).size;
|
|
writeFileSync(
|
|
manifest,
|
|
JSON.stringify(
|
|
{
|
|
version: 1,
|
|
baselineId: "test-baseline",
|
|
snapshotCount: 2,
|
|
archive: {
|
|
url: `file://${archive}`,
|
|
sha256,
|
|
byteSize,
|
|
},
|
|
environment: {
|
|
browser: "chromium",
|
|
viewport: "1200x800",
|
|
deviceScaleFactor: 1,
|
|
platform: "test",
|
|
},
|
|
},
|
|
null,
|
|
2,
|
|
),
|
|
);
|
|
|
|
const env = {
|
|
...process.env,
|
|
STORYBOOK_VISUAL_BASELINE_MANIFEST: manifest,
|
|
STORYBOOK_VISUAL_BASELINE_CACHE_DIR: cache,
|
|
STORYBOOK_VISUAL_SNAPSHOT_DIR: snapshots,
|
|
};
|
|
const download = spawnSync(process.execPath, [script, "download"], { env, encoding: "utf8" });
|
|
assert.equal(download.status, 0, download.stderr);
|
|
const verify = spawnSync(process.execPath, [script, "verify"], { env, encoding: "utf8" });
|
|
assert.equal(verify.status, 0, verify.stderr);
|
|
} finally {
|
|
rmSync(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("verify fails closed on snapshot count mismatch", () => {
|
|
const root = mkdtempSync(join(tmpdir(), "storybook-visual-baseline-test-"));
|
|
try {
|
|
const snapshots = join(root, "snapshots");
|
|
const manifest = join(root, "manifest.json");
|
|
mkdirSync(snapshots, { recursive: true });
|
|
writeFileSync(join(snapshots, "one.png"), "png-one");
|
|
const archive = join(root, "snapshots.tgz");
|
|
run("tar", ["--sort=name", "--mtime=@0", "--owner=0", "--group=0", "--numeric-owner", "-czf", archive, "-C", snapshots, "."]);
|
|
const sha256 = createHash("sha256").update(readFileSync(archive)).digest("hex");
|
|
const manifestBody = {
|
|
version: 1,
|
|
baselineId: "test-baseline",
|
|
snapshotCount: 1,
|
|
archive: {
|
|
url: `file://${archive}`,
|
|
sha256,
|
|
byteSize: statSync(archive).size,
|
|
},
|
|
};
|
|
writeFileSync(manifest, JSON.stringify(manifestBody));
|
|
const env = {
|
|
...process.env,
|
|
STORYBOOK_VISUAL_BASELINE_MANIFEST: manifest,
|
|
STORYBOOK_VISUAL_BASELINE_CACHE_DIR: root,
|
|
STORYBOOK_VISUAL_SNAPSHOT_DIR: snapshots,
|
|
};
|
|
const download = spawnSync(process.execPath, [script, "download"], { env, encoding: "utf8" });
|
|
assert.equal(download.status, 0, download.stderr);
|
|
writeFileSync(manifest, JSON.stringify({ ...manifestBody, snapshotCount: 2 }));
|
|
unlinkSync(join(snapshots, "one.png"));
|
|
const result = spawnSync(process.execPath, [script, "verify"], { env, encoding: "utf8" });
|
|
assert.notEqual(result.status, 0);
|
|
assert.match(result.stderr, /snapshot count mismatch/i);
|
|
} finally {
|
|
rmSync(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
function run(cmd, args) {
|
|
const result = spawnSync(cmd, args, { stdio: "pipe", encoding: "utf8" });
|
|
assert.equal(result.status, 0, result.stderr);
|
|
}
|