mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 00:05:49 +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>
175 lines
6.1 KiB
TypeScript
175 lines
6.1 KiB
TypeScript
import { useEffect, useState } from "react";
|
|
import { useMutation, useQueryClient } from "@tanstack/react-query";
|
|
import type { CompanySecret, UserSecretDefinition } from "@paperclipai/shared";
|
|
import {
|
|
Dialog,
|
|
DialogContent,
|
|
DialogDescription,
|
|
DialogFooter,
|
|
DialogHeader,
|
|
DialogTitle,
|
|
} from "@/components/ui/dialog";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Input } from "@/components/ui/input";
|
|
import { Textarea } from "@/components/ui/textarea";
|
|
import { secretsApi } from "../../api/secrets";
|
|
import { ApiError } from "../../api/client";
|
|
import { queryKeys } from "../../lib/queryKeys";
|
|
import { useToastActions } from "../../context/ToastContext";
|
|
import { UserSecretChip } from "./user-secret-presentation";
|
|
|
|
/**
|
|
* Shared "set my value" dialog for a user-secret definition. Used both from the
|
|
* Secrets → My secrets tab and from the missing-required-secret warning surfaces
|
|
* (task run / issue failure), so a user can satisfy a required secret from either
|
|
* place with identical behavior.
|
|
*/
|
|
export function SetMyUserSecretDialog({
|
|
companyId,
|
|
definition,
|
|
existingSecret,
|
|
open,
|
|
onOpenChange,
|
|
onSaved,
|
|
}: {
|
|
companyId: string;
|
|
definition: UserSecretDefinition | null;
|
|
existingSecret?: CompanySecret | null;
|
|
open: boolean;
|
|
onOpenChange: (open: boolean) => void;
|
|
onSaved?: (secret: CompanySecret) => void;
|
|
}) {
|
|
const queryClient = useQueryClient();
|
|
const { pushToast } = useToastActions();
|
|
const [value, setValue] = useState("");
|
|
const [externalRef, setExternalRef] = useState("");
|
|
const [error, setError] = useState<string | null>(null);
|
|
|
|
const isExternal = definition?.managedMode === "external_reference";
|
|
|
|
useEffect(() => {
|
|
if (open) {
|
|
setValue("");
|
|
setExternalRef("");
|
|
setError(null);
|
|
}
|
|
}, [open, definition?.id]);
|
|
|
|
const save = useMutation({
|
|
mutationFn: async () => {
|
|
if (!definition) throw new Error("No definition selected");
|
|
const payload = isExternal
|
|
? { externalRef: externalRef.trim() }
|
|
: { value: value.trim() };
|
|
if (existingSecret) {
|
|
// A stored value already exists → rotate it in place.
|
|
return secretsApi.rotateMyUserSecret(companyId, existingSecret.id, payload);
|
|
}
|
|
return secretsApi.createMyUserSecret(companyId, {
|
|
definitionId: definition.id,
|
|
definitionKey: definition.key,
|
|
...payload,
|
|
});
|
|
},
|
|
onSuccess: (secret) => {
|
|
queryClient.invalidateQueries({ queryKey: queryKeys.secrets.myUserSecrets(companyId) });
|
|
queryClient.invalidateQueries({ queryKey: queryKeys.secrets.userDefinitions(companyId) });
|
|
pushToast({
|
|
title: existingSecret ? "Value updated" : "Value saved",
|
|
body: definition?.name,
|
|
tone: "success",
|
|
});
|
|
onSaved?.(secret);
|
|
onOpenChange(false);
|
|
},
|
|
onError: (err) => {
|
|
setError(
|
|
err instanceof ApiError
|
|
? err.message
|
|
: err instanceof Error
|
|
? err.message
|
|
: "Failed to save value",
|
|
);
|
|
},
|
|
});
|
|
|
|
const canSave = isExternal ? externalRef.trim().length > 0 : value.trim().length > 0;
|
|
|
|
return (
|
|
<Dialog open={open} onOpenChange={onOpenChange}>
|
|
<DialogContent>
|
|
<DialogHeader>
|
|
<DialogTitle className="flex items-center gap-2">
|
|
{existingSecret ? "Update your value" : "Set your value"}
|
|
<UserSecretChip />
|
|
</DialogTitle>
|
|
<DialogDescription>
|
|
{definition ? (
|
|
<>
|
|
This value is yours only. It is used when you are the user responsible for a run that
|
|
needs <span className="font-mono">{definition.key}</span>.
|
|
</>
|
|
) : null}
|
|
</DialogDescription>
|
|
</DialogHeader>
|
|
|
|
{definition ? (
|
|
<div className="space-y-3">
|
|
<div className="rounded-md border border-border bg-muted/20 p-3 text-xs">
|
|
<div className="font-medium text-foreground">{definition.name}</div>
|
|
{definition.description ? (
|
|
<p className="mt-1 text-muted-foreground">{definition.description}</p>
|
|
) : null}
|
|
{definition.usageGuidance ? (
|
|
<p className="mt-1 text-muted-foreground">{definition.usageGuidance}</p>
|
|
) : null}
|
|
</div>
|
|
|
|
{isExternal ? (
|
|
<div className="space-y-1">
|
|
<label className="text-xs font-medium text-foreground">External reference</label>
|
|
<Input
|
|
value={externalRef}
|
|
onChange={(event) => setExternalRef(event.target.value)}
|
|
placeholder="provider reference or ARN"
|
|
className="font-mono text-sm"
|
|
autoFocus
|
|
/>
|
|
<p className="text-(length:--text-micro) text-muted-foreground">
|
|
Points at your own credential in the configured provider. Paperclip stores the
|
|
reference, not the value.
|
|
</p>
|
|
</div>
|
|
) : (
|
|
<div className="space-y-1">
|
|
<label className="text-xs font-medium text-foreground">Your value</label>
|
|
<Textarea
|
|
value={value}
|
|
onChange={(event) => setValue(event.target.value)}
|
|
placeholder="Paste your token or credential"
|
|
className="font-mono text-sm min-h-(--sz-80px)"
|
|
autoFocus
|
|
/>
|
|
<p className="text-(length:--text-micro) text-muted-foreground">
|
|
Stored encrypted. Never shown back to anyone, including admins.
|
|
</p>
|
|
</div>
|
|
)}
|
|
|
|
{error ? <p className="text-xs text-destructive">{error}</p> : null}
|
|
</div>
|
|
) : null}
|
|
|
|
<DialogFooter>
|
|
<Button variant="ghost" onClick={() => onOpenChange(false)} disabled={save.isPending}>
|
|
Cancel
|
|
</Button>
|
|
<Button onClick={() => save.mutate()} disabled={!canSave || save.isPending}>
|
|
{save.isPending ? "Saving…" : existingSecret ? "Update value" : "Save value"}
|
|
</Button>
|
|
</DialogFooter>
|
|
</DialogContent>
|
|
</Dialog>
|
|
);
|
|
}
|