mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-17 21:34:48 +01:00
## Thinking Path > - Paperclip helps people manage AI agents and their work. > - The inbox collects decisions, requests, and updates for the people in a company. > - People need a clear personal queue and a consistent way to answer each request. > - Repeated headings, inconsistent card actions, and separate review flows make that work harder. > - This pull request connects the inbox UI to the routing foundation in #20959. > - Compact cards use shared task controls and open supporting work in a side panel. > - People can answer, claim, transfer, archive, and inspect outcomes from one place. ## Linked Issues or Issue Description **What existing behavior does this improve?** The inbox cards, personal views, shared task controls, and decision history. **Subsystem affected** UI. This PR targets master and uses the routing foundation merged in #20959. **Current behavior** The inbox repeats headings and counts. Cards have different layouts and action placement. The requester can repeat the signed-in person's name. Review and question controls differ between the inbox and task thread. **Proposed behavior** Open Assigned to you by default. Show one count line above the cards. Use a compact card layout with consistent actions and supporting details. Show the requester's avatar and name only when they differ from the signed-in person. Share question controls, including a radio option for Other that reveals a text field when selected. **Reason and benefit** People can scan their queue and complete requests without losing the surrounding task or creating separate drafts for the same review. **Breaking changes** The default inbox view becomes personal. The all-assignee and shared views remain available. Card close menus distinguish personal archive and snooze from shared withdrawal. **Additional context** Refs #20959, #19363, and #19520. Refs #20268 for related actionable-request work. This stack adds personal routing and shared controls. ROADMAP.md includes Multiple Human Users and Agent Reviews and Approvals. ## What Changed - Add personal, unassigned, company, all-assignee, and archived inbox views. Add claim, transfer, personal close actions, receipts, and history controls. - Use compact decision cards with a single count line, one-pixel borders, and equal space above, below, and to the right of each primary action. - Open artifacts and synchronized confirmation/approval controls in a shared side panel. Share their revision drafts and action state with the task thread. Other requests keep one editable form on the inbox card while reviewing an artifact. - Make Other match the question options and reveal its field only when selected. Apply this to inbox and task question cards. - Hide self-requester labels, space agent avatars, and use the standard canceled status icon for withdrawn requests. - Use connector logos in connector cards. Keep the connector promotion background and sidebar border continuous. - Add company and project decision-owner controls and document the updated inbox behavior. ## Verification - The complete [GitHub Actions CI matrix](https://github.com/paperclipai/paperclip/actions/runs/43141559641) passes on `8d81a75e49b518fff6b6ff4c23dd67979b0b97ee` (Linux/Node 24: typecheck, build, general and serialized tests, Runner support, browser shards, and aggregate gates). Greptile is 5/5 on that exact head with zero open findings, and the security scan passes. - Local UI typechecking passes. Eight focused suites pass 382 tests: 236 inbox/review/question/connector tests plus all 146 composer tests. Regressions passed red to green for attachment links, prompt rendering, single-form artifact review, connector scope copy, accessible headings, and the composer test harness's missing theme provider. The final commit changes only that test harness; production code is unchanged from `59d015833f`. - Browser acceptance on the production implementation confirms preserved selected answers with one editable question form, accessible Markdown prompts, inert image references, accurate connector scope copy, native PDF downloads, image sidebar previews, and Open file requesting the attachment endpoint while preserving the inbox URL. Request reads and file responses were intercepted; no question answers were written. The preview is healthy on the final head. - Visual and interaction checks cover Other radio behavior in both themes and on mobile, the loaded Google Calendar logo, and 20px above, below, and to the right of the primary action across all 23 visible cards. The affected desktop/mobile navigation and sidebar specs pass locally and in the final CI browser matrix. - Real-editor browser checks confirm Ctrl/Cmd+Enter cannot bypass another person's confirmation. Cancel preserves the draft and unlocks silently; Continue submits once. Approval write failures remain visible. - `pnpm verify` returns exit 2 because DESIGN.md requires broader coverage; the final full CI matrix supplies every requested gate. Maps and Storybook catalog structural checks pass. The routing foundation #20959 merged after passing 249 database tests, server typechecking, full CI, Greptile 5/5, and security scanning. Its backend and SDK registry are preserved. - Demo data is retained for testing; database suites and browser specs use separate disposable databases. ## Risks - The inbox uses the routing contracts merged in #20959. Personal filters and history affect shared task entry points; the affected controls are included in local regression coverage and full CI. - Personal defaults and close-menu wording change inbox behavior. Existing resolver permissions still control shared actions. - Shared revision state and live invalidation affect two surfaces. Focused tests cover draft synchronization, action locks, and incoming updates. - Visual changes use the existing design tokens and component primitives. ## Model Used OpenAI GPT-6 through Codex. Used repository tools, code execution, and browser checks. This session does not expose a more specific runtime model ID or its context-window size. ## 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 described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links - [x] My branch name describes the change and contains no internal Paperclip 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 any 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@scottsmbpm5max.lan> Co-authored-by: Paperclip <noreply@paperclip.ing>
321 lines
11 KiB
TypeScript
321 lines
11 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act } from "react";
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { MemoryRouter } from "react-router-dom";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { TooltipProvider } from "@/components/ui/tooltip";
|
|
import { ApiError } from "@/api/client";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import { CompanySettings } from "./CompanySettings";
|
|
|
|
const mockCompaniesApi = vi.hoisted(() => ({
|
|
update: vi.fn(),
|
|
archive: vi.fn(),
|
|
}));
|
|
|
|
const mockAccessApi = vi.hoisted(() => ({
|
|
listMembers: vi.fn(),
|
|
}));
|
|
|
|
const mockAssetsApi = vi.hoisted(() => ({
|
|
uploadCompanyLogo: vi.fn(),
|
|
}));
|
|
|
|
const mockSetBreadcrumbs = vi.hoisted(() => vi.fn());
|
|
const mockSetSelectedCompanyId = vi.hoisted(() => vi.fn());
|
|
|
|
// A tiny external store stands in for the company list query, so a save can
|
|
// hand the page a fresh company object the way a real refetch does.
|
|
const companyStore = vi.hoisted(() => {
|
|
type Company = Record<string, unknown>;
|
|
const initial: Company = {
|
|
id: "company-1",
|
|
name: "Acme Robotics",
|
|
description: null,
|
|
status: "active",
|
|
issuePrefix: "ACM",
|
|
brandColor: null,
|
|
logoUrl: null,
|
|
attachmentMaxBytes: null,
|
|
requireBoardApprovalForNewAgents: false,
|
|
interactionResolverGovernance: {},
|
|
defaultDecisionOwnerUserId: null,
|
|
budgetOwnerUserId: "user-1",
|
|
};
|
|
let company: Company = initial;
|
|
const listeners = new Set<() => void>();
|
|
return {
|
|
initial,
|
|
get: () => company,
|
|
set(next: Company) {
|
|
company = next;
|
|
for (const listener of listeners) listener();
|
|
},
|
|
subscribe(listener: () => void) {
|
|
listeners.add(listener);
|
|
return () => {
|
|
listeners.delete(listener);
|
|
};
|
|
},
|
|
};
|
|
});
|
|
|
|
vi.mock("../api/companies", () => ({ companiesApi: mockCompaniesApi }));
|
|
vi.mock("../api/access", () => ({ accessApi: mockAccessApi }));
|
|
vi.mock("../api/assets", () => ({ assetsApi: mockAssetsApi }));
|
|
|
|
vi.mock("../context/BreadcrumbContext", () => ({
|
|
useBreadcrumbs: () => ({ setBreadcrumbs: mockSetBreadcrumbs }),
|
|
}));
|
|
|
|
vi.mock("../context/CompanyContext", async () => {
|
|
const { useSyncExternalStore } = await import("react");
|
|
return {
|
|
useCompany: () => {
|
|
const company = useSyncExternalStore(companyStore.subscribe, companyStore.get);
|
|
return {
|
|
companies: [company],
|
|
selectedCompany: company,
|
|
selectedCompanyId: company.id,
|
|
setSelectedCompanyId: mockSetSelectedCompanyId,
|
|
};
|
|
},
|
|
};
|
|
});
|
|
|
|
// The governance panel has its own tests; here only its frame matters.
|
|
vi.mock("../components/InteractionGovernancePanel", () => ({
|
|
InteractionGovernancePanel: () => <div data-testid="interaction-governance-panel" />,
|
|
applyGovernanceChange: (governance: unknown) => governance,
|
|
}));
|
|
|
|
// These sections own their own queries (and their own "Save changes").
|
|
vi.mock("../components/observability/AgentObservabilitySettings", () => ({
|
|
AgentObservabilitySettingsSection: () => null,
|
|
}));
|
|
|
|
vi.mock("./InstanceGeneralSettings", () => ({
|
|
InstanceGeneralSettings: () => null,
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
const MEMBERS = {
|
|
members: [
|
|
{ id: "membership-1", user: { id: "user-1", name: "Ada Lovelace", email: "ada@example.test" } },
|
|
{ id: "membership-2", user: { id: "user-2", name: "Grace Hopper", email: "grace@example.test" } },
|
|
],
|
|
};
|
|
|
|
async function flushReact() {
|
|
await act(async () => {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
});
|
|
}
|
|
|
|
async function waitForAssertion(assertion: () => void) {
|
|
let lastError: unknown;
|
|
for (let i = 0; i < 20; i += 1) {
|
|
await flushReact();
|
|
try {
|
|
assertion();
|
|
return;
|
|
} catch (error) {
|
|
lastError = error;
|
|
}
|
|
}
|
|
throw lastError;
|
|
}
|
|
|
|
describe("CompanySettings Decisions section", () => {
|
|
let container: HTMLDivElement;
|
|
let root: Root | null = null;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
companyStore.set({ ...companyStore.initial });
|
|
mockAccessApi.listMembers.mockResolvedValue(MEMBERS);
|
|
// Mirrors the server: the PATCH answers with the updated company, and the
|
|
// refetch then carries it to the page.
|
|
mockCompaniesApi.update.mockImplementation(
|
|
async (_companyId: string, patch: Record<string, unknown>) => {
|
|
await Promise.resolve();
|
|
const next = { ...companyStore.get(), ...patch };
|
|
companyStore.set(next);
|
|
return next;
|
|
},
|
|
);
|
|
});
|
|
|
|
afterEach(() => {
|
|
if (root) flushSync(() => root!.unmount());
|
|
root = null;
|
|
container.remove();
|
|
document.body.innerHTML = "";
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
async function render() {
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false }, mutations: { retry: false } },
|
|
});
|
|
// CloudAccessGate owns the health fetch in the app.
|
|
queryClient.setQueryData(queryKeys.health, { status: "ok", cloud: null });
|
|
root = createRoot(container);
|
|
flushSync(() => {
|
|
root!.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<TooltipProvider>
|
|
<MemoryRouter>
|
|
<CompanySettings />
|
|
</MemoryRouter>
|
|
</TooltipProvider>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
// Members fill the pickers before anyone can choose.
|
|
await waitForAssertion(() => {
|
|
expect(getByLabelText("Budget owner").querySelectorAll("option")).toHaveLength(3);
|
|
});
|
|
}
|
|
|
|
/** The control a `<label>` with exactly this text names via `htmlFor`. */
|
|
function getByLabelText(text: string): HTMLSelectElement {
|
|
const label = Array.from(container.querySelectorAll("label")).find(
|
|
(element) => element.textContent?.trim() === text,
|
|
);
|
|
expect(label, `label "${text}"`).toBeDefined();
|
|
expect(label!.htmlFor).not.toBe("");
|
|
const control = document.getElementById(label!.htmlFor);
|
|
expect(control).toBeInstanceOf(HTMLSelectElement);
|
|
return control as HTMLSelectElement;
|
|
}
|
|
|
|
function changeSelect(select: HTMLSelectElement, value: string) {
|
|
// Go through the native setter so React sees a real change.
|
|
Object.getOwnPropertyDescriptor(HTMLSelectElement.prototype, "value")!.set!.call(select, value);
|
|
act(() => {
|
|
select.dispatchEvent(new Event("change", { bubbles: true }));
|
|
});
|
|
}
|
|
|
|
function typeInto(input: HTMLInputElement, value: string) {
|
|
Object.getOwnPropertyDescriptor(HTMLInputElement.prototype, "value")!.set!.call(input, value);
|
|
act(() => {
|
|
input.dispatchEvent(new Event("input", { bubbles: true }));
|
|
});
|
|
}
|
|
|
|
function statusFor(select: HTMLSelectElement) {
|
|
return select.parentElement!.querySelector("[role=status]")?.textContent?.trim() ?? "";
|
|
}
|
|
|
|
function alertFor(select: HTMLSelectElement) {
|
|
return select.parentElement!.querySelector("[role=alert]")?.textContent?.trim() ?? null;
|
|
}
|
|
|
|
function saveChangesButtons() {
|
|
return Array.from(container.querySelectorAll("button")).filter(
|
|
(button) => button.textContent?.trim() === "Save changes",
|
|
);
|
|
}
|
|
|
|
it("names both owner selects with an associated label", async () => {
|
|
await render();
|
|
const decisionOwner = getByLabelText("Default decision owner");
|
|
const budgetOwner = getByLabelText("Budget owner");
|
|
|
|
expect(decisionOwner.dataset.testid).toBe("company-settings-default-decision-owner");
|
|
expect(budgetOwner.dataset.testid).toBe("company-settings-budget-owner");
|
|
expect(Array.from(decisionOwner.labels ?? []).map((label) => label.textContent)).toEqual([
|
|
"Default decision owner",
|
|
]);
|
|
expect(budgetOwner.value).toBe("user-1");
|
|
});
|
|
|
|
it("saves the default decision owner on change with only that field", async () => {
|
|
await render();
|
|
const decisionOwner = getByLabelText("Default decision owner");
|
|
// Nothing is waiting on the page-level save before or after the change.
|
|
expect(saveChangesButtons()).toHaveLength(0);
|
|
|
|
changeSelect(decisionOwner, "user-2");
|
|
|
|
await waitForAssertion(() => {
|
|
expect(statusFor(getByLabelText("Default decision owner"))).toBe("Saved");
|
|
});
|
|
expect(mockCompaniesApi.update).toHaveBeenCalledTimes(1);
|
|
expect(mockCompaniesApi.update).toHaveBeenCalledWith("company-1", {
|
|
defaultDecisionOwnerUserId: "user-2",
|
|
});
|
|
expect(getByLabelText("Default decision owner").value).toBe("user-2");
|
|
expect(saveChangesButtons()).toHaveLength(0);
|
|
});
|
|
|
|
it("clears the budget owner with an explicit null", async () => {
|
|
await render();
|
|
|
|
changeSelect(getByLabelText("Budget owner"), "");
|
|
|
|
await waitForAssertion(() => {
|
|
expect(statusFor(getByLabelText("Budget owner"))).toBe("Saved");
|
|
});
|
|
expect(mockCompaniesApi.update).toHaveBeenCalledWith("company-1", { budgetOwnerUserId: null });
|
|
expect(getByLabelText("Budget owner").value).toBe("");
|
|
});
|
|
|
|
it("shows the server's rejection and keeps the saved owner", async () => {
|
|
const message = "Budget owner must be an active member of this company";
|
|
mockCompaniesApi.update.mockRejectedValueOnce(
|
|
new ApiError(message, 422, { error: message }),
|
|
);
|
|
await render();
|
|
|
|
changeSelect(getByLabelText("Budget owner"), "user-2");
|
|
|
|
await waitForAssertion(() => {
|
|
expect(alertFor(getByLabelText("Budget owner"))).toBe(message);
|
|
});
|
|
const budgetOwner = getByLabelText("Budget owner");
|
|
expect(budgetOwner.value).toBe("user-1");
|
|
expect(budgetOwner.getAttribute("aria-invalid")).toBe("true");
|
|
expect(document.getElementById(budgetOwner.getAttribute("aria-describedby")!)?.textContent).toBe(
|
|
message,
|
|
);
|
|
});
|
|
|
|
it("keeps an unsaved organization name draft when an owner saves", async () => {
|
|
await render();
|
|
const nameInput = container.querySelector<HTMLInputElement>("input[type=text]")!;
|
|
typeInto(nameInput, "Acme Labs");
|
|
expect(saveChangesButtons()).toHaveLength(1);
|
|
|
|
changeSelect(getByLabelText("Default decision owner"), "user-2");
|
|
|
|
await waitForAssertion(() => {
|
|
expect(statusFor(getByLabelText("Default decision owner"))).toBe("Saved");
|
|
});
|
|
// The owner PATCH did not carry the draft, and the refetch did not wipe it.
|
|
expect(mockCompaniesApi.update).toHaveBeenCalledWith("company-1", {
|
|
defaultDecisionOwnerUserId: "user-2",
|
|
});
|
|
expect(container.querySelector<HTMLInputElement>("input[type=text]")!.value).toBe("Acme Labs");
|
|
expect(saveChangesButtons()).toHaveLength(1);
|
|
});
|
|
|
|
it("frames the interaction governance table to the form column", async () => {
|
|
await render();
|
|
const frame = container.querySelector("[data-testid=interaction-governance-panel]")!.parentElement!;
|
|
expect(frame.dataset.testid).toBe("company-settings-interaction-governance-frame");
|
|
expect(frame.className.split(" ")).toEqual(
|
|
expect.arrayContaining(["min-w-0", "max-w-2xl", "overflow-x-auto"]),
|
|
);
|
|
});
|
|
});
|