feat(ui): NUX rework behind enableConferenceRoomChat experimental flag — capsule onboarding, conference-room chat, unified composer (#8000)
## 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>
This commit is contained in:
scotttong
@@ -0,0 +1,158 @@
|
||||
import express from "express";
|
||||
import { EventEmitter } from "node:events";
|
||||
import request from "supertest";
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
const mockGetExperimental = vi.hoisted(() => vi.fn());
|
||||
const mockIssueService = vi.hoisted(() => ({
|
||||
list: vi.fn(),
|
||||
create: vi.fn(),
|
||||
addComment: vi.fn(),
|
||||
listComments: vi.fn(),
|
||||
}));
|
||||
const mockSpawn = vi.hoisted(() => vi.fn());
|
||||
|
||||
vi.mock("../services/index.js", () => ({
|
||||
instanceSettingsService: () => ({ getExperimental: mockGetExperimental }),
|
||||
issueService: () => mockIssueService,
|
||||
}));
|
||||
|
||||
vi.mock("node:child_process", () => ({ spawn: mockSpawn }));
|
||||
|
||||
vi.mock("../routes/authz.js", () => ({
|
||||
getActorInfo: () => ({ actorId: "user-1", agentId: null, runId: null }),
|
||||
assertCompanyAccess: () => {},
|
||||
}));
|
||||
|
||||
async function createApp(deploymentMode: "local_trusted" | "authenticated" = "local_trusted") {
|
||||
const { boardChatRoutes } = await import("../routes/board-chat.js");
|
||||
const app = express();
|
||||
app.use(express.json());
|
||||
app.use("/api", boardChatRoutes({} as any, { deploymentMode }));
|
||||
return app;
|
||||
}
|
||||
|
||||
describe("POST /api/board/chat/stream feature flag guard (PAP-137)", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it("returns 403 FEATURE_DISABLED when enableConferenceRoomChat is off", async () => {
|
||||
mockGetExperimental.mockResolvedValue({ enableConferenceRoomChat: false });
|
||||
const app = await createApp();
|
||||
|
||||
const res = await request(app)
|
||||
.post("/api/board/chat/stream")
|
||||
.send({ companyId: "company-1", message: "hello" });
|
||||
|
||||
expect(res.status).toBe(403);
|
||||
expect(res.body).toEqual({
|
||||
error: "Conference Room Chat is not enabled",
|
||||
code: "FEATURE_DISABLED",
|
||||
});
|
||||
// The guard must fire before anything is persisted.
|
||||
expect(mockIssueService.addComment).not.toHaveBeenCalled();
|
||||
expect(mockIssueService.create).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("returns 403 DEPLOYMENT_MODE_UNSUPPORTED outside local_trusted even with the flag on", async () => {
|
||||
mockGetExperimental.mockResolvedValue({ enableConferenceRoomChat: true });
|
||||
const app = await createApp("authenticated");
|
||||
|
||||
const res = await request(app)
|
||||
.post("/api/board/chat/stream")
|
||||
.send({ companyId: "company-1", message: "hello" });
|
||||
|
||||
expect(res.status).toBe(403);
|
||||
expect(res.body.code).toBe("DEPLOYMENT_MODE_UNSUPPORTED");
|
||||
expect(mockIssueService.addComment).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("lets requests past the guard when the flag is on (400 on missing body, not 403)", async () => {
|
||||
mockGetExperimental.mockResolvedValue({ enableConferenceRoomChat: true });
|
||||
const app = await createApp();
|
||||
|
||||
// Omit the body so the request stops at validation — proves the guard
|
||||
// admitted it without spawning the chat subprocess.
|
||||
const res = await request(app).post("/api/board/chat/stream").send({});
|
||||
|
||||
expect(res.status).toBe(400);
|
||||
expect(res.body).toEqual({ error: "companyId and message are required" });
|
||||
});
|
||||
});
|
||||
|
||||
describe("board-chat client disconnect", () => {
|
||||
function makeFakeProc() {
|
||||
const proc = new EventEmitter() as any;
|
||||
proc.stdout = new EventEmitter();
|
||||
proc.stderr = new EventEmitter();
|
||||
proc.stdin = { write: vi.fn(), end: vi.fn() };
|
||||
proc.exitCode = null;
|
||||
proc.killed = false;
|
||||
proc.kill = vi.fn(() => {
|
||||
proc.killed = true;
|
||||
});
|
||||
return proc;
|
||||
}
|
||||
|
||||
it("kills the spawned subprocess when the client disconnects mid-stream", async () => {
|
||||
mockGetExperimental.mockResolvedValue({ enableConferenceRoomChat: true });
|
||||
mockIssueService.list.mockResolvedValue([
|
||||
{ id: "issue-1", title: "Board Operations", status: "todo" },
|
||||
]);
|
||||
mockIssueService.addComment.mockResolvedValue({ id: "comment-1" });
|
||||
mockIssueService.listComments.mockResolvedValue([]);
|
||||
const fakeProc = makeFakeProc();
|
||||
mockSpawn.mockReturnValue(fakeProc);
|
||||
const app = await createApp();
|
||||
|
||||
const req = request(app)
|
||||
.post("/api/board/chat/stream")
|
||||
.send({ companyId: "company-1", message: "hello" });
|
||||
// Start the request without awaiting the (never-ending) SSE response.
|
||||
const pending = req.then(
|
||||
() => undefined,
|
||||
() => undefined,
|
||||
);
|
||||
|
||||
await vi.waitFor(() => expect(mockSpawn).toHaveBeenCalled());
|
||||
expect(fakeProc.kill).not.toHaveBeenCalled();
|
||||
|
||||
// Client walks away mid-stream.
|
||||
req.abort();
|
||||
await vi.waitFor(() => expect(fakeProc.kill).toHaveBeenCalledWith("SIGTERM"));
|
||||
|
||||
// Let the subprocess close handler run so the slot is released.
|
||||
fakeProc.exitCode = 143;
|
||||
fakeProc.emit("close", 143);
|
||||
await pending;
|
||||
});
|
||||
});
|
||||
|
||||
describe("board-chat history role classification", () => {
|
||||
it("treats only board-concierge comments as assistant turns", async () => {
|
||||
const { isConciergeReply } = await import("../routes/board-chat.js");
|
||||
|
||||
// The relay's own persisted replies.
|
||||
expect(
|
||||
isConciergeReply({ authorAgentId: null, authorUserId: "board-concierge" }),
|
||||
).toBe(true);
|
||||
|
||||
// A human board user.
|
||||
expect(isConciergeReply({ authorAgentId: null, authorUserId: "user-1" })).toBe(
|
||||
false,
|
||||
);
|
||||
|
||||
// An agent commenting on the standing issue is NOT this assistant — its
|
||||
// words must not be serialized as the assistant's own prior turns.
|
||||
expect(
|
||||
isConciergeReply({ authorAgentId: "agent-1", authorUserId: null }),
|
||||
).toBe(false);
|
||||
|
||||
// Defensive: an agent comment can never impersonate the concierge even if
|
||||
// both author fields are somehow set.
|
||||
expect(
|
||||
isConciergeReply({ authorAgentId: "agent-1", authorUserId: "board-concierge" }),
|
||||
).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -17,6 +17,7 @@ describe("instance settings service", () => {
|
||||
enableEnvironments: true,
|
||||
enableIsolatedWorkspaces: true,
|
||||
enableStreamlinedLeftNavigation: false,
|
||||
enableConferenceRoomChat: false,
|
||||
enableIssuePlanDecompositions: true,
|
||||
enableExperimentalFileViewer: true,
|
||||
enableCloudSync: true,
|
||||
@@ -25,4 +26,32 @@ describe("instance settings service", () => {
|
||||
issueGraphLivenessAutoRecoveryLookbackHours: 48,
|
||||
});
|
||||
});
|
||||
|
||||
it("defaults enableConferenceRoomChat to false for empty and legacy stored settings", () => {
|
||||
expect(normalizeExperimentalSettings(undefined).enableConferenceRoomChat).toBe(false);
|
||||
expect(normalizeExperimentalSettings({}).enableConferenceRoomChat).toBe(false);
|
||||
// Rows persisted before the flag existed (PAP-137) must normalize to off.
|
||||
expect(
|
||||
normalizeExperimentalSettings({ enableStreamlinedLeftNavigation: true }).enableConferenceRoomChat,
|
||||
).toBe(false);
|
||||
});
|
||||
|
||||
it("round-trips an enableConferenceRoomChat patch through the update merge", () => {
|
||||
// updateExperimental merges `{ ...normalize(current), ...patch }` and
|
||||
// re-normalizes; emulate that to prove the flag survives the roundtrip
|
||||
// without disturbing other settings.
|
||||
const current = normalizeExperimentalSettings({});
|
||||
const enabled = normalizeExperimentalSettings({ ...current, enableConferenceRoomChat: true });
|
||||
expect(enabled.enableConferenceRoomChat).toBe(true);
|
||||
expect(enabled.enableStreamlinedLeftNavigation).toBe(false);
|
||||
|
||||
const disabled = normalizeExperimentalSettings({ ...enabled, enableConferenceRoomChat: false });
|
||||
expect(disabled).toEqual(current);
|
||||
});
|
||||
|
||||
it("rejects non-boolean enableConferenceRoomChat values back to the default", () => {
|
||||
expect(
|
||||
normalizeExperimentalSettings({ enableConferenceRoomChat: "yes" }).enableConferenceRoomChat,
|
||||
).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -18,6 +18,7 @@ const apiPrefixes: Record<string, string> = {
|
||||
"approvals.ts": "/api",
|
||||
"assets.ts": "/api",
|
||||
"auth.ts": "/api/auth",
|
||||
"board-chat.ts": "/api",
|
||||
"cloud-upstreams.ts": "/api",
|
||||
"companies.ts": "/api/companies",
|
||||
"company-skills.ts": "/api",
|
||||
|
||||
Reference in New Issue
Block a user