Files
PaperClipAI/tests/e2e/connection-intents.spec.ts
DottaandPaperclip b43073d11f feat(connections): sync and group accounts managed by aggregators (#15254)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Connections give agents governed access to external tools.
> - Aggregator gateways can expose accounts that users already connected
upstream.
> - The Apps catalog did not show those accounts or their current
provider status.
> - Separate cards and setup tasks also made account ownership unclear.
> - This pull request discovers upstream accounts and groups them under
one app card.
> - Users can find connected apps while each provider keeps control of
its accounts.

## Linked Issues or Issue Description

**Subsystem affected**

Connections across the database, shared contracts, server, and board UI.

**Problem or motivation**

Users cannot see which apps are connected through a saved aggregator
gateway. Native and upstream accounts need one app card. Discovery must
preserve company, user, gateway, and credential boundaries.

**Proposed solution**

Sync account metadata from Composio, Arcade, and supported Executor
gateways. Keep upstream account management in each provider. Use source
chips and search to browse the catalog. Preserve native setup and the
gateway's existing access policy.

**Alternatives considered**

Creating a local executable connection for each upstream account would
duplicate authorization state. Using an agent task for routine Composio
setup would add an unnecessary step. The board now calls the saved
gateway directly for that setup.

**Roadmap alignment**

This extends the shipped Connected Apps and MCP Tool Gateway features in
ROADMAP.md. The duplicate search found no open PR for managed account
discovery.

Related work: Refs #13755, Refs #13941, Refs #14725, Refs #13855. Open
PR #12906 covers adjacent toolkit routing work.

## What Changed

- Add provider-neutral discovery, sync, and refresh APIs. Preserve the
Composio API paths.
- Cache observations by company, saved gateway, viewing user, and
credential version. Retain stale observations after failed or incomplete
scans.
- Add optional Arcade account sync credentials in the vault. Discover
Executor accounts through its supported inventory interface.
- Group native and upstream accounts in one app card. Imported account
menus open their provider. Gateway menus own refresh and sync setup.
- Add Paperclip, Composio, Arcade, Installed, and All chips. Show 50
catalog entries per page. Keep connected accounts above discovery. Keep
explicit provider searches scoped.
- Simplify Composio app setup and refresh its connected app list on the
gateway Permissions page.
- Add a compact agent access card and task creation defaults for
connection setup. Preserve explicit blocks and approval policies.
- Add two replay-safe migrations, service and UI tests, Storybook
journeys, and acceptance stories.

## Verification

- Passed the repository typecheck, full build, token gates, and
migration ordering check.
- Passed the focused provider adapter, connection interaction, and
catalog tests after rebasing onto master.
- Passed all nine database sync and migration replay tests using a
disposable database on the test-drive PostgreSQL cluster. Removed that
database after the run.
- Verified Arcade cursor pagination against its official Go SDK and
passed all eight adapter tests, including short and incomplete pages.
- Passed all 45 interaction tests after making the exact requested tools
and their Allowed/Ask first permissions visible before granting access.
Verified the compact card in Storybook.
- Passed the complete UI suite on the final code: 683 files and 7,432
tests, including the corrected Composio destination assertions. Passed
130 focused tests for the UUID, management-link, and health-status
corrections.
- Passed 22 Composio setup/sync tests, 23 connection-intent service
tests, and the connection migration test in separate disposable
databases. Database startup alone was substituted; the suites exercised
their real SQL and services.
- Passed all 10 OpenAPI route checks and the full-stack
connection-intent browser test, including scoped consent, agent
continuation, and task completion.
- The local full runner encountered embedded PostgreSQL startup failures
on this loaded macOS host. The earlier in-flight run also held the
pre-fix Arcade transform; a fresh run of the final provider suite
passes. The final-head CI is queued during GitHub’s active Actions
incident: https://www.githubstatus.com/. The previous run also lost
several runners simultaneously; its real catalog assertion failures are
fixed and the fresh complete UI suite passes.
- Tested the real test-drive server in the embedded browser with a live
Composio gateway. Detected Airtable and Circleback. Verified refresh
progress, account rows, source chips, search scope, and 50-entry
pagination.
- Arcade and Executor coverage uses provider fixtures. Live credentials
were unavailable.
- Storybook builds successfully and includes grouped native/provider
accounts, stale and unavailable discovery, optional Arcade setup, and
mobile states. The acceptance document records the simulated and live
coverage separately.

- Greptile reviewed final commit
`217b024c27b5933e773ce9419c4e92b1032042c6` at 5/5. All six review
threads are resolved, security scans pass, and the PR has no merge
conflicts. The outstanding remote checks are `ci / Select trusted
runner` and `review`, queued by GitHub. They need to complete before
merge.

## Risks

- Provider response changes can break inventory discovery. Failed scans
retain observations and show stale status.
- Composio scans only the supported catalog and can take time. Large
inventories run in the background with progress and a bounded lease.
- Arcade requires a project API key and user ID when the gateway cannot
supply them. This key is used only for discovery.
- Executor discovery depends on the server's exposed inventory tools.
Unsupported servers report unavailable discovery.
- Cached account rows do not grant access or create executable
connections. Gateway policies still govern tool use. Account deletion
and per-app authorization remain upstream.
- The migrations add tables and one nullable column. Replay preserves
existing rows and company-scoped foreign keys.

## Model Used

OpenAI Codex, based on GPT-6. The session does not expose a more
specific serving model ID or context limit. Used reasoning, repository
tools, code execution, and browser verification.

## 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
- [ ] 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
- [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>
2026-10-05 14:57:04 -05:00

470 lines
19 KiB
TypeScript

import { expect, test, type APIRequestContext } from "@playwright/test";
import { createServer, type Server } from "node:http";
import { listenOnFetchAllowedPort } from "./fetch-allowed-port";
import { send } from "./agent-chat.shared";
type Json = Record<string, unknown>;
type Seed = { companyId: string; prefix: string };
type Agent = { id: string; name: string };
async function json<T = Json>(
response: Awaited<ReturnType<APIRequestContext["get"]>>,
): Promise<T> {
expect(
response.ok(),
`${response.url()} failed ${response.status()}: ${await response.text()}`,
).toBe(true);
return (await response.json()) as T;
}
async function newCompany(request: APIRequestContext): Promise<Seed> {
const company = await json<{ id: string; issuePrefix: string }>(
await request.post("/api/companies", {
data: { name: `Connection intent E2E ${Date.now()}` },
}),
);
return { companyId: company.id, prefix: company.issuePrefix };
}
async function createAgent(
request: APIRequestContext,
companyId: string,
name: string,
): Promise<Agent> {
return await json<Agent>(
await request.post(`/api/companies/${companyId}/agents`, {
data: {
name,
role: "qa",
title: "Connection intent fixture agent",
capabilities: "Exercises deterministic connection intent wiring.",
adapterType: "process",
adapterConfig: {
command: process.execPath,
args: ["--input-type=module", "-e", "process.exit(0)"],
},
},
}),
);
}
async function startFakeProvider() {
const captures: Array<{ method: string; toolName: string | null }> = [];
const server: Server = createServer(async (req, res) => {
const chunks: Buffer[] = [];
for await (const chunk of req) chunks.push(chunk as Buffer);
const payload = JSON.parse(
Buffer.concat(chunks).toString("utf8") || "{}",
) as {
id?: string | number;
method?: string;
params?: { name?: string };
};
captures.push({
method: String(payload.method ?? "<unknown>"),
toolName: payload.params?.name ?? null,
});
res.writeHead(200, { "Content-Type": "application/json" });
if (payload.method === "tools/list") {
res.end(
JSON.stringify({
jsonrpc: "2.0",
id: payload.id ?? null,
result: {
tools: [
{
name: "notion:list_pages",
title: "List fixture pages",
description:
"Reads deterministic pages from the fake Notion provider.",
inputSchema: {
type: "object",
properties: {},
additionalProperties: false,
},
},
],
},
}),
);
return;
}
if (payload.method === "tools/call") {
res.end(
JSON.stringify({
jsonrpc: "2.0",
id: payload.id ?? null,
result: {
content: [{ type: "text", text: "Fixture page inventory" }],
},
}),
);
return;
}
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}/`,
captures,
close: () => new Promise<void>((resolve) => server.close(() => resolve())),
};
}
function connectionAwareScript(connectionId: string) {
return `
const post = async (url, body, token = process.env.PAPERCLIP_RUNTIME_TOOLS_TOKEN) => {
const response = await fetch(url, {
method: "POST",
headers: { authorization: \`Bearer \${token}\`, "content-type": "application/json" },
body: JSON.stringify(body)
});
if (!response.ok) throw new Error(\`\${response.status}: \${await response.text()}\`);
return await response.json();
};
const apiHeaders = { authorization: \`Bearer \${process.env.PAPERCLIP_API_KEY}\`, "content-type": "application/json", "x-paperclip-run-id": process.env.PAPERCLIP_RUN_ID };
const runResponse = await fetch(\`\${process.env.PAPERCLIP_API_URL}/api/heartbeat-runs/\${process.env.PAPERCLIP_RUN_ID}\`, { headers: apiHeaders });
if (!runResponse.ok) throw new Error(await runResponse.text());
const run = await runResponse.json();
const issueId = process.env.PAPERCLIP_TASK_ID ?? run.contextSnapshot.issueId;
if (!issueId) throw new Error("Missing task binding");
const search = await post(process.env.PAPERCLIP_RUNTIME_TOOLS_CONNECTIONS_SEARCH_URL, { query: "notion" });
const notion = search.results.find((result) => result.service === "notion");
if (!notion) throw new Error("Notion was not advertised");
if (notion.state !== "ready") {
const requested = await post(process.env.PAPERCLIP_RUNTIME_TOOLS_CONNECTION_REQUEST_URL, { service: notion.service });
if (requested.state !== "needs_user_action") throw new Error("Expected a user-action request");
const comment = await fetch(\`\${process.env.PAPERCLIP_API_URL}/api/issues/\${issueId}/comments\`, {
method: "POST",
headers: apiHeaders,
body: JSON.stringify({ body: "Requested Notion access through the connection card." })
});
if (!comment.ok) throw new Error(await comment.text());
console.log("waiting for connection intent");
process.exit(0);
}
const sessionResponse = await fetch(\`\${process.env.PAPERCLIP_API_URL}/api/tool-gateway/sessions\`, {
method: "POST",
headers: apiHeaders,
body: JSON.stringify({ runId: process.env.PAPERCLIP_RUN_ID, ttlMs: 60000 })
});
if (!sessionResponse.ok) throw new Error(await sessionResponse.text());
const session = await sessionResponse.json();
const toolsResponse = await fetch(\`\${process.env.PAPERCLIP_API_URL}/api/tool-gateway/tools\`, {
headers: { "x-paperclip-tool-gateway-token": session.token }
});
const tools = await toolsResponse.json();
const tool = tools.find((entry) => entry.connectionId === ${JSON.stringify(connectionId)} && entry.upstreamToolName === "notion:list_pages");
if (!tool) throw new Error("Continuation did not receive the installed Notion tool");
const call = await fetch(\`\${process.env.PAPERCLIP_API_URL}/api/tool-gateway/tools/call\`, {
method: "POST",
headers: { "x-paperclip-tool-gateway-token": session.token, "content-type": "application/json" },
body: JSON.stringify({ tool: tool.name, parameters: {} })
});
if (!call.ok) throw new Error(await call.text());
console.log(await call.text());
// Successful tool use must end with a durable task disposition.
const completion = await fetch(\`\${process.env.PAPERCLIP_API_URL}/api/issues/\${issueId}\`, {
method: "PATCH",
headers: apiHeaders,
body: JSON.stringify({ status: "done", comment: "Read the requested Notion page inventory." })
});
if (!completion.ok) throw new Error(await completion.text());
`;
}
test("AgentMail request shows a durable inline key card in agent chat", async ({ page, request }, testInfo) => {
test.setTimeout(120_000);
const settings = await json(await request.get("/api/instance/settings/experimental"));
try {
await json(await request.patch("/api/instance/settings/experimental", { data: {
enableAgentChat: true, enableChatConnectors: true, enableClassicTaskInterface: false,
} }));
const seed = await newCompany(request);
const agent = await createAgent(request, seed.companyId, "Email requester");
// Script only the agent's choice of tool; persistence, routes, and UI are real.
const script = `
const headers = { authorization: "Bearer " + process.env.PAPERCLIP_API_KEY, "content-type": "application/json", "x-paperclip-run-id": process.env.PAPERCLIP_RUN_ID };
const runResponse = await fetch(process.env.PAPERCLIP_API_URL + "/api/heartbeat-runs/" + process.env.PAPERCLIP_RUN_ID, { headers });
if (!runResponse.ok) throw new Error(await runResponse.text());
const run = await runResponse.json();
if (run.contextSnapshot?.interactionId) process.exit(0);
const post = async (url, body) => {
const response = await fetch(url, { method: "POST", headers: { authorization: "Bearer " + process.env.PAPERCLIP_RUNTIME_TOOLS_TOKEN, "content-type": "application/json" }, body: JSON.stringify(body) });
if (!response.ok) throw new Error(await response.text());
return response.json();
};
const search = await post(process.env.PAPERCLIP_RUNTIME_TOOLS_CONNECTIONS_SEARCH_URL, { query: "Get yourself an email address with AgentMail" });
if (!search.results.some(result => result.service === "agentmail") || !search.instruction.includes("connection_request")) throw new Error("AgentMail card was not advertised");
const result = await post(process.env.PAPERCLIP_RUNTIME_TOOLS_CONNECTION_REQUEST_URL, { service: "agentmail" });
if (result.state !== "needs_user_action") throw new Error("Expected an inline card");
`;
await json(await request.patch(`/api/agents/${agent.id}`, { data: {
adapterConfig: { command: process.execPath, args: ["--input-type=module", "-e", script] }, replaceAdapterConfig: true,
} }));
await page.goto(`/${seed.prefix}/chats/${agent.id}`);
await send(page, "Get yourself an email address with AgentMail.");
await waitForAgentRun(request, seed.companyId, agent.id);
const chat = await json<{ id: string }>(await request.get(`/api/companies/${seed.companyId}/chats/${agent.id}`));
const interactions = await json<Array<{ id: string; kind: string; status: string; addresseeUserId: string; payload: Json }>>(
await request.get(`/api/issues/${chat.id}/interactions`),
);
expect(interactions).toHaveLength(1);
expect(interactions[0]).toMatchObject({ kind: "connection_intent", status: "pending", addresseeUserId: "local-board",
payload: { purpose: "channel", serviceSlug: "agentmail", requestingAgentId: agent.id } });
await page.reload();
const form = page.getByTestId("agentmail-inline-setup");
await expect(form).toBeVisible();
await expect(form.locator("input")).toHaveCount(1);
await expect(form.getByLabel("API key")).toHaveAttribute("type", "password");
await expect(form.getByRole("link", { name: "Get an AgentMail API key" })).toHaveAttribute("href", "https://console.agentmail.to/dashboard/api-keys");
await expect(form.locator('[role="radiogroup"], [role="combobox"], select')).toHaveCount(0);
await expect(page.getByRole("dialog")).toHaveCount(0);
await expect(form.getByRole("button", { name: "Connect AgentMail" })).toBeDisabled();
const card = page.getByTestId("connection-intent-focus-target");
await card.screenshot({ path: testInfo.outputPath("agentmail-inline-card.png") });
await page.setViewportSize({ width: 390, height: 844 });
await expect(form).toBeVisible();
await card.screenshot({ path: testInfo.outputPath("agentmail-inline-card-mobile.png") });
await form.getByRole("button", { name: "Not now" }).click();
await expect(form).toHaveCount(0);
await expect.poll(async () => {
const rows = await json<Array<{ status: string }>>(await request.get(`/api/issues/${chat.id}/interactions`));
return rows.map(row => row.status);
}).toEqual(["rejected"]);
expect(await json(await request.get(`/api/companies/${seed.companyId}/email/inboxes`))).toEqual([]);
const connections = await json<{ connections: unknown[] }>(await request.get(`/api/companies/${seed.companyId}/tools/connections`));
expect(connections.connections).toEqual([]);
} finally {
await json(await request.patch("/api/instance/settings/experimental", { data: {
enableAgentChat: settings.enableAgentChat, enableChatConnectors: settings.enableChatConnectors,
enableClassicTaskInterface: settings.enableClassicTaskInterface,
} }));
}
});
async function waitForAgentRun(
request: APIRequestContext,
companyId: string,
agentId: string,
) {
let terminalRun: { id: string; status: string } | null = null;
await expect
.poll(
async () => {
const runs = await json<Array<{ id: string; status: string }>>(
await request.get(
`/api/companies/${companyId}/heartbeat-runs?agentId=${agentId}&limit=10`,
),
);
terminalRun =
runs.find((run) => !["queued", "running"].includes(run.status)) ??
null;
return terminalRun?.status ?? null;
},
{ timeout: 45_000 },
)
.toBe("succeeded");
if (!terminalRun)
throw new Error("Agent run completed without a run receipt");
return terminalRun;
}
test("store setup and task connection intent share one fake provider through continuation", async ({
page,
request,
}) => {
test.setTimeout(180_000);
const provider = await startFakeProvider();
try {
const seed = await newCompany(request);
const holder = await createAgent(
request,
seed.companyId,
"Existing access holder",
);
// Entry point one: connect and test the provider through the Connections store.
await page.goto(`/${seed.prefix}/apps`);
await expect(page.getByRole("heading", { name: "Connectors" })).toBeVisible({
timeout: 30_000,
});
const customConnector = page
.getByRole("list", { name: "Connector list" })
.getByRole("listitem")
.filter({ hasText: "Connect your own tool" });
await customConnector.getByRole("button", { name: "Connect", exact: true }).click();
await customConnector.getByRole("button", { name: "Connect your own MCP server" }).click();
await page
.getByPlaceholder("https://example.com/actions")
.fill(provider.url);
await page.getByRole("button", { name: "Continue" }).click();
await page.getByRole("button", { name: /Check link/i }).click();
// A no-auth read-only provider can complete the access/install defaults in
// one commit. Other methods exercise the same intermediate steps in the
// shared-flow component suite.
await expect(page.getByRole("heading", { name: /is ready/i })).toBeVisible({
timeout: 30_000,
});
const connections = await json<{
connections: Array<{ id: string; name: string; config: Json }>;
}>(await request.get(`/api/companies/${seed.companyId}/tools/connections`));
expect(connections.connections).toHaveLength(1);
const connection = connections.connections[0]!;
const connectionId = connection.id;
await json(
await request.patch(`/api/tool-connections/${connectionId}`, {
data: {
config: {
...connection.config,
url: provider.url,
sourceTemplateKey: "notion",
},
},
}),
);
await json(
await request.put(`/api/tool-connections/${connectionId}/installs`, {
data: {
installs: [{ targetType: "agent", targetId: holder.id }],
},
}),
);
await page.goto(`/${seed.prefix}/apps/${connectionId}/permissions`);
const actionRow = page.locator("[data-action-id]").filter({ hasText: "List fixture pages" });
await actionRow.getByRole("button", { name: "Test", exact: true }).click();
await expect(
page.getByRole("heading", { name: "Test List fixture pages" }),
).toBeVisible({ timeout: 30_000 });
await page.getByRole("button", { name: "Run", exact: true }).click();
await expect(page.getByText("Fixture page inventory")).toBeVisible({
timeout: 30_000,
});
const callsBeforeContinuation = provider.captures.filter(
(capture) => capture.method === "tools/call" && capture.toolName === "notion:list_pages",
).length;
// Entry point two: a scripted agent requests Notion, then the same shared
// provider is reused from the task dialog and appears in the fresh run.
const scout = await createAgent(
request,
seed.companyId,
"Connection requester",
);
await json(
await request.patch(`/api/agents/${scout.id}`, {
data: {
adapterType: "process",
adapterConfig: {
command: process.execPath,
args: [
"--input-type=module",
"-e",
connectionAwareScript(connectionId),
],
},
replaceAdapterConfig: true,
},
}),
);
const issue = await json<{ id: string; identifier: string }>(
await request.post(`/api/companies/${seed.companyId}/issues`, {
data: {
title: "Read our Notion pages",
status: "in_progress",
assigneeAgentId: scout.id,
},
}),
);
// Assigning an in-progress task is the production wake path. Waiting for
// that run avoids creating a second artificial request from an explicit
// heartbeat invocation.
const firstRun = await waitForAgentRun(request, seed.companyId, scout.id);
const taskUrl = `/${seed.prefix}/issues/${issue.identifier}`;
await page.goto(taskUrl);
await expect(
page.getByText(`Grant Connection requester access to “${connection.name}”?`),
).toBeVisible({ timeout: 30_000 });
const permissions = page.getByRole("list", { name: "Tool permissions" });
await expect(permissions.getByText("notion:list_pages", { exact: true })).toBeVisible();
await expect(permissions.getByText("Allowed", { exact: true })).toBeVisible();
await page.getByRole("button", { name: "Grant access", exact: true }).click();
await expect(page.getByText("Notion access granted")).toBeVisible({
timeout: 30_000,
});
await expect(page).toHaveURL(new RegExp(`${taskUrl}$`));
await expect(
page
.getByTestId("connection-intent-focus-target")
.filter({ hasText: "Notion access granted" }),
).toBeFocused();
expect(await page.locator("body").innerText()).not.toMatch(
/\/authorize\?|authorizationUrl/,
);
await expect
.poll(
async () => {
const runs = await json<Array<{ id: string; status: string }>>(
await request.get(
`/api/companies/${seed.companyId}/heartbeat-runs?agentId=${scout.id}&limit=10`,
),
);
return runs.find((run) => run.id !== firstRun.id)?.status ?? null;
},
{ timeout: 45_000 },
)
.toBe("succeeded");
await expect
.poll(() =>
provider.captures.filter(
(capture) =>
capture.method === "tools/call" &&
capture.toolName === "notion:list_pages",
).length,
)
.toBe(callsBeforeContinuation + 1);
const completedIssue = await json<{ status: string }>(
await request.get(`/api/issues/${issue.id}`),
);
expect(completedIssue.status).toBe("done");
const finalRuns = await json<Array<{ id: string; status: string }>>(
await request.get(`/api/companies/${seed.companyId}/heartbeat-runs?agentId=${scout.id}&limit=10`),
);
expect(finalRuns).toHaveLength(2);
expect(finalRuns.every((run) => run.status === "succeeded")).toBe(true);
const interactions = await json<Array<{ kind: string; status: string }>>(
await request.get(`/api/issues/${issue.id}/interactions`),
);
const connectionIntents = interactions.filter(
(interaction) => interaction.kind === "connection_intent",
);
expect(
connectionIntents.filter(
(interaction) => interaction.status === "accepted",
),
).toHaveLength(1);
expect(
connectionIntents.filter(
(interaction) => interaction.status === "pending",
),
).toHaveLength(0);
expect(
connectionIntents.every((interaction) =>
["accepted", "expired"].includes(interaction.status),
),
).toBe(true);
expect(holder.id).not.toBe(scout.id);
} finally {
await provider.close();
}
});