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

255 lines
8.9 KiB
TypeScript

// @vitest-environment jsdom
import { act, useState } from "react";
import { createRoot } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { ChatComposer, type ChatComposerProps } from "./ChatComposer";
(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
/** Stateful harness so the controlled textarea reflects typed input. */
function Harness(props: Partial<ChatComposerProps> & { initial?: string }) {
const { initial = "", onChange, ...rest } = props;
const [value, setValue] = useState(initial);
return (
<ChatComposer
value={value}
onChange={(v) => {
setValue(v);
onChange?.(v);
}}
onSubmit={rest.onSubmit ?? (() => {})}
{...rest}
/>
);
}
function typeInput(textarea: HTMLTextAreaElement, text: string) {
const setter = Object.getOwnPropertyDescriptor(
window.HTMLTextAreaElement.prototype,
"value",
)?.set;
setter?.call(textarea, text);
textarea.dispatchEvent(new Event("input", { bubbles: true }));
}
describe("ChatComposer", () => {
let container: HTMLDivElement;
beforeEach(() => {
container = document.createElement("div");
document.body.appendChild(container);
});
afterEach(() => {
container.remove();
});
function input() {
return container.querySelector<HTMLTextAreaElement>('[data-testid="chat-composer-input"]')!;
}
function sendButton() {
return container.querySelector<HTMLButtonElement>('button[aria-label="Send message"]')!;
}
function attachButton() {
return container.querySelector<HTMLButtonElement>('button[aria-label="Attach files"]');
}
it("renders a bare textarea + send and no attach button without a handler", () => {
const root = createRoot(container);
act(() => {
root.render(<Harness placeholder="Ask anything…" />);
});
expect(input()).toBeTruthy();
expect(input().placeholder).toBe("Ask anything…");
expect(attachButton()).toBeNull();
// No formatting toolbar — there is exactly one button (send) when bare.
expect(container.querySelectorAll("button").length).toBe(1);
act(() => root.unmount());
});
it("shows the attach affordance when onAttachFiles is provided", () => {
const root = createRoot(container);
act(() => {
root.render(<Harness onAttachFiles={() => {}} />);
});
expect(attachButton()).toBeTruthy();
act(() => root.unmount());
});
it("disables send while empty and enables it once there is text", () => {
const root = createRoot(container);
act(() => {
root.render(<Harness />);
});
expect(sendButton().disabled).toBe(true);
act(() => {
typeInput(input(), "hello");
});
expect(sendButton().disabled).toBe(false);
act(() => root.unmount());
});
it("submits on click", () => {
const onSubmit = vi.fn();
const root = createRoot(container);
act(() => {
root.render(<Harness onSubmit={onSubmit} initial="hi" />);
});
act(() => {
sendButton().dispatchEvent(new MouseEvent("click", { bubbles: true }));
});
expect(onSubmit).toHaveBeenCalledTimes(1);
act(() => root.unmount());
});
it('submitKey="enter": plain Enter submits, Shift+Enter does not', () => {
const onSubmit = vi.fn();
const root = createRoot(container);
act(() => {
root.render(<Harness onSubmit={onSubmit} initial="hi" submitKey="enter" />);
});
act(() => {
input().dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true, shiftKey: true }));
});
expect(onSubmit).not.toHaveBeenCalled();
act(() => {
input().dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
});
expect(onSubmit).toHaveBeenCalledTimes(1);
act(() => root.unmount());
});
it('submitKey="mod-enter": plain Enter does not submit, Cmd/Ctrl+Enter does', () => {
const onSubmit = vi.fn();
const root = createRoot(container);
act(() => {
root.render(<Harness onSubmit={onSubmit} initial="hi" submitKey="mod-enter" />);
});
act(() => {
input().dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
});
expect(onSubmit).not.toHaveBeenCalled();
act(() => {
input().dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true, metaKey: true }));
});
expect(onSubmit).toHaveBeenCalledTimes(1);
act(() => root.unmount());
});
it("singleLine strips newlines from input", () => {
const onChange = vi.fn();
const root = createRoot(container);
act(() => {
root.render(<Harness singleLine onChange={onChange} />);
});
act(() => {
typeInput(input(), "one\ntwo");
});
expect(onChange).toHaveBeenLastCalledWith("one two");
act(() => root.unmount());
});
it("default (multiline) mode soft-wraps and auto-grows instead of clipping (PAP-116)", () => {
// The conference room composer adopts this default mode. Text must wrap and
// the box grow up to a cap — never clip horizontally or show an idle scrollbar.
const root = createRoot(container);
act(() => {
root.render(<Harness />);
});
const el = input();
expect(el.getAttribute("wrap")).toBe("soft");
expect(el.className).toContain("overflow-y-auto");
expect(el.className).toContain("max-h-(--sz-200px)");
expect(el.className).not.toContain("whitespace-nowrap");
expect(el.className).not.toContain("overflow-x-auto");
act(() => root.unmount());
});
it("singleLine mode clips to one row (opt-in only)", () => {
const root = createRoot(container);
act(() => {
root.render(<Harness singleLine />);
});
const el = input();
expect(el.getAttribute("wrap")).toBe("off");
expect(el.className).toContain("whitespace-nowrap");
expect(el.className).toContain("max-h-(--sz-22px)");
act(() => root.unmount());
});
it('tone="planning" is reflected on the container', () => {
const root = createRoot(container);
act(() => {
root.render(<Harness tone="planning" />);
});
const box = container.querySelector('[data-testid="chat-composer"]');
expect(box?.getAttribute("data-tone")).toBe("planning");
act(() => root.unmount());
});
it('tone="ask" is reflected on the container', () => {
const root = createRoot(container);
act(() => {
root.render(<Harness tone="ask" />);
});
const box = container.querySelector('[data-testid="chat-composer"]');
expect(box?.getAttribute("data-tone")).toBe("ask");
expect(box?.className).toContain("sky");
act(() => root.unmount());
});
it('defaults to the opaque "card" surface', () => {
// PAP-131: surface is opt-in — existing adopters keep the bg-card box.
const root = createRoot(container);
act(() => {
root.render(<Harness />);
});
const box = container.querySelector('[data-testid="chat-composer"]')!;
expect(box.getAttribute("data-surface")).toBe("card");
expect(box.className).toContain("bg-card");
expect(box.className).not.toContain("backdrop-blur");
// Rounded corners are shared chrome on both surfaces.
expect(box.className).toContain("rounded-xl");
act(() => root.unmount());
});
it('surface="translucent" applies the task glass recipe and keeps shared chrome (PAP-131)', () => {
const root = createRoot(container);
act(() => {
root.render(<Harness surface="translucent" />);
});
const box = container.querySelector('[data-testid="chat-composer"]')!;
expect(box.getAttribute("data-surface")).toBe("translucent");
// Glass recipe — mirrors the task-comments composer shell.
expect(box.className).toContain("bg-background/95");
expect(box.className).toContain("supports-[backdrop-filter]:bg-background/85");
expect(box.className).toContain("backdrop-blur");
expect(box.className).toContain("shadow-(--shadow-extract-4)");
expect(box.className).toContain("dark:shadow-(--shadow-extract-5)");
expect(box.className).not.toContain("bg-card");
// Shared chrome survives: rounded-xl corners + neutral focus darkening.
expect(box.className).toContain("rounded-xl");
expect(box.className).toContain("focus-within:border-muted-foreground/40");
act(() => root.unmount());
});
it("translucent surface keeps the drag-over attach layering", () => {
const root = createRoot(container);
act(() => {
root.render(<Harness surface="translucent" onAttachFiles={() => {}} />);
});
const box = container.querySelector<HTMLDivElement>('[data-testid="chat-composer"]')!;
act(() => {
const dataTransfer = { types: ["Files"], dropEffect: "none" };
const evt = new Event("dragenter", { bubbles: true }) as DragEvent & {
dataTransfer: typeof dataTransfer;
};
Object.defineProperty(evt, "dataTransfer", { value: dataTransfer });
box.dispatchEvent(evt);
});
expect(container.querySelector('[data-testid="chat-composer-drop-overlay"]')).toBeTruthy();
act(() => root.unmount());
});
});