mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-30 21:49:18 +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>
387 lines
14 KiB
TypeScript
387 lines
14 KiB
TypeScript
import { useState } from "react";
|
|
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
|
import type { SecretStatus, UserSecretDefinition } from "@paperclipai/shared";
|
|
import { AlertCircle, Pencil, Plus, Trash2, UserRound, Users } from "lucide-react";
|
|
import {
|
|
Dialog,
|
|
DialogContent,
|
|
DialogDescription,
|
|
DialogFooter,
|
|
DialogHeader,
|
|
DialogTitle,
|
|
} from "@/components/ui/dialog";
|
|
import {
|
|
Select,
|
|
SelectContent,
|
|
SelectItem,
|
|
SelectTrigger,
|
|
SelectValue,
|
|
} from "@/components/ui/select";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Input } from "@/components/ui/input";
|
|
import { Textarea } from "@/components/ui/textarea";
|
|
import { Badge } from "@/components/ui/badge";
|
|
import { EmptyState } from "../../components/EmptyState";
|
|
import { secretsApi } from "../../api/secrets";
|
|
import { ApiError } from "../../api/client";
|
|
import { queryKeys } from "../../lib/queryKeys";
|
|
import { cn } from "../../lib/utils";
|
|
import { useToastActions } from "../../context/ToastContext";
|
|
import {
|
|
coverageSummaryLabel,
|
|
secretStatusTone,
|
|
UserSecretChip,
|
|
} from "./user-secret-presentation";
|
|
|
|
function keyFromName(name: string): string {
|
|
return name
|
|
.trim()
|
|
.toUpperCase()
|
|
.replace(/[^A-Z0-9_]+/g, "_")
|
|
.replace(/^_+|_+$/g, "")
|
|
.slice(0, 120);
|
|
}
|
|
|
|
interface DefinitionForm {
|
|
name: string;
|
|
key: string;
|
|
description: string;
|
|
usageGuidance: string;
|
|
status: SecretStatus;
|
|
}
|
|
|
|
const emptyForm: DefinitionForm = {
|
|
name: "",
|
|
key: "",
|
|
description: "",
|
|
usageGuidance: "",
|
|
status: "active",
|
|
};
|
|
|
|
/**
|
|
* Secrets → User secret definitions tab (admin). Defines the shared credentials
|
|
* that each member fills in with their own value. Coverage is shown as counts
|
|
* only — never values — per the UX terminology decisions.
|
|
*/
|
|
export function UserSecretDefinitionsTab({ companyId }: { companyId: string }) {
|
|
const queryClient = useQueryClient();
|
|
const { pushToast } = useToastActions();
|
|
const [dialogOpen, setDialogOpen] = useState(false);
|
|
const [editing, setEditing] = useState<UserSecretDefinition | null>(null);
|
|
const [form, setForm] = useState<DefinitionForm>(emptyForm);
|
|
const [keyDirty, setKeyDirty] = useState(false);
|
|
const [error, setError] = useState<string | null>(null);
|
|
const [deleteTarget, setDeleteTarget] = useState<UserSecretDefinition | null>(null);
|
|
|
|
const definitionsQuery = useQuery({
|
|
queryKey: queryKeys.secrets.userDefinitions(companyId),
|
|
queryFn: () => secretsApi.listUserSecretDefinitions(companyId),
|
|
});
|
|
const definitions = definitionsQuery.data ?? [];
|
|
|
|
function openCreate() {
|
|
setEditing(null);
|
|
setForm(emptyForm);
|
|
setKeyDirty(false);
|
|
setError(null);
|
|
setDialogOpen(true);
|
|
}
|
|
|
|
function openEdit(definition: UserSecretDefinition) {
|
|
setEditing(definition);
|
|
setForm({
|
|
name: definition.name,
|
|
key: definition.key,
|
|
description: definition.description ?? "",
|
|
usageGuidance: definition.usageGuidance ?? "",
|
|
status: definition.status,
|
|
});
|
|
setKeyDirty(true);
|
|
setError(null);
|
|
setDialogOpen(true);
|
|
}
|
|
|
|
const save = useMutation({
|
|
mutationFn: async () => {
|
|
const sharedPayload = {
|
|
name: form.name.trim(),
|
|
description: form.description.trim() || null,
|
|
usageGuidance: form.usageGuidance.trim() || null,
|
|
};
|
|
if (editing) {
|
|
return secretsApi.updateUserSecretDefinition(companyId, editing.id, {
|
|
...sharedPayload,
|
|
status: form.status,
|
|
});
|
|
}
|
|
return secretsApi.createUserSecretDefinition(companyId, {
|
|
...sharedPayload,
|
|
key: form.key.trim(),
|
|
status: form.status === "deleted" ? "active" : form.status,
|
|
});
|
|
},
|
|
onSuccess: (definition) => {
|
|
queryClient.invalidateQueries({ queryKey: queryKeys.secrets.userDefinitions(companyId) });
|
|
pushToast({
|
|
title: editing ? "Definition updated" : "Definition created",
|
|
body: definition.name,
|
|
tone: "success",
|
|
});
|
|
setDialogOpen(false);
|
|
},
|
|
onError: (err) =>
|
|
setError(err instanceof ApiError || err instanceof Error ? err.message : "Failed to save"),
|
|
});
|
|
|
|
const remove = useMutation({
|
|
mutationFn: (definition: UserSecretDefinition) =>
|
|
secretsApi.removeUserSecretDefinition(companyId, definition.id),
|
|
onSuccess: () => {
|
|
queryClient.invalidateQueries({ queryKey: queryKeys.secrets.userDefinitions(companyId) });
|
|
pushToast({ title: "Definition removed", tone: "info" });
|
|
setDeleteTarget(null);
|
|
},
|
|
onError: (err) =>
|
|
pushToast({
|
|
title: "Could not remove definition",
|
|
body: err instanceof Error ? err.message : undefined,
|
|
tone: "error",
|
|
}),
|
|
});
|
|
|
|
const canSave = form.name.trim().length > 0 && form.key.trim().length > 0;
|
|
|
|
return (
|
|
<div className="flex min-h-0 flex-1 flex-col gap-3 overflow-hidden">
|
|
<div className="flex items-start gap-2 rounded-md border border-violet-500/30 bg-violet-500/5 px-4 py-3 text-xs text-violet-800 dark:text-violet-200">
|
|
<UserRound className="h-4 w-4 mt-0.5 shrink-0" />
|
|
<p>
|
|
Define credentials that <span className="font-medium">each member supplies for
|
|
themselves</span>. You set the shape here; every user enters their own value under My
|
|
secrets. Coverage shows how many members have set a value — never the values themselves.
|
|
</p>
|
|
</div>
|
|
|
|
<div className="flex items-center justify-end">
|
|
<Button size="sm" onClick={openCreate}>
|
|
<Plus className="mr-1 h-3.5 w-3.5" /> New user secret
|
|
</Button>
|
|
</div>
|
|
|
|
<div className="min-h-0 flex-1 overflow-y-auto">
|
|
{definitionsQuery.isError ? (
|
|
<div className="flex items-center gap-2 py-4 text-sm text-destructive">
|
|
<AlertCircle className="h-4 w-4" /> Failed to load definitions:{" "}
|
|
{(definitionsQuery.error as Error).message}
|
|
<Button variant="ghost" size="sm" onClick={() => definitionsQuery.refetch()}>
|
|
Retry
|
|
</Button>
|
|
</div>
|
|
) : definitions.length === 0 && !definitionsQuery.isPending ? (
|
|
<EmptyState
|
|
icon={UserRound}
|
|
message="No user secret definitions yet. Create one to require each member to supply their own credential."
|
|
action="New user secret"
|
|
onAction={openCreate}
|
|
/>
|
|
) : (
|
|
<ul className="space-y-2">
|
|
{definitions.map((definition) => (
|
|
<li
|
|
key={definition.id}
|
|
className="flex items-start gap-3 rounded-md border border-border p-3"
|
|
>
|
|
<div className="min-w-0 flex-1">
|
|
<div className="flex flex-wrap items-center gap-2">
|
|
<span className="font-medium text-foreground">{definition.name}</span>
|
|
<code className="rounded bg-muted px-1.5 py-0.5 text-(length:--text-micro) text-muted-foreground">
|
|
{definition.key}
|
|
</code>
|
|
<UserSecretChip />
|
|
<Badge
|
|
variant="outline"
|
|
className={cn("text-(length:--text-micro)", secretStatusTone(definition.status))}
|
|
>
|
|
{definition.status}
|
|
</Badge>
|
|
</div>
|
|
{definition.description ? (
|
|
<p className="mt-1 text-xs text-muted-foreground">{definition.description}</p>
|
|
) : null}
|
|
<CoverageBadge companyId={companyId} definitionId={definition.id} />
|
|
</div>
|
|
<div className="flex shrink-0 items-center gap-1">
|
|
<Button size="sm" variant="ghost" onClick={() => openEdit(definition)}>
|
|
<Pencil className="h-3.5 w-3.5" />
|
|
</Button>
|
|
<Button
|
|
size="sm"
|
|
variant="ghost"
|
|
className="text-muted-foreground hover:text-destructive"
|
|
onClick={() => setDeleteTarget(definition)}
|
|
>
|
|
<Trash2 className="h-3.5 w-3.5" />
|
|
</Button>
|
|
</div>
|
|
</li>
|
|
))}
|
|
</ul>
|
|
)}
|
|
</div>
|
|
|
|
{/* Create / edit dialog */}
|
|
<Dialog open={dialogOpen} onOpenChange={setDialogOpen}>
|
|
<DialogContent>
|
|
<DialogHeader>
|
|
<DialogTitle className="flex items-center gap-2">
|
|
{editing ? "Edit user secret" : "New user secret"}
|
|
<UserSecretChip />
|
|
</DialogTitle>
|
|
<DialogDescription>
|
|
Members supply their own value for this credential. No value is entered here.
|
|
</DialogDescription>
|
|
</DialogHeader>
|
|
|
|
<div className="space-y-3">
|
|
<div className="space-y-1">
|
|
<label className="text-xs font-medium text-foreground">Name</label>
|
|
<Input
|
|
value={form.name}
|
|
onChange={(event) => {
|
|
const name = event.target.value;
|
|
setForm((current) => ({
|
|
...current,
|
|
name,
|
|
key: keyDirty ? current.key : keyFromName(name),
|
|
}));
|
|
}}
|
|
placeholder="Personal GitHub token"
|
|
autoFocus
|
|
/>
|
|
</div>
|
|
<div className="space-y-1">
|
|
<label className="text-xs font-medium text-foreground">Key</label>
|
|
<Input
|
|
value={form.key}
|
|
onChange={(event) => {
|
|
setKeyDirty(true);
|
|
setForm((current) => ({ ...current, key: event.target.value }));
|
|
}}
|
|
placeholder="PERSONAL_GH_TOKEN"
|
|
className="font-mono text-sm"
|
|
disabled={Boolean(editing)}
|
|
/>
|
|
<p className="text-(length:--text-micro) text-muted-foreground">
|
|
Stable identifier referenced by env bindings. {editing ? "Cannot be changed." : ""}
|
|
</p>
|
|
</div>
|
|
<div className="space-y-1">
|
|
<label className="text-xs font-medium text-foreground">Description</label>
|
|
<Input
|
|
value={form.description}
|
|
onChange={(event) =>
|
|
setForm((current) => ({ ...current, description: event.target.value }))
|
|
}
|
|
placeholder="What this credential is for"
|
|
/>
|
|
</div>
|
|
<div className="space-y-1">
|
|
<label className="text-xs font-medium text-foreground">
|
|
Usage guidance <span className="text-muted-foreground">(optional)</span>
|
|
</label>
|
|
<Textarea
|
|
value={form.usageGuidance}
|
|
onChange={(event) =>
|
|
setForm((current) => ({ ...current, usageGuidance: event.target.value }))
|
|
}
|
|
placeholder="Tell members how to create their token, required scopes, etc."
|
|
className="min-h-(--sz-70px) text-sm"
|
|
/>
|
|
</div>
|
|
{editing ? (
|
|
<div className="space-y-1">
|
|
<label className="text-xs font-medium text-foreground">Status</label>
|
|
<Select
|
|
value={form.status}
|
|
onValueChange={(status) =>
|
|
setForm((current) => ({ ...current, status: status as SecretStatus }))
|
|
}
|
|
>
|
|
<SelectTrigger className="w-40">
|
|
<SelectValue />
|
|
</SelectTrigger>
|
|
<SelectContent>
|
|
<SelectItem value="active">Active</SelectItem>
|
|
<SelectItem value="disabled">Disabled</SelectItem>
|
|
<SelectItem value="archived">Archived</SelectItem>
|
|
</SelectContent>
|
|
</Select>
|
|
</div>
|
|
) : null}
|
|
{error ? <p className="text-xs text-destructive">{error}</p> : null}
|
|
</div>
|
|
|
|
<DialogFooter>
|
|
<Button variant="ghost" onClick={() => setDialogOpen(false)} disabled={save.isPending}>
|
|
Cancel
|
|
</Button>
|
|
<Button onClick={() => save.mutate()} disabled={!canSave || save.isPending}>
|
|
{save.isPending ? "Saving…" : editing ? "Save changes" : "Create"}
|
|
</Button>
|
|
</DialogFooter>
|
|
</DialogContent>
|
|
</Dialog>
|
|
|
|
{/* Delete confirm */}
|
|
<Dialog open={deleteTarget !== null} onOpenChange={(open) => !open && setDeleteTarget(null)}>
|
|
<DialogContent>
|
|
<DialogHeader>
|
|
<DialogTitle>Remove user secret?</DialogTitle>
|
|
<DialogDescription>
|
|
This removes the definition <span className="font-mono">{deleteTarget?.key}</span> for
|
|
the whole company. Existing member values become unreferenced. This cannot be undone.
|
|
</DialogDescription>
|
|
</DialogHeader>
|
|
<DialogFooter>
|
|
<Button variant="ghost" onClick={() => setDeleteTarget(null)} disabled={remove.isPending}>
|
|
Cancel
|
|
</Button>
|
|
<Button
|
|
variant="destructive"
|
|
onClick={() => deleteTarget && remove.mutate(deleteTarget)}
|
|
disabled={remove.isPending}
|
|
>
|
|
{remove.isPending ? "Removing…" : "Remove"}
|
|
</Button>
|
|
</DialogFooter>
|
|
</DialogContent>
|
|
</Dialog>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function CoverageBadge({
|
|
companyId,
|
|
definitionId,
|
|
}: {
|
|
companyId: string;
|
|
definitionId: string;
|
|
}) {
|
|
const coverageQuery = useQuery({
|
|
queryKey: queryKeys.secrets.userDefinitionCoverage(companyId, definitionId),
|
|
queryFn: () => secretsApi.userSecretDefinitionCoverage(companyId, definitionId),
|
|
staleTime: 30_000,
|
|
});
|
|
const summary = coverageQuery.data;
|
|
const missing = summary ? summary.missingCount : 0;
|
|
return (
|
|
<p className="mt-1 inline-flex items-center gap-1 text-(length:--text-micro) text-muted-foreground">
|
|
<Users className="h-3 w-3" />
|
|
Coverage: {coverageSummaryLabel(summary)}
|
|
{summary && missing > 0 ? (
|
|
<span className="text-amber-600 dark:text-amber-400">· {missing} not set</span>
|
|
) : null}
|
|
</p>
|
|
);
|
|
}
|