mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-24 01:41:42 +02:00
## Thinking Path > - Paperclip helps people manage AI agents and their work. > - People need consistent UI patterns to review and control that work. > - The current board uses related layouts and controls with different spacing, type, and behavior. > - That drift makes it hard for a designer or an agent to build a new page from a reliable reference. > - Storybook can show the shared patterns and the states they need to support. > - This pull request adds design proposals, a local sandbox, and reusable UI controls so people can compare the patterns in context. > - The benefit is a clearer design system that agents can use to build consistent UI. ## Linked Issues or Issue Description **Subsystem affected** `ui/` — React board UI and Storybook. **Problem or motivation** Board pages repeat visual and interaction decisions. Storybook did not provide a complete reference for task views, conversation states, typography, toolbars, tabs, and light/dark colors. People could not compare a proposed pattern with the running board in one place. **Proposed solution** Add a staged Design Proposals catalog with foundations, components, layouts, and page specimens. Add an opt-in sandbox. Reuse production components where possible. Include synthetic conversation states and shared controls so reviewers can compare and refine them. **Alternatives considered** Separate static mockups would not show keyboard behavior, responsive layout, or real component states. Rebuilding each page only in Storybook would allow the reference to drift from the board. **Roadmap alignment** This improves existing board UI and Skills Manager surfaces. It does not add a new control-plane capability. ## What Changed - Added dark and light color references, typography and conversation specimens, and component stories for buttons, tabs, toolbars, sidebar, popovers, activity, and task lists. - Added a local design sandbox with synthetic task conversation playback and representative states. - Shared collection toolbars and navigation patterns across task, agent, project, routine, skill, connector, and artifact pages. - Added the streamlined Skills tabs and a My Skills collection that uses the shared skill cards. - Restored saved-thread access during synthetic playback, kept connector searchbox semantics, and updated reproduction checks after moving trial stories. - Documented the proposed patterns and added focused UI, catalog, and browser checks. ## Verification - `pnpm check:token-gates`, `node scripts/check-maps.mjs`, and `node scripts/storybook-catalog.mjs --check` passed. - Full workspace `pnpm -r typecheck` and `pnpm build` passed after merging master. After the review fixes, focused UI typecheck, `pnpm build-storybook`, 23 Skills Sources tests, and all 15 Storybook typography browser tests passed. - Focused task-thread and system-notice suites passed: 251 tests. Connector Browse passed 84 tests; the connector, attachment, recovery, and Storybook flyout browser journeys passed locally. - A local full Vitest run hit one intermittent chat-channels integration failure; that test passed in isolation. GitHub CI [39347996059](https://github.com/paperclipai/paperclip/actions/runs/39347996059) passed on the exact latest commit: 55 successful checks and two skipped draft-only Storybook jobs. - Greptile reviewed the exact latest commit at 5/5 with no new comments or open review threads. GitHub reports the branch as cleanly mergeable. ## Risks - This PR changes 206 files and exceeds the repository's 100-file review target. Review by commit and consider a scoped split before merge. - Design Proposals are staged references. Fixture interactions do not prove API behavior, permissions, or provider execution. - UI changes to shared controls may affect pages outside the proposal sandbox. Focused browser checks and the full CI matrix passed. ## Model Used - OpenAI Codex, GPT-6 family. The exact runtime model ID and context window are not exposed in this session. The model used reasoning, code execution, browser inspection, and local tests. Earlier branch commits were also AI-assisted in this Codex conversation. ## 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 available in this session) - [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 where applicable - [x] I have either linked existing issues or described the issue in-PR following the relevant issue template - [x] I have not referenced internal or instance-local Paperclip issues or links - [x] My branch name describes the change and contains no internal ticket id - [x] I have run focused tests locally and they pass - [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 risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Scott Tong <scott@scotts-mbp-m5-max.local> Co-authored-by: Paperclip <noreply@paperclip.ing>
173 lines
9.6 KiB
TypeScript
173 lines
9.6 KiB
TypeScript
// @vitest-environment jsdom
|
|
import { act, type ReactNode } from "react";
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { afterEach, beforeEach, expect, it, vi } from "vitest";
|
|
import { MemoryRouter } from "react-router-dom";
|
|
import { ThemeProvider } from "@/context/ThemeContext";
|
|
import DesignSandboxTaskThread from "./DesignSandboxTaskThread";
|
|
import { THREAD_PREVIEW_CASES } from "./task-thread-fixtures";
|
|
import { transcriptToTaskChatItems } from "../task-chat/transcript-adapter";
|
|
|
|
// Real composer behavior is covered in the browser. Retain its takeover slots
|
|
// and callbacks here; the transcript/history/protocol surfaces are all real.
|
|
vi.mock("../task-chat/TaskChatComposer", async () => {
|
|
const { TaskChatPausedTakeover } = await import("../task-chat/TaskChatPausedTakeover");
|
|
return { TaskChatComposer: ({ onAdd, takeover, pause, onStop }: {
|
|
onAdd: (body: string) => void; takeover?: { content: ReactNode } | null;
|
|
pause?: Parameters<typeof TaskChatPausedTakeover>[0]; onStop?: () => void;
|
|
}) => pause ? <TaskChatPausedTakeover {...pause} /> : takeover ? takeover.content : <>
|
|
<button onClick={() => onAdd("Please check timeouts.")}>Send synthetic reply</button>
|
|
{onStop ? <button onClick={onStop}>Stop synthetic run</button> : null}
|
|
</> };
|
|
});
|
|
let host: HTMLDivElement;
|
|
let root: Root;
|
|
const network = vi.fn();
|
|
beforeEach(() => {
|
|
host = document.body.appendChild(document.createElement("div"));
|
|
root = createRoot(host);
|
|
vi.stubGlobal("fetch", network);
|
|
vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);
|
|
network.mockReset();
|
|
});
|
|
afterEach(() => {
|
|
flushSync(() => root.unmount());
|
|
host.remove();
|
|
vi.unstubAllGlobals();
|
|
vi.useRealTimers();
|
|
document.documentElement.style.removeProperty("--motion-sandbox-stream-tick");
|
|
document.documentElement.style.removeProperty("--motion-sandbox-playback-step");
|
|
});
|
|
function render(query = "", defaultConversation = false, previewMode: "catalog" | "playback" = "catalog") {
|
|
flushSync(() => root.render(<MemoryRouter initialEntries={[`/DES/issues/DES-1${query}`]}>
|
|
<ThemeProvider>
|
|
<DesignSandboxTaskThread previewMode={previewMode} header={<h2>Task title</h2>} agentName="Preview engineer" defaultConversation={defaultConversation}>
|
|
<p>Saved conversation</p>
|
|
</DesignSandboxTaskThread>
|
|
</ThemeProvider>
|
|
</MemoryRouter>));
|
|
}
|
|
function button(label: string) {
|
|
const match = [...host.querySelectorAll("button")].find(el => el.textContent === label);
|
|
expect(match, `button ${label}`).toBeTruthy();
|
|
return match!;
|
|
}
|
|
it("leaves the saved conversation as the default on ordinary sandbox tasks", () => {
|
|
render();
|
|
expect(host.textContent).toContain("Saved conversation");
|
|
expect(host.querySelector("[data-preview-case]")).toBeNull();
|
|
});
|
|
it("defaults the demonstration task to a staging-style conversation", () => {
|
|
render("", true);
|
|
expect(host.querySelector('[data-preview-case="staging-conversation"]')).not.toBeNull();
|
|
expect(host.querySelector('[data-testid="task-chat-human-bubble"]')).not.toBeNull();
|
|
expect(host.querySelector('[data-testid="task-chat-bubble-attached-turn"]')).not.toBeNull();
|
|
expect(host.querySelector('[data-testid="task-chat-live-run-pill"]')).not.toBeNull();
|
|
expect(host.textContent).toContain("Thought through the task");
|
|
expect(host.textContent).toContain("Read files");
|
|
expect(host.querySelector('[data-testid="task-chat-runner-turn"]')).toBeNull();
|
|
expect(network).not.toHaveBeenCalled();
|
|
});
|
|
it("renders every snapshot through real thread surfaces", () => {
|
|
render("?threadPreview=all");
|
|
expect(host.querySelectorAll("[data-preview-case]")).toHaveLength(THREAD_PREVIEW_CASES.length);
|
|
expect(host.querySelector('[data-testid="task-chat-runner-turn"]')).not.toBeNull();
|
|
expect(host.querySelector('[data-testid="paused-composer-takeover"]')).not.toBeNull();
|
|
expect(host.textContent).toContain("Choose a reconnect policy");
|
|
expect(network).not.toHaveBeenCalled();
|
|
});
|
|
it("keeps completed commentary and tools in the Activity disclosure", async () => {
|
|
render("?threadPreview=completed");
|
|
const summaries = [...host.querySelectorAll<HTMLButtonElement>('[data-testid="task-chat-turn-summary"]')];
|
|
expect(summaries).toHaveLength(2);
|
|
expect(summaries.every(el => el.getAttribute("aria-expanded") === "false")).toBe(true);
|
|
await act(async () => summaries[1].click());
|
|
expect(summaries[1].getAttribute("aria-expanded")).toBe("true");
|
|
expect(host.textContent).toContain("The follow-up asks how I arrived at the count.");
|
|
expect(host.querySelector('[data-testid="task-chat-activity-phase-toggle"]')).not.toBeNull();
|
|
});
|
|
it("resolves permissions locally in the composer takeover", async () => {
|
|
render("?threadPreview=awaiting-approval");
|
|
await act(async () => button("Allow once").click());
|
|
expect(host.textContent?.toLowerCase()).toContain("resolved");
|
|
expect(network).not.toHaveBeenCalled();
|
|
});
|
|
it("stops synthetic activity without touching a real run", async () => {
|
|
render("?threadPreview=working");
|
|
await act(async () => button("Stop synthetic run").click());
|
|
expect(host.textContent).toContain("Run cancelled");
|
|
expect(host.querySelector('[data-testid="task-chat-live-run-pill"]')?.textContent).toContain("Stopped");
|
|
expect(network).not.toHaveBeenCalled();
|
|
});
|
|
it("keeps the native renderer separate from the staging transcript layout", () => {
|
|
render("?threadPreview=runner-running");
|
|
expect(host.querySelector('[data-testid="task-chat-runner-turn"]')).not.toBeNull();
|
|
expect(host.querySelector('[data-testid="task-chat-live-run-pill"]')).toBeNull();
|
|
});
|
|
it("preserves failure, incomplete-tool and streaming lifecycles through the real event adapter", () => {
|
|
const itemsFor = (id: string, running: boolean) => transcriptToTaskChatItems(
|
|
THREAD_PREVIEW_CASES.find(item => item.id === id)!.build().entries,
|
|
{ runId: "fixture-check", running },
|
|
);
|
|
expect(itemsFor("tool-failed", true)).toContainEqual(expect.objectContaining({ kind: "tool", status: "failed" }));
|
|
expect(itemsFor("tool-interrupted", false)).toContainEqual(expect.objectContaining({ kind: "tool", status: "interrupted" }));
|
|
expect(itemsFor("streaming-final", true)).toContainEqual(expect.objectContaining({ kind: "message", channel: "final", streaming: true }));
|
|
expect(itemsFor("native-failed", false)).toContainEqual(expect.objectContaining({ kind: "protocol", surface: "run_terminal", runState: "failed" }));
|
|
});
|
|
it("keeps replies local and restores the saved conversation", async () => {
|
|
render("?threadPreview=human-message");
|
|
await act(async () => button("Send synthetic reply").click());
|
|
expect(host.textContent).toContain("Please check timeouts.");
|
|
expect(host.textContent).toContain("Preview reply received.");
|
|
await act(async () => button("Show saved thread").click());
|
|
expect(host.textContent).toContain("Saved conversation");
|
|
expect(host.textContent).not.toContain("Preview reply received.");
|
|
expect(network).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("plays one cumulative conversation, freezes on pause, settles and replays locally", async () => {
|
|
vi.useFakeTimers();
|
|
document.documentElement.style.setProperty("--motion-sandbox-stream-tick", "40ms");
|
|
document.documentElement.style.setProperty("--motion-sandbox-playback-step", "4s");
|
|
await act(async () => render("?threadPreview=all", true, "playback"));
|
|
const playback = () => host.querySelector('[data-testid="conversation-playback"]')!;
|
|
expect(playback().getAttribute("data-playback-state")).toBe("idle");
|
|
expect(host.querySelectorAll('[data-testid="task-chat-human-bubble"]')).toHaveLength(0);
|
|
expect(host.querySelector("#sandbox-thread-state")).toBeNull();
|
|
await act(async () => button("Play conversation").click());
|
|
expect(host.querySelectorAll('[data-testid="task-chat-human-bubble"]')).toHaveLength(1);
|
|
await act(async () => vi.advanceTimersByTime(2500));
|
|
expect(playback().getAttribute("data-playback-stage")).toBe("1");
|
|
await act(async () => button("Pause").click());
|
|
const paused = host.textContent;
|
|
await act(async () => vi.advanceTimersByTime(10_000));
|
|
expect(host.textContent).toBe(paused);
|
|
expect(playback().getAttribute("data-playback-state")).toBe("paused");
|
|
await act(async () => button("Resume conversation").click());
|
|
await act(async () => vi.advanceTimersByTime(60_000));
|
|
expect(playback().getAttribute("data-playback-state")).toBe("complete");
|
|
expect(host.textContent).toContain("26 component source files");
|
|
expect(host.querySelector('[data-testid="task-chat-bubble-attached-turn"]')).not.toBeNull();
|
|
expect(host.querySelectorAll('[data-testid="task-chat-human-bubble"]')).toHaveLength(2);
|
|
expect(host.querySelectorAll('[data-testid="task-chat-agent-bubble"]')).toHaveLength(2);
|
|
expect(host.textContent).toContain("Verification complete");
|
|
await act(async () => button("Replay conversation").click());
|
|
expect(playback().getAttribute("data-playback-stage")).toBe("0");
|
|
expect(host.querySelector('[data-testid="task-chat-agent-bubble"]')).toBeNull();
|
|
await act(async () => button("Show saved thread").click());
|
|
expect(host.textContent).toContain("Saved conversation");
|
|
expect(host.querySelector('[data-testid="conversation-playback"]')).toBeNull();
|
|
expect(network).not.toHaveBeenCalled();
|
|
});
|
|
it("shows the saved conversation for an unknown playback preview", () => {
|
|
render("?threadPreview=unknown", true, "playback");
|
|
expect(host.textContent).toContain("Saved conversation");
|
|
expect(host.querySelector('[data-testid="conversation-playback"]')).toBeNull();
|
|
});
|
|
it("retains the saved conversation on ordinary tasks in playback mode", () => {
|
|
render("", false, "playback");
|
|
expect(host.textContent).toContain("Saved conversation");
|
|
expect(host.querySelector('[data-testid="conversation-playback"]')).toBeNull();
|
|
});
|