mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-22 16:51:28 +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>
191 lines
9.2 KiB
TypeScript
191 lines
9.2 KiB
TypeScript
import { expect, test, type APIRequestContext, type Page } from "@playwright/test";
|
|
import { createServer, type Server } from "node:http";
|
|
import { listenOnFetchAllowedPort } from "./fetch-allowed-port";
|
|
|
|
// Apps navigation — dark-mode + navigation QA for the prosumer Apps surfaces.
|
|
// Seeds a healthy app and a broken (needs-attention) app, forces dark theme,
|
|
// and screenshots /apps, the folded attention banner, and the Advanced/developer doors to
|
|
// prove the amber/emerald surfaces read correctly on dark.
|
|
|
|
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())),
|
|
};
|
|
}
|
|
|
|
async function connectApp(request: APIRequestContext, seed: Seed, url: string): Promise<string> {
|
|
const connect = await request.post(`/api/companies/${seed.companyId}/tools/apps/connect`, {
|
|
data: { link: url, credentialValues: { "credentials.authorization": "qa-token" } },
|
|
});
|
|
expect(connect.ok(), `connect failed ${connect.status()}: ${await connect.text()}`).toBe(true);
|
|
const body = await connect.json();
|
|
const enabledCatalogEntryIds = (body.actions?.readOnly ?? []).map(
|
|
(action: { catalogEntryId: string }) => action.catalogEntryId,
|
|
);
|
|
const finish = await request.post(`/api/companies/${seed.companyId}/tools/apps/${body.connectionId}/finish`, {
|
|
data: { enabledCatalogEntryIds, askFirstCatalogEntryIds: [], access: "all_agents" },
|
|
});
|
|
expect(finish.ok(), `finish failed ${finish.status()}: ${await finish.text()}`).toBe(true);
|
|
return body.connectionId as string;
|
|
}
|
|
|
|
async function forceDark(page: Page) {
|
|
await page.addInitScript(() => window.localStorage.setItem("paperclip.theme", "dark"));
|
|
}
|
|
|
|
test.describe.serial("dark-mode Apps surfaces", () => {
|
|
test.setTimeout(240_000);
|
|
|
|
let healthy: MockMcpServer;
|
|
let seed: Seed;
|
|
let brokenId: string;
|
|
|
|
test.beforeAll(async ({ request }) => {
|
|
healthy = await startMockMcp();
|
|
seed = await newCompany(request, "dark");
|
|
|
|
// Healthy app.
|
|
await connectApp(request, seed, healthy.url);
|
|
|
|
// Broken app → needs attention. Use a `localhost` URL so the derived
|
|
// connection name differs from the healthy `127.0.0.1` app.
|
|
const ephemeral = await startMockMcp();
|
|
brokenId = await connectApp(request, seed, ephemeral.url.replace("127.0.0.1", "localhost"));
|
|
const brokenUrl = "http://localhost:65535/";
|
|
const patch = await request.patch(`/api/tool-connections/${brokenId}`, {
|
|
data: { config: { url: brokenUrl } },
|
|
});
|
|
expect(patch.ok(), `patch broken url failed ${patch.status()}: ${await patch.text()}`).toBe(true);
|
|
await ephemeral.close();
|
|
const health = await request.post(`/api/tool-connections/${brokenId}/health-check`);
|
|
expect(health.status()).toBe(502);
|
|
});
|
|
|
|
test.afterAll(async () => {
|
|
await healthy?.close();
|
|
});
|
|
|
|
test("sidebar says Apps and links to /apps", async ({ page }) => {
|
|
await forceDark(page);
|
|
await page.goto(`/${seed.prefix}/dashboard`);
|
|
const appsLink = page.getByRole("link", { name: "Apps", exact: true });
|
|
await expect(appsLink).toBeVisible({ timeout: 30_000 });
|
|
await expect(appsLink).toHaveAttribute("href", new RegExp(`/${seed.prefix}/apps$`));
|
|
});
|
|
|
|
test("apps list dark mode with attention banner", async ({ page }) => {
|
|
await forceDark(page);
|
|
await page.goto(`/${seed.prefix}/apps/connections`);
|
|
await expect(page.getByRole("heading", { name: "Connectors" })).toBeVisible({ timeout: 30_000 });
|
|
await expect(page.getByText(/needs attention/i).first()).toBeVisible({ timeout: 30_000 });
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-01-apps-dark.png`, fullPage: true });
|
|
});
|
|
|
|
test("attention details dark mode", async ({ page }) => {
|
|
await forceDark(page);
|
|
await page.goto(`/${seed.prefix}/apps/connections`);
|
|
await expect(page.getByRole("heading", { name: "Connectors" })).toBeVisible({ timeout: 30_000 });
|
|
await expect(page.getByText(/connect ECONNREFUSED/i).first()).toBeVisible({ timeout: 30_000 });
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-02-attention-dark.png`, fullPage: true });
|
|
});
|
|
|
|
test("advanced door shows paste config with the merged Apps sidebar", async ({ page }) => {
|
|
await forceDark(page);
|
|
await page.goto(`/${seed.prefix}/apps/advanced`);
|
|
await expect(page.getByRole("heading", { name: "Advanced setup" })).toBeVisible({ timeout: 30_000 });
|
|
await expect(page.getByText(/Paste the MCP config snippet/i).first()).toBeVisible({ timeout: 20_000 });
|
|
await expect(page.getByRole("link", { name: "Connectors" })).toBeVisible();
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-03-advanced-run-dark.png`, fullPage: true });
|
|
|
|
// Sidebar and tab switcher both link Paste a config — either lands on /paste-config.
|
|
await page.getByRole("link", { name: "Paste a config" }).first().click();
|
|
await expect(page).toHaveURL(/\/apps\/advanced\/paste-config$/);
|
|
await expect(page.getByText(/Paste the MCP config snippet/i).first()).toBeVisible({ timeout: 20_000 });
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-04-advanced-paste-dark.png`, fullPage: true });
|
|
});
|
|
|
|
test("developer routes share the merged Apps sidebar without hidden tabs", async ({ page }) => {
|
|
await forceDark(page);
|
|
await page.goto(`/${seed.prefix}/apps/advanced/profiles`);
|
|
await expect(page.getByRole("heading", { name: "Access profiles" })).toBeVisible({ timeout: 30_000 });
|
|
await expect(page.locator('a[href$="/apps/advanced/gateways"]', { hasText: "Gateways" })).toHaveCount(0);
|
|
await expect(page.locator('a[href$="/apps/advanced/profiles"]', { hasText: "Profiles" })).toHaveCount(0);
|
|
await expect(page.locator('a[href$="/apps/advanced/audit"]', { hasText: "Activity" })).toHaveCount(0);
|
|
await expect(page.locator('a[href$="/activity"]', { hasText: "Activity" })).toBeVisible();
|
|
await expect(page.getByRole("link", { name: "Applications", exact: true })).toHaveCount(0);
|
|
// Apps section lives in the same sidebar now.
|
|
await expect(page.locator('a[href$="/apps"]', { hasText: "Connectors" })).toBeVisible();
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-05-developer-overview-dark.png`, fullPage: true });
|
|
});
|
|
|
|
test("app detail rename and danger zone removal", async ({ page }) => {
|
|
await forceDark(page);
|
|
await page.goto(`/${seed.prefix}/apps/${brokenId}/advanced`);
|
|
await expect(page.getByText("Danger zone")).toBeVisible({ timeout: 30_000 });
|
|
|
|
// Rename from the header pencil.
|
|
await page.getByRole("button", { name: "Rename app" }).click();
|
|
await page.getByLabel("App name").fill("QA Renamed App");
|
|
await page.getByRole("button", { name: "Save", exact: true }).click();
|
|
await expect(page.getByRole("heading", { name: "QA Renamed App" })).toBeVisible({ timeout: 20_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-06-danger-zone-dark.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 page.screenshot({ path: `${SCREENSHOT_DIR}/apps-nav-07-after-remove-dark.png`, fullPage: true });
|
|
});
|
|
});
|