Files
PaperClipAI/server/src/__tests__/tool-connection-removal.test.ts
T
Nicky LeachandClaude Opus 5.5 11ac90e31f fix(build): typecheck server/src/__tests__ and fix every type error (#18739)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - The server has about 1,100 test and helper files in
`server/src/__tests__`
> - `server/tsconfig.json` excludes that directory, Vitest does not
check types, and no script runs the tsconfig in that directory
> - So a test can call a function with the wrong arguments and still
pass, and no tool reports it
> - This gap hid 2,168 real type errors, and some of them hid tests that
did not test what they claim
> - This pull request fixes all of these errors and adds the directory
to the server layers from paperclipai/paperclip#18737
> - The benefit is that a type error in a server test now fails the
typecheck, with no baseline and no backlog

## Linked Issues or Issue Description

Refs paperclipai/paperclip#18737, which is merged and added the server
layers. Refs paperclipai/paperclip#18738, which is merged and checks the
test projects outside `pnpm -r`, so it is not a duplicate. Refs
paperclipai/paperclip#18137, which records that this directory has no
check.

**What happened?**

No tool checked the types of 1,074 of the 1,101 files in
`server/src/__tests__`. I searched `package.json`, the workflows, and
all tsconfig files. 27 files are in the program of another tsconfig, and
these 27 have 0 errors. 11 of the 27 are in
`helpers/maintenance/tsconfig.json`. No script ran that project when I
measured this. paperclipai/paperclip#18738 now runs it.

**Expected behavior**

The server typecheck checks these files, and a type error fails the
check.

**Steps to reproduce**

1. On the base commit, run `tsc -p server/src/__tests__/tsconfig.json
--noEmit`. It reports 6,536 errors and needs 12.3 GiB.
2. Add a type error to any file in `server/src/__tests__`.
3. Run `pnpm --filter @paperclipai/server typecheck`. It passes.

**Paperclip version or commit**

I measured the error breakdown below on commit `8dfd632452`, with
TypeScript 7.0.2. The branch now includes master up to
paperclipai/paperclip#18865.

**Deployment mode**

Not applicable. This issue applies to development and CI. No production
source file in the server changes.

### Error breakdown

Each row adds one change to the row above.

| Step | Total errors | Change | Cause |
| --- | --- | --- | --- |
| Config as committed | 6,536 | | |
| Add `src/types/*.d.ts` | 4,447 | -2,089 | Config. The Express request
types were missing. |
| Set `rootDir` to the repository root | 2,436 | -2,011 | Config. |
| Set `allowImportingTsExtensions` | 2,181 | -255 | Config. Vitest
accepts `.ts` imports. |
| Add `ES2024.Promise` to `lib` | 2,138 | -43 | Config. Node 24 has
`Promise.withResolvers`. |
| Set `allowJs` for `.mjs` imports | 2,148 | +10 | Config. It removes 8
`TS7016` errors and shows new real errors. |
| Set `declaration` to false | 2,142 | -6 | Config. Tests emit nothing.
|
| Count only files in `server/src` | 2,058 | -84 | Other packages: 53
Daytona, 29 Runner test, 2 UI. |

So 4,478 of the 6,536 errors (69%) came from config or scope, and 2,058
are real type errors in 314 files. The 29 Runner test errors are also
real, which gives 2,087 errors. Tests that master added after this
measurement had 81 more errors, so this pull request fixes 2,168 errors.

This table classifies the first 2,058 errors.

| Kind of real error | Errors |
| --- | --- |
| Wrong argument or assignment type | 1,023 |
| Stale or partial fixture objects | 525 |
| Property that the type does not have | 317 |
| Missing narrowing of null or unknown | 101 |
| Implicit any | 60 |
| Missing name or module | 16 |
| Other | 16 |

### What the type errors hid

Most errors were stale fixtures and loose mocks. These errors hid real
test problems, and this pull request fixes them:

- **A test that never ran.** `instrumentation.test.ts` required
`sdk-trace-base`, which is not installed. So 3 span tests were skipped.
They now run and pass.
- **Assertions that could not fail.**
- `issue-thread-interactions-service` used a company ID as an issue ID.
- `status-card-evaluation-work` compared `[]` with `[]` in a rollback
check.
- `slack-conversation-lifecycle` read `item.issueId`, which does not
exist.
  - `email-channels` used a permission key that does not exist.
- `heartbeat-project-env` imported `LOW_TRUST_REVIEW_PRESET`, which is
not exported. The value was undefined.
- **Postgres processes that did not stop.** 11 test files called `stop`
on the test database helper. That method does not exist, and the helper
method is `cleanup`.
- **Arguments that the service ignored.**
- `methodKey` is now `connectionMethodKey` in the Daytona, Unikraft,
1Password, and Railway tests.
- 108 calls passed `"owner-user"` to a parameter that expects an options
object.
- 9 chat wizard fixtures passed `managementContext` as `source`, so they
ran `existing_app` and not `manifest`.
  - 2 tests passed a `{ userId }` actor that the function ignores.
- Inserts into `environments` passed a `companyId` column that the table
does not have.
- **Problems in tests that master added during this work.**
- `sandbox-creation-operations` read `database.connectionString` when an
external test database was set. In that mode `database` is undefined, so
the fixture would stop with a TypeError. It now uses the external URL.
- `idle-completed-history` set a Dot operation to `dispatched`. That is
a Muse status, and the Dot type does not have it. The fixture now uses
`admitted`, which is a real in-flight Dot status.

### Possible product problems, not changed

These may be real problems in production code or types. I did not change
them, because this pull request does not change production behavior:

- `decisions-service` `service.create` does not validate the lenient
`cancel_issue_tree` input.
- `createConnection` ignores `input.connectionPurpose`.
- The `createConnection` route schema default stores `{}` for
`transportConfig`.
- `prepareManagedAiRuntime` accepted the invalid value `mode:
"connection"`.
- `createBinding` accepts invalid `projectionClass` strings outside
class 3.
- `ensureManagedProjectWorkspace` forwards an untyped `repoRef` by
spread.
- `routineVariableSchema.label` is optional, but `RoutineVariable.label`
is required.
- `ToolRunContext.projectId` may be too strict.
- `withdrawInteraction` reads `issue.status`, which its type omits.
- `issueService.list` and `reconcileNativeFinalizations` omit fields
that they return at runtime.
- `createGitHubExternalObjectProvider` handles `tokenProvider: null`,
but its type forbids this value.

## What Changed

- Fixed the 2,168 type errors. The diff changes 322 test and helper
files.
- Corrected `server/src/__tests__/tsconfig.json`. Editors and the
typecheck now read the same options and report the same errors.
- Added three `test-tree` layers to
`server/scripts/typecheck-layers.mjs`. They read the server layers as
declarations, and any error fails them. A hash of the path selects the
shard, so a new file does not move other files.
- Added `server/scripts/typecheck-stubs/daytona-sdk.d.ts`. Server tests
reach Daytona plugin source, and the root install does not have
`@daytonaio/sdk`.
- Changed two imports in `ui/src/lib/issue-execution-policy.ts` to use
`.js` extensions, because server tests import this file.
- Made `declarationsConfig` and `--declarations-only` skip the
`test-tree` layers, because these layers emit nothing. Other projects
read only the source layers. Added a test for this.
- Updated `doc/DEVELOPING.md`.

## Verification

Run these commands:

```sh
pnpm --filter @paperclipai/server typecheck
pnpm exec vitest run server/scripts/typecheck-layers.test.mjs
```

Results on macOS (arm64), Node 24, 16 cores. Each check ran after the
merge of paperclipai/paperclip#18738 unless the row says otherwise:

| Check | Commit | Result |
| --- | --- | --- |
| Server typecheck, `PAPERCLIP_TYPECHECK_LOW_MEMORY=1`, all 7 layers |
`6e45a08573` | Exit 0, 0 errors, 62 seconds, peak 3.52 GiB |
| `node scripts/typecheck-test-projects.mjs --low-memory` | `a3306bd13e`
| Exit 0, 0 errors, 42 seconds, peak 3.25 GiB |
| The same script with `--reuse-declarations` | `1b878aabc0` | Exit 0, 0
errors |
| `typecheck-layers.test.mjs` and `live-recovery-work.test.ts` |
`01db5634e4` | 90 passed. These include real compiler runs for a pass, a
type error, and an invalid tsconfig. |
| `tsconfig.declarations.json` after a full server typecheck |
`0fb1e4fb0a` | It references only `below`, `cycle`, and `above`. No
generated config names a `tsconfig.layers.json` file. |
| Owned runtime test in `idle-completed-history` | `e8f2f448ac` |
Passed, with the fix that master later replaced |
| `idle-incoming-wake`, `plugin-idle-manager`, and the changed
`chat-channels` test | `6e45a08573` | 30 passed |
| Runner `native-execution.test.ts` | `eab4dcc1f4` | 114 passed |
| The 19 server test files that changed since `eab4dcc1f4`, and
`typecheck-layers.test.mjs` | `259737b700` | 4,275 of 4,277 passed. The
2 failures are in `chat-channels` and are in the list of 7 below. |

The peak is the largest single process, from `/usr/bin/time -l`. Peaks
for the server typecheck were between 3.42 GiB and 3.56 GiB across 8
runs. Peaks for the test projects were 3.25 GiB and 3.37 GiB across 2
runs. I did not measure a cgroup.

**Runtime check of the fixes.** Types do not prove that a test still
works. So I ran all 309 changed server test files, 11,929 tests, before
the rebase onto paperclipai/paperclip#18737:

| Result | Tests | Detail |
| --- | --- | --- |
| Passed | 11,913 | Includes the 2 tests and the 54 `dot-runner` tests
that passed in a later run, as described below. |
| Failed | 7 | The same 7 tests also fail on the commit before the
fixes. |
| Skipped | 9 | These tests have their own skip conditions: `sentry` 5,
and 1 each in `bundled-plugin-registration`, `customer-success-cloud`,
`onepassword-connection`, and `workspace-runtime-https-live-exercise`. |

The 7 tests that fail with and without this change, on my machine:

- 3 tests in `chat-channels` and `email-channels` stop with `ENOENT` on
a `SKILL.md` file. The path is in the parent checkout, above the git
worktree that I used, so I expect that the worktree is the cause. I did
not prove this.
- `workspace-instance-cleanup` compares `/private/var/...` with
`/var/...`. This is a macOS symlink difference.
- 2 tests in `git-reproducible-managed-checkouts` get
`unknown_base_git_files` and expect `unpushed_managed_checkout`. I did
not find the cause.
- 1 more test in `chat-channels`, `materializes direct external-chat
finals once`, gets `undefined`. I did not find the cause.

CI is the check for these 7 tests. `ci / verify` passed on `eab4dcc1f4`.

Failures during this work:

- My fix to `agent-runtime-connector-access` changed an invalid
permission key in the setup, but not in the assertion. The runtime check
found this. I corrected the assertion, and the file passes.
- `heartbeat-plugin-environment` failed one wait in the full run. It
passed three times alone, so I think that load caused the failure. It
can fail again under load.
- `dot-runner` skipped all 54 tests in the full run because `cargo` was
not on my `PATH`. It then passed 54 of 54 with the toolchain on the
`PATH`.
- My first `lib` value removed the default DOM types, and the error
count went up by 375. I added the DOM libraries.
- My Daytona stub with bare `any` left 48 errors, because generic
helpers then inferred `unknown`. I added shapes that return promises.
- One fix to `agent-secrets-routes` used `class_3_static_lease`, and the
test failed. That class allows only specific paths. I reverted to
`unclassified`.
- `ci / General tests (server (8/12))` failed on `259737b700` because of
the flaky port in `idle-completed-history`. paperclipai/paperclip#18853
fixed this test on master, so this pull request keeps that fix.

**Audit of the diff.** I counted these patterns in added and removed
lines, to find fixes that only hide an error:

| Pattern | Added | Removed |
| --- | --- | --- |
| `@ts-ignore` | 0 | 0 |
| `@ts-expect-error` | 0 | 1 |
| `.skip` | 0 | 0 |
| `as any` | 9 | 9 |
| `: any` | 11 | 2 |
| `as never` | 8 | 2 |
| `as unknown as` | 35 | 4 |
| `Promise<unknown>` | 16 | 5 |
| `expect(` | 128 | 113 |

No hunk removes more `expect(` calls than it adds. Three removals of
test content were intentional, and I checked each one:

- `muse-control` removed `signalToken`. Line 1012 already asserts that
it is absent.
- `merged-pr-confirmation-sweep` removed legacy aliases. Other tests
cover them.
- `heartbeat-workspace-branch-containment` removed a `finalize` branch
that no test row can reach.

Some partial fixtures stay unchecked through `as unknown as` and
`Promise<unknown>`, mostly in `issue-agent-mutation-ownership-routes`
and `issue-comment-reopen-routes`.

**Accuracy of the check.** One program over the tree and the three
shards reported the same errors at the same positions. Memory, as the
peak of the largest process on one thread, was 3.93 GiB for one program
and 2.43 GiB for the largest shard. I measured these two values before
the fixes.

Not run or not proven:

- I did not run the full `pnpm test:run`, or a root `pnpm build`. I
expect CI to run the full suites.
- I did not run the 4 GiB container check, or the full
`scripts/typecheck-low-memory.mjs`. The peaks above come from macOS, so
they are not a Linux cgroup measurement.
- I did not run the UI typecheck after the merges.
- `workspace-runtime-https-live-exercise` is skipped, so its `cleanup`
fix did not run.

## Risks

- **A large diff in test files.** 328 files change. A pull request that
edits the same tests can get merge conflicts. New tests on master can
also add type errors before this merges. Any such error fails this check
and needs a fix here.
- **A higher cost for changes to source types.** A change to a type can
add errors in test files that the author did not touch. The author must
then fix them. This is the purpose of the check, but it is new work.
- **Changed test behavior.** Some tests now run paths that they did not
run before, such as the 9 chat wizard fixtures and the 3 span tests.
They pass here, but they can be more sensitive to timing or to the
environment.
- **The Daytona stub can go stale.** The stub is written by hand. If the
plugin uses a new SDK member, the typecheck reports an error until
someone updates the stub.
- **The release path.** `release-verify.yml` and `scripts/release.sh`
run `pnpm -r typecheck`, so they now run this check.
- **The tsconfig change.** The test transform reads
`server/src/__tests__/tsconfig.json`. The options that I changed are for
type checks, and the runs above passed.
- **A gap that remains.** Tsconfigs in `packages/paperclip-runner` and
in most sandbox provider plugins exclude `*.test.ts`. This check does
not read most of those test files, so they can still drift. That work is
separate from this pull request.

> 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

Anthropic Claude Opus 5.5 (`claude-opus-5-5`) through Claude Code, with
reasoning, tool use, code execution, and subagents. The runtime does not
show the context window size.

## 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 (7 tests fail locally, with
and without this change. See Verification.)
- [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
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 15:27:38 -08:00

705 lines
31 KiB
TypeScript

import { randomUUID } from "node:crypto";
import express from "express";
import request from "supertest";
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from "vitest";
import {
activityLog,
agents,
authUsers,
companies,
companyMemberships,
companySecretBindings,
companySecrets,
companySecretVersions,
connectionGrants,
connectionTokenIssuances,
createDb,
heartbeatRuns,
issues,
managedAgentProfiles,
routines,
routineTriggers,
secretAccessEvents,
toolAccessAuditEvents,
toolApplications,
toolCatalogEntries,
toolConnectionInstalls,
toolConnections,
toolGatewaySessions,
toolMcpGateways,
toolMcpGatewayTokens,
toolOauthStates,
toolProfileBindings,
toolProfileEntries,
toolProfiles,
toolRuntimeSlots,
} from "@paperclipai/db";
import { and, eq } from "drizzle-orm";
import {
getEmbeddedPostgresTestSupport,
startEmbeddedPostgresTestDatabase,
} from "./helpers/embedded-postgres.js";
import { toolAccessService } from "../services/tool-access.js";
import { toolAccessPolicyService } from "../services/tool-access-policy.js";
import { toolAccessRoutes } from "../routes/tool-access.js";
import { secretService } from "../services/secrets.js";
import { localEncryptedProvider } from "../secrets/local-encrypted-provider.js";
import { errorHandler } from "../middleware/index.js";
const embeddedPostgresSupport = await getEmbeddedPostgresTestSupport();
const describeEmbeddedPostgres = embeddedPostgresSupport.supported ? describe : describe.skip;
/**
* PAP-17119 — "Remove app" is a credential revocation boundary, not a status
* flip. Everything here asks the same question from a different angle: after a
* removal, is there any surviving row that still resolves a credential or still
* grants an agent a way to call the app?
*
* The connection is built through the real connect path where that is possible,
* so the tests fail if `connectGalleryApp` ever starts writing credential state
* somewhere the teardown does not look.
*/
// A public IP literal, matching the generic MCP suite: remote endpoints are
// DNS-pinned even in local/private mode (PAP-17098), so a made-up hostname would
// fail resolution before it ever reached this fixture.
const MCP_ORIGIN = "https://203.0.113.10";
const MCP_URL = `${MCP_ORIGIN}/mcp`;
const FIXTURE_TOOLS = [
{ name: "list_things", description: "List things", annotations: { readOnlyHint: true } },
{ name: "delete_thing", description: "Delete a thing", annotations: { readOnlyHint: false, destructiveHint: true } },
];
function jsonResponse(payload: unknown, status = 200): Response {
const body = JSON.stringify(payload);
return {
ok: status >= 200 && status < 300,
status,
headers: {
get: (name: string) => (name.toLowerCase() === "content-type" ? "application/json" : null),
},
text: async () => body,
json: async () => payload,
} as unknown as Response;
}
function headerRecord(init: RequestInit | undefined): Record<string, string> {
const raw = init?.headers;
if (!raw) return {};
if (raw instanceof Headers) return Object.fromEntries(raw.entries());
if (Array.isArray(raw)) return Object.fromEntries(raw as Array<[string, string]>);
return Object.fromEntries(
Object.entries(raw as Record<string, string>).map(([key, value]) => [key.toLowerCase(), value]),
);
}
/**
* The narrowest endpoint that satisfies a header-authenticated connect: it lists
* tools when the expected header arrives and 401s otherwise, which is all the
* catalog refresh and health check need.
*/
function installMcpFixture(requiredHeader: { name: string; value: string }) {
return vi.spyOn(globalThis, "fetch").mockImplementation(async (url, init) => {
const href = String(url);
const method = (init?.method ?? "GET").toUpperCase();
const headers = headerRecord(init);
if (href === MCP_URL && method === "POST") {
if (headers[requiredHeader.name.toLowerCase()] !== requiredHeader.value) {
return jsonResponse({ error: "unauthorized" }, 401);
}
return jsonResponse({ jsonrpc: "2.0", id: "paperclip-catalog-refresh", result: { tools: FIXTURE_TOOLS } });
}
return jsonResponse({ error: "not_found" }, 404);
});
}
async function createCompany(db: ReturnType<typeof createDb>) {
return db
.insert(companies)
.values({
name: `Removal ${randomUUID()}`,
issuePrefix: `RM${randomUUID().slice(0, 6).toUpperCase()}`,
})
.returning()
.then((rows) => rows[0]!);
}
async function createAgent(db: ReturnType<typeof createDb>, companyId: string) {
return db
.insert(agents)
.values({
companyId,
name: `Removal agent ${randomUUID()}`,
role: "engineer",
status: "active",
adapterType: "process",
adapterConfig: {},
runtimeConfig: {},
})
.returning()
.then((rows) => rows[0]!);
}
function createRouteApp(db: ReturnType<typeof createDb>) {
const app = express();
app.use(express.json());
app.use((req, _res, next) => {
req.actor = {
type: "board",
userId: "board-user",
userName: "Board User",
userEmail: null,
isInstanceAdmin: true,
source: "local_implicit",
};
next();
});
app.use("/api", toolAccessRoutes(db));
app.use(errorHandler);
return app;
}
describeEmbeddedPostgres("tool connection removal", () => {
let db!: ReturnType<typeof createDb>;
let tempDb: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>> | null = null;
const HEADER = { name: "X-Api-Key", value: "fixture-secret-value" };
beforeAll(async () => {
tempDb = await startEmbeddedPostgresTestDatabase("paperclip-removal-");
db = createDb(tempDb.connectionString);
}, 20_000);
afterEach(async () => {
vi.restoreAllMocks();
vi.unstubAllEnvs();
await db.delete(toolGatewaySessions);
await db.delete(toolMcpGatewayTokens);
await db.delete(toolMcpGateways);
await db.delete(connectionTokenIssuances);
await db.delete(connectionGrants);
await db.delete(toolOauthStates);
await db.delete(secretAccessEvents);
await db.delete(companySecretBindings);
await db.delete(companySecretVersions);
await db.delete(managedAgentProfiles);
await db.delete(routines);
await db.delete(companySecrets);
await db.delete(activityLog);
await db.delete(toolAccessAuditEvents);
await db.delete(toolRuntimeSlots);
await db.delete(toolConnectionInstalls);
await db.delete(toolProfileBindings);
await db.delete(toolProfileEntries);
await db.delete(toolProfiles);
await db.delete(toolCatalogEntries);
await db.delete(toolConnections);
await db.delete(toolApplications);
await db.delete(heartbeatRuns);
await db.delete(issues);
await db.delete(companyMemberships);
await db.delete(agents);
await db.delete(companies);
await db.delete(authUsers);
});
afterAll(async () => {
await tempDb?.cleanup();
});
/** Connect a header-authenticated app and finish the wizard for one agent. */
async function connectHeaderApp(companyId: string, agentId: string) {
const service = toolAccessService(db);
const connected = await service.connectGalleryApp(companyId, {
link: MCP_URL,
name: `Removal fixture ${randomUUID().slice(0, 8)}`,
credentialValues: { [`headers.${HEADER.name}`]: HEADER.value },
});
const readEntry = connected.catalog.find((entry) => entry.toolName === "list_things")!;
const finished = await service.finishGalleryAppConnection(companyId, connected.connectionId, {
enabledCatalogEntryIds: [readEntry.id],
askFirstCatalogEntryIds: [],
access: { agentIds: [agentId] },
}, { actorType: "user", actorId: "board-user" });
await service.putConnectionInstalls(connected.connectionId, {
installs: [{ targetType: "agent", targetId: agentId }],
}, { actorType: "user", actorId: "board-user" });
return { service, connectionId: connected.connectionId, readEntry, profile: finished.profile };
}
it("revokes the custom-header credential and every access path it granted", async () => {
installMcpFixture(HEADER);
const company = await createCompany(db);
const agent = await createAgent(db, company.id);
const policy = toolAccessPolicyService(db);
const { service, connectionId, readEntry, profile } = await connectHeaderApp(company.id, agent.id);
const [before] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
// One pasted header value is one secret, referenced twice: once as a header
// credential ref and once as a secret ref.
const secretIds = [...new Set([
...before!.credentialRefs.map((ref) => ref.secretId),
...before!.credentialSecretRefs.map((ref) => ref.secretId),
])];
expect(secretIds).toHaveLength(1);
expect(before!.credentialRefs).toHaveLength(1);
expect(before!.credentialSecretRefs).toHaveLength(1);
// The credential really does resolve before removal, so the assertions after
// it are measuring a change rather than a permanent failure.
await expect(secretService(db).resolveSecretValue(company.id, secretIds[0]!, "latest", {
consumerType: "tool_connection",
consumerId: connectionId,
configPath: `headers.${HEADER.name}`,
actorType: "system",
})).resolves.toBe(HEADER.value);
await expect(policy.decide({
companyId: company.id,
actor: { actorType: "agent", actorId: agent.id, agentId: agent.id },
request: { connectionId, catalogEntryId: readEntry.id, toolName: "list_things" },
})).resolves.toMatchObject({ allowed: true });
const removed = await service.archiveConnection(connectionId, company.id, {
actorType: "user",
actorId: "board-user",
});
expect(removed.connection).toMatchObject({ status: "archived", enabled: false });
expect(removed.removal).toMatchObject({
secretsRevoked: secretIds.length,
secretsRetainedShared: 0,
appProfile: "deleted",
installsRemoved: 1,
applicationArchived: true,
});
expect(removed.removal.credentialRefsCleared).toBeGreaterThan(0);
expect(removed.removal.secretBindingsRemoved).toBeGreaterThan(0);
expect(removed.removal.catalogEntriesMarkedRemoved).toBe(FIXTURE_TOOLS.length);
// No secret row, no version row, nothing resolvable.
for (const secretId of secretIds) {
expect(await db.select().from(companySecrets).where(eq(companySecrets.id, secretId))).toEqual([]);
expect(await db.select().from(companySecretVersions).where(eq(companySecretVersions.secretId, secretId))).toEqual([]);
await expect(secretService(db).resolveSecretValue(company.id, secretId, "latest", {
consumerType: "tool_connection",
consumerId: connectionId,
configPath: `headers.${HEADER.name}`,
actorType: "system",
})).rejects.toMatchObject({ status: 404 });
}
expect(await db.select().from(companySecretBindings).where(and(
eq(companySecretBindings.targetType, "tool_connection"),
eq(companySecretBindings.targetId, connectionId),
))).toEqual([]);
// No ref left on the connection to point at a credential.
const [after] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
expect(after!.credentialRefs).toEqual([]);
expect(after!.credentialSecretRefs).toEqual([]);
// No install, no app-managed profile, no profile entries or bindings.
expect(await db.select().from(toolConnectionInstalls).where(eq(toolConnectionInstalls.connectionId, connectionId))).toEqual([]);
expect(await db.select().from(toolProfiles).where(eq(toolProfiles.profileKey, `app:${connectionId}`))).toEqual([]);
expect(await db.select().from(toolProfileEntries).where(eq(toolProfileEntries.profileId, profile.id))).toEqual([]);
expect(await db.select().from(toolProfileBindings).where(eq(toolProfileBindings.profileId, profile.id))).toEqual([]);
// Catalog history survives, marked non-executable.
const catalog = await db.select().from(toolCatalogEntries).where(eq(toolCatalogEntries.connectionId, connectionId));
expect(catalog.length).toBe(FIXTURE_TOOLS.length);
expect(catalog.every((entry) => entry.status === "removed")).toBe(true);
// And the agent is denied.
await expect(policy.decide({
companyId: company.id,
actor: { actorType: "agent", actorId: agent.id, agentId: agent.id },
request: { connectionId, catalogEntryId: readEntry.id, toolName: "list_things" },
})).resolves.toMatchObject({ allowed: false });
expect(await service.listConnectionInstalls(connectionId, company.id)).toEqual([]);
});
it("revokes OAuth secrets, grant credentials and outstanding authorization state", async () => {
installMcpFixture(HEADER);
const company = await createCompany(db);
const agent = await createAgent(db, company.id);
const { service, connectionId } = await connectHeaderApp(company.id, agent.id);
const secrets = secretService(db);
// Stand in for a completed sign-in: access and refresh tokens as dedicated
// `tool_app.*` secrets, referenced by the connection and by a user grant.
const accessSecret = await secrets.create(company.id, {
name: `Removal access ${randomUUID().slice(0, 8)}`,
key: `tool_app.${randomUUID()}.oauth_access_token`,
provider: "local_encrypted",
value: "oauth-access-token",
});
const refreshSecret = await secrets.create(company.id, {
name: `Removal refresh ${randomUUID().slice(0, 8)}`,
key: `tool_app.${randomUUID()}.oauth_refresh_token`,
provider: "local_encrypted",
value: "oauth-refresh-token",
});
const grantSecret = await secrets.create(company.id, {
name: `Removal grant ${randomUUID().slice(0, 8)}`,
key: `tool_app.${randomUUID()}.oauth_access_token`,
provider: "local_encrypted",
value: "grant-access-token",
});
const [existing] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
const headerSecretIds = existing!.credentialSecretRefs.map((ref) => ref.secretId);
await service.updateConnection(connectionId, {
credentialSecretRefs: [
...existing!.credentialSecretRefs,
{ secretId: accessSecret.id, versionSelector: "latest", configPath: "oauth.access_token", required: true, label: "OAuth access token" },
{ secretId: refreshSecret.id, versionSelector: "latest", configPath: "oauth.refresh_token", required: false, label: "OAuth refresh token" },
],
});
const [grant] = await db.insert(connectionGrants).values({
companyId: company.id,
connectionId,
kind: "user",
subjectUserId: "user-1",
credentialSecretRefs: [
{ secretId: grantSecret.id, versionSelector: "latest", configPath: "oauth.access_token", required: true, label: "OAuth access token" },
],
status: "active",
}).returning();
await db.insert(toolOauthStates).values({
state: `state-${randomUUID()}`,
companyId: company.id,
connectionId,
codeVerifier: "verifier",
expiresAt: new Date(Date.now() + 600_000),
});
await db.insert(connectionTokenIssuances).values({
companyId: company.id,
connectionId,
agentId: agent.id,
path: "oauth_access",
outcome: "success",
tokenHash: "a".repeat(64),
expiresAt: new Date(Date.now() + 600_000),
});
const removed = await service.archiveConnection(connectionId, company.id);
expect(removed.removal).toMatchObject({
secretsRevoked: headerSecretIds.length + 3,
secretsRetainedShared: 0,
// The default organization grant and the explicit user grant are both revoked.
grantsRevoked: 2,
oauthStatesDiscarded: 1,
tokenIssuanceHashesCleared: 1,
});
for (const secretId of [accessSecret.id, refreshSecret.id, grantSecret.id, ...headerSecretIds]) {
expect(await db.select().from(companySecrets).where(eq(companySecrets.id, secretId))).toEqual([]);
}
const [grantAfter] = await db.select().from(connectionGrants).where(eq(connectionGrants.id, grant!.id));
expect(grantAfter).toMatchObject({ status: "revoked", isDefault: false });
expect(grantAfter!.revokedAt).not.toBeNull();
expect(grantAfter!.credentialSecretRefs).toEqual([]);
expect(await db.select().from(toolOauthStates).where(eq(toolOauthStates.connectionId, connectionId))).toEqual([]);
const [issuance] = await db.select().from(connectionTokenIssuances).where(eq(connectionTokenIssuances.connectionId, connectionId));
expect(issuance!.tokenHash).toBeNull();
// The ledger row itself is history and stays.
expect(issuance!.path).toBe("oauth_access");
});
it.each(["managed-profile", "routine-trigger"])("retains a credential referenced directly by a %s", async (consumer) => {
installMcpFixture(HEADER);
const company = await createCompany(db);
const agent = await createAgent(db, company.id);
const { service, connectionId } = await connectHeaderApp(company.id, agent.id);
const [connection] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
const secretId = connection!.credentialRefs[0]!.secretId;
if (consumer === "managed-profile") {
await db.insert(managedAgentProfiles).values({ companyId: company.id, profileKey: "shared", displayName: "Shared",
anthropicAgentId: "fixture", agentVersion: "1", environmentId: "fixture", apiKeySecretId: secretId });
} else {
const [routine] = await db.insert(routines).values({ companyId: company.id, title: "Shared" }).returning();
await db.insert(routineTriggers).values({ companyId: company.id, routineId: routine!.id, kind: "webhook", secretId });
}
const removed = await service.archiveConnection(connectionId, company.id);
expect(removed.removal.secretsRetainedShared).toBe(1);
expect((await db.select().from(companySecrets).where(eq(companySecrets.id, secretId)))[0]!.status).toBe("active");
await expect(secretService(db).resolveSecretValue(company.id, secretId, "latest")).resolves.toBe(HEADER.value);
});
it("leaves another consumer's credential in place", async () => {
installMcpFixture(HEADER);
const company = await createCompany(db);
const agent = await createAgent(db, company.id);
const { service, connectionId } = await connectHeaderApp(company.id, agent.id);
const secrets = secretService(db);
// Two secrets removal must not destroy: one the operator manages by hand
// (outside the `tool_app.` namespace), and one dedicated-looking secret a
// second connection also binds.
const operatorSecret = await secrets.create(company.id, {
name: `Operator managed ${randomUUID().slice(0, 8)}`,
key: `shared_api_key_${randomUUID().slice(0, 8)}`,
provider: "local_encrypted",
value: "operator-managed-value",
});
const alsoUsedSecret = await secrets.create(company.id, {
name: `Shared app secret ${randomUUID().slice(0, 8)}`,
key: `tool_app.${randomUUID()}.headers_x_shared`,
provider: "local_encrypted",
value: "shared-app-value",
});
const [existing] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
await service.updateConnection(connectionId, {
credentialSecretRefs: [
...existing!.credentialSecretRefs,
{ secretId: operatorSecret.id, versionSelector: "latest", configPath: "credentials.operator", required: false, label: "Operator key" },
{ secretId: alsoUsedSecret.id, versionSelector: "latest", configPath: "credentials.shared", required: false, label: "Shared key" },
],
});
// A second connection referencing the same secret is the other consumer.
const [otherApplication] = await db.insert(toolApplications).values({
companyId: company.id,
applicationKey: `other:${randomUUID()}`,
name: `Other app ${randomUUID().slice(0, 8)}`,
type: "mcp_http",
status: "active",
}).returning();
const otherConnection = await service.createConnection(company.id, {
applicationId: otherApplication!.id,
name: `Other connection ${randomUUID().slice(0, 8)}`,
connectionPurpose: "tool",
transport: "mcp_remote",
authKind: "none",
ownership: "customer",
connectionKind: "managed",
config: { url: MCP_URL },
transportConfig: { url: MCP_URL },
credentialSecretRefs: [
{ secretId: alsoUsedSecret.id, versionSelector: "latest", configPath: "credentials.shared", required: false, label: "Shared key" },
],
});
const removed = await service.archiveConnection(connectionId, company.id);
expect(removed.removal.secretsRetainedShared).toBe(2);
for (const secretId of [operatorSecret.id, alsoUsedSecret.id]) {
const [row] = await db.select().from(companySecrets).where(eq(companySecrets.id, secretId));
expect(row).toBeTruthy();
expect(row!.status).not.toBe("deleted");
}
// The other consumer can still resolve its credential.
await expect(secretService(db).resolveSecretValue(company.id, alsoUsedSecret.id, "latest", {
consumerType: "tool_connection",
consumerId: otherConnection.id,
configPath: "credentials.shared",
actorType: "system",
})).resolves.toBe("shared-app-value");
// Its binding survives; the removed connection's does not.
expect(await db.select().from(companySecretBindings).where(and(
eq(companySecretBindings.targetType, "tool_connection"),
eq(companySecretBindings.targetId, connectionId),
))).toEqual([]);
expect((await db.select().from(companySecretBindings).where(and(
eq(companySecretBindings.targetType, "tool_connection"),
eq(companySecretBindings.targetId, otherConnection.id),
))).length).toBeGreaterThan(0);
// And the removed connection no longer points at either of them.
const [after] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
expect(after!.credentialSecretRefs).toEqual([]);
});
it("fails closed and stays resumable when the secret provider errors", async () => {
installMcpFixture(HEADER);
const company = await createCompany(db);
const agent = await createAgent(db, company.id);
const { service, connectionId, readEntry } = await connectHeaderApp(company.id, agent.id);
const policy = toolAccessPolicyService(db);
const [before] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
const secretIds = before!.credentialSecretRefs.map((ref) => ref.secretId);
expect(secretIds.length).toBeGreaterThan(0);
// Break provider deletion for the first attempt only. The registry hands out
// this very object, so patching the method is enough.
let failures = 0;
const spy = vi.spyOn(localEncryptedProvider, "deleteOrArchive").mockImplementation(async () => {
failures += 1;
throw new Error("provider unavailable");
});
await expect(service.archiveConnection(connectionId, company.id)).rejects.toThrow("provider unavailable");
expect(failures).toBe(1);
// Failed closed: the app is already undispatchable and the credential is
// already unresolvable, even though the provider copy survives.
const [midway] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
expect(midway).toMatchObject({ status: "archived", enabled: false });
expect(await db.select().from(toolConnectionInstalls).where(eq(toolConnectionInstalls.connectionId, connectionId))).toEqual([]);
expect(await db.select().from(toolProfiles).where(eq(toolProfiles.profileKey, `app:${connectionId}`))).toEqual([]);
await expect(policy.decide({
companyId: company.id,
actor: { actorType: "agent", actorId: agent.id, agentId: agent.id },
request: { connectionId, catalogEntryId: readEntry.id, toolName: "list_things" },
})).resolves.toMatchObject({ allowed: false });
await expect(secretService(db).resolveSecretValue(company.id, secretIds[0]!, "latest", {
consumerType: "tool_connection",
consumerId: connectionId,
configPath: `headers.${HEADER.name}`,
actorType: "system",
})).rejects.toMatchObject({ status: 404 });
// The ref survives the failure on purpose: it is the only pointer a retry
// has to the secret it still has to revoke.
expect(midway!.credentialSecretRefs.length).toBeGreaterThan(0);
// Retrying the same removal finishes the job.
spy.mockRestore();
const removed = await service.archiveConnection(connectionId, company.id);
expect(removed.removal.secretsRevoked).toBe(secretIds.length);
expect(removed.removal.secretsRetainedShared).toBe(0);
for (const secretId of secretIds) {
expect(await db.select().from(companySecrets).where(eq(companySecrets.id, secretId))).toEqual([]);
}
const [after] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
expect(after!.credentialSecretRefs).toEqual([]);
// A third removal is a no-op that still succeeds.
const again = await service.archiveConnection(connectionId, company.id);
expect(again.removal).toMatchObject({
secretsRevoked: 0,
secretsRetainedShared: 0,
installsRemoved: 0,
appProfile: "absent",
grantsRevoked: 0,
});
});
it("archives the app profile and revokes gateway tokens when a gateway still points at it", async () => {
installMcpFixture(HEADER);
const company = await createCompany(db);
const agent = await createAgent(db, company.id);
const { service, connectionId, profile } = await connectHeaderApp(company.id, agent.id);
const [gateway] = await db.insert(toolMcpGateways).values({
companyId: company.id,
name: `Gateway ${randomUUID().slice(0, 8)}`,
slug: `gw-${randomUUID().slice(0, 8)}`,
profileId: profile.id,
status: "active",
}).returning();
const [token] = await db.insert(toolMcpGatewayTokens).values({
companyId: company.id,
gatewayId: gateway!.id,
name: "client",
tokenHash: randomUUID().replace(/-/g, "").padEnd(64, "0"),
}).returning();
const removed = await service.archiveConnection(connectionId, company.id);
expect(removed.removal).toMatchObject({
appProfile: "archived",
gatewayTokensRevoked: 1,
});
const [profileAfter] = await db.select().from(toolProfiles).where(eq(toolProfiles.id, profile.id));
// The row survives only because the gateway foreign key forbids deleting it;
// a non-active profile with no entries is what the policy engine ignores.
expect(profileAfter).toMatchObject({ status: "archived", defaultAction: "deny" });
expect(await db.select().from(toolProfileEntries).where(eq(toolProfileEntries.profileId, profile.id))).toEqual([]);
const [tokenAfter] = await db.select().from(toolMcpGatewayTokens).where(eq(toolMcpGatewayTokens.id, token!.id));
expect(tokenAfter!.revokedAt).not.toBeNull();
});
it("stops a live local runtime so no process keeps serving the revoked credential", async () => {
installMcpFixture(HEADER);
const company = await createCompany(db);
const agent = await createAgent(db, company.id);
const { service, connectionId } = await connectHeaderApp(company.id, agent.id);
const [connection] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
const [slot] = await db.insert(toolRuntimeSlots).values({
companyId: company.id,
applicationId: connection!.applicationId,
connectionId,
slotKey: `mcp:${company.id}:${connectionId}`,
ownerScopeType: "connection",
ownerScopeId: connectionId,
runtimeKind: "local_stdio",
status: "running",
provider: "paperclip",
healthStatus: "ok",
}).returning();
const removed = await service.archiveConnection(connectionId, company.id);
expect(removed.removal.runtimeSlotsStopped).toBe(1);
const [slotAfter] = await db.select().from(toolRuntimeSlots).where(eq(toolRuntimeSlots.id, slot!.id));
expect(slotAfter!.status).toBe("stopped");
expect(slotAfter!.metadata).toMatchObject({ stoppedReason: "connection_removed" });
// A second removal has nothing left to stop.
const again = await service.archiveConnection(connectionId, company.id);
expect(again.removal.runtimeSlotsStopped).toBe(0);
});
it("removes over the route with a secret-free receipt, then requires fresh credentials to reconnect", async () => {
installMcpFixture(HEADER);
const company = await createCompany(db);
const agent = await createAgent(db, company.id);
const { service, connectionId } = await connectHeaderApp(company.id, agent.id);
const app = createRouteApp(db);
const [beforeRemoval] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
const originalSecretIds = beforeRemoval!.credentialSecretRefs.map((ref) => ref.secretId);
expect(originalSecretIds.length).toBeGreaterThan(0);
const response = await request(app).delete(`/api/tool-connections/${connectionId}`).expect(200);
expect(response.body).toMatchObject({ id: connectionId, status: "archived", enabled: false });
expect(response.body.removal).toMatchObject({ appProfile: "deleted", secretsRetainedShared: 0 });
expect(response.body.removal.secretsRevoked).toBeGreaterThan(0);
// Nothing in the response body echoes the pasted value or a secret name.
expect(JSON.stringify(response.body)).not.toContain(HEADER.value);
const [receipt] = await db
.select()
.from(activityLog)
.where(and(eq(activityLog.companyId, company.id), eq(activityLog.action, "tool_connection.archived")));
expect(receipt!.details).toMatchObject({
transport: "mcp_remote",
appProfile: "deleted",
secretsRetainedShared: 0,
applicationArchived: true,
});
expect(Number((receipt!.details as Record<string, unknown>).secretsRevoked)).toBeGreaterThan(0);
const receiptText = JSON.stringify(receipt!.details);
expect(receiptText).not.toContain(HEADER.value);
expect(receiptText).not.toContain("tool_app.");
// Reconnect cannot lean on a retained credential: the archived connection
// refuses both reconnect and sign-in, and a fresh connect has to be given
// new credential values.
await expect(service.reconnectGalleryApp(connectionId, company.id, { credentialValues: {} }))
.rejects.toMatchObject({ status: 409 });
await expect(service.startOAuth(company.id, connectionId, {
redirectUri: "https://paperclip.fixture.test/api/tools/oauth/callback",
actor: { actorType: "user", actorId: "board-user" },
})).rejects.toMatchObject({ status: 409 });
const [archived] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
const reconnected = await service.connectGalleryApp(company.id, {
applicationId: archived!.applicationId,
link: MCP_URL,
name: archived!.name,
credentialValues: { [`headers.${HEADER.name}`]: HEADER.value },
});
// Same connection identity, brand new credential.
expect(reconnected.connectionId).toBe(connectionId);
const [after] = await db.select().from(toolConnections).where(eq(toolConnections.id, connectionId));
expect(after!.credentialSecretRefs.length).toBeGreaterThan(0);
const reconnectedSecretIds = after!.credentialSecretRefs.map((ref) => ref.secretId);
// Not one of the revoked secrets came back.
for (const secretId of originalSecretIds) expect(reconnectedSecretIds).not.toContain(secretId);
// A fresh connect recreates the deny-by-default profile, but does not restore installs.
await expect(db.select().from(toolProfiles).where(eq(toolProfiles.profileKey, `app:${connectionId}`)))
.resolves.toHaveLength(1);
expect(await service.listConnectionInstalls(connectionId, company.id)).toEqual([]);
});
});