mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-03 09:37:19 +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>
251 lines
10 KiB
TypeScript
251 lines
10 KiB
TypeScript
import { useEffect, useMemo, useState } from "react";
|
|
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
|
import { Shield, ShieldCheck } from "lucide-react";
|
|
import { accessApi } from "@/api/access";
|
|
import { ApiError } from "@/api/client";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Checkbox } from "@/components/ui/checkbox";
|
|
import { useBreadcrumbs } from "@/context/BreadcrumbContext";
|
|
import { useCompany } from "@/context/CompanyContext";
|
|
import { useToast } from "@/context/ToastContext";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
|
|
export function InstanceAccess() {
|
|
const { companies } = useCompany();
|
|
const { setBreadcrumbs } = useBreadcrumbs();
|
|
const { pushToast } = useToast();
|
|
const queryClient = useQueryClient();
|
|
const [search, setSearch] = useState("");
|
|
const [selectedUserId, setSelectedUserId] = useState<string | null>(null);
|
|
const [selectedCompanyIds, setSelectedCompanyIds] = useState<Set<string>>(new Set());
|
|
|
|
useEffect(() => {
|
|
setBreadcrumbs([
|
|
{ label: "Settings", href: "/company/settings" },
|
|
{ label: "Instance settings", href: "/company/settings/instance/general" },
|
|
{ label: "Access" },
|
|
]);
|
|
}, [setBreadcrumbs]);
|
|
|
|
const usersQuery = useQuery({
|
|
queryKey: queryKeys.access.adminUsers(search),
|
|
queryFn: () => accessApi.searchAdminUsers(search),
|
|
});
|
|
|
|
const selectedUser = useMemo(
|
|
() => usersQuery.data?.find((user) => user.id === selectedUserId) ?? null,
|
|
[selectedUserId, usersQuery.data],
|
|
);
|
|
|
|
const userAccessQuery = useQuery({
|
|
queryKey: queryKeys.access.userCompanyAccess(selectedUserId ?? ""),
|
|
queryFn: () => accessApi.getUserCompanyAccess(selectedUserId!),
|
|
enabled: !!selectedUserId,
|
|
});
|
|
|
|
useEffect(() => {
|
|
if (!selectedUserId && usersQuery.data?.[0]) {
|
|
setSelectedUserId(usersQuery.data[0].id);
|
|
}
|
|
}, [selectedUserId, usersQuery.data]);
|
|
|
|
useEffect(() => {
|
|
if (!userAccessQuery.data) return;
|
|
setSelectedCompanyIds(
|
|
new Set(
|
|
userAccessQuery.data.companyAccess
|
|
.filter((membership) => membership.status === "active")
|
|
.map((membership) => membership.companyId),
|
|
),
|
|
);
|
|
}, [userAccessQuery.data]);
|
|
|
|
const updateCompanyAccessMutation = useMutation({
|
|
mutationFn: () => accessApi.setUserCompanyAccess(selectedUserId!, [...selectedCompanyIds]),
|
|
onSuccess: async () => {
|
|
await queryClient.invalidateQueries({ queryKey: queryKeys.access.userCompanyAccess(selectedUserId!) });
|
|
await queryClient.invalidateQueries({ queryKey: queryKeys.access.adminUsers(search) });
|
|
pushToast({ title: "Company access updated", tone: "success" });
|
|
},
|
|
});
|
|
|
|
const setAdminMutation = useMutation({
|
|
mutationFn: async (makeAdmin: boolean) => {
|
|
if (!selectedUserId) throw new Error("No user selected");
|
|
if (makeAdmin) return accessApi.promoteInstanceAdmin(selectedUserId);
|
|
return accessApi.demoteInstanceAdmin(selectedUserId);
|
|
},
|
|
onSuccess: async () => {
|
|
await queryClient.invalidateQueries({ queryKey: queryKeys.access.adminUsers(search) });
|
|
if (selectedUserId) {
|
|
await queryClient.invalidateQueries({ queryKey: queryKeys.access.userCompanyAccess(selectedUserId) });
|
|
}
|
|
pushToast({ title: "Instance role updated", tone: "success" });
|
|
},
|
|
});
|
|
|
|
if (usersQuery.isLoading) {
|
|
return <div className="text-sm text-muted-foreground">Loading instance users…</div>;
|
|
}
|
|
|
|
if (usersQuery.error) {
|
|
const message =
|
|
usersQuery.error instanceof ApiError && usersQuery.error.status === 403
|
|
? "Instance admin access is required to manage users."
|
|
: usersQuery.error instanceof Error
|
|
? usersQuery.error.message
|
|
: "Failed to load users.";
|
|
return <div className="text-sm text-destructive">{message}</div>;
|
|
}
|
|
|
|
return (
|
|
<div className="max-w-6xl space-y-6">
|
|
<div className="space-y-3">
|
|
<div className="flex items-center gap-2">
|
|
<Shield className="h-5 w-5 text-muted-foreground" />
|
|
<h1 className="text-lg font-semibold">Instance Access</h1>
|
|
</div>
|
|
<p className="max-w-3xl text-sm text-muted-foreground">
|
|
Search users, manage instance-admin status, and control which companies they can access.
|
|
</p>
|
|
</div>
|
|
|
|
<div className="grid gap-6 lg:grid-cols-(--gtc-34)">
|
|
<section className="space-y-4 rounded-xl border border-border bg-card p-4">
|
|
<label className="block space-y-2 text-sm">
|
|
<span className="font-medium">Search users</span>
|
|
<input
|
|
className="w-full rounded-md border border-border bg-background px-3 py-2"
|
|
value={search}
|
|
onChange={(event) => setSearch(event.target.value)}
|
|
placeholder="Search by name or email"
|
|
/>
|
|
</label>
|
|
<div className="space-y-2">
|
|
{(usersQuery.data ?? []).map((user) => (
|
|
<button
|
|
key={user.id}
|
|
type="button"
|
|
onClick={() => setSelectedUserId(user.id)}
|
|
className={`w-full rounded-lg border px-3 py-3 text-left transition-colors ${
|
|
user.id === selectedUserId
|
|
? "border-foreground bg-accent"
|
|
: "border-border hover:bg-accent/40"
|
|
}`}
|
|
>
|
|
<div className="flex items-center justify-between gap-2">
|
|
<div className="min-w-0">
|
|
<div className="truncate font-medium">{user.name || user.email || user.id}</div>
|
|
<div className="truncate text-sm text-muted-foreground">{user.email || user.id}</div>
|
|
</div>
|
|
{user.isInstanceAdmin ? (
|
|
<ShieldCheck className="h-4 w-4 text-emerald-600" />
|
|
) : null}
|
|
</div>
|
|
<div className="mt-2 text-xs text-muted-foreground">
|
|
{user.activeCompanyMembershipCount} active company memberships
|
|
</div>
|
|
</button>
|
|
))}
|
|
</div>
|
|
</section>
|
|
|
|
<section className="space-y-4 rounded-xl border border-border bg-card p-5">
|
|
{!selectedUserId ? (
|
|
<div className="text-sm text-muted-foreground">Select a user to inspect instance access.</div>
|
|
) : userAccessQuery.isLoading ? (
|
|
<div className="text-sm text-muted-foreground">Loading user access…</div>
|
|
) : userAccessQuery.error ? (
|
|
<div className="text-sm text-destructive">
|
|
{userAccessQuery.error instanceof Error ? userAccessQuery.error.message : "Failed to load user access."}
|
|
</div>
|
|
) : (
|
|
<>
|
|
<div className="flex flex-wrap items-start justify-between gap-4">
|
|
<div>
|
|
<div className="text-lg font-semibold">
|
|
{selectedUser?.name || selectedUser?.email || selectedUserId}
|
|
</div>
|
|
<div className="text-sm text-muted-foreground">
|
|
{selectedUser?.email || selectedUserId}
|
|
</div>
|
|
</div>
|
|
<Button
|
|
variant={selectedUser?.isInstanceAdmin ? "outline" : "default"}
|
|
onClick={() => setAdminMutation.mutate(!(selectedUser?.isInstanceAdmin ?? false))}
|
|
disabled={setAdminMutation.isPending}
|
|
>
|
|
{selectedUser?.isInstanceAdmin ? "Remove instance admin" : "Promote to instance admin"}
|
|
</Button>
|
|
</div>
|
|
|
|
<div className="space-y-3">
|
|
<div>
|
|
<h2 className="text-sm font-semibold">Company access</h2>
|
|
<p className="text-sm text-muted-foreground">
|
|
Toggle company membership for this user. New access defaults to an active operator membership.
|
|
</p>
|
|
</div>
|
|
<div className="grid gap-3 md:grid-cols-2">
|
|
{companies.map((company) => (
|
|
<label
|
|
key={company.id}
|
|
className="flex items-start gap-3 rounded-lg border border-border px-3 py-3"
|
|
>
|
|
<Checkbox
|
|
checked={selectedCompanyIds.has(company.id)}
|
|
onCheckedChange={(checked) => {
|
|
setSelectedCompanyIds((current) => {
|
|
const next = new Set(current);
|
|
if (checked) next.add(company.id);
|
|
else next.delete(company.id);
|
|
return next;
|
|
});
|
|
}}
|
|
/>
|
|
<span className="space-y-1">
|
|
<span className="block text-sm font-medium">{company.name}</span>
|
|
<span className="block text-xs text-muted-foreground">{company.issuePrefix}</span>
|
|
</span>
|
|
</label>
|
|
))}
|
|
</div>
|
|
<div className="flex justify-end">
|
|
<Button
|
|
onClick={() => updateCompanyAccessMutation.mutate()}
|
|
disabled={updateCompanyAccessMutation.isPending}
|
|
>
|
|
{updateCompanyAccessMutation.isPending ? "Saving…" : "Save company access"}
|
|
</Button>
|
|
</div>
|
|
</div>
|
|
|
|
<div className="space-y-2">
|
|
<h2 className="text-sm font-semibold">Current memberships</h2>
|
|
<div className="space-y-2">
|
|
{(userAccessQuery.data?.companyAccess ?? []).map((membership) => (
|
|
<div
|
|
key={membership.id}
|
|
className="flex items-center justify-between rounded-lg border border-border px-3 py-2 text-sm"
|
|
>
|
|
<div>
|
|
<div className="font-medium">{membership.companyName || membership.companyId}</div>
|
|
<div className="text-muted-foreground">
|
|
{membership.membershipRole || "unset"} • {membership.status}
|
|
</div>
|
|
</div>
|
|
<div className="text-xs text-muted-foreground">
|
|
{new Date(membership.updatedAt).toLocaleDateString()}
|
|
</div>
|
|
</div>
|
|
))}
|
|
</div>
|
|
</div>
|
|
</>
|
|
)}
|
|
</section>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|