mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-14 17:40:37 +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>
140 lines
4.9 KiB
TypeScript
140 lines
4.9 KiB
TypeScript
import { useQuery } from "@tanstack/react-query";
|
|
import { Clock3, FileDiff, GitCommit, type LucideIcon } from "lucide-react";
|
|
import { healthApi, type HealthStatus } from "@/api/health";
|
|
import { instanceSettingsApi } from "@/api/instanceSettings";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
|
|
function formatTimestamp(value: string | null | undefined): string {
|
|
if (!value) return "Unavailable";
|
|
const date = new Date(value);
|
|
if (Number.isNaN(date.getTime())) return "Unavailable";
|
|
return new Intl.DateTimeFormat(undefined, {
|
|
dateStyle: "medium",
|
|
timeStyle: "short",
|
|
}).format(date);
|
|
}
|
|
|
|
function isValidTimestamp(value: string | null | undefined): value is string {
|
|
return !!value && !Number.isNaN(new Date(value).getTime());
|
|
}
|
|
|
|
function restartTimestamp(health: HealthStatus | undefined): string | null {
|
|
return health?.devServer?.lastRestartAt ?? health?.serverInfo?.processStartedAt ?? null;
|
|
}
|
|
|
|
function commitLabel(health: HealthStatus | undefined): string {
|
|
const git = health?.serverInfo?.git;
|
|
if (!git?.available) return "Commit unavailable";
|
|
return `${git.shortSha} · ${git.subject}`;
|
|
}
|
|
|
|
function localChangesLabel(health: HealthStatus | undefined): string {
|
|
const git = health?.serverInfo?.git;
|
|
if (!git?.available) return "Unavailable";
|
|
const localChanges = git.localChanges;
|
|
if (!localChanges) return "Change status unavailable";
|
|
if (!localChanges.available) return "Change status unavailable";
|
|
if (!localChanges.hasLocalChanges) return "Clean checkout";
|
|
|
|
const parts = [
|
|
[localChanges.stagedFileCount, "staged"],
|
|
[localChanges.unstagedFileCount, "unstaged"],
|
|
[localChanges.untrackedFileCount, "untracked"],
|
|
]
|
|
.filter(([count]) => Number(count) > 0)
|
|
.map(([count, label]) => `${count} ${label}`);
|
|
|
|
return parts.length > 0 ? `Local changes present (${parts.join(", ")})` : "Local changes present";
|
|
}
|
|
|
|
function ServerInfoRow({
|
|
icon: Icon,
|
|
label,
|
|
value,
|
|
dateTime,
|
|
}: {
|
|
icon: LucideIcon;
|
|
label: string;
|
|
value: string;
|
|
dateTime?: string | null;
|
|
}) {
|
|
return (
|
|
<div className="flex w-full items-start gap-3 rounded-xl px-3 py-3 text-left">
|
|
<span className="mt-0.5 rounded-lg border border-border bg-background/70 p-2 text-muted-foreground">
|
|
<Icon className="size-4" />
|
|
</span>
|
|
<span className="min-w-0 flex-1">
|
|
<span className="block text-sm font-medium text-foreground">{label}</span>
|
|
{dateTime ? (
|
|
<time dateTime={dateTime} className="block break-words text-xs text-muted-foreground">
|
|
{value}
|
|
</time>
|
|
) : (
|
|
<span className="block break-words text-xs text-muted-foreground">{value}</span>
|
|
)}
|
|
</span>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export function SidebarServerInfo() {
|
|
const experimentalQuery = useQuery({
|
|
queryKey: queryKeys.instance.experimentalSettings,
|
|
queryFn: () => instanceSettingsApi.getExperimental(),
|
|
});
|
|
const enabled = experimentalQuery.data?.enableServerInfoDebugView === true;
|
|
const healthQuery = useQuery({
|
|
queryKey: queryKeys.health,
|
|
queryFn: () => healthApi.get(),
|
|
enabled,
|
|
// The drawer only mounts while the account popover is open, so it cannot
|
|
// rely on Layout's background health poll (which is itself gated on
|
|
// devServer.enabled). Always refetch on open and poll while open so a server
|
|
// restart is reflected without leaving stale boot-time serverInfo on screen.
|
|
refetchOnMount: "always",
|
|
refetchInterval: (query) => {
|
|
const data = query.state.data as HealthStatus | undefined;
|
|
return data?.devServer?.enabled ? 2000 : false;
|
|
},
|
|
});
|
|
|
|
if (!enabled) return null;
|
|
|
|
const health = healthQuery.data;
|
|
const isWaitingForHealth = healthQuery.isLoading && !health;
|
|
const healthUnavailable = healthQuery.isError;
|
|
const restartedAt = restartTimestamp(health);
|
|
const restartedAtIsValid = isValidTimestamp(restartedAt);
|
|
const lastRestartedLabel = healthUnavailable
|
|
? "Health unavailable"
|
|
: isWaitingForHealth
|
|
? "Loading..."
|
|
: formatTimestamp(restartedAt);
|
|
const commit = healthUnavailable
|
|
? "Health unavailable"
|
|
: isWaitingForHealth
|
|
? "Loading..."
|
|
: commitLabel(health);
|
|
const localChanges = healthUnavailable
|
|
? "Health unavailable"
|
|
: isWaitingForHealth
|
|
? "Loading..."
|
|
: localChangesLabel(health);
|
|
|
|
return (
|
|
<div className="mt-2 border-t border-border pt-2">
|
|
<p className="px-3 pb-1 pt-1 text-(length:--text-micro) font-medium uppercase tracking-wide text-muted-foreground">
|
|
Server
|
|
</p>
|
|
<ServerInfoRow
|
|
icon={Clock3}
|
|
label="Last restarted"
|
|
value={lastRestartedLabel}
|
|
dateTime={!healthUnavailable && !isWaitingForHealth && restartedAtIsValid ? restartedAt : null}
|
|
/>
|
|
<ServerInfoRow icon={GitCommit} label="Running commit" value={commit} />
|
|
<ServerInfoRow icon={FileDiff} label="Checkout state" value={localChanges} />
|
|
</div>
|
|
);
|
|
}
|