Files
PaperClipAI/ui/src/components/RoutineRunVariablesDialog.test.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

580 lines
17 KiB
TypeScript

// @vitest-environment jsdom
import { flushSync } from "react-dom";
import { createRoot } from "react-dom/client";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import type { Agent, ExecutionWorkspace, Project, RoutineVariable } from "@paperclipai/shared";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { RoutineRunVariablesDialog } from "./RoutineRunVariablesDialog";
let issueWorkspaceDraftCalls = 0;
let issueWorkspaceDraft = {
executionWorkspaceId: null as string | null,
executionWorkspacePreference: "shared_workspace",
executionWorkspaceSettings: { mode: "shared_workspace" },
};
let issueWorkspaceBranchName: string | null = null;
let latestWorkspaceIssue: Record<string, unknown> | null = null;
vi.mock("../api/instanceSettings", () => ({
instanceSettingsApi: {
getExperimental: vi.fn(async () => ({ enableIsolatedWorkspaces: true })),
},
}));
vi.mock("./IssueWorkspaceCard", async () => {
const React = await import("react");
return {
IssueWorkspaceCard: ({
issue,
onDraftChange,
}: {
issue: Record<string, unknown>;
onDraftChange?: (
data: Record<string, unknown>,
meta: { canSave: boolean; workspaceBranchName?: string | null },
) => void;
}) => {
React.useEffect(() => {
latestWorkspaceIssue = issue;
issueWorkspaceDraftCalls += 1;
if (issueWorkspaceDraftCalls > 20) {
throw new Error("IssueWorkspaceCard onDraftChange looped");
}
onDraftChange?.(issueWorkspaceDraft, {
canSave: true,
workspaceBranchName: issueWorkspaceBranchName,
});
}, [onDraftChange]);
return <div data-testid="workspace-card">Workspace card</div>;
},
};
});
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
async function settleEffects() {
await Promise.resolve();
await Promise.resolve();
await new Promise((resolve) => setTimeout(resolve, 0));
}
async function flushUi(callback: () => void) {
flushSync(callback);
await settleEffects();
}
function createProject(): Project {
return {
id: "project-1",
companyId: "company-1",
urlKey: "workspace-project",
goalId: null,
goalIds: [],
goals: [],
name: "Workspace project",
description: null,
status: "in_progress",
leadAgentId: null,
targetDate: null,
color: "#22c55e",
icon: null,
env: null,
pauseReason: null,
pausedAt: null,
archivedAt: null,
executionWorkspacePolicy: {
enabled: true,
defaultMode: "shared_workspace",
allowIssueOverride: true,
},
codebase: {
workspaceId: null,
repoUrl: null,
repoRef: null,
defaultRef: null,
repoName: null,
localFolder: null,
managedFolder: "/tmp/paperclip/project-1",
effectiveLocalFolder: "/tmp/paperclip/project-1",
origin: "managed_checkout",
},
workspaces: [],
primaryWorkspace: null,
createdAt: new Date("2026-04-02T00:00:00.000Z"),
updatedAt: new Date("2026-04-02T00:00:00.000Z"),
};
}
function createAgent(): Agent {
return {
id: "agent-1",
companyId: "company-1",
name: "Routine Agent",
role: "engineer",
title: null,
status: "active",
reportsTo: null,
capabilities: null,
adapterType: "process",
adapterConfig: {},
runtimeConfig: {},
budgetMonthlyCents: 0,
spentMonthlyCents: 0,
lastHeartbeatAt: null,
icon: "code",
metadata: null,
createdAt: new Date("2026-04-02T00:00:00.000Z"),
updatedAt: new Date("2026-04-02T00:00:00.000Z"),
urlKey: "routine-agent",
pauseReason: null,
pausedAt: null,
permissions: { canCreateAgents: false },
};
}
function createExecutionWorkspace(): ExecutionWorkspace {
return {
id: "workspace-1",
companyId: "company-1",
projectId: "project-1",
projectWorkspaceId: "project-workspace-1",
sourceIssueId: null,
mode: "isolated_workspace",
strategyType: "git_worktree",
name: "PAP-1634",
status: "active",
cwd: "/tmp/paperclip/PAP-1634",
repoUrl: null,
baseRef: "main",
branchName: "pap-1634-routine-branch",
providerType: "local_fs",
providerRef: null,
derivedFromExecutionWorkspaceId: null,
lastUsedAt: new Date("2026-04-02T00:00:00.000Z"),
openedAt: new Date("2026-04-02T00:00:00.000Z"),
closedAt: null,
cleanupEligibleAt: null,
cleanupReason: null,
config: {
provisionCommand: null,
teardownCommand: null,
cleanupCommand: null,
workspaceRuntime: null,
desiredState: null,
},
metadata: null,
runtimeServices: [],
createdAt: new Date("2026-04-02T00:00:00.000Z"),
updatedAt: new Date("2026-04-02T00:00:00.000Z"),
};
}
function createQueryClient() {
return new QueryClient({
defaultOptions: {
queries: {
retry: false,
},
},
});
}
async function renderRoutineRunDialog(container: HTMLDivElement, props: {
variables: RoutineVariable[];
onSubmit?: (data: unknown) => void;
}) {
const root = createRoot(container);
const queryClient = createQueryClient();
const onSubmit = props.onSubmit ?? vi.fn();
await flushUi(() => {
root.render(
<QueryClientProvider client={queryClient}>
<RoutineRunVariablesDialog
open
onOpenChange={() => {}}
companyId="company-1"
projects={[]}
agents={[createAgent()]}
defaultAssigneeAgentId="agent-1"
variables={props.variables}
isPending={false}
onSubmit={onSubmit}
/>
</QueryClientProvider>,
);
});
return { root, onSubmit };
}
function setInputValue(input: HTMLInputElement, value: string) {
const setter = Object.getOwnPropertyDescriptor(window.HTMLInputElement.prototype, "value")?.set;
setter?.call(input, value);
input.dispatchEvent(new Event("input", { bubbles: true }));
}
function findRunButton() {
return Array.from(document.querySelectorAll("button"))
.find((button) => button.textContent === "Run routine") as HTMLButtonElement | undefined;
}
describe("RoutineRunVariablesDialog", () => {
let container: HTMLDivElement;
beforeEach(() => {
container = document.createElement("div");
document.body.appendChild(container);
issueWorkspaceDraftCalls = 0;
issueWorkspaceDraft = {
executionWorkspaceId: null,
executionWorkspacePreference: "shared_workspace",
executionWorkspaceSettings: { mode: "shared_workspace" },
};
issueWorkspaceBranchName = null;
latestWorkspaceIssue = null;
});
afterEach(() => {
container.remove();
document.body.innerHTML = "";
});
it("does not loop when the workspace card reports the same draft repeatedly", async () => {
const root = createRoot(container);
const queryClient = new QueryClient({
defaultOptions: {
queries: {
retry: false,
},
},
});
await flushUi(() => {
root.render(
<QueryClientProvider client={queryClient}>
<RoutineRunVariablesDialog
open
onOpenChange={() => {}}
companyId="company-1"
projects={[createProject()]}
agents={[createAgent()]}
defaultProjectId="project-1"
defaultAssigneeAgentId="agent-1"
variables={[]}
isPending={false}
onSubmit={() => {}}
/>
</QueryClientProvider>,
);
});
expect(issueWorkspaceDraftCalls).toBeLessThanOrEqual(2);
expect(document.body.textContent).toContain("Run routine");
expect(document.body.textContent).not.toContain("Search agents...");
expect(document.body.textContent).not.toContain("Search projects...");
await flushUi(() => {
root.unmount();
});
});
it("keeps the mobile dialog bounded with an internal form scroll region", async () => {
const root = createRoot(container);
const queryClient = new QueryClient({
defaultOptions: {
queries: {
retry: false,
},
},
});
await flushUi(() => {
root.render(
<QueryClientProvider client={queryClient}>
<RoutineRunVariablesDialog
open
onOpenChange={() => {}}
companyId="company-1"
projects={[createProject()]}
agents={[createAgent()]}
defaultProjectId="project-1"
defaultAssigneeAgentId="agent-1"
variables={[
{
name: "notes",
label: "notes",
type: "textarea",
defaultValue: null,
required: false,
options: [],
},
]}
isPending={false}
onSubmit={() => {}}
/>
</QueryClientProvider>,
);
});
const dialogContent = Array.from(document.body.querySelectorAll("div")).find((element) =>
typeof element.className === "string" && element.className.includes("max-h-(--sz-calc-18)"),
);
expect(dialogContent?.className).toContain("h-(--sz-calc-18)");
expect(dialogContent?.className).toContain("overflow-hidden");
const notesInput = document.querySelector("textarea");
const formScrollRegion = Array.from(document.body.querySelectorAll("div")).find((element) =>
typeof element.className === "string" && element.className.includes("overscroll-contain"),
);
expect(formScrollRegion?.className).toContain("min-h-0");
expect(formScrollRegion?.className).toContain("flex-1");
expect(formScrollRegion?.className).toContain("overflow-y-auto");
expect(formScrollRegion?.contains(notesInput)).toBe(true);
const footer = Array.from(document.body.querySelectorAll("div")).find((element) =>
typeof element.className === "string" && element.className.includes("pb-(--sz-calc-19)"),
);
expect(footer?.className).toContain("shrink-0");
expect(footer?.contains(formScrollRegion ?? null)).toBe(false);
expect(footer?.textContent).toContain("Run routine");
await flushUi(() => {
root.unmount();
});
});
it("renders workspaceBranch as a read-only selected workspace value", async () => {
issueWorkspaceDraft = {
executionWorkspaceId: "workspace-1",
executionWorkspacePreference: "reuse_existing",
executionWorkspaceSettings: { mode: "isolated_workspace" },
};
issueWorkspaceBranchName = "pap-1634-routine-branch";
const onSubmit = vi.fn();
const root = createRoot(container);
const queryClient = new QueryClient({
defaultOptions: {
queries: {
retry: false,
},
},
});
await flushUi(() => {
root.render(
<QueryClientProvider client={queryClient}>
<RoutineRunVariablesDialog
open
onOpenChange={() => {}}
companyId="company-1"
projects={[createProject()]}
agents={[createAgent()]}
defaultProjectId="project-1"
defaultAssigneeAgentId="agent-1"
variables={[
{
name: "workspaceBranch",
label: null,
type: "text",
defaultValue: null,
required: true,
options: [],
},
]}
isPending={false}
onSubmit={onSubmit}
/>
</QueryClientProvider>,
);
});
for (let i = 0; i < 10 && !document.querySelector('[data-testid="workspace-card"]'); i += 1) {
await settleEffects();
}
const branchInput = Array.from(document.querySelectorAll("input"))
.find((input) => input.value === "pap-1634-routine-branch");
expect(branchInput?.disabled).toBe(true);
expect(document.body.textContent).not.toContain("Missing: workspaceBranch");
const runButton = Array.from(document.querySelectorAll("button"))
.find((button) => button.textContent === "Run routine");
expect(runButton).toBeTruthy();
await flushUi(() => {
runButton?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
});
expect(onSubmit).toHaveBeenCalledWith({
variables: {
workspaceBranch: "pap-1634-routine-branch",
},
assigneeAgentId: "agent-1",
projectId: "project-1",
executionWorkspaceId: "workspace-1",
executionWorkspacePreference: "reuse_existing",
executionWorkspaceSettings: { mode: "isolated_workspace" },
});
await flushUi(() => {
root.unmount();
});
});
it("prefills the supplied execution workspace for workspace-specific routine runs", async () => {
const workspace = createExecutionWorkspace();
issueWorkspaceDraft = {
executionWorkspaceId: workspace.id,
executionWorkspacePreference: "reuse_existing",
executionWorkspaceSettings: { mode: "isolated_workspace" },
};
issueWorkspaceBranchName = workspace.branchName;
const root = createRoot(container);
const queryClient = new QueryClient({
defaultOptions: {
queries: {
retry: false,
},
},
});
await flushUi(() => {
root.render(
<QueryClientProvider client={queryClient}>
<RoutineRunVariablesDialog
open
onOpenChange={() => {}}
companyId="company-1"
projects={[createProject()]}
agents={[createAgent()]}
defaultProjectId="project-1"
defaultAssigneeAgentId="agent-1"
defaultExecutionWorkspace={workspace}
variables={[]}
isPending={false}
onSubmit={() => {}}
/>
</QueryClientProvider>,
);
});
for (let i = 0; i < 10 && latestWorkspaceIssue === null; i += 1) {
await settleEffects();
}
expect(latestWorkspaceIssue).toMatchObject({
executionWorkspaceId: workspace.id,
executionWorkspacePreference: "reuse_existing",
currentExecutionWorkspace: workspace,
projectWorkspaceId: workspace.projectWorkspaceId,
});
await flushUi(() => {
root.unmount();
});
});
it("respects explicit date and text variable types for Date-suffixed names", async () => {
const { root } = await renderRoutineRunDialog(container, {
variables: [
{
name: "startDate",
label: null,
type: "text",
defaultValue: "2026-06-26",
required: true,
options: [],
},
{
name: "releaseOn",
label: "Release on",
type: "date",
defaultValue: "2026-07-01",
required: false,
options: [],
},
],
});
const dateInputs = Array.from(document.querySelectorAll<HTMLInputElement>('input[type="date"]'));
expect(dateInputs).toHaveLength(1);
expect(dateInputs[0]?.value).toBe("2026-07-01");
const textInput = Array.from(document.querySelectorAll<HTMLInputElement>('input[type="text"]'))
.find((input) => input.value === "2026-06-26");
expect(textInput).toBeTruthy();
await flushUi(() => {
root.unmount();
});
});
it("blocks empty required dates, submits date strings, and omits optional empty dates", async () => {
const onSubmit = vi.fn();
const { root } = await renderRoutineRunDialog(container, {
variables: [
{
name: "startDate",
label: null,
type: "date",
defaultValue: null,
required: true,
options: [],
},
{
name: "releaseOn",
label: "Release on",
type: "date",
defaultValue: null,
required: true,
options: [],
},
{
name: "endDate",
label: null,
type: "date",
defaultValue: null,
required: false,
options: [],
},
],
onSubmit,
});
const runButton = findRunButton();
expect(runButton?.disabled).toBe(true);
expect(document.body.textContent).toContain("Missing: startDate, Release on");
const dateInputs = Array.from(document.querySelectorAll<HTMLInputElement>('input[type="date"]'));
await flushUi(() => {
setInputValue(dateInputs[0]!, "2026-07-04");
setInputValue(dateInputs[1]!, "2026-08-01");
});
expect(runButton?.disabled).toBe(false);
await flushUi(() => {
runButton?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
});
expect(onSubmit).toHaveBeenCalledWith({
variables: {
startDate: "2026-07-04",
releaseOn: "2026-08-01",
},
assigneeAgentId: "agent-1",
projectId: null,
});
await flushUi(() => {
root.unmount();
});
});
});