mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-05 21:02:34 +01:00
## 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>
1158 lines
35 KiB
TypeScript
1158 lines
35 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const mockRegistry = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
getByKey: vi.fn(),
|
|
upsertConfig: vi.fn(),
|
|
getCompanySettings: vi.fn(),
|
|
upsertCompanySettings: vi.fn(),
|
|
}));
|
|
|
|
const mockLifecycle = vi.hoisted(() => ({
|
|
load: vi.fn(),
|
|
upgrade: vi.fn(),
|
|
unload: vi.fn(),
|
|
enable: vi.fn(),
|
|
disable: vi.fn(),
|
|
}));
|
|
|
|
const mockSecretService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
syncSecretRefsForTarget: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../services/plugin-registry.js", () => ({
|
|
pluginRegistryService: () => mockRegistry,
|
|
}));
|
|
|
|
vi.mock("../services/plugin-lifecycle.js", () => ({
|
|
pluginLifecycleManager: () => mockLifecycle,
|
|
}));
|
|
|
|
vi.mock("../services/activity-log.js", () => ({
|
|
logActivity: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../services/secrets.js", () => ({
|
|
secretService: () => mockSecretService,
|
|
}));
|
|
|
|
vi.mock("../services/live-events.js", () => ({
|
|
publishGlobalLiveEvent: vi.fn(),
|
|
}));
|
|
|
|
async function createApp(
|
|
actor: Record<string, unknown>,
|
|
loaderOverrides: Record<string, unknown> = {},
|
|
routeOverrides: {
|
|
db?: unknown;
|
|
jobDeps?: unknown;
|
|
toolDeps?: unknown;
|
|
bridgeDeps?: unknown;
|
|
captureJsonContext?: (context: unknown, body: unknown) => void;
|
|
} = {},
|
|
) {
|
|
const [{ pluginRoutes }, { errorHandler }] = await Promise.all([
|
|
import("../routes/plugins.js"),
|
|
import("../middleware/index.js"),
|
|
]);
|
|
|
|
const loader = {
|
|
installPlugin: vi.fn(),
|
|
...loaderOverrides,
|
|
};
|
|
|
|
const app = express();
|
|
app.use(express.json());
|
|
if (routeOverrides.captureJsonContext) {
|
|
app.use((_req, res, next) => {
|
|
const originalJson = res.json.bind(res);
|
|
res.json = ((body: unknown) => {
|
|
routeOverrides.captureJsonContext?.((res as any).__errorContext, body);
|
|
return originalJson(body);
|
|
}) as typeof res.json;
|
|
next();
|
|
});
|
|
}
|
|
app.use((req, _res, next) => {
|
|
req.actor = actor as typeof req.actor;
|
|
next();
|
|
});
|
|
app.use("/api", pluginRoutes(
|
|
(routeOverrides.db ?? {}) as never,
|
|
loader as never,
|
|
routeOverrides.jobDeps as never,
|
|
undefined,
|
|
routeOverrides.toolDeps as never,
|
|
routeOverrides.bridgeDeps as never,
|
|
));
|
|
app.use(errorHandler);
|
|
|
|
return { app, loader };
|
|
}
|
|
|
|
function createSelectQueueDb(rows: Array<Array<Record<string, unknown>>>) {
|
|
return {
|
|
select: vi.fn(() => ({
|
|
from: vi.fn(() => ({
|
|
where: vi.fn(() => ({
|
|
limit: vi.fn(() => Promise.resolve(rows.shift() ?? [])),
|
|
})),
|
|
})),
|
|
})),
|
|
};
|
|
}
|
|
|
|
const companyA = "22222222-2222-4222-8222-222222222222";
|
|
const companyB = "33333333-3333-4333-8333-333333333333";
|
|
const agentA = "44444444-4444-4444-8444-444444444444";
|
|
const runA = "55555555-5555-4555-8555-555555555555";
|
|
const projectA = "66666666-6666-4666-8666-666666666666";
|
|
const pluginId = "11111111-1111-4111-8111-111111111111";
|
|
const secretId = "77777777-7777-4777-8777-777777777777";
|
|
|
|
function boardActor(overrides: Record<string, unknown> = {}) {
|
|
return {
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyA],
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function agentActor(overrides: Record<string, unknown> = {}) {
|
|
return {
|
|
type: "agent",
|
|
agentId: agentA,
|
|
companyId: companyA,
|
|
runId: runA,
|
|
source: "agent_jwt",
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function readyPlugin() {
|
|
mockRegistry.getById.mockResolvedValue({
|
|
id: pluginId,
|
|
pluginKey: "paperclip.example",
|
|
version: "1.0.0",
|
|
status: "ready",
|
|
});
|
|
}
|
|
|
|
describe("plugin install and upgrade authz", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("lists bundled monorepo plugin packages", async () => {
|
|
const { app } = await createApp(boardActor());
|
|
|
|
const res = await request(app).get("/api/plugins/examples");
|
|
|
|
expect(res.status).toBe(200);
|
|
const packageNames = res.body.map((plugin: { packageName: string }) => plugin.packageName);
|
|
const byPackageName = new Map<string, { experimental: boolean; hasBuiltEntrypoints: boolean }>(
|
|
res.body.map((plugin: { packageName: string; experimental: boolean; hasBuiltEntrypoints: boolean }) => [plugin.packageName, plugin]),
|
|
);
|
|
expect(packageNames).toContain("@paperclipai/plugin-workspace-diff");
|
|
expect(packageNames).toContain("@paperclipai/plugin-llm-wiki");
|
|
expect(packageNames).toContain("@paperclipai/plugin-modal");
|
|
expect(packageNames).toContain("@paperclipai/plugin-authoring-smoke-example");
|
|
expect(packageNames).not.toContain("@paperclipai/plugin-sdk");
|
|
expect(byPackageName.get("@paperclipai/plugin-workspace-diff")?.experimental).toBe(true);
|
|
expect(byPackageName.get("@paperclipai/plugin-llm-wiki")?.experimental).toBe(true);
|
|
expect(byPackageName.get("@paperclipai/plugin-modal")?.experimental).toBe(true);
|
|
expect(byPackageName.get("@paperclipai/plugin-authoring-smoke-example")?.experimental).toBe(false);
|
|
expect(typeof byPackageName.get("@paperclipai/plugin-workspace-diff")?.hasBuiltEntrypoints).toBe("boolean");
|
|
}, 20_000);
|
|
|
|
it("rejects plugin installation for non-admin board users", async () => {
|
|
const { app, loader } = await createApp({
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["company-1"],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/plugins/install")
|
|
.send({ packageName: "paperclip-plugin-example" });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(loader.installPlugin).not.toHaveBeenCalled();
|
|
}, 20_000);
|
|
|
|
it("allows instance admins to install plugins", async () => {
|
|
const pluginId = "11111111-1111-4111-8111-111111111111";
|
|
const pluginKey = "paperclip.example";
|
|
const discovered = {
|
|
manifest: {
|
|
id: pluginKey,
|
|
},
|
|
};
|
|
|
|
mockRegistry.getByKey.mockResolvedValue({
|
|
id: pluginId,
|
|
pluginKey,
|
|
packageName: "paperclip-plugin-example",
|
|
version: "1.0.0",
|
|
});
|
|
mockRegistry.getById.mockResolvedValue({
|
|
id: pluginId,
|
|
pluginKey,
|
|
packageName: "paperclip-plugin-example",
|
|
version: "1.0.0",
|
|
});
|
|
mockLifecycle.load.mockResolvedValue(undefined);
|
|
|
|
const { app, loader } = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "admin-1",
|
|
source: "session",
|
|
isInstanceAdmin: true,
|
|
companyIds: [],
|
|
},
|
|
{ installPlugin: vi.fn().mockResolvedValue(discovered) },
|
|
);
|
|
|
|
const res = await request(app)
|
|
.post("/api/plugins/install")
|
|
.send({ packageName: "paperclip-plugin-example" });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(loader.installPlugin).toHaveBeenCalledWith({
|
|
packageName: "paperclip-plugin-example",
|
|
version: undefined,
|
|
});
|
|
expect(mockLifecycle.load).toHaveBeenCalledWith(pluginId);
|
|
}, 20_000);
|
|
|
|
it("rejects plugin upgrades for non-admin board users", async () => {
|
|
const pluginId = "11111111-1111-4111-8111-111111111111";
|
|
const { app } = await createApp({
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["company-1"],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/upgrade`)
|
|
.send({});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(mockRegistry.getById).not.toHaveBeenCalled();
|
|
expect(mockLifecycle.upgrade).not.toHaveBeenCalled();
|
|
}, 20_000);
|
|
|
|
it.each([
|
|
["delete", "delete", "/api/plugins/11111111-1111-4111-8111-111111111111", undefined],
|
|
["enable", "post", "/api/plugins/11111111-1111-4111-8111-111111111111/enable", {}],
|
|
["disable", "post", "/api/plugins/11111111-1111-4111-8111-111111111111/disable", {}],
|
|
["config", "post", "/api/plugins/11111111-1111-4111-8111-111111111111/config", { configJson: {} }],
|
|
] as const)("rejects plugin %s for non-admin board users", async (_name, method, path, body) => {
|
|
const { app } = await createApp({
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["company-1"],
|
|
});
|
|
|
|
const req = method === "delete" ? request(app).delete(path) : request(app).post(path).send(body);
|
|
const res = await req;
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(mockRegistry.getById).not.toHaveBeenCalled();
|
|
expect(mockRegistry.upsertConfig).not.toHaveBeenCalled();
|
|
expect(mockLifecycle.unload).not.toHaveBeenCalled();
|
|
expect(mockLifecycle.enable).not.toHaveBeenCalled();
|
|
expect(mockLifecycle.disable).not.toHaveBeenCalled();
|
|
}, 20_000);
|
|
|
|
it("resolves plugin keys without probing the UUID id column for core plugin actions", async () => {
|
|
const pluginKey = "paperclipqa.hello-plugin";
|
|
const plugin = {
|
|
id: pluginId,
|
|
pluginKey,
|
|
version: "1.0.0",
|
|
status: "ready",
|
|
};
|
|
mockRegistry.getById.mockImplementation(() => {
|
|
throw new Error("getById should not be called for plugin keys");
|
|
});
|
|
mockRegistry.getByKey.mockResolvedValue(plugin);
|
|
mockLifecycle.unload.mockResolvedValue(plugin);
|
|
mockLifecycle.enable.mockResolvedValue(plugin);
|
|
mockLifecycle.disable.mockResolvedValue(plugin);
|
|
|
|
const { app } = await createApp({
|
|
type: "board",
|
|
userId: "admin-1",
|
|
source: "session",
|
|
isInstanceAdmin: true,
|
|
companyIds: [companyA],
|
|
});
|
|
|
|
const inspectRes = await request(app).get(`/api/plugins/${pluginKey}`);
|
|
const disableRes = await request(app).post(`/api/plugins/${pluginKey}/disable`).send({});
|
|
const enableRes = await request(app).post(`/api/plugins/${pluginKey}/enable`).send({});
|
|
const uninstallRes = await request(app).delete(`/api/plugins/${pluginKey}?purge=true`);
|
|
|
|
expect(inspectRes.status).toBe(200);
|
|
expect(disableRes.status).toBe(200);
|
|
expect(enableRes.status).toBe(200);
|
|
expect(uninstallRes.status).toBe(200);
|
|
expect(mockRegistry.getById).not.toHaveBeenCalled();
|
|
expect(mockRegistry.getByKey).toHaveBeenCalledWith(pluginKey);
|
|
expect(mockLifecycle.disable).toHaveBeenCalledWith(pluginId, undefined);
|
|
expect(mockLifecycle.enable).toHaveBeenCalledWith(pluginId);
|
|
expect(mockLifecycle.unload).toHaveBeenCalledWith(pluginId, true);
|
|
}, 20_000);
|
|
|
|
it("allows instance admins to save company-scoped secret refs and sync plugin bindings", async () => {
|
|
readyPlugin();
|
|
const configJson = {
|
|
apiKeyRef: { type: "secret_ref", secretId, version: "latest" },
|
|
};
|
|
mockSecretService.getById.mockResolvedValue({ id: secretId, companyId: companyA, status: "active" });
|
|
mockSecretService.syncSecretRefsForTarget.mockResolvedValue([]);
|
|
mockRegistry.upsertConfig.mockResolvedValue({ id: "config-1", pluginId, companyId: companyA, configJson });
|
|
|
|
const { app } = await createApp({
|
|
type: "board",
|
|
userId: "admin-1",
|
|
source: "session",
|
|
isInstanceAdmin: true,
|
|
companyIds: [companyA],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/config`)
|
|
.send({ companyId: companyA, configJson });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockSecretService.getById).toHaveBeenCalledWith(secretId);
|
|
expect(mockSecretService.syncSecretRefsForTarget).toHaveBeenCalledWith(
|
|
companyA,
|
|
{ targetType: "plugin", targetId: pluginId },
|
|
[expect.objectContaining({ secretId, configPath: "apiKeyRef", versionSelector: "latest" })],
|
|
{ replaceAll: true },
|
|
);
|
|
expect(mockRegistry.upsertConfig).toHaveBeenCalledWith(pluginId, companyA, {
|
|
companyId: companyA,
|
|
configJson,
|
|
});
|
|
}, 20_000);
|
|
|
|
it("rejects plugin config saves that reference another company's secret before syncing bindings", async () => {
|
|
readyPlugin();
|
|
mockSecretService.getById.mockResolvedValue({ id: secretId, companyId: companyB, status: "active" });
|
|
mockSecretService.syncSecretRefsForTarget.mockResolvedValue([]);
|
|
|
|
const { app } = await createApp({
|
|
type: "board",
|
|
userId: "admin-1",
|
|
source: "session",
|
|
isInstanceAdmin: true,
|
|
companyIds: [companyA],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/config`)
|
|
.send({
|
|
companyId: companyA,
|
|
configJson: {
|
|
apiKeyRef: { type: "secret_ref", secretId, version: "latest" },
|
|
},
|
|
});
|
|
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/outside the selected company/i);
|
|
expect(mockSecretService.syncSecretRefsForTarget).not.toHaveBeenCalled();
|
|
expect(mockRegistry.upsertConfig).not.toHaveBeenCalled();
|
|
}, 20_000);
|
|
|
|
it("allows instance admins to upgrade plugins", async () => {
|
|
const pluginId = "11111111-1111-4111-8111-111111111111";
|
|
mockRegistry.getById.mockResolvedValue({
|
|
id: pluginId,
|
|
pluginKey: "paperclip.example",
|
|
version: "1.0.0",
|
|
});
|
|
mockLifecycle.upgrade.mockResolvedValue({
|
|
id: pluginId,
|
|
version: "1.1.0",
|
|
});
|
|
|
|
const { app } = await createApp({
|
|
type: "board",
|
|
userId: "admin-1",
|
|
source: "session",
|
|
isInstanceAdmin: true,
|
|
companyIds: [],
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/upgrade`)
|
|
.send({ version: "1.1.0" });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockLifecycle.upgrade).toHaveBeenCalledWith(pluginId, "1.1.0");
|
|
}, 20_000);
|
|
});
|
|
|
|
describe("scoped plugin API routes", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("dispatches manifest-declared scoped routes after company access checks", async () => {
|
|
const pluginId = "11111111-1111-4111-8111-111111111111";
|
|
const workerManager = {
|
|
call: vi.fn().mockResolvedValue({
|
|
status: 202,
|
|
body: { ok: true },
|
|
}),
|
|
};
|
|
mockRegistry.getById.mockResolvedValue(null);
|
|
mockRegistry.getByKey.mockResolvedValue({
|
|
id: pluginId,
|
|
pluginKey: "paperclip.example",
|
|
version: "1.0.0",
|
|
status: "ready",
|
|
manifestJson: {
|
|
id: "paperclip.example",
|
|
capabilities: ["api.routes.register"],
|
|
apiRoutes: [
|
|
{
|
|
routeKey: "smoke",
|
|
method: "GET",
|
|
path: "/smoke",
|
|
auth: "board-or-agent",
|
|
capability: "api.routes.register",
|
|
companyResolution: { from: "query", key: "companyId" },
|
|
},
|
|
],
|
|
},
|
|
});
|
|
|
|
const { app } = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "admin-1",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["company-1"],
|
|
},
|
|
{},
|
|
{ bridgeDeps: { workerManager } },
|
|
);
|
|
|
|
const res = await request(app)
|
|
.get("/api/plugins/paperclip.example/api/smoke")
|
|
.query({ companyId: "company-1" });
|
|
|
|
expect(res.status).toBe(202);
|
|
expect(res.body).toEqual({ ok: true });
|
|
expect(workerManager.call).toHaveBeenCalledWith(
|
|
pluginId,
|
|
"handleApiRequest",
|
|
expect.objectContaining({
|
|
routeKey: "smoke",
|
|
method: "GET",
|
|
companyId: "company-1",
|
|
query: { companyId: "company-1" },
|
|
}),
|
|
);
|
|
}, 20_000);
|
|
});
|
|
|
|
describe("plugin local folder routes", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
mockRegistry.getCompanySettings.mockResolvedValue(null);
|
|
});
|
|
|
|
function readyLocalFolderPlugin() {
|
|
mockRegistry.getById.mockResolvedValue({
|
|
id: pluginId,
|
|
pluginKey: "paperclip.example",
|
|
version: "1.0.0",
|
|
status: "ready",
|
|
manifestJson: {
|
|
id: "paperclip.example",
|
|
capabilities: ["local.folders"],
|
|
localFolders: [
|
|
{
|
|
folderKey: "content-root",
|
|
displayName: "Content root",
|
|
access: "readWrite",
|
|
requiredDirectories: ["docs"],
|
|
requiredFiles: ["README.md"],
|
|
},
|
|
],
|
|
},
|
|
});
|
|
}
|
|
|
|
it("rejects validation for undeclared local folder keys", async () => {
|
|
readyLocalFolderPlugin();
|
|
const { app } = await createApp(boardActor());
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/companies/${companyA}/local-folders/ssh/validate`)
|
|
.send({ path: "/tmp" });
|
|
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toContain("Local folder key is not declared");
|
|
expect(mockRegistry.upsertCompanySettings).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects saving undeclared local folder keys", async () => {
|
|
readyLocalFolderPlugin();
|
|
const { app } = await createApp(boardActor());
|
|
|
|
const res = await request(app)
|
|
.put(`/api/plugins/${pluginId}/companies/${companyA}/local-folders/ssh`)
|
|
.send({ path: "/tmp" });
|
|
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toContain("Local folder key is not declared");
|
|
expect(mockRegistry.upsertCompanySettings).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe("plugin tool and bridge authz", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("rejects tool execution when the board user cannot access runContext.companyId", async () => {
|
|
const executeTool = vi.fn();
|
|
const getTool = vi.fn();
|
|
const { app } = await createApp(boardActor(), {}, {
|
|
toolDeps: {
|
|
toolDispatcher: {
|
|
listToolsForAgent: vi.fn(),
|
|
getTool,
|
|
executeTool,
|
|
},
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/plugins/tools/execute")
|
|
.send({
|
|
tool: "paperclip.example:search",
|
|
parameters: {},
|
|
runContext: {
|
|
agentId: agentA,
|
|
runId: runA,
|
|
companyId: companyB,
|
|
projectId: projectA,
|
|
},
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(getTool).not.toHaveBeenCalled();
|
|
expect(executeTool).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects tool execution when any runContext reference is outside the company scope", async () => {
|
|
const cases: Array<[string, Array<Array<Record<string, unknown>>>]> = [
|
|
[
|
|
"agentId",
|
|
[
|
|
[{ companyId: companyB }],
|
|
],
|
|
],
|
|
[
|
|
"runId company",
|
|
[
|
|
[{ companyId: companyA }],
|
|
[{ companyId: companyB, agentId: agentA }],
|
|
],
|
|
],
|
|
[
|
|
"runId agent",
|
|
[
|
|
[{ companyId: companyA }],
|
|
[{ companyId: companyA, agentId: "77777777-7777-4777-8777-777777777777" }],
|
|
],
|
|
],
|
|
[
|
|
"projectId",
|
|
[
|
|
[{ companyId: companyA }],
|
|
[{ companyId: companyA, agentId: agentA }],
|
|
[{ companyId: companyB }],
|
|
],
|
|
],
|
|
];
|
|
|
|
for (const [label, rows] of cases) {
|
|
const executeTool = vi.fn();
|
|
const { app } = await createApp(boardActor(), {}, {
|
|
db: createSelectQueueDb(rows),
|
|
toolDeps: {
|
|
toolDispatcher: {
|
|
listToolsForAgent: vi.fn(),
|
|
getTool: vi.fn(() => ({ name: "paperclip.example:search" })),
|
|
executeTool,
|
|
},
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/plugins/tools/execute")
|
|
.send({
|
|
tool: "paperclip.example:search",
|
|
parameters: {},
|
|
runContext: {
|
|
agentId: agentA,
|
|
runId: runA,
|
|
companyId: companyA,
|
|
projectId: projectA,
|
|
},
|
|
});
|
|
|
|
expect(res.status, label).toBe(403);
|
|
expect(executeTool).not.toHaveBeenCalled();
|
|
}
|
|
});
|
|
|
|
it("allows tool execution when agent, run, and project all belong to runContext.companyId", async () => {
|
|
const executeTool = vi.fn().mockResolvedValue({ content: "ok" });
|
|
const { app } = await createApp(boardActor(), {}, {
|
|
db: createSelectQueueDb([
|
|
[{ companyId: companyA }],
|
|
[{ companyId: companyA, agentId: agentA }],
|
|
[{ companyId: companyA }],
|
|
]),
|
|
toolDeps: {
|
|
toolDispatcher: {
|
|
listToolsForAgent: vi.fn(),
|
|
getTool: vi.fn(() => ({ name: "paperclip.example:search" })),
|
|
executeTool,
|
|
},
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/plugins/tools/execute")
|
|
.send({
|
|
tool: "paperclip.example:search",
|
|
parameters: { q: "test" },
|
|
runContext: {
|
|
agentId: agentA,
|
|
runId: runA,
|
|
companyId: companyA,
|
|
projectId: projectA,
|
|
},
|
|
});
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(executeTool).toHaveBeenCalledWith(
|
|
"paperclip.example:search",
|
|
{ q: "test" },
|
|
{
|
|
agentId: agentA,
|
|
runId: runA,
|
|
companyId: companyA,
|
|
projectId: projectA,
|
|
},
|
|
);
|
|
});
|
|
|
|
it.each([
|
|
["legacy data", "post", `/api/plugins/${pluginId}/bridge/data`, { key: "health" }],
|
|
["legacy action", "post", `/api/plugins/${pluginId}/bridge/action`, { key: "sync" }],
|
|
["url data", "post", `/api/plugins/${pluginId}/data/health`, {}],
|
|
["url action", "post", `/api/plugins/${pluginId}/actions/sync`, {}],
|
|
] as const)("rejects %s bridge calls without companyId for non-admin users", async (_name, _method, path, body) => {
|
|
readyPlugin();
|
|
const call = vi.fn();
|
|
const { app } = await createApp(boardActor(), {}, {
|
|
bridgeDeps: {
|
|
workerManager: { call },
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(path)
|
|
.send(body);
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(call).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("forwards authorized bridge company scope to the plugin worker", async () => {
|
|
readyPlugin();
|
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
|
const { app } = await createApp(boardActor(), {}, {
|
|
bridgeDeps: {
|
|
workerManager: { call },
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/data/health`)
|
|
.send({ companyId: companyA, params: { view: "compact" } });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(call).toHaveBeenCalledWith(pluginId, "getData", {
|
|
key: "health",
|
|
companyId: companyA,
|
|
params: { view: "compact" },
|
|
renderEnvironment: null,
|
|
});
|
|
});
|
|
|
|
it("allows omitted-company bridge calls for instance admins as global plugin actions", async () => {
|
|
readyPlugin();
|
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
|
const { app } = await createApp(boardActor({
|
|
userId: "admin-1",
|
|
isInstanceAdmin: true,
|
|
companyIds: [],
|
|
}), {}, {
|
|
bridgeDeps: {
|
|
workerManager: { call },
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/actions/sync`)
|
|
.send({});
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", {
|
|
key: "sync",
|
|
params: {},
|
|
actorContext: {
|
|
type: "user",
|
|
userId: "admin-1",
|
|
agentId: null,
|
|
runId: null,
|
|
companyId: null,
|
|
},
|
|
renderEnvironment: null,
|
|
});
|
|
});
|
|
|
|
it("passes authenticated actor context and overrides spoofed company scope for plugin actions", async () => {
|
|
readyPlugin();
|
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
|
const { app } = await createApp(boardActor({ runId: runA }), {}, {
|
|
bridgeDeps: {
|
|
workerManager: { call },
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/actions/sync`)
|
|
.send({
|
|
companyId: companyA,
|
|
params: {
|
|
companyId: companyB,
|
|
reviewerUserId: "spoofed-user",
|
|
},
|
|
});
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", {
|
|
key: "sync",
|
|
params: {
|
|
companyId: companyA,
|
|
reviewerUserId: "spoofed-user",
|
|
},
|
|
actorContext: {
|
|
type: "user",
|
|
userId: "user-1",
|
|
agentId: null,
|
|
runId: runA,
|
|
companyId: companyA,
|
|
},
|
|
renderEnvironment: null,
|
|
});
|
|
});
|
|
|
|
it("uses null for board actor userId when no authenticated user id is present", async () => {
|
|
readyPlugin();
|
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
|
const { app } = await createApp(boardActor({ userId: undefined }), {}, {
|
|
bridgeDeps: {
|
|
workerManager: { call },
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/actions/sync`)
|
|
.send({ companyId: companyA });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", expect.objectContaining({
|
|
actorContext: expect.objectContaining({
|
|
type: "user",
|
|
userId: null,
|
|
companyId: companyA,
|
|
}),
|
|
}));
|
|
});
|
|
|
|
it("allows agent-scoped plugin actions with authenticated actor context", async () => {
|
|
readyPlugin();
|
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
|
const { app } = await createApp(agentActor(), {}, {
|
|
bridgeDeps: {
|
|
workerManager: { call },
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/actions/sync`)
|
|
.send({
|
|
companyId: companyA,
|
|
params: {
|
|
companyId: companyB,
|
|
reviewerAgentId: "spoofed-agent",
|
|
},
|
|
});
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", {
|
|
key: "sync",
|
|
params: {
|
|
companyId: companyA,
|
|
reviewerAgentId: "spoofed-agent",
|
|
},
|
|
actorContext: {
|
|
type: "agent",
|
|
userId: null,
|
|
agentId: agentA,
|
|
runId: runA,
|
|
companyId: companyA,
|
|
},
|
|
renderEnvironment: null,
|
|
});
|
|
|
|
call.mockClear();
|
|
const legacyRes = await request(app)
|
|
.post(`/api/plugins/${pluginId}/bridge/action`)
|
|
.send({
|
|
key: "sync",
|
|
companyId: companyA,
|
|
params: {
|
|
companyId: companyB,
|
|
reviewerAgentId: "spoofed-agent",
|
|
},
|
|
});
|
|
|
|
expect(legacyRes.status).toBe(200);
|
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", {
|
|
key: "sync",
|
|
params: {
|
|
companyId: companyA,
|
|
reviewerAgentId: "spoofed-agent",
|
|
},
|
|
actorContext: {
|
|
type: "agent",
|
|
userId: null,
|
|
agentId: agentA,
|
|
runId: runA,
|
|
companyId: companyA,
|
|
},
|
|
renderEnvironment: null,
|
|
});
|
|
});
|
|
|
|
it("rejects agent plugin actions outside the authenticated company scope", async () => {
|
|
readyPlugin();
|
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
|
const { app } = await createApp(agentActor(), {}, {
|
|
bridgeDeps: {
|
|
workerManager: { call },
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/actions/sync`)
|
|
.send({ companyId: companyB });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(call).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("attaches worker bridge errors to the HTTP logger context", async () => {
|
|
readyPlugin();
|
|
const call = vi.fn().mockRejectedValue(new Error("missing source_objects column"));
|
|
const captured: Array<{ context: any; body: unknown }> = [];
|
|
const { app } = await createApp(boardActor(), {}, {
|
|
bridgeDeps: {
|
|
workerManager: { call },
|
|
},
|
|
captureJsonContext: (context, body) => {
|
|
captured.push({ context, body });
|
|
},
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/data/source-objects`)
|
|
.send({ companyId: companyA });
|
|
|
|
expect(res.status).toBe(502);
|
|
expect(res.body).toMatchObject({
|
|
code: "UNKNOWN",
|
|
message: "missing source_objects column",
|
|
});
|
|
expect(captured.at(-1)?.context?.error).toMatchObject({
|
|
message: "missing source_objects column",
|
|
details: {
|
|
pluginId,
|
|
pluginKey: "paperclip.example",
|
|
bridgeMethod: "getData",
|
|
dataKey: "source-objects",
|
|
bridgeCode: "UNKNOWN",
|
|
},
|
|
});
|
|
});
|
|
|
|
it("rejects manual job triggers for non-admin board users", async () => {
|
|
const scheduler = { triggerJob: vi.fn() };
|
|
const jobStore = { getJobByIdForPlugin: vi.fn() };
|
|
const { app } = await createApp(boardActor(), {}, {
|
|
jobDeps: { scheduler, jobStore },
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/jobs/job-1/trigger`)
|
|
.send({});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(scheduler.triggerJob).not.toHaveBeenCalled();
|
|
expect(jobStore.getJobByIdForPlugin).not.toHaveBeenCalled();
|
|
}, 15_000);
|
|
|
|
it("allows manual job triggers for instance admins", async () => {
|
|
readyPlugin();
|
|
const scheduler = { triggerJob: vi.fn().mockResolvedValue({ runId: "run-1", jobId: "job-1" }) };
|
|
const jobStore = { getJobByIdForPlugin: vi.fn().mockResolvedValue({ id: "job-1" }) };
|
|
const { app } = await createApp(boardActor({
|
|
userId: "admin-1",
|
|
isInstanceAdmin: true,
|
|
companyIds: [],
|
|
}), {}, {
|
|
jobDeps: { scheduler, jobStore },
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post(`/api/plugins/${pluginId}/jobs/job-1/trigger`)
|
|
.send({});
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toEqual({ runId: "run-1", jobId: "job-1" });
|
|
expect(scheduler.triggerJob).toHaveBeenCalledWith("job-1", "manual");
|
|
});
|
|
|
|
// ─── Agent JWT tool execution (cherry-picked from #5549) ─────────────────────
|
|
|
|
it("rejects board users with no company memberships from listing plugin tools", async () => {
|
|
const listToolsForAgent = vi.fn(() => []);
|
|
const { app } = await createApp(
|
|
boardActor({ companyIds: [], isInstanceAdmin: false, source: "session" }),
|
|
{},
|
|
{
|
|
toolDeps: {
|
|
toolDispatcher: {
|
|
listToolsForAgent,
|
|
getTool: vi.fn(),
|
|
executeTool: vi.fn(),
|
|
},
|
|
},
|
|
},
|
|
);
|
|
|
|
const res = await request(app).get("/api/plugins/tools");
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(listToolsForAgent).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("allows agent JWT to list available plugin tools", async () => {
|
|
const listToolsForAgent = vi.fn(() => []);
|
|
const { app } = await createApp(agentActor(), {}, {
|
|
toolDeps: {
|
|
toolDispatcher: {
|
|
listToolsForAgent,
|
|
getTool: vi.fn(),
|
|
executeTool: vi.fn(),
|
|
},
|
|
},
|
|
});
|
|
|
|
const res = await request(app).get("/api/plugins/tools");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(listToolsForAgent).toHaveBeenCalled();
|
|
});
|
|
|
|
it("allows agent JWT to execute a tool within its company scope", async () => {
|
|
const executeTool = vi.fn().mockResolvedValue({ content: "ok" });
|
|
const { app } = await createApp(
|
|
agentActor(),
|
|
{},
|
|
{
|
|
db: createSelectQueueDb([
|
|
[{ companyId: companyA }],
|
|
[{ companyId: companyA, agentId: agentA }],
|
|
[{ companyId: companyA }],
|
|
]),
|
|
toolDeps: {
|
|
toolDispatcher: {
|
|
listToolsForAgent: vi.fn(),
|
|
getTool: vi.fn(() => ({ name: "paperclip.example:search", pluginDbId: pluginId })),
|
|
executeTool,
|
|
},
|
|
},
|
|
},
|
|
);
|
|
|
|
const res = await request(app)
|
|
.post("/api/plugins/tools/execute")
|
|
.send({
|
|
tool: "paperclip.example:search",
|
|
parameters: { q: "test" },
|
|
runContext: { agentId: agentA, runId: runA, companyId: companyA, projectId: projectA },
|
|
});
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(executeTool).toHaveBeenCalledWith(
|
|
"paperclip.example:search",
|
|
{ q: "test" },
|
|
{ agentId: agentA, runId: runA, companyId: companyA, projectId: projectA },
|
|
);
|
|
});
|
|
|
|
it("rejects agent JWT when runContext.companyId is outside the agent's company scope", async () => {
|
|
const executeTool = vi.fn();
|
|
const { app } = await createApp(
|
|
agentActor(),
|
|
{},
|
|
{
|
|
db: createSelectQueueDb([]),
|
|
toolDeps: {
|
|
toolDispatcher: {
|
|
listToolsForAgent: vi.fn(),
|
|
getTool: vi.fn(() => ({ name: "paperclip.example:search", pluginDbId: pluginId })),
|
|
executeTool,
|
|
},
|
|
},
|
|
},
|
|
);
|
|
|
|
const res = await request(app)
|
|
.post("/api/plugins/tools/execute")
|
|
.send({
|
|
tool: "paperclip.example:search",
|
|
parameters: {},
|
|
runContext: { agentId: agentA, runId: runA, companyId: companyB, projectId: projectA },
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(executeTool).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects agent JWT when runContext.agentId does not belong to runContext.companyId", async () => {
|
|
const otherAgent = "77777777-7777-4777-8777-777777777777";
|
|
const executeTool = vi.fn();
|
|
const { app } = await createApp(
|
|
agentActor(),
|
|
{},
|
|
{
|
|
db: createSelectQueueDb([
|
|
[{ companyId: companyB }],
|
|
]),
|
|
toolDeps: {
|
|
toolDispatcher: {
|
|
listToolsForAgent: vi.fn(),
|
|
getTool: vi.fn(() => ({ name: "paperclip.example:search", pluginDbId: pluginId })),
|
|
executeTool,
|
|
},
|
|
},
|
|
},
|
|
);
|
|
|
|
const res = await request(app)
|
|
.post("/api/plugins/tools/execute")
|
|
.send({
|
|
tool: "paperclip.example:search",
|
|
parameters: {},
|
|
runContext: { agentId: otherAgent, runId: runA, companyId: companyA, projectId: projectA },
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(executeTool).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe("operator-hidden plugin management floor", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
process.env.PAPERCLIP_HIDDEN_SETTINGS = "instance.plugins";
|
|
});
|
|
afterEach(() => {
|
|
delete process.env.PAPERCLIP_HIDDEN_SETTINGS;
|
|
});
|
|
|
|
const instanceAdmin = () => boardActor({ isInstanceAdmin: true, userId: "instance-admin" });
|
|
|
|
it("floors plugin lifecycle and config writes for instance admins", async () => {
|
|
const { app, loader } = await createApp(instanceAdmin());
|
|
readyPlugin();
|
|
|
|
const attempts: Array<[string, request.Test]> = [
|
|
["install", request(app).post("/api/plugins/install").send({ packageName: "@paperclipai/plugin-modal" })],
|
|
["uninstall", request(app).delete(`/api/plugins/${pluginId}`)],
|
|
["enable", request(app).post(`/api/plugins/${pluginId}/enable`)],
|
|
["disable", request(app).post(`/api/plugins/${pluginId}/disable`).send({})],
|
|
["upgrade", request(app).post(`/api/plugins/${pluginId}/upgrade`).send({})],
|
|
["config", request(app).post(`/api/plugins/${pluginId}/config`).send({ config: {} })],
|
|
["config test", request(app).post(`/api/plugins/${pluginId}/config/test`).send({ config: {} })],
|
|
[
|
|
"local folder",
|
|
request(app)
|
|
.put(`/api/plugins/${pluginId}/companies/${companyA}/local-folders/data`)
|
|
.send({ path: "/tmp/folder" }),
|
|
],
|
|
];
|
|
for (const [name, attempt] of attempts) {
|
|
const res = await attempt;
|
|
expect(res.status, `${name}: ${JSON.stringify(res.body)}`).toBe(403);
|
|
expect(res.body.details, name).toMatchObject({ code: "settings_operator_managed" });
|
|
}
|
|
expect(loader.installPlugin).not.toHaveBeenCalled();
|
|
expect(mockLifecycle.enable).not.toHaveBeenCalled();
|
|
expect(mockLifecycle.disable).not.toHaveBeenCalled();
|
|
expect(mockLifecycle.upgrade).not.toHaveBeenCalled();
|
|
expect(mockLifecycle.unload).not.toHaveBeenCalled();
|
|
expect(mockRegistry.upsertConfig).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("keeps plugin reads open while the surface is hidden", async () => {
|
|
const { app } = await createApp(boardActor());
|
|
|
|
const res = await request(app).get("/api/plugins/examples");
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(200);
|
|
}, 20_000);
|
|
});
|