Files
PaperClipAI/server/src/__tests__/bundled-plugins.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

652 lines
30 KiB
TypeScript

import { mkdtempSync, mkdirSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
import os from "node:os";
import path from "node:path";
import { afterAll, describe, expect, it, vi } from "vitest";
import {
BUNDLED_PLUGIN_CATALOG,
DEFAULT_BUNDLED_CATALOG_ROOT,
SELF_HOSTED_AUTO_INSTALL_KEYS,
ensureBundledPlugins,
resolveBundledCatalogRoot,
resolveBundledPluginInstalls,
resolveManagedBundledPluginKeys,
type BundledPluginProvisionerDeps,
type ResolvedBundledPlugin,
} from "../services/bundled-plugins.js";
const CATALOG_ROOT = "/app/packages/plugins";
const tempDirs: string[] = [];
function makeTempDir(prefix: string): string {
const dir = mkdtempSync(path.join(os.tmpdir(), prefix));
tempDirs.push(dir);
return dir;
}
afterAll(() => {
for (const dir of tempDirs) rmSync(dir, { recursive: true, force: true });
});
// ---------------------------------------------------------------------------
// Catalog-root resolution (fail-to-start allowlist)
// ---------------------------------------------------------------------------
describe("managed bundled plugin selection", () => {
it.each([
{ env: {}, selected: undefined, expected: null },
{ env: { PAPERCLIP_CLOUD_TENANT_SERVER_TOKEN: "tenant-fixture" }, selected: undefined, expected: [] },
{ env: { PAPERCLIP_CLOUD_TENANT_SERVER_TOKEN: " " }, selected: undefined, expected: null },
{ env: { PAPERCLIP_MANAGED_CONFIG: "" }, selected: undefined, expected: [] },
{ env: { PAPERCLIP_MANAGED_CONFIG: "{}" }, selected: null, expected: [] },
{ env: { PAPERCLIP_CLOUD_TENANT_SERVER_TOKEN: "tenant-fixture" }, selected: ["daytona"], expected: ["daytona"] },
{ env: {}, selected: ["modal"], expected: ["modal"] },
{ env: {}, selected: [], expected: [] },
])("uses the canonical Cloud floor and preserves explicit selection: $env / $selected", ({ env, selected, expected }) => {
expect(resolveManagedBundledPluginKeys(selected, env)).toEqual(expected);
});
});
describe("resolveBundledPluginInstalls", () => {
it("resolves the optional CreateOS sandbox provider without making it a self-hosted default", () => {
expect(resolveBundledPluginInstalls(["createos"], {
catalogRoot: CATALOG_ROOT,
env: {},
enforceCatalogRoot: true,
})).toEqual([{
key: "createos",
pluginKey: "paperclip.createos-sandbox-provider",
localPath: path.join(CATALOG_ROOT, "sandbox-providers/createos"),
}]);
expect(SELF_HOSTED_AUTO_INSTALL_KEYS).not.toContain("createos");
});
it("resolves the optional boxd sandbox provider without making it a self-hosted default", () => {
expect(resolveBundledPluginInstalls(["boxd"], {
catalogRoot: CATALOG_ROOT,
env: {},
enforceCatalogRoot: true,
})).toEqual([{
key: "boxd",
pluginKey: "paperclip.boxd-sandbox-provider",
localPath: path.join(CATALOG_ROOT, "sandbox-providers/boxd"),
}]);
expect(SELF_HOSTED_AUTO_INSTALL_KEYS).not.toContain("boxd");
});
it("resolves known keys to paths inside the catalog root", () => {
const resolved = resolveBundledPluginInstalls(["kubernetes", "daytona"], {
catalogRoot: CATALOG_ROOT,
env: {},
enforceCatalogRoot: true,
});
expect(resolved).toEqual([
{
key: "kubernetes",
pluginKey: "paperclip.kubernetes-sandbox-provider",
localPath: path.join(CATALOG_ROOT, "sandbox-providers/kubernetes"),
},
{
key: "daytona",
pluginKey: "paperclip.daytona-sandbox-provider",
localPath: path.join(CATALOG_ROOT, "sandbox-providers/daytona"),
},
]);
});
it("throws on a key outside the bundled catalog (fail to start)", () => {
expect(() =>
resolveBundledPluginInstalls(["kubernetes", "not-a-bundled-plugin"], {
catalogRoot: CATALOG_ROOT,
env: {},
enforceCatalogRoot: true,
}),
).toThrow(/"not-a-bundled-plugin" is not in the bundled catalog.*refusing to start/);
});
it("names the known catalog keys in the unknown-key error", () => {
expect(() =>
resolveBundledPluginInstalls(["nope"], {
catalogRoot: CATALOG_ROOT,
env: {},
enforceCatalogRoot: true,
}),
).toThrow(new RegExp(BUNDLED_PLUGIN_CATALOG.map((entry) => entry.key).join(", ")));
});
it("resolves an empty key list to no installs", () => {
expect(
resolveBundledPluginInstalls([], {
catalogRoot: CATALOG_ROOT,
env: {},
enforceCatalogRoot: true,
}),
).toEqual([]);
});
it("throws when an env override escapes the catalog root under enforcement", () => {
expect(() =>
resolveBundledPluginInstalls(["kubernetes"], {
catalogRoot: CATALOG_ROOT,
env: { PAPERCLIP_KUBERNETES_PLUGIN_PATH: "/srv/evil/plugin" },
enforceCatalogRoot: true,
}),
).toThrow(/outside the bundled catalog root.*refusing to start/);
});
it("collapses `..` segments in an override before the containment check", () => {
expect(() =>
resolveBundledPluginInstalls(["kubernetes"], {
catalogRoot: CATALOG_ROOT,
env: {
PAPERCLIP_KUBERNETES_PLUGIN_PATH: path.join(
CATALOG_ROOT,
"sandbox-providers/../../../../etc/kubernetes",
),
},
enforceCatalogRoot: true,
}),
).toThrow(/outside the bundled catalog root/);
});
it("throws when a symlink inside the root points outside it under enforcement", () => {
const outside = makeTempDir("bundled-outside-");
const root = makeTempDir("bundled-root-");
mkdirSync(path.join(root, "sandbox-providers"), { recursive: true });
symlinkSync(outside, path.join(root, "sandbox-providers", "kubernetes"));
expect(() =>
resolveBundledPluginInstalls(["kubernetes"], {
catalogRoot: root,
env: {},
enforceCatalogRoot: true,
}),
).toThrow(/outside the bundled catalog root/);
});
it("honors the legacy kubernetes path override without enforcement (self-hosted)", () => {
const resolved = resolveBundledPluginInstalls(["kubernetes"], {
catalogRoot: CATALOG_ROOT,
env: { PAPERCLIP_KUBERNETES_PLUGIN_PATH: "/somewhere/else/kubernetes" },
enforceCatalogRoot: false,
});
expect(resolved).toEqual([
{
key: "kubernetes",
pluginKey: "paperclip.kubernetes-sandbox-provider",
localPath: "/somewhere/else/kubernetes",
},
]);
});
it("honors an env override that stays inside the catalog root under enforcement", () => {
const inside = path.join(CATALOG_ROOT, "sandbox-providers", "kubernetes");
const resolved = resolveBundledPluginInstalls(["kubernetes"], {
catalogRoot: CATALOG_ROOT,
env: { PAPERCLIP_KUBERNETES_PLUGIN_PATH: inside },
enforceCatalogRoot: true,
});
expect(resolved[0]!.localPath).toBe(inside);
});
it("dedupes repeated keys", () => {
const resolved = resolveBundledPluginInstalls(["kubernetes", "kubernetes"], {
catalogRoot: CATALOG_ROOT,
env: {},
enforceCatalogRoot: true,
});
expect(resolved).toHaveLength(1);
});
it("keeps the self-hosted default list to exactly the kubernetes bundle", () => {
expect(SELF_HOSTED_AUTO_INSTALL_KEYS).toEqual(["kubernetes"]);
const [entry] = resolveBundledPluginInstalls(SELF_HOSTED_AUTO_INSTALL_KEYS, {
catalogRoot: resolveBundledCatalogRoot({}),
env: {},
enforceCatalogRoot: false,
});
// Exactly the pre-refactor default path.
expect(entry).toEqual({
key: "kubernetes",
pluginKey: "paperclip.kubernetes-sandbox-provider",
localPath: "/app/packages/plugins/sandbox-providers/kubernetes",
});
});
it("covers every catalog entry with a path inside the default root", () => {
const keys = BUNDLED_PLUGIN_CATALOG.map((entry) => entry.key);
const resolved = resolveBundledPluginInstalls(keys, {
catalogRoot: DEFAULT_BUNDLED_CATALOG_ROOT,
env: {},
enforceCatalogRoot: true,
});
expect(resolved).toHaveLength(BUNDLED_PLUGIN_CATALOG.length);
});
});
describe("resolveBundledCatalogRoot", () => {
it("defaults to the image catalog root", () => {
expect(resolveBundledCatalogRoot({})).toBe(DEFAULT_BUNDLED_CATALOG_ROOT);
});
it("honors PAPERCLIP_BUNDLED_PLUGIN_ROOT", () => {
expect(resolveBundledCatalogRoot({ PAPERCLIP_BUNDLED_PLUGIN_ROOT: "/custom/root" })).toBe(
"/custom/root",
);
});
});
// ---------------------------------------------------------------------------
// ensureBundledPlugins (fail-safe installer)
// ---------------------------------------------------------------------------
type LooseRow = {
id: string;
pluginKey: string;
status: string;
version?: string;
manifestJson?: Record<string, unknown>;
lastError?: string | null;
packagePath?: string | null;
};
// Build a minimal manifest for a persisted row or a shipped bundle. The reconcile
// step compares the bundle version with the persisted version.
function makeManifest(pluginKey: string, version: string) {
return { id: pluginKey, apiVersion: 1, version, capabilities: [] } as unknown as import("@paperclipai/shared").PaperclipPluginManifestV1;
}
function makeDeps(overrides?: {
rows?: Record<string, LooseRow | null>;
bundleManifestExists?: (localPath: string) => boolean;
installError?: Error;
/** Version the shipped bundle manifest reports, keyed by pluginKey. */
bundleVersionByKey?: Record<string, string>;
}) {
const rows = overrides?.rows ?? {};
const normalize = (row: LooseRow | null): (LooseRow & { version: string; manifestJson: Record<string, unknown> }) | null => {
if (!row) return null;
const version = row.version ?? "0.1.0";
return {
...row,
version,
manifestJson: row.manifestJson ?? { id: row.pluginKey, apiVersion: 1, version },
};
};
const installedRows = new Map(
Object.entries(rows).map(([key, row]) => [key, normalize(row)] as const),
);
const installPlugin = vi.fn(async ({ localPath }: { localPath: string }): Promise<{ manifest: { id: string } | null }> => {
if (overrides?.installError) throw overrides.installError;
const entry = BUNDLED_PLUGIN_CATALOG.find((candidate) =>
localPath.endsWith(candidate.relativePath),
);
const pluginKey = entry?.pluginKey ?? "unknown";
installedRows.set(pluginKey, normalize({ id: `id-${pluginKey}`, pluginKey, status: "installed" }));
return { manifest: { id: pluginKey } };
});
const update = vi.fn(async () => undefined);
const updateStatus = vi.fn(async () => undefined);
const loadManifest = vi.fn(async (localPath: string) => {
const entry = BUNDLED_PLUGIN_CATALOG.find((candidate) =>
localPath.endsWith(candidate.relativePath),
);
const pluginKey = entry?.pluginKey ?? "unknown";
const persisted = installedRows.get(pluginKey);
// Default: the bundle version matches the persisted version, so no
// reconcile fires unless a test overrides `bundleVersionByKey`.
const version = overrides?.bundleVersionByKey?.[pluginKey] ?? persisted?.version ?? "0.1.0";
return makeManifest(pluginKey, version);
});
const deps: BundledPluginProvisionerDeps = {
registry: {
getByKey: vi.fn(async (pluginKey: string) => installedRows.get(pluginKey) ?? null),
update,
updateStatus,
} as unknown as BundledPluginProvisionerDeps["registry"],
loader: { installPlugin, loadManifest } as unknown as BundledPluginProvisionerDeps["loader"],
lifecycle: { load: vi.fn(async () => undefined) },
logger: { info: vi.fn(), warn: vi.fn(), error: vi.fn() },
bundleManifestExists: overrides?.bundleManifestExists ?? (() => true),
};
return { deps, installPlugin, update, updateStatus, loadManifest };
}
const K8S: ResolvedBundledPlugin = {
key: "kubernetes",
pluginKey: "paperclip.kubernetes-sandbox-provider",
localPath: path.join(CATALOG_ROOT, "sandbox-providers/kubernetes"),
};
const DAYTONA: ResolvedBundledPlugin = {
key: "daytona",
pluginKey: "paperclip.daytona-sandbox-provider",
localPath: path.join(CATALOG_ROOT, "sandbox-providers/daytona"),
};
describe("ensureBundledPlugins", () => {
it("installs and loads a missing bundled plugin", async () => {
const { deps, installPlugin } = makeDeps();
await ensureBundledPlugins([K8S], deps, { reinstallUninstalled: true });
expect(installPlugin).toHaveBeenCalledWith({ localPath: K8S.localPath });
expect(deps.lifecycle.load).toHaveBeenCalledWith(
"id-paperclip.kubernetes-sandbox-provider",
);
});
it("skips a plugin present in any non-uninstalled state (disabled is not re-enabled)", async () => {
for (const status of ["installed", "ready", "disabled", "upgrade_pending"]) {
const { deps, installPlugin } = makeDeps({
rows: {
[K8S.pluginKey]: { id: "row-1", pluginKey: K8S.pluginKey, status },
},
});
await ensureBundledPlugins([K8S], deps, { reinstallUninstalled: true });
expect(installPlugin).not.toHaveBeenCalled();
expect(deps.lifecycle.load).not.toHaveBeenCalled();
expect(deps.registry.updateStatus).not.toHaveBeenCalled();
}
});
it("resets a bundled plugin that a previous activation left in error back to ready, without reinstalling it", async () => {
const { deps, installPlugin, updateStatus } = makeDeps({
rows: {
[K8S.pluginKey]: {
id: "row-1",
pluginKey: K8S.pluginKey,
status: "error",
lastError: 'RPC call "initialize" timed out after 15000ms',
},
},
});
await ensureBundledPlugins([K8S], deps, { reinstallUninstalled: false });
expect(installPlugin).not.toHaveBeenCalled();
// No lifecycle call: the row goes straight back to `ready` with its error
// cleared, and the startup loadAll() does the activation (and emits the
// lifecycle events only once the worker actually started).
expect(deps.lifecycle.load).not.toHaveBeenCalled();
expect(updateStatus).toHaveBeenCalledTimes(1);
expect(updateStatus).toHaveBeenCalledWith("row-1", { status: "ready", lastError: null });
// The prior failure is surfaced at warn level with its recorded cause, so
// an operator reading boot logs sees why the plugin needed a retry.
expect(deps.logger.warn).toHaveBeenCalledWith(
expect.objectContaining({
pluginKey: K8S.pluginKey,
lastError: 'RPC call "initialize" timed out after 15000ms',
}),
expect.stringContaining("re-enabling"),
);
expect(deps.logger.error).not.toHaveBeenCalled();
});
it("continues boot when resetting an errored bundled plugin fails", async () => {
const { deps, installPlugin, updateStatus } = makeDeps({
rows: {
[K8S.pluginKey]: { id: "row-1", pluginKey: K8S.pluginKey, status: "error" },
},
});
updateStatus.mockRejectedValueOnce(new Error("db down"));
await expect(
ensureBundledPlugins([K8S, DAYTONA], deps, { reinstallUninstalled: true }),
).resolves.toBeUndefined();
expect(deps.logger.error).toHaveBeenCalledWith(
expect.objectContaining({ pluginKey: K8S.pluginKey }),
expect.stringContaining("continuing boot"),
);
// The later entry is still provisioned.
expect(installPlugin).toHaveBeenCalledWith({ localPath: DAYTONA.localPath });
});
it("reconciles the persisted manifest of a present plugin when the bundle version changed", async () => {
const { deps, installPlugin, update } = makeDeps({
rows: {
[DAYTONA.pluginKey]: {
id: "row-daytona",
pluginKey: DAYTONA.pluginKey,
status: "ready",
version: "0.1.1",
},
},
bundleVersionByKey: { [DAYTONA.pluginKey]: "0.1.2" },
});
await ensureBundledPlugins([DAYTONA], deps, { reinstallUninstalled: false });
// The plugin stays present, so it is never re-installed.
expect(installPlugin).not.toHaveBeenCalled();
// The persisted manifest is refreshed to the shipped bundle version, so a
// capability added to the bundle reaches the existing install.
expect(update).toHaveBeenCalledWith(
"row-daytona",
expect.objectContaining({ version: "0.1.2" }),
);
});
it("does not reconcile when the persisted version already matches the bundle", async () => {
const { deps, update } = makeDeps({
rows: {
[DAYTONA.pluginKey]: {
id: "row-daytona",
pluginKey: DAYTONA.pluginKey,
status: "ready",
version: "0.1.2",
},
},
bundleVersionByKey: { [DAYTONA.pluginKey]: "0.1.2" },
});
await ensureBundledPlugins([DAYTONA], deps, { reinstallUninstalled: false });
expect(update).not.toHaveBeenCalled();
});
it.each([null, "/old/plugins/widget"])("adopts a selected distribution path from %s even at the same version", async (packagePath) => {
const localPath = path.join(CATALOG_ROOT, "distribution/widget");
const distribution = { key: "widget", pluginKey: "acme.widget", version: "0.1.0", directory: "widget", digest: `sha256:${"a".repeat(64)}`, localPath, entrypoints: { worker: "dist/worker.js" } };
for (const status of ["ready", "disabled", "error"]) {
const { deps, loadManifest, update, installPlugin, updateStatus } = makeDeps({
rows: { "acme.widget": { id: "row-widget", pluginKey: "acme.widget", status, version: "0.1.0", packagePath } },
// Distribution packages may declare a manifest outside dist/manifest.js.
bundleManifestExists: () => false,
});
const manifest = makeManifest("acme.widget", "0.1.0");
loadManifest.mockResolvedValue(manifest);
await ensureBundledPlugins([{ ...distribution, distribution }], deps, { reinstallUninstalled: true });
// Same row: retain config/state and operator-disabled status; only error
// gets the existing one-shot boot retry. No reinstall/capability reset.
expect(update).toHaveBeenCalledExactlyOnceWith("row-widget", { packagePath: localPath, version: "0.1.0", manifest });
expect(installPlugin).not.toHaveBeenCalled();
expect(updateStatus).toHaveBeenCalledTimes(status === "error" ? 1 : 0);
expect(loadManifest).toHaveBeenCalledExactlyOnceWith(localPath);
expect(deps.logger.error).not.toHaveBeenCalled();
}
});
it("does not rebind a distribution install whose new manifest fails validation", async () => {
const localPath = path.join(CATALOG_ROOT, "distribution/widget");
const distribution = { key: "widget", pluginKey: "acme.widget", version: "0.1.0", directory: "widget", digest: `sha256:${"a".repeat(64)}`, localPath, entrypoints: { worker: "dist/worker.js" } };
const { deps, loadManifest, update, updateStatus } = makeDeps({
rows: { "acme.widget": { id: "row-widget", pluginKey: "acme.widget", status: "error", packagePath: "/old/widget" } },
});
loadManifest.mockRejectedValue(new Error("Distribution manifest entrypoints do not match the verified package"));
await ensureBundledPlugins([{ ...distribution, distribution }], deps, { reinstallUninstalled: true });
expect(update).not.toHaveBeenCalled();
expect(updateStatus).not.toHaveBeenCalled();
expect(deps.logger.error).toHaveBeenCalled();
});
it.each(["ready", "error", "disabled"])("gates same-version distribution capability additions from %s atomically", async (status) => {
const localPath = path.join(CATALOG_ROOT, "distribution/widget");
const distribution = { key: "widget", pluginKey: "acme.widget", version: "0.1.0", directory: "widget", digest: `sha256:${"a".repeat(64)}`, localPath, entrypoints: { worker: "dist/worker.js" } };
const oldManifest = makeManifest("acme.widget", "0.1.0");
const { deps, loadManifest, update, updateStatus, installPlugin } = makeDeps({
rows: { "acme.widget": { id: "row-widget", pluginKey: "acme.widget", status, packagePath: localPath, manifestJson: { ...oldManifest } } },
});
const replacement = { ...oldManifest, capabilities: ["issues.read" as const] };
loadManifest.mockResolvedValue(replacement);
await ensureBundledPlugins([{ ...distribution, distribution }], deps, { reinstallUninstalled: true });
expect(update).toHaveBeenCalledExactlyOnceWith("row-widget", { version: "0.1.0", manifest: replacement, status: "upgrade_pending" });
expect(updateStatus).not.toHaveBeenCalled();
expect(installPlugin).not.toHaveBeenCalled();
expect(deps.lifecycle.load).not.toHaveBeenCalled();
// A later boot must leave the approval gate in place.
vi.mocked(deps.registry.getByKey).mockResolvedValue({ id: "row-widget", pluginKey: "acme.widget", status: "upgrade_pending", version: "0.1.0", packagePath: localPath, manifestJson: replacement });
await ensureBundledPlugins([{ ...distribution, distribution }], deps, { reinstallUninstalled: true });
expect(update).toHaveBeenCalledTimes(1);
expect(updateStatus).not.toHaveBeenCalled();
});
it("does not save an inconsistent distribution manifest", async () => {
const localPath = path.join(CATALOG_ROOT, "distribution/widget");
const distribution = { key: "widget", pluginKey: "acme.widget", version: "0.1.0", directory: "widget", digest: `sha256:${"a".repeat(64)}`, localPath, entrypoints: { worker: "dist/worker.js" } };
const { deps, loadManifest, update } = makeDeps({ rows: { "acme.widget": { id: "row-widget", pluginKey: "acme.widget", status: "ready", packagePath: localPath } } });
const manifest = makeManifest("acme.widget", "0.1.0");
manifest.ui = { slots: [{ type: "appShellOverlay", id: "overlay", displayName: "Overlay", exportName: "Overlay" }] };
loadManifest.mockResolvedValue(manifest);
await ensureBundledPlugins([{ ...distribution, distribution }], deps, { reinstallUninstalled: true });
expect(update).not.toHaveBeenCalled();
expect(deps.logger.error).toHaveBeenCalled();
});
it("does not replace an operator uninstall with a distribution approval request", async () => {
const localPath = path.join(CATALOG_ROOT, "distribution/widget");
const distribution = { key: "widget", pluginKey: "acme.widget", version: "0.1.0", directory: "widget", digest: `sha256:${"a".repeat(64)}`, localPath, entrypoints: { worker: "dist/worker.js" } };
const { deps, loadManifest, update, updateStatus, installPlugin } = makeDeps({ rows: { "acme.widget": { id: "row-widget", pluginKey: "acme.widget", status: "uninstalled" } } });
loadManifest.mockResolvedValue({ ...makeManifest("acme.widget", "0.1.0"), capabilities: ["issues.read"] });
await ensureBundledPlugins([{ ...distribution, distribution }], deps, { reinstallUninstalled: false });
expect(update).not.toHaveBeenCalled();
expect(updateStatus).not.toHaveBeenCalled();
expect(installPlugin).not.toHaveBeenCalled();
});
it("refreshes a same-version rollback while retaining the pending operator decision", async () => {
const localPath = path.join(CATALOG_ROOT, "distribution/widget");
const distribution = { key: "widget", pluginKey: "acme.widget", version: "0.1.0", directory: "widget", digest: `sha256:${"a".repeat(64)}`, localPath, entrypoints: { worker: "dist/worker.js" } };
const pending = { ...makeManifest("acme.widget", "0.1.0"), capabilities: ["issues.read", "issues.update"] };
const { deps, loadManifest, update, updateStatus } = makeDeps({ rows: { "acme.widget": { id: "row-widget", pluginKey: "acme.widget", status: "upgrade_pending", packagePath: localPath, manifestJson: pending } } });
// A smaller capability set is not proof that every remaining capability
// was approved, or that the plugin was enabled before the pending upgrade.
const rollback = { ...makeManifest("acme.widget", "0.1.0"), capabilities: ["issues.read" as const] };
loadManifest.mockResolvedValue(rollback);
await ensureBundledPlugins([{ ...distribution, distribution }], deps, { reinstallUninstalled: true });
expect(update).toHaveBeenCalledExactlyOnceWith("row-widget", { version: "0.1.0", manifest: rollback });
expect(updateStatus).not.toHaveBeenCalled();
expect(deps.lifecycle.load).not.toHaveBeenCalled();
});
it("ignores object key order when comparing a distribution manifest read from JSONB", async () => {
const localPath = path.join(CATALOG_ROOT, "distribution/widget");
const distribution = { key: "widget", pluginKey: "acme.widget", version: "0.1.0", directory: "widget", digest: `sha256:${"a".repeat(64)}`, localPath, entrypoints: { worker: "dist/worker.js" } };
const manifest = { ...makeManifest("acme.widget", "0.1.0"), entrypoints: { worker: "dist/worker.js", ui: "dist/ui" } };
const reordered = { entrypoints: { ui: "dist/ui", worker: "dist/worker.js" }, capabilities: [], version: "0.1.0", apiVersion: 1, id: "acme.widget" };
const { deps, loadManifest, update } = makeDeps({ rows: { "acme.widget": { id: "row-widget", pluginKey: "acme.widget", status: "ready", packagePath: localPath, manifestJson: reordered } } });
loadManifest.mockResolvedValue(manifest);
await ensureBundledPlugins([{ ...distribution, distribution }], deps, { reinstallUninstalled: true });
expect(update).not.toHaveBeenCalled();
});
it("swallows a reconcile error and continues boot", async () => {
const { deps, update } = makeDeps({
rows: {
[DAYTONA.pluginKey]: {
id: "row-daytona",
pluginKey: DAYTONA.pluginKey,
status: "ready",
version: "0.1.1",
},
},
bundleVersionByKey: { [DAYTONA.pluginKey]: "0.1.2" },
});
(update as ReturnType<typeof vi.fn>).mockRejectedValueOnce(new Error("db down"));
await expect(
ensureBundledPlugins([DAYTONA], deps, { reinstallUninstalled: false }),
).resolves.toBeUndefined();
expect(deps.logger.error).toHaveBeenCalled();
});
it("reinstalls a soft-uninstalled plugin in managed mode", async () => {
const { deps, installPlugin } = makeDeps({
rows: {
[K8S.pluginKey]: { id: "row-1", pluginKey: K8S.pluginKey, status: "uninstalled" },
},
});
await ensureBundledPlugins([K8S], deps, { reinstallUninstalled: true });
expect(installPlugin).toHaveBeenCalledOnce();
});
it("leaves a soft-uninstalled plugin alone in self-hosted mode (pre-refactor behavior)", async () => {
const { deps, installPlugin } = makeDeps({
rows: {
[K8S.pluginKey]: { id: "row-1", pluginKey: K8S.pluginKey, status: "uninstalled" },
},
});
await ensureBundledPlugins([K8S], deps, { reinstallUninstalled: false });
expect(installPlugin).not.toHaveBeenCalled();
});
it("skips silently when the bundle is absent on disk", async () => {
const { deps, installPlugin } = makeDeps({ bundleManifestExists: () => false });
await ensureBundledPlugins([K8S], deps, { reinstallUninstalled: true });
expect(installPlugin).not.toHaveBeenCalled();
expect(deps.logger.error).not.toHaveBeenCalled();
});
it("logs and continues past a failing install, still processing later entries", async () => {
const { deps, installPlugin } = makeDeps();
installPlugin.mockRejectedValueOnce(new Error("disk exploded"));
await expect(
ensureBundledPlugins([K8S, DAYTONA], deps, { reinstallUninstalled: true }),
).resolves.toBeUndefined();
expect(deps.logger.error).toHaveBeenCalledWith(
expect.objectContaining({ pluginKey: K8S.pluginKey }),
expect.stringContaining("continuing boot"),
);
// Daytona still installed after the kubernetes failure.
expect(installPlugin).toHaveBeenCalledTimes(2);
expect(deps.lifecycle.load).toHaveBeenCalledWith("id-paperclip.daytona-sandbox-provider");
});
it("never uninstalls anything: plugins absent from the list are untouched", async () => {
const { deps, installPlugin } = makeDeps({
rows: {
[DAYTONA.pluginKey]: { id: "row-d", pluginKey: DAYTONA.pluginKey, status: "ready" },
},
});
// Daytona was removed from the autoInstall list; only kubernetes remains.
await ensureBundledPlugins([K8S], deps, { reinstallUninstalled: true });
expect(installPlugin).toHaveBeenCalledOnce();
expect(installPlugin).toHaveBeenCalledWith({ localPath: K8S.localPath });
// No uninstall/unload calls exist on the provisioner deps at all; daytona
// was never queried beyond its own key and its row is untouched.
expect(deps.lifecycle.load).toHaveBeenCalledTimes(1);
});
it("logs an error and does not load when install returns no manifest", async () => {
const { deps, installPlugin } = makeDeps();
installPlugin.mockResolvedValueOnce({ manifest: null });
await ensureBundledPlugins([K8S], deps, { reinstallUninstalled: true });
expect(deps.logger.error).toHaveBeenCalledWith(
expect.objectContaining({ pluginKey: K8S.pluginKey }),
expect.stringContaining("manifest is missing"),
);
expect(deps.lifecycle.load).not.toHaveBeenCalled();
});
it("logs an error when the installed plugin never appears in the registry", async () => {
const { deps, installPlugin } = makeDeps();
(deps.registry.getByKey as ReturnType<typeof vi.fn>).mockResolvedValue(null);
await ensureBundledPlugins([K8S], deps, { reinstallUninstalled: true });
expect(installPlugin).toHaveBeenCalledOnce();
expect(deps.logger.error).toHaveBeenCalledWith(
expect.objectContaining({ pluginKey: K8S.pluginKey }),
expect.stringContaining("not found in registry"),
);
expect(deps.lifecycle.load).not.toHaveBeenCalled();
});
it("checks the real bundle manifest path by default (dist/manifest.js)", async () => {
const bundleDir = makeTempDir("bundled-bundle-");
const { deps, installPlugin } = makeDeps();
delete deps.bundleManifestExists;
const install = { ...K8S, localPath: bundleDir };
await ensureBundledPlugins([install], deps, { reinstallUninstalled: true });
expect(installPlugin).not.toHaveBeenCalled();
mkdirSync(path.join(bundleDir, "dist"), { recursive: true });
writeFileSync(path.join(bundleDir, "dist", "manifest.js"), "module.exports = {}\n");
await ensureBundledPlugins([install], deps, { reinstallUninstalled: true });
expect(installPlugin).toHaveBeenCalledOnce();
});
});