mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-26 10:26:26 +01:00
## Thinking Path > - Paperclip is the open source control plane people use to manage AI-agent companies and their governed access to external systems. > - Connected Apps build on the existing Apps and MCP gateway substrate so companies can configure reusable, auditable integrations. > - The current connection record does not yet have a stable public address, explicit ownership/auth method fields, or subject-specific credential grants. > - Without that schema core, later OAuth, per-user authorization, token brokering, triggers, and connector-service phases cannot enforce tenant and subject boundaries consistently. > - This pull request adds the forward-compatible Connections v3 schema core while preserving the existing connection lifecycle and directly migrating the remote MCP transport name. > - The benefit is a company-scoped, least-privilege foundation for one-click integrations without bypassing Paperclip secrets, profiles, rules, or audit controls. ## Linked Issues or Issue Description No matching public issue was found. **Problem** Paperclip's current app connections need a durable identity and authorization substrate before Connected Apps can safely support multiple setup methods, per-user credentials, provider tenants, and managed connector services. The existing schema only models a single connection-level credential set and uses legacy transport terminology. **Proposed solution** Add a stable company-scoped connection UID, explicit ownership/auth/transport fields, a subject-aware `connection_grants` table, and multi-key credential annotations. Backfill existing connections and workspace grants in a reversible migration, then update shared/server/UI contracts to the new `mcp_remote` transport name. **Related work** - Related foundation: #9534 - Roadmap: Connected Apps (one-click integrations) ## What Changed - Added company-scoped connection `uid`, `ownership`, `authKind`, and canonical transport fields across database, shared contracts, validators, services, and UI fixtures. - Added `connection_grants` with workspace/user subject rules, provider tenant metadata, credential secret refs, revocation state, company scoping, and uniqueness constraints. - Added migration `0182_connections_v3_schema_core` to backfill stable UIDs, rename `remote_http` to `mcp_remote`, infer auth kinds, create default workspace grants, and support rollback coverage. - Added multi-key credential annotations and updated gateway/access services without changing the existing lifecycle behavior. - Updated the connection glossary, connector playbook, and security threat model for the new identity, grant, and relay boundaries. - Added explicit test UIDs to direct database fixtures so the new non-null invariant is exercised across affected server suites. ## Verification - `pnpm --filter @paperclipai/shared typecheck` - `pnpm --filter @paperclipai/db typecheck` - `pnpm --filter @paperclipai/server typecheck` - `pnpm --filter @paperclipai/ui typecheck` - `pnpm exec vitest run server/src/__tests__/tool-access-service.test.ts server/src/__tests__/tool-gateway-service.test.ts server/src/__tests__/tool-gateway.test.ts server/src/__tests__/heartbeat-runtime-skills.test.ts server/src/__tests__/tool-oauth-legacy-backfill.test.ts server/src/__tests__/tool-access-policy-service.test.ts server/src/__tests__/heartbeat-runtime-mcp-servers.test.ts packages/db/src/connections-v3-schema-core-migration.test.ts packages/shared/src/validators/tool-access.test.ts --config vitest.config.ts` — 9 files, 218 tests passed. - Latest-head GitHub Actions: build, typecheck, general/serialized suites, backup/worktree restore coverage, both e2e shards, canary, policy, and security scans pass. - Greptile: 5/5 with zero unresolved threads. - `pnpm check:token-gates` remains red only on five pre-existing `#9627` color literals outside this change. ## Risks - **Migration risk:** UID backfill and default-grant creation touch every existing connection. The migration uses company-scoped uniqueness, deterministic legacy UIDs with ID suffixes, and seeded up/rollback coverage. - **Authorization risk:** Grant rows carry credential references. Constraints enforce workspace-vs-user subject shape, company/connection lookup indexes, one default grant per connection, and one user grant per connection/subject. Security review is requested specifically for this design. - **Compatibility risk:** `remote_http` is renamed directly to `mcp_remote`; all repository call sites and fixtures are updated in the same change. - **Future-phase risk:** Subject-bound token issuance, triggers, and connector-service relay verification remain fail-closed requirements documented for later phases; this PR does not expose those capabilities. > 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 CLI coding agent. The runtime did not expose an exact underlying model ID or context-window size; capabilities used include repository inspection, code editing, shell execution, test execution, Git/GitHub CLI operations, and structured reasoning. ## 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>
155 lines
7.4 KiB
TypeScript
155 lines
7.4 KiB
TypeScript
import { expect, test, type APIRequestContext, type Page } from "@playwright/test";
|
|
|
|
// Current Apps lifecycle coverage. The legacy Tools -> Applications CRUD table
|
|
// was retired; old links now redirect to /apps. Keep this harness focused on
|
|
// the user-visible Connections list plus app detail setup/advanced flows.
|
|
|
|
type SeedResult = {
|
|
companyId: string;
|
|
prefix: string;
|
|
};
|
|
|
|
const SCREENSHOT_DIR = "test-results";
|
|
const APP_PREFIX = `QA 10820 ${Date.now().toString(36)}`;
|
|
|
|
async function discoverCompany(request: APIRequestContext): Promise<SeedResult> {
|
|
const res = await request.post("/api/companies", {
|
|
data: { name: `applications lifecycle ${Date.now()}` },
|
|
});
|
|
expect(res.ok(), `create company failed ${res.status()}: ${await res.text()}`).toBe(true);
|
|
const company = await res.json();
|
|
const flags = await request.patch("/api/instance/settings/experimental", { data: { enableApps: true } });
|
|
expect(flags.ok(), `enable apps failed ${flags.status()}: ${await flags.text()}`).toBe(true);
|
|
return {
|
|
companyId: company.id,
|
|
prefix: company.issuePrefix ?? company.prefix ?? company.urlKey ?? "E2E",
|
|
};
|
|
}
|
|
|
|
async function createApplication(
|
|
request: APIRequestContext,
|
|
companyId: string,
|
|
body: { name: string; description?: string; type?: string },
|
|
): Promise<{ id: string; name: string }> {
|
|
const res = await request.post(`/api/companies/${companyId}/tools/applications`, {
|
|
data: { type: "mcp_http", ...body },
|
|
});
|
|
if (!res.ok()) throw new Error(`create app failed ${res.status()}: ${await res.text()}`);
|
|
return res.json();
|
|
}
|
|
|
|
async function createConnection(
|
|
request: APIRequestContext,
|
|
companyId: string,
|
|
data: { applicationName?: string; applicationId?: string; name: string; transport?: string; config?: object },
|
|
): Promise<{ id: string; applicationId: string; name: string }> {
|
|
const res = await request.post(`/api/companies/${companyId}/tools/connections`, {
|
|
data: {
|
|
transport: "mcp_remote",
|
|
config: { url: "https://fixture.example/mcp" },
|
|
enabled: true,
|
|
status: "active",
|
|
...data,
|
|
},
|
|
});
|
|
if (!res.ok()) throw new Error(`create connection failed ${res.status()}: ${await res.text()}`);
|
|
return res.json();
|
|
}
|
|
|
|
async function gotoApps(page: Page, prefix: string) {
|
|
await page.goto(`/${prefix}/apps`);
|
|
await expect(page.getByRole("heading", { name: "Connections" })).toBeVisible({ timeout: 30_000 });
|
|
}
|
|
|
|
test.describe.serial("applications lifecycle", () => {
|
|
let seed: SeedResult;
|
|
|
|
test.beforeAll(async ({ request }) => {
|
|
seed = await discoverCompany(request);
|
|
});
|
|
|
|
test.afterAll(async ({ request }) => {
|
|
if (!seed?.companyId) return;
|
|
await request.delete(`/api/companies/${seed.companyId}`).catch(() => undefined);
|
|
});
|
|
|
|
test("Connections list surfaces connected and not-connected apps", async ({ page, request }) => {
|
|
const connectedName = `${APP_PREFIX}-connected`;
|
|
const notConnectedName = `${APP_PREFIX}-not-connected`;
|
|
const connected = await createConnection(request, seed.companyId, {
|
|
applicationName: connectedName,
|
|
name: connectedName,
|
|
});
|
|
const notConnected = await createApplication(request, seed.companyId, { name: notConnectedName });
|
|
|
|
await gotoApps(page, seed.prefix);
|
|
|
|
const connectedRow = page.locator("tbody tr", { hasText: connectedName });
|
|
await expect(connectedRow).toBeVisible();
|
|
await expect(connectedRow.getByText("Healthy")).toBeVisible();
|
|
await expect(connectedRow.getByRole("button", { name: "Open" })).toBeVisible();
|
|
|
|
const notConnectedRow = page.locator("tbody tr", { hasText: notConnectedName });
|
|
await expect(notConnectedRow).toBeVisible();
|
|
await expect(notConnectedRow.getByText("Not connected")).toBeVisible();
|
|
await expect(notConnectedRow.getByRole("button", { name: "Connect" })).toBeVisible();
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/applications-crud-current-list.png`, fullPage: true });
|
|
|
|
await connectedRow.getByRole("button", { name: "Open" }).click();
|
|
await expect(page).toHaveURL(new RegExp(`/${seed.prefix}/apps/${connected.id}`), { timeout: 20_000 });
|
|
|
|
await gotoApps(page, seed.prefix);
|
|
await notConnectedRow.getByRole("button", { name: "Connect" }).click();
|
|
await expect(page).toHaveURL(new RegExp(`/${seed.prefix}/apps/app/${notConnected.id}`), { timeout: 20_000 });
|
|
});
|
|
|
|
test("connected app detail supports pause, rename, and removal", async ({ page, request }) => {
|
|
const appName = `${APP_PREFIX}-detail-app`;
|
|
const renamed = `${APP_PREFIX}-renamed-app`;
|
|
const connection = await createConnection(request, seed.companyId, {
|
|
applicationName: appName,
|
|
name: appName,
|
|
});
|
|
|
|
await page.goto(`/${seed.prefix}/apps/${connection.id}/setup`);
|
|
await expect(page.getByRole("heading", { name: appName })).toBeVisible({ timeout: 30_000 });
|
|
await expect(page.getByRole("heading", { name: "Agents can use this app" })).toBeVisible();
|
|
|
|
await page.getByRole("switch", { name: "Pause this app" }).click();
|
|
await expect(page.getByRole("heading", { name: "This app is paused" })).toBeVisible({ timeout: 15_000 });
|
|
await page.getByRole("switch", { name: "Resume this app" }).click();
|
|
await expect(page.getByRole("heading", { name: "Agents can use this app" })).toBeVisible({ timeout: 15_000 });
|
|
|
|
await page.getByRole("button", { name: "Rename app" }).click();
|
|
await page.getByLabel("App name").fill(renamed);
|
|
await page.getByRole("button", { name: "Save", exact: true }).click();
|
|
await expect(page.getByRole("heading", { name: renamed })).toBeVisible({ timeout: 15_000 });
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/applications-crud-current-detail.png`, fullPage: true });
|
|
|
|
await page.goto(`/${seed.prefix}/apps/${connection.id}/advanced`);
|
|
await expect(page.getByText("Danger zone")).toBeVisible({ timeout: 15_000 });
|
|
await page.getByRole("button", { name: "Remove app", exact: true }).click();
|
|
await expect(page.getByRole("button", { name: "Yes, remove it" })).toBeVisible();
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/applications-crud-current-remove-connected.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.locator("tbody tr", { hasText: renamed })).toHaveCount(0);
|
|
});
|
|
|
|
test("not-connected app advanced page removes the application", async ({ page, request }) => {
|
|
const cleanAppName = `${APP_PREFIX}-clean-remove-app`;
|
|
const cleanApp = await createApplication(request, seed.companyId, { name: cleanAppName });
|
|
|
|
await page.goto(`/${seed.prefix}/apps/app/${cleanApp.id}/advanced`);
|
|
await expect(page.getByRole("heading", { name: cleanAppName })).toBeVisible({ timeout: 30_000 });
|
|
await expect(page.getByText("Danger zone")).toBeVisible();
|
|
await page.getByRole("button", { name: "Remove app", exact: true }).click();
|
|
await page.screenshot({ path: `${SCREENSHOT_DIR}/applications-crud-current-remove-not-connected.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.locator("tbody tr", { hasText: cleanAppName })).toHaveCount(0);
|
|
});
|
|
});
|