mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-09 06:15:21 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Governed MCP access spans contracts, runtime enforcement, adapters, UI surfaces, and operator verification > - The parity reference PR #9534 is too large for effective automated or human review > - The feature therefore needs a linear stack whose individual diffs stay below the 100-file review limit > - This pull request is split 4/8 and focuses on gateway runtime, Smoke Lab, plugins, and server wiring > - The benefit is a standalone, testable review boundary while preserving byte-for-byte parity at the top of the stack ## Linked Issues or Issue Description - Related parity reference: #9534 - Problem: The policy core needs runtime execution, endpoint guards, route registration, heartbeat integration, and adapter MCP injection to become operational. - Proposed solution: Adds the remaining server routes/wiring/consumers, runtime tests, adapter-utils MCP contracts, and Claude/Codex injection implementations required by the server layer. - Alternatives considered: keeping #9534 as one 403-file review, or rewriting the feature to manufacture seams; both were rejected in favor of path extraction plus compile-driven boundary moves. - Roadmap alignment: this advances the existing governed MCP/tool-access work already represented by #9534; it does not introduce a separate roadmap initiative. - Stack position: base branch is `pap10341-split/03-server-tool-access`. - Merge policy: merge bottom-up, in order, only after the complete eight-PR stack has been reviewed and the top-of-stack parity gate remains empty. - Requested review: SecurityEngineer for gateway, endpoint guard, token issuance, and runtime wiring; Greptile on every PR. ## What Changed - Adds the remaining server routes/wiring/consumers, runtime tests, adapter-utils MCP contracts, and Claude/Codex injection implementations required by the server layer. - Keeps this PR below 100 changed files and independently typecheckable. - Preserves the final tree from #9534 when combined with the other seven stack levels. ## Verification - `pnpm typecheck` - Changed server test set — 26 files, 382 tests passed - Affected server adapter tests — 38 tests passed after concrete adapter boundary move - Adapter-utils and Codex focused tests — 76 tests passed ## Risks - Remote endpoint validation, token handling, and runtime supervision are security-sensitive and can fail closed or deny legitimate access if misconfigured. - Stack risk: merging out of order can expose incomplete layers; mitigate by following the documented bottom-up merge policy. - Parity risk: later edits to an intermediate branch can drift from #9534; mitigate by re-running the empty top-of-stack diff before merge. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex, exact model ID `gpt-5.4`; runtime-managed context window; medium reasoning with repository, shell, Git, GitHub CLI, and code-execution tools enabled. ## 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] Internal references are omitted except the execution-plan link explicitly required for this coordinated split stack - [x] My branch name describes the change and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] 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 ## Stack Coordination - Internal execution plan: [PAP-13874](/PAP/issues/PAP-13874#document-plan) - Parity reference: #9534 - Stack: #9556 → #9557 → #9558 → #9559 → #9560 → #9561 → #9562 → #9563 - Merge bottom-up only after full-stack review and an empty parity diff at #9563. --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
165 lines
4.9 KiB
TypeScript
165 lines
4.9 KiB
TypeScript
import express from "express";
|
|
import { randomUUID } from "node:crypto";
|
|
import { mkdirSync, rmSync, writeFileSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
import request from "supertest";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const mockRegistry = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
getByKey: vi.fn(),
|
|
getConfig: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../services/plugin-registry.js", () => ({
|
|
pluginRegistryService: () => mockRegistry,
|
|
}));
|
|
|
|
const companyA = "22222222-2222-4222-8222-222222222222";
|
|
const companyB = "33333333-3333-4333-8333-333333333333";
|
|
const pluginId = "11111111-1111-4111-8111-111111111111";
|
|
const tempDirs: string[] = [];
|
|
let originalNodeEnv: string | undefined;
|
|
|
|
function createPluginPackage(source = "export default {};\n") {
|
|
const packageRoot = path.join(
|
|
tmpdir(),
|
|
`paperclip-plugin-ui-static-${randomUUID()}`,
|
|
);
|
|
const uiDir = path.join(packageRoot, "dist", "ui");
|
|
mkdirSync(uiDir, { recursive: true });
|
|
writeFileSync(path.join(uiDir, "index.js"), source);
|
|
tempDirs.push(packageRoot);
|
|
return packageRoot;
|
|
}
|
|
|
|
function readyPlugin(packageRoot: string) {
|
|
mockRegistry.getById.mockResolvedValue({
|
|
id: pluginId,
|
|
pluginKey: "paperclip.example",
|
|
packageName: "paperclip-plugin-example",
|
|
packagePath: packageRoot,
|
|
version: "1.0.0",
|
|
status: "ready",
|
|
manifestJson: {
|
|
id: "paperclip.example",
|
|
entrypoints: {
|
|
ui: "./dist/ui",
|
|
},
|
|
},
|
|
});
|
|
mockRegistry.getByKey.mockResolvedValue(null);
|
|
}
|
|
|
|
function boardActor(companyIds: string[]) {
|
|
return {
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds,
|
|
};
|
|
}
|
|
|
|
async function createApp(actor: Record<string, unknown>) {
|
|
const [{ pluginUiStaticRoutes }, { errorHandler }] = await Promise.all([
|
|
import("../routes/plugin-ui-static.js"),
|
|
import("../middleware/index.js"),
|
|
]);
|
|
|
|
const app = express();
|
|
app.use((req, _res, next) => {
|
|
req.actor = actor as typeof req.actor;
|
|
next();
|
|
});
|
|
app.use(pluginUiStaticRoutes({} as never, { localPluginDir: tmpdir() }));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
describe("plugin UI static route", () => {
|
|
beforeEach(() => {
|
|
originalNodeEnv = process.env.NODE_ENV;
|
|
vi.resetAllMocks();
|
|
vi.unstubAllGlobals();
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.unstubAllGlobals();
|
|
if (originalNodeEnv === undefined) {
|
|
delete process.env.NODE_ENV;
|
|
} else {
|
|
process.env.NODE_ENV = originalNodeEnv;
|
|
}
|
|
while (tempDirs.length > 0) {
|
|
const dir = tempDirs.pop();
|
|
if (dir) rmSync(dir, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it("serves built UI assets publicly when no company context is requested", async () => {
|
|
readyPlugin(createPluginPackage("export const marker = 'static-bundle';\n"));
|
|
const app = await createApp({ type: "none", source: "none" });
|
|
|
|
const res = await request(app).get(`/_plugins/${pluginId}/ui/index.js`);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.text).toContain("static-bundle");
|
|
expect(mockRegistry.getConfig).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires authentication before reading company-scoped devUiUrl config", async () => {
|
|
readyPlugin(createPluginPackage());
|
|
const app = await createApp({ type: "none", source: "none" });
|
|
|
|
const res = await request(app)
|
|
.get(`/_plugins/${pluginId}/ui/index.js`)
|
|
.query({ companyId: companyA });
|
|
|
|
expect(res.status).toBe(401);
|
|
expect(mockRegistry.getConfig).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects cross-company companyId before reading devUiUrl config", async () => {
|
|
readyPlugin(createPluginPackage());
|
|
const app = await createApp(boardActor([companyA]));
|
|
|
|
const res = await request(app)
|
|
.get(`/_plugins/${pluginId}/ui/index.js`)
|
|
.query({ companyId: companyB });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toMatch(/does not have access/i);
|
|
expect(mockRegistry.getConfig).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("proxies devUiUrl only after company access succeeds", async () => {
|
|
process.env.NODE_ENV = "development";
|
|
readyPlugin(createPluginPackage());
|
|
mockRegistry.getConfig.mockResolvedValue({
|
|
configJson: {
|
|
devUiUrl: "http://localhost:5173/",
|
|
},
|
|
});
|
|
const fetchMock = vi.fn().mockResolvedValue(new Response("hot bundle", {
|
|
status: 200,
|
|
headers: { "content-type": "application/javascript" },
|
|
}));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
const app = await createApp(boardActor([companyA]));
|
|
|
|
const res = await request(app)
|
|
.get(`/_plugins/${pluginId}/ui/index.js`)
|
|
.query({ companyId: companyA });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.text).toBe("hot bundle");
|
|
expect(mockRegistry.getConfig).toHaveBeenCalledWith(pluginId, companyA);
|
|
expect(fetchMock).toHaveBeenCalledWith(
|
|
"http://localhost:5173/index.js",
|
|
expect.objectContaining({ signal: expect.any(Object) }),
|
|
);
|
|
});
|
|
});
|