Files
PaperClipAI/ui/src/components/environment-variables-editor/CreateSecretPopover.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

157 lines
6.4 KiB
TypeScript

import { useState } from "react";
import { Eye, EyeOff, Loader2 } from "lucide-react";
import { Button } from "@/components/ui/button";
import { cn } from "@/lib/utils";
import { PopoverTitle, PopoverDescription } from "@/components/ui/popover";
const SECRET_NAME_RE = /^[a-z][a-z0-9_]*$/;
const fieldClass =
"w-full rounded-md border border-border px-2.5 py-1.5 bg-transparent outline-none text-sm font-mono placeholder:text-muted-foreground/40 focus-visible:ring-2 focus-visible:ring-ring/40";
export interface SecretPopoverFormProps {
/** Popover heading / body copy differ between the two flows. */
mode: "create" | "store";
initialName: string;
/** The plaintext value being stored. Editable (create) or read-only (store). */
initialValue: string;
/** For a same-name uniqueness hint before the server round-trips. */
existingSecretNames?: readonly string[];
onCancel: () => void;
/** Resolves once the secret is created + the row is bound; rejects with a message. */
onSubmit: (name: string, value: string) => Promise<void>;
}
/**
* Shared anchored-popover form behind {@link CreateSecretPopover} and
* {@link ConvertToSecretPopover}. Replaces the old `window.prompt` seal flow
* (plan §6.5). Meant to be rendered inside a `<PopoverContent>`.
*/
export function SecretPopoverForm({
mode,
initialName,
initialValue,
existingSecretNames,
onCancel,
onSubmit,
}: SecretPopoverFormProps) {
const [name, setName] = useState(initialName);
const [value, setValue] = useState(initialValue);
const [reveal, setReveal] = useState(false);
const [submitting, setSubmitting] = useState(false);
const [error, setError] = useState<string | null>(null);
const [touched, setTouched] = useState(false);
const trimmedName = name.trim();
const nameError = (() => {
if (!trimmedName) return touched ? "Name is required" : null;
if (!SECRET_NAME_RE.test(trimmedName)) return "Use lowercase letters, digits and _";
if (existingSecretNames?.some((existing) => existing.toLowerCase() === trimmedName)) {
return "A secret with this name already exists";
}
return null;
})();
const valueError = value.length === 0 ? (touched ? "Value is required" : null) : null;
const canSubmit = !submitting && trimmedName.length > 0 && value.length > 0 && !nameError;
async function handleSubmit() {
setTouched(true);
if (!canSubmit) return;
setSubmitting(true);
setError(null);
try {
await onSubmit(trimmedName, value);
} catch (submitError) {
setError(submitError instanceof Error ? submitError.message : "Failed to create secret");
setSubmitting(false);
}
}
const ctaLabel = mode === "create" ? "Create & bind" : "Store & bind";
const heading = mode === "create" ? "Create secret" : "Store value as secret";
return (
<div className="w-72 space-y-3">
<div className="space-y-1">
<PopoverTitle className="text-sm font-medium">{heading}</PopoverTitle>
{mode === "store" ? (
<PopoverDescription className="text-(length:--text-micro) text-muted-foreground">
Moves the typed value into an encrypted company secret and binds{" "}
<span className="font-mono">{initialName || "this variable"}</span> to it.
</PopoverDescription>
) : null}
</div>
<label className="block space-y-1">
<span className="text-(length:--text-micro) font-medium text-muted-foreground">Name</span>
<input
className={cn(fieldClass, nameError && "border-destructive focus-visible:ring-destructive/40")}
value={name}
autoFocus
spellCheck={false}
placeholder="secret_name"
aria-label="Secret name"
aria-invalid={nameError ? true : undefined}
onChange={(event) => setName(event.target.value)}
onBlur={() => setTouched(true)}
onKeyDown={(event) => {
if (event.key === "Enter") {
event.preventDefault();
void handleSubmit();
}
}}
/>
{nameError ? <span className="block text-(length:--text-micro) text-destructive">{nameError}</span> : null}
</label>
<label className="block space-y-1">
<span className="text-(length:--text-micro) font-medium text-muted-foreground">Value</span>
<div className="relative">
<input
className={cn(fieldClass, "pr-8", valueError && "border-destructive focus-visible:ring-destructive/40")}
type={reveal ? "text" : "password"}
value={value}
readOnly={mode === "store"}
spellCheck={false}
placeholder={mode === "create" ? "value" : undefined}
aria-label="Secret value"
aria-invalid={valueError ? true : undefined}
onChange={mode === "create" ? (event) => setValue(event.target.value) : undefined}
/>
<button
type="button"
className="absolute right-1.5 top-1/2 -translate-y-1/2 rounded p-1 text-muted-foreground hover:text-foreground"
aria-label={reveal ? "Hide value" : "Show value"}
onClick={() => setReveal((prev) => !prev)}
>
{reveal ? <EyeOff className="h-3.5 w-3.5" /> : <Eye className="h-3.5 w-3.5" />}
</button>
</div>
{valueError ? <span className="block text-(length:--text-micro) text-destructive">{valueError}</span> : null}
</label>
{error ? <p className="text-(length:--text-micro) text-destructive">{error}</p> : null}
<div className="flex items-center justify-end gap-2 pt-0.5">
<Button type="button" variant="ghost" size="sm" onClick={onCancel} disabled={submitting}>
Cancel
</Button>
<Button type="button" size="sm" onClick={() => void handleSubmit()} disabled={!canSubmit}>
{submitting ? <Loader2 className="h-3.5 w-3.5 animate-spin" /> : null}
{ctaLabel}
</Button>
</div>
</div>
);
}
/** Create a brand-new secret from the fuzzy picker's creatable item (§6.4/§6.5). */
export function CreateSecretPopover(props: Omit<SecretPopoverFormProps, "mode">) {
return <SecretPopoverForm mode="create" {...props} />;
}
/** Store a typed Text value as a secret and bind the row (replaces "Seal", §6.5). */
export function ConvertToSecretPopover(props: Omit<SecretPopoverFormProps, "mode">) {
return <SecretPopoverForm mode="store" {...props} />;
}