mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 08:22:20 +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>
202 lines
7.6 KiB
TypeScript
202 lines
7.6 KiB
TypeScript
import { useMemo, useState } from "react";
|
|
import type { Agent, Issue } from "@paperclipai/shared";
|
|
import { useQuery } from "@tanstack/react-query";
|
|
import { accessApi } from "../api/access";
|
|
import { formatAssigneeUserLabel } from "../lib/assignees";
|
|
import { buildCompanyUserInlineOptions, buildCompanyUserLabelMap } from "../lib/company-members";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
import { sortAgentsByRecency, getRecentAssigneeIds } from "../lib/recent-assignees";
|
|
import {
|
|
buildExecutionPolicy,
|
|
stageParticipantValues,
|
|
} from "../lib/issue-execution-policy";
|
|
import { cn } from "../lib/utils";
|
|
import { Popover, PopoverContent, PopoverTrigger } from "@/components/ui/popover";
|
|
import { User, Eye, ShieldCheck } from "lucide-react";
|
|
import { AgentIcon } from "./AgentIconPicker";
|
|
|
|
type StageType = "review" | "approval";
|
|
|
|
interface ExecutionParticipantPickerProps {
|
|
issue: Issue;
|
|
stageType: StageType;
|
|
agents: Agent[];
|
|
currentUserId: string | null;
|
|
onUpdate: (data: Record<string, unknown>) => void;
|
|
}
|
|
|
|
export function ExecutionParticipantPicker({
|
|
issue,
|
|
stageType,
|
|
agents,
|
|
currentUserId,
|
|
onUpdate,
|
|
}: ExecutionParticipantPickerProps) {
|
|
const [open, setOpen] = useState(false);
|
|
const [search, setSearch] = useState("");
|
|
|
|
const reviewerValues = stageParticipantValues(issue.executionPolicy, "review");
|
|
const approverValues = stageParticipantValues(issue.executionPolicy, "approval");
|
|
const values = stageType === "review" ? reviewerValues : approverValues;
|
|
const { data: companyMembers } = useQuery({
|
|
queryKey: queryKeys.access.companyUserDirectory(issue.companyId),
|
|
queryFn: () => accessApi.listUserDirectory(issue.companyId),
|
|
enabled: !!issue.companyId,
|
|
});
|
|
|
|
const sortedAgents = sortAgentsByRecency(
|
|
agents.filter((a) => a.status !== "terminated"),
|
|
getRecentAssigneeIds(),
|
|
);
|
|
const userLabelMap = useMemo(
|
|
() => buildCompanyUserLabelMap(companyMembers?.users),
|
|
[companyMembers?.users],
|
|
);
|
|
const otherUserOptions = useMemo(
|
|
() => buildCompanyUserInlineOptions(companyMembers?.users, { excludeUserIds: [currentUserId, issue.createdByUserId] }),
|
|
[companyMembers?.users, currentUserId, issue.createdByUserId],
|
|
);
|
|
|
|
const userLabel = (userId: string | null | undefined) =>
|
|
formatAssigneeUserLabel(userId, currentUserId, userLabelMap);
|
|
const creatorUserLabel = userLabel(issue.createdByUserId);
|
|
|
|
const agentName = (id: string) => {
|
|
const agent = agents.find((a) => a.id === id);
|
|
return agent?.name ?? id.slice(0, 8);
|
|
};
|
|
|
|
const participantLabel = (value: string) => {
|
|
if (value.startsWith("agent:")) return agentName(value.slice("agent:".length));
|
|
if (value.startsWith("user:")) return userLabel(value.slice("user:".length)) ?? "User";
|
|
return value;
|
|
};
|
|
|
|
const updatePolicy = (nextValues: string[]) => {
|
|
onUpdate({
|
|
executionPolicy: buildExecutionPolicy({
|
|
existingPolicy: issue.executionPolicy ?? null,
|
|
reviewerValues: stageType === "review" ? nextValues : reviewerValues,
|
|
approverValues: stageType === "approval" ? nextValues : approverValues,
|
|
}),
|
|
});
|
|
};
|
|
|
|
const toggle = (value: string) => {
|
|
const next = values.includes(value)
|
|
? values.filter((v) => v !== value)
|
|
: [...values, value];
|
|
updatePolicy(next);
|
|
};
|
|
|
|
const label = stageType === "review" ? "Reviewers" : "Approvers";
|
|
const Icon = stageType === "review" ? Eye : ShieldCheck;
|
|
|
|
return (
|
|
<Popover open={open} onOpenChange={(o) => { setOpen(o); if (!o) setSearch(""); }}>
|
|
<PopoverTrigger asChild>
|
|
<button
|
|
className={cn(
|
|
"inline-flex items-center gap-1 rounded-full border px-2 py-0.5 text-(length:--text-nano) font-medium transition-colors cursor-pointer",
|
|
values.length > 0
|
|
? "border-border text-foreground hover:bg-accent/50"
|
|
: "border-dashed border-border/60 text-muted-foreground hover:border-border hover:text-foreground",
|
|
)}
|
|
>
|
|
<Icon className="h-3 w-3" />
|
|
{values.length > 0 ? (
|
|
<span className="truncate max-w-(--sz-100px)">
|
|
{values.map(participantLabel).join(", ")}
|
|
</span>
|
|
) : (
|
|
<span>{label}</span>
|
|
)}
|
|
</button>
|
|
</PopoverTrigger>
|
|
<PopoverContent className="p-1 w-56" align="start" collisionPadding={16}>
|
|
<input
|
|
className="w-full px-2 py-1.5 text-xs bg-transparent outline-none border-b border-border mb-1 placeholder:text-muted-foreground/50"
|
|
placeholder={`Search ${label.toLowerCase()}...`}
|
|
value={search}
|
|
onChange={(e) => setSearch(e.target.value)}
|
|
autoFocus
|
|
/>
|
|
<div className="max-h-48 overflow-y-auto overscroll-contain">
|
|
<button
|
|
className={cn(
|
|
"flex items-center gap-2 w-full px-2 py-1.5 text-xs rounded hover:bg-accent/50",
|
|
values.length === 0 && "bg-accent",
|
|
)}
|
|
onClick={() => updatePolicy([])}
|
|
>
|
|
No {label.toLowerCase()}
|
|
</button>
|
|
{currentUserId && (
|
|
<button
|
|
className={cn(
|
|
"flex items-center gap-2 w-full px-2 py-1.5 text-xs rounded hover:bg-accent/50",
|
|
values.includes(`user:${currentUserId}`) && "bg-accent",
|
|
)}
|
|
onClick={() => toggle(`user:${currentUserId}`)}
|
|
>
|
|
<User className="h-3 w-3 shrink-0 text-muted-foreground" />
|
|
Assign to me
|
|
</button>
|
|
)}
|
|
{issue.createdByUserId && issue.createdByUserId !== currentUserId && (
|
|
<button
|
|
className={cn(
|
|
"flex items-center gap-2 w-full px-2 py-1.5 text-xs rounded hover:bg-accent/50",
|
|
values.includes(`user:${issue.createdByUserId}`) && "bg-accent",
|
|
)}
|
|
onClick={() => toggle(`user:${issue.createdByUserId}`)}
|
|
>
|
|
<User className="h-3 w-3 shrink-0 text-muted-foreground" />
|
|
{creatorUserLabel ?? "Requester"}
|
|
</button>
|
|
)}
|
|
{otherUserOptions
|
|
.filter((option) => {
|
|
if (!search.trim()) return true;
|
|
return `${option.label} ${option.searchText ?? ""}`.toLowerCase().includes(search.toLowerCase());
|
|
})
|
|
.map((option) => (
|
|
<button
|
|
key={option.id}
|
|
className={cn(
|
|
"flex items-center gap-2 w-full px-2 py-1.5 text-xs rounded hover:bg-accent/50",
|
|
values.includes(option.id) && "bg-accent",
|
|
)}
|
|
onClick={() => toggle(option.id)}
|
|
>
|
|
<User className="h-3 w-3 shrink-0 text-muted-foreground" />
|
|
{option.label}
|
|
</button>
|
|
))}
|
|
{sortedAgents
|
|
.filter((agent) => {
|
|
if (!search.trim()) return true;
|
|
return agent.name.toLowerCase().includes(search.toLowerCase());
|
|
})
|
|
.map((agent) => {
|
|
const encoded = `agent:${agent.id}`;
|
|
return (
|
|
<button
|
|
key={agent.id}
|
|
className={cn(
|
|
"flex items-center gap-2 w-full px-2 py-1.5 text-xs rounded hover:bg-accent/50",
|
|
values.includes(encoded) && "bg-accent",
|
|
)}
|
|
onClick={() => toggle(encoded)}
|
|
>
|
|
<AgentIcon icon={agent.icon} className="shrink-0 h-3 w-3 text-muted-foreground" />
|
|
{agent.name}
|
|
</button>
|
|
);
|
|
})}
|
|
</div>
|
|
</PopoverContent>
|
|
</Popover>
|
|
);
|
|
}
|