mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-18 05:23:39 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The Apps subsystem gives humans and agents governed access to external tools. > - The current connection flow hides Apps behind an experimental gate and repeats setup text. > - Google sharing choices and generic MCP permissions do not use one consistent opening model. > - Self-hosted installs also need a safe default origin for managed OAuth without a manual config file. > - This pull request makes Apps available, simplifies connection setup, and applies one governed permissions model. > - The benefit is a shorter connection flow that works on a clean self-hosted install. ## Linked Issues or Issue Description **What existing behavior does this improve?** This improves the Apps connection setup flow, managed Google connection flow, generic MCP connection flow, navigation, and runtime origin discovery. **Subsystem affected** Cross-cutting. This changes `ui/`, `server/`, `packages/shared/`, connector documentation, and browser tests. **Current behavior** Apps require an experimental switch. Setup pages repeat titles and explanatory copy. Connection names require manual input. Google credential sharing does not always offer both personal and organization access. Generic MCP providers do not start with the same permission choices. Managed OAuth needs a public URL setting even when the request already has a safe HTTPS origin. **Proposed behavior** Apps are available by default. Setup asks only for required permissions and sharing choices. Paperclip creates conflict-free connection names. Google apps and generic MCP providers use the same human and agent access model. Managed OAuth derives a validated same-origin HTTPS URL when no explicit public URL is set. **Reason and benefit** A clean self-hosted install can connect a managed Google app without hidden setup. Humans can share a service account with their organization. The shorter flow reduces duplicated choices and setup errors. **Breaking changes** The Apps experimental switch is removed. Existing connection APIs remain compatible. New connections can receive a numeric suffix when a name already exists. No duplicate or related public issue was found. ## What Changed - Removed the Apps experimental gate and the breadcrumb that leaves the Apps section. - Simplified all connection setup pages and moved optional provider requirements into one small link. - Added consistent human and agent access choices for Google apps, Zapier, and generic MCP connections. - Added organization sharing to Google Workspace credentials while keeping personal access available. - Generated connection names automatically and resolved name conflicts with numeric suffixes. - Derived a validated public HTTPS origin from the request for config-free managed OAuth. - Updated connector contracts, tests, browser coverage, and authoring documentation. ## Verification - `pnpm check:token-gates` - `pnpm -r typecheck` - `pnpm build` - `pnpm exec vitest run server/src/__tests__/tool-access-service.test.ts server/src/__tests__/generic-mcp-connection.test.ts` (273 passed) - Targeted UI/service regression suite (308 passed) - Six targeted Playwright connection journeys on a fresh onboarding instance (6 passed) - Fresh-install browser proof through Tailscale HTTPS: enrolled with Paperclip Cloud, connected managed Google Drive, and completed a real read operation. - [Exact-head CI run](https://github.com/paperclipai/paperclip/actions/runs/33669760711): all 23 matrix jobs passed, including build, typecheck, server, serialized, canary, and all browser shards. - Greptile 5/5 on `0ae2a859f269984ee950d0af231a5b09a06f3dfd`, with no unresolved review threads. ## Risks Apps are now visible to all operators. The removed experimental flag no longer hides unfinished app definitions. Managed Google availability still depends on the Cloud profile rollout and active instance enrollment. Automatic conflict handling changes only the display name of a newly conflicting connection. > I checked [`ROADMAP.md`](ROADMAP.md). MCP Tool Gateway and Apps are shipped. Connected Apps is planned, and this change improves the existing shipped connection flow. ## Model Used OpenAI Codex, GPT-5, with reasoning, browser control, 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 (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) 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>
206 lines
9.6 KiB
TypeScript
206 lines
9.6 KiB
TypeScript
import { expect, test, type APIRequestContext } from "@playwright/test";
|
|
import { createServer, type Server } from "node:http";
|
|
import { listenOnFetchAllowedPort } from "./fetch-allowed-port";
|
|
|
|
// Apps navigation wave 6 — not-connected apps get a real app page.
|
|
// A row with no live connection must open /apps/app/:applicationId/setup (previous
|
|
// setup + advanced danger zone + reconnect prefill), not the generic connect wizard,
|
|
// and reconnecting must revive the same application/connection, not duplicate.
|
|
|
|
const SCREENSHOT_DIR = "test-results";
|
|
|
|
type Seed = { companyId: string; prefix: string };
|
|
|
|
async function newCompany(request: APIRequestContext, label: string): Promise<Seed> {
|
|
const res = await request.post("/api/companies", { data: { name: `Apps navigation ${label} ${Date.now()}` } });
|
|
expect(res.ok(), `create company failed ${res.status()}: ${await res.text()}`).toBe(true);
|
|
const company = await res.json();
|
|
return {
|
|
companyId: company.id,
|
|
prefix: company.issuePrefix ?? company.prefix ?? company.urlKey ?? "E2E",
|
|
};
|
|
}
|
|
|
|
type MockMcpServer = { url: string; close: () => Promise<void> };
|
|
|
|
async function startMockMcp(): Promise<MockMcpServer> {
|
|
const server: Server = createServer(async (req, res) => {
|
|
const chunks: Buffer[] = [];
|
|
for await (const chunk of req) chunks.push(chunk as Buffer);
|
|
let payload: { id?: string | number; method?: string } = {};
|
|
try {
|
|
payload = JSON.parse(Buffer.concat(chunks).toString("utf8") || "{}");
|
|
} catch {
|
|
// fall through
|
|
}
|
|
if (payload.method === "tools/list") {
|
|
res.writeHead(200, { "Content-Type": "application/json" });
|
|
res.end(
|
|
JSON.stringify({
|
|
jsonrpc: "2.0",
|
|
id: payload.id ?? null,
|
|
result: {
|
|
tools: [
|
|
{
|
|
name: "list_widgets",
|
|
title: "List widgets",
|
|
description: "Read-only listing of widgets.",
|
|
inputSchema: { type: "object", properties: {}, additionalProperties: false },
|
|
},
|
|
],
|
|
},
|
|
}),
|
|
);
|
|
return;
|
|
}
|
|
res.writeHead(200, { "Content-Type": "application/json" });
|
|
res.end(JSON.stringify({ jsonrpc: "2.0", id: payload.id ?? null, result: {} }));
|
|
});
|
|
const port = await listenOnFetchAllowedPort(server);
|
|
return {
|
|
url: `http://127.0.0.1:${port}`,
|
|
close: () => new Promise((resolve) => server.close(() => resolve())),
|
|
};
|
|
}
|
|
|
|
test.describe.serial("not-connected app page", () => {
|
|
test.setTimeout(240_000);
|
|
|
|
let mock: MockMcpServer;
|
|
let seed: Seed;
|
|
let applicationId: string;
|
|
let connectionId: string;
|
|
|
|
test.beforeAll(async ({ request }) => {
|
|
mock = await startMockMcp();
|
|
seed = await newCompany(request, "app-page");
|
|
|
|
const connect = await request.post(`/api/companies/${seed.companyId}/tools/apps/connect`, {
|
|
data: { link: mock.url, name: "Bla", credentialValues: { "credentials.authorization": "qa-token" } },
|
|
});
|
|
expect(connect.ok(), `connect failed ${connect.status()}: ${await connect.text()}`).toBe(true);
|
|
const body = await connect.json();
|
|
connectionId = body.connectionId as string;
|
|
applicationId = body.application.id as string;
|
|
|
|
// Archive the connection (Remove app), then resurrect the application so
|
|
// its connector card offers a fresh Connect action.
|
|
const archive = await request.delete(`/api/tool-connections/${connectionId}`);
|
|
expect(archive.ok(), `archive failed ${archive.status()}: ${await archive.text()}`).toBe(true);
|
|
const revive = await request.patch(`/api/tool-applications/${applicationId}`, {
|
|
data: { status: "active" },
|
|
});
|
|
expect(revive.ok(), `revive failed ${revive.status()}: ${await revive.text()}`).toBe(true);
|
|
});
|
|
|
|
test.afterAll(async () => {
|
|
await mock?.close();
|
|
});
|
|
|
|
test("not-connected row opens the app page, not the generic wizard", async ({ page }) => {
|
|
await page.goto(`/${seed.prefix}/apps/connections`);
|
|
const row = page
|
|
.getByRole("list", { name: "Connector list" })
|
|
.getByRole("listitem")
|
|
.filter({ has: page.getByRole("heading", { name: "Bla", exact: true }) });
|
|
await expect(row).toBeVisible({ timeout: 30_000 });
|
|
await expect(row).toHaveAttribute("data-connected", "false");
|
|
const connectButton = row.getByRole("button", { name: "Connect Bla" });
|
|
await expect(connectButton).toBeVisible();
|
|
|
|
await connectButton.click();
|
|
await expect(page).toHaveURL(new RegExp(`/${seed.prefix}/apps/app/${applicationId}/setup$`), { timeout: 20_000 });
|
|
await expect(page.getByRole("heading", { name: "Bla" })).toBeVisible({ timeout: 20_000 });
|
|
await expect(page.getByRole("heading", { name: "Previous setup" })).toBeVisible();
|
|
await expect(page.getByRole("heading", { name: "Reconnect this app" })).toBeVisible();
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-w6-01-app-not-connected.png`, fullPage: true });
|
|
});
|
|
|
|
test("reconnect prefills the wizard and revives the same application", async ({ page, request }) => {
|
|
await page.goto(`/${seed.prefix}/apps/app/${applicationId}`);
|
|
await page.getByRole("button", { name: "Reconnect", exact: true }).click();
|
|
await expect(page).toHaveURL(/\/apps\/connect\?/, { timeout: 20_000 });
|
|
await expect(page.getByText("Connect your own MCP server")).toBeVisible({ timeout: 20_000 });
|
|
await page.getByRole("button", { name: "Save and continue" }).click();
|
|
await expect(page.getByText(mock.url)).toBeVisible();
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-w6-02-reconnect-prefilled.png`, fullPage: true });
|
|
|
|
await page.getByRole("button", { name: "Check link" }).click();
|
|
// Reconnect retains the previous identity and application, so the generic
|
|
// check can commit the restored connection transactionally.
|
|
await expect(page.getByRole("heading", { name: "Bla is ready." })).toBeVisible({ timeout: 30_000 });
|
|
|
|
const apps = await request.get(`/api/companies/${seed.companyId}/tools/applications`);
|
|
const appsBody = await apps.json();
|
|
const matching = (appsBody.applications as Array<{ id: string; name: string }>).filter(
|
|
(app) => app.name === "Bla",
|
|
);
|
|
expect(matching).toHaveLength(1);
|
|
expect(matching[0].id).toBe(applicationId);
|
|
|
|
const conns = await request.get(`/api/companies/${seed.companyId}/tools/connections`);
|
|
const connsBody = await conns.json();
|
|
const appConns = (connsBody.connections as Array<{ id: string; applicationId: string; status: string }>).filter(
|
|
(c) => c.applicationId === applicationId,
|
|
);
|
|
expect(appConns).toHaveLength(1);
|
|
expect(appConns[0].id).toBe(connectionId);
|
|
expect(appConns[0].status).not.toBe("archived");
|
|
});
|
|
|
|
test("archived app connection returns to provider setup", async ({ page, request }) => {
|
|
const archive = await request.delete(`/api/tool-connections/${connectionId}`);
|
|
expect(archive.ok(), `archive failed ${archive.status()}: ${await archive.text()}`).toBe(true);
|
|
const revive = await request.patch(`/api/tool-applications/${applicationId}`, { data: { status: "active" } });
|
|
expect(revive.ok(), `revive failed ${revive.status()}: ${await revive.text()}`).toBe(true);
|
|
|
|
await page.goto(`/${seed.prefix}/apps/app/${applicationId}`);
|
|
await expect(page).toHaveURL(
|
|
new RegExp(`/${seed.prefix}/apps/app/${applicationId}/setup$`),
|
|
{ timeout: 20_000 },
|
|
);
|
|
await expect(page.getByText("Not connected", { exact: true })).toBeVisible();
|
|
await expect(page.getByRole("heading", { name: "Connect this app" })).toBeVisible();
|
|
|
|
await page.goto(`/${seed.prefix}/apps/connections`);
|
|
const row = page
|
|
.getByRole("list", { name: "Connector list" })
|
|
.getByRole("listitem")
|
|
.filter({ has: page.getByRole("heading", { name: "Bla", exact: true }) });
|
|
await expect(row).toBeVisible({ timeout: 30_000 });
|
|
await expect(row.getByRole("button", { name: "Connect Bla" })).toBeVisible();
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-w6-03-reconnected-row.png`, fullPage: true });
|
|
});
|
|
|
|
test("danger zone on the app page removes the app", async ({ page, request }) => {
|
|
// Build a second not-connected app to remove from its app page.
|
|
const second = await request.post(`/api/companies/${seed.companyId}/tools/apps/connect`, {
|
|
data: {
|
|
link: mock.url.replace("127.0.0.1", "localhost"),
|
|
name: "Doomed app",
|
|
credentialValues: { "credentials.authorization": "qa-token" },
|
|
},
|
|
});
|
|
expect(second.ok(), `second connect failed ${second.status()}: ${await second.text()}`).toBe(true);
|
|
const secondBody = await second.json();
|
|
await request.delete(`/api/tool-connections/${secondBody.connectionId}`);
|
|
await request.patch(`/api/tool-applications/${secondBody.application.id}`, { data: { status: "active" } });
|
|
|
|
await page.goto(`/${seed.prefix}/apps/app/${secondBody.application.id}/advanced`);
|
|
await expect(page.getByText("Danger zone")).toBeVisible({ timeout: 30_000 });
|
|
await page.getByText("Danger zone", { exact: true }).click();
|
|
await page.getByRole("button", { name: "Remove app", exact: true }).click();
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-w6-04-app-page-danger.png`, fullPage: true });
|
|
await page.getByRole("button", { name: "Yes, remove it" }).click();
|
|
await expect(page).toHaveURL(new RegExp(`/${seed.prefix}/apps$`), { timeout: 20_000 });
|
|
await expect(page.getByText("App removed").first()).toBeVisible({ timeout: 20_000 });
|
|
await expect(page.getByRole("heading", { name: "Connectors" })).toBeVisible();
|
|
await expect(
|
|
page
|
|
.getByRole("list", { name: "Connector list" })
|
|
.getByRole("listitem")
|
|
.filter({ has: page.getByRole("heading", { name: "Doomed app", exact: true }) }),
|
|
).toHaveCount(0);
|
|
});
|
|
});
|