mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-03 09:37:19 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - App connections must work in both the operator UI and agent tool gateway. > - The first stack layer adds secure remote connections. > - Operators still need clear setup, test, and recovery states. > - This pull request adds the gateway behavior and the workspace connection experience. > - The benefit is a connection flow that is easier to understand and recover. ## Linked Issues or Issue Description Refs #11965 This is stack 2 of 11. It depends on stack 1 and replaces another reviewable part of #11965. ## What Changed - Improve remote tool gateway connection behavior. - Add clearer app setup, test, and recovery states. - Add focused server and UI tests for the new paths. - Keep the diff isolated from later identity and catalog work. - Stabilize DNS-pinned remote HTTP protocol fixtures and the managed-runtime public-origin fixture for this independently tested layer. ## Verification - `pnpm -r typecheck` - `pnpm --filter @paperclipai/server exec vitest run src/__tests__/tool-access-service.test.ts` (150 passed) - `pnpm test:run` - `pnpm check:token-gates` - `pnpm build` ## Risks - Gateway errors now surface through new user-facing states. - A stale connection can require a new setup attempt. - The change does not add a database migration. - The injected HTTP transport and public URL are test-only fixtures; production DNS pinning and runtime behavior are unchanged. > I checked `ROADMAP.md`. This stack continues the existing app connection work from #11965 and does not duplicate another planned item. ## Model Used OpenAI Codex, GPT-5. The runtime model ID and context window were not exposed. The model used reasoning, tool use, and code execution. ## 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 not referenced internal/instance-local Paperclip issues or links - [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 - [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: Paperclip <noreply@paperclip.ing>
258 lines
9.3 KiB
TypeScript
258 lines
9.3 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type { ReactNode } from "react";
|
|
import type { ToolMcpGatewayToken, ToolMcpGatewayWithTokens } from "@paperclipai/shared";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { TokensPanel } from "./TokensPanel";
|
|
|
|
const createGatewayTokenMock = vi.hoisted(() => vi.fn());
|
|
const revokeGatewayTokenMock = vi.hoisted(() => vi.fn());
|
|
const pushToastMock = vi.hoisted(() => vi.fn());
|
|
|
|
vi.mock("@/api/tools", () => ({
|
|
toolsApi: {
|
|
createGatewayToken: (...args: unknown[]) => createGatewayTokenMock(...args),
|
|
revokeGatewayToken: (...args: unknown[]) => revokeGatewayTokenMock(...args),
|
|
},
|
|
}));
|
|
|
|
vi.mock("@/context/ToastContext", () => ({
|
|
useToast: () => ({ pushToast: pushToastMock }),
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
async function act(callback: () => void | Promise<void>) {
|
|
let result: void | Promise<void> = undefined;
|
|
flushSync(() => {
|
|
result = callback();
|
|
});
|
|
await result;
|
|
}
|
|
|
|
async function flushReact() {
|
|
for (let i = 0; i < 3; i += 1) {
|
|
await act(async () => {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
});
|
|
}
|
|
}
|
|
|
|
function token(overrides: Partial<ToolMcpGatewayToken> = {}): ToolMcpGatewayToken {
|
|
return {
|
|
id: "token-1",
|
|
companyId: "company-1",
|
|
gatewayId: "gateway-1",
|
|
name: "cto-cursor",
|
|
tokenPrefix: "pcgw_live_8x4Pa",
|
|
subjectType: "gateway_client",
|
|
subjectId: null,
|
|
clientLabel: "Cursor",
|
|
ownerNote: "Local IDE",
|
|
allowedActions: ["tools/list", "tools/call"],
|
|
expiresAt: "2026-09-01T00:00:00.000Z",
|
|
expiryOverrideReason: null,
|
|
expiryOverrideByUserId: null,
|
|
expiryOverrideByAgentId: null,
|
|
expiryOverrideAt: null,
|
|
lastUsedAt: null,
|
|
revokedAt: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: "user-1",
|
|
createdAt: "2026-06-01T00:00:00.000Z",
|
|
updatedAt: "2026-06-01T00:00:00.000Z",
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function gateway(overrides: Partial<ToolMcpGatewayWithTokens> = {}): ToolMcpGatewayWithTokens {
|
|
return {
|
|
id: "gateway-1",
|
|
companyId: "company-1",
|
|
gatewayPublicId: "gw",
|
|
name: "CTO agents",
|
|
displaySlug: "cto-agents",
|
|
slug: "cto-agents",
|
|
description: null,
|
|
status: "active",
|
|
profileId: "profile-1",
|
|
defaultProfileMode: "gateway_only",
|
|
contextScopeType: "none",
|
|
contextScopeId: null,
|
|
agentId: null,
|
|
projectId: null,
|
|
issueId: null,
|
|
approvalIssueId: null,
|
|
endpointPath: "/g/cto-agents/mcp",
|
|
authConfig: {} as ToolMcpGatewayWithTokens["authConfig"],
|
|
headerPolicy: {} as ToolMcpGatewayWithTokens["headerPolicy"],
|
|
metadataPolicy: {} as ToolMcpGatewayWithTokens["metadataPolicy"],
|
|
onDemandToolsConfig: {} as ToolMcpGatewayWithTokens["onDemandToolsConfig"],
|
|
metadata: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: "user-1",
|
|
archivedAt: null,
|
|
createdAt: new Date(),
|
|
updatedAt: new Date(),
|
|
tokens: [],
|
|
clientSnippets: [],
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
describe("TokensPanel", () => {
|
|
let container: HTMLDivElement;
|
|
let root: ReturnType<typeof createRoot>;
|
|
|
|
beforeEach(() => {
|
|
vi.spyOn(Date, "now").mockReturnValue(new Date("2026-06-16T12:00:00.000Z").getTime());
|
|
vi.clearAllMocks();
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
});
|
|
|
|
afterEach(() => {
|
|
flushSync(() => root?.unmount());
|
|
container.remove();
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
async function render(node: ReactNode) {
|
|
const client = new QueryClient({ defaultOptions: { queries: { retry: false } } });
|
|
root = createRoot(container);
|
|
await act(async () => {
|
|
root.render(<QueryClientProvider client={client}>{node}</QueryClientProvider>);
|
|
});
|
|
await flushReact();
|
|
}
|
|
|
|
function clickButton(label: string) {
|
|
const button = [...container.querySelectorAll("button")].find(
|
|
(el) => el.textContent?.trim() === label,
|
|
);
|
|
if (!button) throw new Error(`Button "${label}" not found`);
|
|
return act(async () => {
|
|
button.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
}
|
|
|
|
function clickButtonContaining(label: string) {
|
|
const button = [...container.querySelectorAll("button")].find(
|
|
(el) => el.textContent?.includes(label),
|
|
);
|
|
if (!button) throw new Error(`Button containing "${label}" not found`);
|
|
return act(async () => {
|
|
button.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
}
|
|
|
|
function setInput(selectorText: string, value: string) {
|
|
const input = container.querySelector<HTMLInputElement>(selectorText);
|
|
if (!input) throw new Error(`Input ${selectorText} not found`);
|
|
const setter = Object.getOwnPropertyDescriptor(window.HTMLInputElement.prototype, "value")?.set;
|
|
setter?.call(input, value);
|
|
return act(async () => {
|
|
input.dispatchEvent(new Event("input", { bubbles: true }));
|
|
});
|
|
}
|
|
|
|
it("masks existing tokens and never renders the full secret at rest", async () => {
|
|
await render(<TokensPanel companyId="company-1" gateway={gateway({ tokens: [token()] })} />);
|
|
expect(container.textContent).not.toContain("pcgw_live_8x4Pa•••");
|
|
expect(container.textContent).toContain("fresh one-hour runtime token");
|
|
expect(container.textContent).toContain("one run may leave two revoked rows");
|
|
|
|
await clickButtonContaining("Token history");
|
|
expect(container.textContent).toContain("pcgw_live_8x4Pa•••");
|
|
expect(container.textContent).toContain("Active");
|
|
});
|
|
|
|
it("autofills a token name, reuses it as the client label, and reveals the token once", async () => {
|
|
const created = { ...token({ id: "new-token" }), token: "pcgw_live_FULLSECRETVALUE" };
|
|
createGatewayTokenMock.mockResolvedValue(created);
|
|
const writeText = vi.fn().mockResolvedValue(undefined);
|
|
Object.assign(navigator, { clipboard: { writeText } });
|
|
|
|
await render(<TokensPanel companyId="company-1" gateway={gateway()} />);
|
|
|
|
await clickButton("Issue token");
|
|
const form = container.querySelector("form");
|
|
if (!form) throw new Error("token form not found");
|
|
const nameInput = form.querySelector<HTMLInputElement>('input:not([type="date"])');
|
|
if (!nameInput) throw new Error("token name input not found");
|
|
expect(nameInput.value).toMatch(/^cto-agents-\d{12}$/);
|
|
await act(async () => {
|
|
form.dispatchEvent(new Event("submit", { bubbles: true, cancelable: true }));
|
|
});
|
|
await flushReact();
|
|
|
|
expect(createGatewayTokenMock).toHaveBeenCalledTimes(1);
|
|
expect(createGatewayTokenMock).toHaveBeenCalledWith(
|
|
"company-1",
|
|
"gateway-1",
|
|
expect.objectContaining({
|
|
name: nameInput.value,
|
|
clientLabel: nameInput.value,
|
|
ownerNote: "",
|
|
}),
|
|
);
|
|
expect(container.textContent).toContain("New token — copy now");
|
|
// Reveal-once banner shows the full value immediately after creation.
|
|
expect(container.textContent).toContain("pcgw_live_FULLSECRETVALUE");
|
|
|
|
await clickButton("Copy");
|
|
expect(writeText).toHaveBeenCalledWith("pcgw_live_FULLSECRETVALUE");
|
|
});
|
|
|
|
it("gates revoke behind a typed confirmation matching the token name", async () => {
|
|
revokeGatewayTokenMock.mockResolvedValue(token({ revokedAt: "2026-06-16T12:00:00.000Z" }));
|
|
await render(<TokensPanel companyId="company-1" gateway={gateway({ tokens: [token()] })} />);
|
|
|
|
await clickButtonContaining("Token history");
|
|
await clickButton("Revoke");
|
|
const confirmButton = [...container.querySelectorAll("button")].find(
|
|
(el) => el.textContent?.trim() === "Revoke token",
|
|
) as HTMLButtonElement;
|
|
expect(confirmButton.disabled).toBe(true);
|
|
|
|
await setInput('input[aria-label="Type the token name to confirm"]', "cto-cursor");
|
|
expect(confirmButton.disabled).toBe(false);
|
|
|
|
await clickButton("Revoke token");
|
|
await flushReact();
|
|
expect(revokeGatewayTokenMock).toHaveBeenCalledWith("company-1", "token-1");
|
|
});
|
|
|
|
it("paginates the folded token log and labels past expiry as expired", async () => {
|
|
const tokens = Array.from({ length: 11 }, (_, index) => token({
|
|
id: `token-${index}`,
|
|
name: `client-${index}`,
|
|
tokenPrefix: `pcgw_${index}`,
|
|
expiresAt: index === 0 ? "2026-06-01T00:00:00.000Z" : "2026-09-01T00:00:00.000Z",
|
|
revokedAt: index === 0 ? "2026-06-10T00:00:00.000Z" : null,
|
|
createdAt: new Date(Date.UTC(2026, 5, index + 1)).toISOString(),
|
|
}));
|
|
await render(<TokensPanel companyId="company-1" gateway={gateway({ tokens })} />);
|
|
|
|
expect(container.textContent).not.toContain("client-10");
|
|
await clickButtonContaining("Token history");
|
|
expect(container.textContent).toContain("Page 1 of 2");
|
|
expect(container.textContent).toContain("client-10");
|
|
expect(container.textContent).not.toContain("client-0");
|
|
|
|
const next = container.querySelector<HTMLButtonElement>('button[aria-label="Next token page"]');
|
|
if (!next) throw new Error("next token page button not found");
|
|
await act(async () => next.click());
|
|
|
|
expect(container.textContent).toContain("Page 2 of 2");
|
|
expect(container.textContent).toContain("client-0");
|
|
expect(container.textContent).toContain("Expired");
|
|
expect(container.textContent).not.toContain("Expires 2 months ago");
|
|
});
|
|
});
|