mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 11:20:42 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Governed MCP access spans contracts, runtime enforcement, adapters, UI surfaces, and operator verification > - The parity reference PR #9534 is too large for effective automated or human review > - The feature therefore needs a linear stack whose individual diffs stay below the 100-file review limit > - This pull request is split 6/8 and focuses on UI API, shared components, and Tools/Profile surfaces > - The benefit is a standalone, testable review boundary while preserving byte-for-byte parity at the top of the stack ## Linked Issues or Issue Description - Related parity reference: #9534 - Problem: Operators need typed clients and administration surfaces that compile independently before navigation exposes them. - Proposed solution: Adds UI APIs, hooks, libraries, shared components, Tools/Profiles pages, and the plugin settings consumer required by the new company-scoped API. - Alternatives considered: keeping #9534 as one 403-file review, or rewriting the feature to manufacture seams; both were rejected in favor of path extraction plus compile-driven boundary moves. - Roadmap alignment: this advances the existing governed MCP/tool-access work already represented by #9534; it does not introduce a separate roadmap initiative. - Stack position: base branch is `pap10341-split/05-runtime-integration`. - Merge policy: merge bottom-up, in order, only after the complete eight-PR stack has been reviewed and the top-of-stack parity gate remains empty. - Requested review: UXDesigner sanity pass on Tools/Profile surfaces; Greptile on every PR. ## What Changed - Adds UI APIs, hooks, libraries, shared components, Tools/Profiles pages, and the plugin settings consumer required by the new company-scoped API. - Keeps this PR below 100 changed files and independently typecheckable. - Preserves the final tree from #9534 when combined with the other seven stack levels. ## Verification - `pnpm typecheck` - `pnpm check:token-gates` — all gates clean - Focused UI Vitest run with `NODE_ENV=test` — 28 files, 183 tests passed ## Risks - Large dead-code UI additions can drift from activation routes; PR 7 supplies the registration layer and top-level parity catches omissions. - Stack risk: merging out of order can expose incomplete layers; mitigate by following the documented bottom-up merge policy. - Parity risk: later edits to an intermediate branch can drift from #9534; mitigate by re-running the empty top-of-stack diff before merge. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex, exact model ID `gpt-5.4`; runtime-managed context window; medium reasoning with repository, shell, Git, GitHub CLI, and code-execution tools enabled. ## 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] Internal references are omitted except the execution-plan link explicitly required for this coordinated split stack - [x] My branch name describes the change and contains no internal Paperclip ticket id or instance-derived details - [x] I have run 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 - [ ] All Paperclip CI gates are green - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge ## Stack Coordination - Internal execution plan: [PAP-13874](/PAP/issues/PAP-13874#document-plan) - Parity reference: #9534 - Stack: #9556 → #9557 → #9558 → #9559 → #9560 → #9561 → #9562 → #9563 - Merge bottom-up only after full-stack review and an empty parity diff at #9563. ## UI Evidence QA captured these from the live Garden MCP split stack at 1440px and verified clean rendering:    --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
159 lines
5.2 KiB
TypeScript
159 lines
5.2 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act, createElement } from "react";
|
|
import { createRoot } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type { ToolCatalogEntry, ToolProfileWithDetails } from "@paperclipai/shared";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const navigate = vi.hoisted(() => vi.fn());
|
|
const api = vi.hoisted(() => ({
|
|
createProfile: vi.fn(),
|
|
updateProfile: vi.fn(),
|
|
bindProfile: vi.fn(),
|
|
unbindProfile: vi.fn(),
|
|
}));
|
|
const profilesData = vi.hoisted(() => ({ current: {} as Record<string, unknown> }));
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
useNavigate: () => navigate,
|
|
Link: ({ to, children }: { to: string; children: unknown }) => createElement("a", { href: to }, children as never),
|
|
}));
|
|
vi.mock("@/context/ToastContext", () => ({ useToast: () => ({ pushToast: vi.fn() }) }));
|
|
vi.mock("@/api/tools", () => ({ toolsApi: api }));
|
|
vi.mock("./useProfilesData", () => ({ useProfilesData: () => profilesData.current }));
|
|
|
|
import { ProfileWizard } from "./ProfileWizard";
|
|
|
|
(globalThis as typeof globalThis & { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
function tool(id: string, toolName: string): ToolCatalogEntry {
|
|
return {
|
|
id,
|
|
toolName,
|
|
title: toolName,
|
|
description: null,
|
|
applicationId: "app1",
|
|
connectionId: "conn1",
|
|
isReadOnly: true,
|
|
isWrite: false,
|
|
isDestructive: false,
|
|
riskLevel: "read",
|
|
} as ToolCatalogEntry;
|
|
}
|
|
|
|
const APP_GROUP = {
|
|
appKey: "app1",
|
|
applicationId: "app1",
|
|
connectionId: "conn1",
|
|
name: "Gmail",
|
|
tools: [tool("t1", "gmail.read"), tool("t2", "gmail.send")],
|
|
};
|
|
|
|
function setData(profiles: ToolProfileWithDetails[] = []) {
|
|
profilesData.current = {
|
|
appGroups: [APP_GROUP],
|
|
catalog: APP_GROUP.tools,
|
|
catalogLoading: false,
|
|
profiles: { isLoading: false, data: { profiles } },
|
|
agents: { data: [{ id: "a1", name: "Sage" }] },
|
|
};
|
|
}
|
|
|
|
function setNativeValue(el: HTMLInputElement | HTMLTextAreaElement, value: string) {
|
|
const proto = el instanceof HTMLTextAreaElement ? HTMLTextAreaElement.prototype : HTMLInputElement.prototype;
|
|
const setter = Object.getOwnPropertyDescriptor(proto, "value")?.set;
|
|
setter?.call(el, value);
|
|
el.dispatchEvent(new Event("input", { bubbles: true }));
|
|
}
|
|
|
|
describe("ProfileWizard", () => {
|
|
let container: HTMLDivElement;
|
|
let root: ReturnType<typeof createRoot>;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = createRoot(container);
|
|
api.createProfile.mockResolvedValue({ id: "new-1", metadata: null, bindings: [] });
|
|
api.updateProfile.mockResolvedValue({ id: "new-1", metadata: null, bindings: [] });
|
|
});
|
|
|
|
afterEach(() => {
|
|
act(() => root.unmount());
|
|
container.remove();
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
async function render(props: { profileId?: string; initialTemplate?: "everyday" }) {
|
|
const client = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={client}>
|
|
<ProfileWizard companyId="c1" {...props} />
|
|
</QueryClientProvider>,
|
|
);
|
|
await Promise.resolve();
|
|
});
|
|
}
|
|
|
|
it("creates a draft and advances to Choose tools on Continue", async () => {
|
|
setData([]);
|
|
await render({ initialTemplate: "everyday" });
|
|
|
|
const nameInput = container.querySelector("#profile-name") as HTMLInputElement;
|
|
await act(async () => {
|
|
setNativeValue(nameInput, "Everyday work");
|
|
await Promise.resolve();
|
|
});
|
|
|
|
const continueBtn = [...container.querySelectorAll("button")].find((b) => b.textContent?.trim() === "Continue");
|
|
await act(async () => {
|
|
continueBtn?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
await Promise.resolve();
|
|
await Promise.resolve();
|
|
});
|
|
|
|
expect(api.createProfile).toHaveBeenCalledTimes(1);
|
|
const [, input] = api.createProfile.mock.calls[0];
|
|
expect(input.status).toBe("draft");
|
|
expect(input.name).toBe("Everyday work");
|
|
// Step 2 is now visible.
|
|
expect(container.textContent).toContain("New tools that appear later");
|
|
});
|
|
|
|
it("resumes a draft at the first unfinished step", async () => {
|
|
const draft: ToolProfileWithDetails = {
|
|
id: "d1",
|
|
companyId: "c1",
|
|
profileKey: "everyday",
|
|
name: "Everyday work",
|
|
description: null,
|
|
status: "draft",
|
|
defaultAction: "deny",
|
|
newToolsReviewedAt: null,
|
|
metadata: { wizard: { lastCompletedStep: 1, template: "everyday" } },
|
|
createdAt: new Date(),
|
|
updatedAt: new Date(),
|
|
entries: [],
|
|
bindings: [],
|
|
summary: {
|
|
accessMode: "selected",
|
|
allowedToolCount: 0,
|
|
allowedApplicationCount: 0,
|
|
excludedToolCount: 0,
|
|
totalToolCount: 0,
|
|
assignmentCount: 0,
|
|
appliesToAgentCount: 0,
|
|
isCompanyDefault: false,
|
|
},
|
|
};
|
|
setData([draft]);
|
|
await render({ profileId: "d1" });
|
|
|
|
// lastCompletedStep 1 -> resume on step 2 (Choose tools), not step 1.
|
|
expect(container.textContent).toContain("New tools that appear later");
|
|
expect(container.querySelector("#profile-name")).toBeNull();
|
|
});
|
|
});
|