6f9801a46b
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work
> - The first-run experience (onboarding wizard) and the chat surfaces
(conference-room/board chat, task threads, composers) are the product's
front door — they decide whether a new operator understands "hire
agents, give them work, review results" in the first five minutes
> - Today those surfaces feel ticket-y and form-like: the wizard is a
static multi-step form that ends in an anticlimactic "Launch" screen,
the task composer and board chat behave differently from each other, and
agent-feed issue quicklooks misbehave (multiple flyouts open at once,
cards jump on hover)
> - We wanted to iterate toward a conversational, team-centric NUX — but
without risking the workflows of everyone already running Paperclip
> - This PR reworks the NUX behind a new default-OFF
`enableConferenceRoomChat` experimental flag: a capsule-motif onboarding
wizard that builds your team as you answer, a conference-room chat
surface, one shared ChatComposer across surfaces, brand-accurate status
chips, and feed-quicklook fixes — with the pre-existing UI
fork-and-frozen as `*Classic` components that flag-OFF users keep
> - The benefit is a complete, testable modern NUX that anyone can opt
into from Settings → Experimental, with zero default behavior change and
a clean path to either graduate or drop the experiment
## Linked Issues or Issue Description
No pre-existing GitHub issue — feature description per
`feature_request.yml`:
- **Problem / motivation:** Paperclip's onboarding wizard and chat
surfaces grew up as separate ticket-centric forms. New users get a
form-filling experience rather than the feeling of standing up a team;
the board chat and task threads use different composers with different
affordances; the agent feed's issue quicklook can stack multiple
popovers and shifts cards on hover.
- **Proposed solution:** A coherent NUX experiment behind one
experimental flag (`enableConferenceRoomChat`, Settings → Experimental,
default OFF): capsule onboarding wizard with an evolving team capsule,
conference-room chat, unified `ChatComposer`, team-centric copy, brand
status chips, quicklook single-flight fix. Flag-OFF users get the exact
pre-experiment UI via frozen `*Classic` forks, verified by an on/off
parity test matrix.
- **Alternatives considered:** (a) incremental unflagged restyling —
rejected: the changes interlock across surfaces and would drip risk into
every release; (b) a separate app shell / route for the new NUX —
rejected: too much divergence, the flag + classic-fork pattern keeps the
diff reviewable and reversible.
- **Roadmap alignment:** `ROADMAP.md` lists **CEO Chat** ("a
lighter-weight way to talk to leadership agents... should still resolve
to real work objects"). This experiment is groundwork in that direction
(conference-room chat resolves to issues/tasks via the same composer
used in task threads) and does not change the core task-and-comments
model.
Related PRs found in the dedup search (same area, none duplicate this
work — they target the classic wizard, which this PR intentionally
leaves intact and mergeable):
- #5385 — Coach-driven onboarding: conversational entry +
agent-companies package import
- #5378 — Onboarding wizard: reusable adapter picker + probe card
- #6636 — ui(onboarding): friendly error surface + retry for the wizard
- #7005 — fix(onboarding): explicitly await first-task wake
- #2616 — fix: restore workspace directory config in onboarding wizard
## What Changed
- **Experimental flag plumbing** — `enableConferenceRoomChat` in shared
types/validators, server instance-settings service + API, Settings →
Experimental card with explicit enable/disable copy
- **Onboarding wizard** — classic wizard forked and frozen
(`OnboardingWizardClassic`); flag-ON variant is a 5-step capsule wizard
with a persistent evolving `AgentCapsule` (gradient/glow motif),
team-centric reframed copy, and a typing-dots intro (hardened with
fake-timer tests)
- **Conference-room chat** — flag-ON board-chat surface with agent
bubble name/icon headers and copy/vote/timestamp action rows
(`AgentBubbleActionRow`)
- **Unified composer** — shared `ChatComposer` adopted across surfaces;
translucent surface + scroll-mask removal; "Agent mode"/"Plan mode"
relabels; no-assignee confirmation `AlertDialog` (new
`ui/alert-dialog.tsx` primitive); `@task` reference picker +
linkification in mentions
- **Agent feed** — single-flight issue-quicklook store (one popover at a
time), flyouts open to the left, removed hover translate-y jitter
- **Status chips** — brand-accurate task status chips behind the flag
(light/dark, 1px borders per paperclip.ing/brand)
- **Tests** — flag on/off parity matrix across IssueDetail,
NewIssueDialog, Sidebar, wizard, gate components; component tests for
all new pieces
- **Merge with `master`** — one conflict in
`ui/src/components/IssueChatThread.tsx`, resolved by keeping master's
new `AssigneeChip`/`HandoffWakeRow`/`RunStatusBadge` components inside
the flag-gated metadata-row chrome (details in commit `21a5642a`);
post-merge fixes: vitest 4 mock typing in `MarkdownEditor.test.tsx`,
flag hook made safe for provider-less mounts (master's new isolated
component tests)
- **Branch hygiene** — internal design wireframes/mockups stripped
before the PR (they live in the Paperclip issue threads)
- No user-facing documentation changes required: the flag is
intentionally experimental and self-described in the Settings card; no
existing docs reference the affected surfaces
## Verification
- `pnpm run typecheck` — green across the workspace (ui, server, shared,
plugins)
- Full UI suite (`vitest run` in `ui/`, clean worktree at this HEAD):
**1593/1595 passing, 223/224 files** — the 2 remaining failures are in
`src/components/artifacts/ArtifactCard.test.tsx` and **fail identically
on pristine `origin/master`** (pre-existing upstream, unrelated to this
branch)
- Full server suite (`vitest run` in `server/`, same clean worktree):
results in PR checks; flag plumbing covered by instance-settings tests
- Targeted post-merge resolution check: `IssueChatThread`,
`IssueChatThreadSystemNotice`, `IssueDetail`, `Sidebar`,
`ConferenceRoomChatGate`, `OnboardingWizardVariant`, `NewIssueDialog`,
`InstanceExperimentalSettings`, `MarkdownEditor` — 172/172 passing
- Manual walkthrough: flag OFF (default) → onboarding wizard, task
thread, board chat, composer all render the classic UI; flag ON via
Settings → Experimental → capsule wizard, conference-room chat, unified
composer, status chips active
- Screenshots: see below
**Flag on/off screenshots** (committed on this branch under
`screenshots/PR-8000-*`):
| Surface | Flag OFF (classic, default) | Flag ON (experimental) |
| --- | --- | --- |
| Settings → Experimental | 
| 
|
| Task thread | 
| 
|
| Home / nav | 
| 
|
| Conference Room (flag-ON only surface) | — | 
|
Capsule onboarding wizard walkthrough screenshots (flag ON) are attached
to the Paperclip design/implementation threads; the wizard requires a
fresh instance so it is captured via the e2e harness
(`tests/e2e/nux-phase4-screenshots.spec.ts`).
## Risks
- **Large surface, but gated:** all new behavior sits behind
`enableConferenceRoomChat`, default OFF; flag-OFF rendering is locked by
frozen `*Classic` forks plus an on/off parity test suite
- **Classic forks are frozen at the fork point (`e3aada1d`):** master
features added to the live thread component after that point (assignee
handoff chips, run status badge, composer mention coach) render in the
flag-ON path; the flag-OFF task thread keeps the fork-point behavior
until the experiment graduates (forks deleted) or is dropped (forks
restored as canonical). Called out for reviewer attention.
- **Merge-conflict resolution in `IssueChatThread.tsx`** (commit
`21a5642a`) deserves reviewer eyes: master's new handoff/run-status
components were kept; the base toast-style no-assignee flow remains
replaced by the AlertDialog flow introduced on this branch
- Schema/server changes are additive (one optional boolean instance
setting); no migrations of existing data
## Model Used
- Claude (Anthropic) via Claude Code running in the Paperclip agent
harness (agent: ClaudeCoder)
- Branch implemented across multiple agent sessions on Claude Opus-class
models with extended thinking + tool use (file edits, shell, Playwright
screenshots); merge/PR session model ID as reported by the harness:
`claude-fable-5` (Claude Code CLI)
- All code was agent-authored and board-reviewed through Paperclip issue
threads (plans, wireframes, confirmations) before merging
## 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 run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes (none
required — experimental flag, self-documenting Settings card; noted
above)
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green (run 3 on `8af3041a`: all 16
gates SUCCESS, incl. e2e and all 4 serialized-suite shards)
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
(re-review verdict: Confidence 5/5, “Safe to merge”; all 4 round-1
findings fixed + confirmed resolved; both summary notes addressed in
`8af3041a`)
- [x] I will address all Greptile and reviewer comments before
requesting merge
---------
Co-authored-by: Paperclip <noreply@paperclip.ing>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
310 lines
10 KiB
TypeScript
310 lines
10 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { existsSync, readFileSync } from "node:fs";
|
|
import path from "node:path";
|
|
import { act, forwardRef, useImperativeHandle } from "react";
|
|
import type { ReactNode } from "react";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { BoardChat } from "./BoardChat";
|
|
|
|
/**
|
|
* Regression coverage for the post-wizard Conference Room intro (PAP-134,
|
|
* plan: PAP-133 A+B): a fresh mount shows the three-dot typing bubble for
|
|
* ~2s, then the CEO welcome, then the suggestion chips ~700ms later. The
|
|
* staged reveal must hold while the onboarding wizard overlay is open or
|
|
* the tab is hidden, and must fast-forward when the user already replied.
|
|
*/
|
|
|
|
const mockAgentsApi = vi.hoisted(() => ({ list: vi.fn() }));
|
|
const mockGoalsApi = vi.hoisted(() => ({ list: vi.fn() }));
|
|
const mockIssuesApi = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
listComments: vi.fn(),
|
|
listFeedbackVotes: vi.fn(),
|
|
}));
|
|
const mockDialogState = vi.hoisted(() => ({ onboardingOpen: false }));
|
|
|
|
vi.mock("../api/agents", () => ({ agentsApi: mockAgentsApi }));
|
|
vi.mock("../api/goals", () => ({ goalsApi: mockGoalsApi }));
|
|
vi.mock("../api/issues", () => ({ issuesApi: mockIssuesApi }));
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => ({
|
|
selectedCompanyId: "company-1",
|
|
selectedCompany: { id: "company-1", name: "Acme Robotics", issuePrefix: "PAP" },
|
|
}),
|
|
}));
|
|
|
|
vi.mock("../context/BreadcrumbContext", () => ({
|
|
useBreadcrumbs: () => ({ setBreadcrumbs: vi.fn() }),
|
|
}));
|
|
|
|
vi.mock("../context/DialogContext", () => ({
|
|
useDialogState: () => ({ onboardingOpen: mockDialogState.onboardingOpen }),
|
|
}));
|
|
|
|
// Heavy children that are irrelevant to the staged intro.
|
|
vi.mock("../components/ActivityFeed", () => ({
|
|
ActivityFeed: () => <div data-testid="activity-feed" />,
|
|
}));
|
|
vi.mock("../components/MarkdownBody", () => ({
|
|
MarkdownBody: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
}));
|
|
vi.mock("../components/ChatComposer", () => ({
|
|
ChatComposer: forwardRef((_props, ref) => {
|
|
useImperativeHandle(ref, () => ({ focus: vi.fn() }));
|
|
return <div data-testid="chat-composer" />;
|
|
}),
|
|
}));
|
|
vi.mock("../components/AgentBubbleActionRow", () => ({
|
|
AgentBubbleActionRow: () => null,
|
|
agentBubbleDateLabel: () => "",
|
|
}));
|
|
vi.mock("../components/AgentIconPicker", () => ({
|
|
AgentIcon: () => null,
|
|
}));
|
|
vi.mock("@/components/ui/tooltip", () => ({
|
|
Tooltip: ({ children }: { children: ReactNode }) => <>{children}</>,
|
|
TooltipTrigger: ({ children }: { children: ReactNode }) => <>{children}</>,
|
|
TooltipContent: () => null,
|
|
}));
|
|
vi.mock("@/components/ui/sheet", () => ({
|
|
Sheet: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
SheetTrigger: ({ children }: { children: ReactNode }) => <>{children}</>,
|
|
SheetContent: () => null,
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
class ResizeObserverStub {
|
|
observe() {}
|
|
unobserve() {}
|
|
disconnect() {}
|
|
}
|
|
|
|
const CEO_AGENT = {
|
|
id: "agent-ceo",
|
|
name: "Alex",
|
|
role: "ceo",
|
|
status: "active",
|
|
icon: null,
|
|
};
|
|
const BOARD_ISSUE = { id: "issue-board", title: "Board Operations", status: "in_progress" };
|
|
const USER_COMMENT = {
|
|
id: "comment-user-1",
|
|
body: "Hi Alex!",
|
|
authorAgentId: null,
|
|
authorUserId: "user-1",
|
|
createdAt: "2026-06-10T00:00:00.000Z",
|
|
};
|
|
|
|
function hasTypingDots(container: HTMLElement) {
|
|
return container.querySelectorAll(".typing-dots").length > 0;
|
|
}
|
|
|
|
function hasWelcome(container: HTMLElement) {
|
|
return (container.textContent ?? "").includes("Welcome to");
|
|
}
|
|
|
|
function hasChips(container: HTMLElement) {
|
|
return (container.textContent ?? "").includes("Draft a Company Brief");
|
|
}
|
|
|
|
describe("BoardChat staged typing intro", () => {
|
|
let container: HTMLDivElement;
|
|
let root: Root | null = null;
|
|
|
|
beforeEach(() => {
|
|
vi.useFakeTimers();
|
|
vi.stubGlobal("ResizeObserver", ResizeObserverStub);
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
mockDialogState.onboardingOpen = false;
|
|
mockAgentsApi.list.mockResolvedValue([CEO_AGENT]);
|
|
mockGoalsApi.list.mockResolvedValue([
|
|
{ id: "goal-1", title: "Build affordable robots", status: "active" },
|
|
]);
|
|
mockIssuesApi.list.mockResolvedValue([BOARD_ISSUE]);
|
|
mockIssuesApi.listComments.mockResolvedValue([]);
|
|
mockIssuesApi.listFeedbackVotes.mockResolvedValue([]);
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await act(async () => {
|
|
root?.unmount();
|
|
});
|
|
root = null;
|
|
container.remove();
|
|
sessionStorage.clear();
|
|
vi.unstubAllGlobals();
|
|
vi.useRealTimers();
|
|
vi.clearAllMocks();
|
|
// Drop any per-test document.visibilityState override.
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
delete (document as any).visibilityState;
|
|
});
|
|
|
|
let queryClient: QueryClient | null = null;
|
|
|
|
function buildElement() {
|
|
// A fresh element every time — rendering an identical element reference
|
|
// lets React bail out of re-rendering, which would hide mock-state flips.
|
|
return (
|
|
<QueryClientProvider client={queryClient!}>
|
|
<BoardChat />
|
|
</QueryClientProvider>
|
|
);
|
|
}
|
|
|
|
async function render() {
|
|
queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
root = createRoot(container);
|
|
await act(async () => {
|
|
root!.render(buildElement());
|
|
});
|
|
// Let the agent/goal/issue queries resolve, plus the follow-up render
|
|
// that enables the comments query off boardIssueId. react-query batches
|
|
// notifications through zero-delay timers, so flush those too.
|
|
for (let i = 0; i < 6; i++) {
|
|
await act(async () => {
|
|
await vi.advanceTimersByTimeAsync(0);
|
|
});
|
|
}
|
|
}
|
|
|
|
/** Re-render the existing tree so hooks re-read mutated mock state. */
|
|
async function rerender() {
|
|
await act(async () => {
|
|
root!.render(buildElement());
|
|
});
|
|
await act(async () => {
|
|
await Promise.resolve();
|
|
});
|
|
}
|
|
|
|
async function advance(ms: number) {
|
|
await act(async () => {
|
|
await vi.advanceTimersByTimeAsync(ms);
|
|
});
|
|
await act(async () => {
|
|
await vi.advanceTimersByTimeAsync(0);
|
|
});
|
|
}
|
|
|
|
it("reveals typing dots, then the welcome at 2s, then chips at +700ms", async () => {
|
|
await render();
|
|
|
|
// Fresh mount: dots only.
|
|
expect(hasTypingDots(container)).toBe(true);
|
|
expect(hasWelcome(container)).toBe(false);
|
|
|
|
// Just before the reveal: still dots.
|
|
await advance(1900);
|
|
expect(hasTypingDots(container)).toBe(true);
|
|
expect(hasWelcome(container)).toBe(false);
|
|
|
|
// t=2s: welcome bubble lands, dots leave, chips not yet.
|
|
await advance(100);
|
|
expect(hasWelcome(container)).toBe(true);
|
|
expect(hasTypingDots(container)).toBe(false);
|
|
expect(hasChips(container)).toBe(false);
|
|
|
|
// t=2.7s: chips stage in.
|
|
await advance(700);
|
|
expect(hasChips(container)).toBe(true);
|
|
});
|
|
|
|
it("skips the staged reveal when a user comment already exists", async () => {
|
|
mockIssuesApi.listComments.mockResolvedValue([USER_COMMENT]);
|
|
await render();
|
|
|
|
// Fast-forwarded: no dots, welcome immediately, no timer needed.
|
|
expect(hasTypingDots(container)).toBe(false);
|
|
expect(hasWelcome(container)).toBe(true);
|
|
});
|
|
|
|
it("holds the dots while the onboarding wizard overlay is open (PAP-134)", async () => {
|
|
mockDialogState.onboardingOpen = true;
|
|
await render();
|
|
|
|
// The 2s window must not burn behind the wizard overlay.
|
|
await advance(2500);
|
|
expect(hasTypingDots(container)).toBe(true);
|
|
expect(hasWelcome(container)).toBe(false);
|
|
|
|
// Wizard closes → reveal timer starts fresh.
|
|
mockDialogState.onboardingOpen = false;
|
|
await rerender();
|
|
await advance(2000);
|
|
expect(hasWelcome(container)).toBe(true);
|
|
expect(hasTypingDots(container)).toBe(false);
|
|
});
|
|
|
|
it("holds the dots while the document is hidden (PAP-134)", async () => {
|
|
let visibility: DocumentVisibilityState = "hidden";
|
|
Object.defineProperty(document, "visibilityState", {
|
|
configurable: true,
|
|
get: () => visibility,
|
|
});
|
|
await render();
|
|
|
|
// The 2s window must not burn while the tab is hidden.
|
|
await advance(2500);
|
|
expect(hasTypingDots(container)).toBe(true);
|
|
expect(hasWelcome(container)).toBe(false);
|
|
|
|
// Tab becomes visible → reveal timer starts fresh.
|
|
visibility = "visible";
|
|
await act(async () => {
|
|
document.dispatchEvent(new Event("visibilitychange"));
|
|
});
|
|
await advance(2000);
|
|
expect(hasWelcome(container)).toBe(true);
|
|
expect(hasTypingDots(container)).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("typing-dots CSS animation guard (PAP-54 failure mode)", () => {
|
|
// PAP-54: the .typing-dots CSS block was silently dropped from index.css
|
|
// during a theme migration, leaving static markup with no animation. Guard
|
|
// the source so the block can't vanish again without failing a test. The
|
|
// browser-computed `animationName !== "none"` assertion lives in
|
|
// tests/e2e/conference-room-typing-intro.spec.ts.
|
|
// Locate ui/src/index.css regardless of whether vitest runs from ui/ or
|
|
// the workspace root (import.meta.url is an http URL under jsdom, and the
|
|
// css pipeline swallows `?raw` imports — plain fs is the reliable path).
|
|
function readIndexCss(): string {
|
|
let dir = process.cwd();
|
|
for (let depth = 0; depth < 6; depth++) {
|
|
for (const candidate of [
|
|
path.join(dir, "src/index.css"),
|
|
path.join(dir, "ui/src/index.css"),
|
|
]) {
|
|
if (existsSync(candidate)) return readFileSync(candidate, "utf8");
|
|
}
|
|
dir = path.dirname(dir);
|
|
}
|
|
throw new Error("ui/src/index.css not found from " + process.cwd());
|
|
}
|
|
const css = readIndexCss();
|
|
|
|
it("keeps the bounce animation wired to .typing-dots span", () => {
|
|
const spanRules = [...css.matchAll(/\.typing-dots span\s*\{[^}]*\}/g)].map(
|
|
(m) => m[0],
|
|
);
|
|
expect(spanRules.length).toBeGreaterThan(0);
|
|
expect(
|
|
spanRules.some((rule) => /animation:\s*typing-bounce/.test(rule)),
|
|
).toBe(true);
|
|
});
|
|
|
|
it("keeps the typing-bounce keyframes", () => {
|
|
expect(css).toMatch(/@keyframes typing-bounce\s*\{/);
|
|
});
|
|
});
|