mirror of
https://github.com/paperclipai/paperclip
synced 2026-04-25 17:25:15 +02:00
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - The plugin system is the extension path for optional capabilities that should not require core product changes for every integration. > - Plugins need scoped host APIs for issue orchestration, documents, wakeups, summaries, activity attribution, and isolated database state. > - Without those host APIs, richer plugins either cannot coordinate Paperclip work safely or need privileged core-side special cases. > - This pull request adds the plugin orchestration host surface, scoped route dispatch, a database namespace layer, and a smoke plugin that exercises the contract. > - The benefit is a broader plugin API that remains company-scoped, auditable, and covered by tests. ## What Changed - Added plugin orchestration host APIs for issue creation, document access, wakeups, summaries, plugin-origin activity, and scoped API route dispatch. - Added plugin database namespace tables, schema exports, migration checks, and idempotent replay coverage under migration `0059_plugin_database_namespaces`. - Added shared plugin route/API types and validators used by server and SDK boundaries. - Expanded plugin SDK types, protocol helpers, worker RPC host behavior, and testing utilities for orchestration flows. - Added the `plugin-orchestration-smoke-example` package to exercise scoped routes, restricted database namespaces, issue orchestration, documents, wakeups, summaries, and UI status surfaces. - Kept the new orchestration smoke fixture out of the root pnpm workspace importer so this PR preserves the repository policy of not committing `pnpm-lock.yaml`. - Updated plugin docs and database docs for the new orchestration and database namespace surfaces. - Rebased the branch onto `public-gh/master`, resolved conflicts, and removed `pnpm-lock.yaml` from the final PR diff. ## Verification - `pnpm install --frozen-lockfile` - `pnpm --filter @paperclipai/db typecheck` - `pnpm exec vitest run packages/db/src/client.test.ts` - `pnpm exec vitest run server/src/__tests__/plugin-database.test.ts server/src/__tests__/plugin-orchestration-apis.test.ts server/src/__tests__/plugin-routes-authz.test.ts server/src/__tests__/plugin-scoped-api-routes.test.ts server/src/__tests__/plugin-sdk-orchestration-contract.test.ts` - From `packages/plugins/examples/plugin-orchestration-smoke-example`: `pnpm exec vitest run --config ./vitest.config.ts` - `pnpm --dir packages/plugins/examples/plugin-orchestration-smoke-example run typecheck` - `pnpm --filter @paperclipai/server typecheck` - PR CI on latest head `293fc67c`: `policy`, `verify`, `e2e`, and `security/snyk` all passed. ## Risks - Medium risk: this expands plugin host authority, so route auth, company scoping, and plugin-origin activity attribution need careful review. - Medium risk: database namespace migration behavior must remain idempotent for environments that may have seen earlier branch versions. - Medium risk: the orchestration smoke fixture is intentionally excluded from the root workspace importer to avoid a `pnpm-lock.yaml` PR diff; direct fixture verification remains listed above. - Low operational risk from the PR setup itself: the branch is rebased onto current `master`, the migration is ordered after upstream `0057`/`0058`, and `pnpm-lock.yaml` is not in the final diff. > 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`. Roadmap checked: this work aligns with the completed Plugin system milestone and extends the plugin surface rather than duplicating an unrelated planned core feature. ## Model Used - OpenAI Codex, GPT-5-based coding agent in a tool-enabled CLI environment. Exact hosted model build and context-window size are not exposed by the runtime; reasoning/tool use were enabled for repository inspection, editing, testing, git operations, and PR creation. ## 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots (N/A: no core UI screen change; example plugin UI contract is covered by tests) - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
268 lines
7.4 KiB
TypeScript
268 lines
7.4 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const mockRegistry = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
getByKey: vi.fn(),
|
|
upsertConfig: vi.fn(),
|
|
}));
|
|
|
|
const mockLifecycle = vi.hoisted(() => ({
|
|
load: vi.fn(),
|
|
upgrade: vi.fn(),
|
|
unload: vi.fn(),
|
|
enable: vi.fn(),
|
|
disable: 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/live-events.js", () => ({
|
|
publishGlobalLiveEvent: vi.fn(),
|
|
}));
|
|
|
|
async function createApp(
|
|
actor: Record<string, unknown>,
|
|
loaderOverrides: Record<string, unknown> = {},
|
|
bridgeDeps?: Record<string, unknown>,
|
|
) {
|
|
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());
|
|
app.use((req, _res, next) => {
|
|
req.actor = actor as typeof req.actor;
|
|
next();
|
|
});
|
|
app.use("/api", pluginRoutes({} as never, loader as never, undefined, undefined, undefined, bridgeDeps as never));
|
|
app.use(errorHandler);
|
|
|
|
return { app, loader };
|
|
}
|
|
|
|
describe("plugin install and upgrade authz", () => {
|
|
beforeEach(() => {
|
|
vi.resetAllMocks();
|
|
});
|
|
|
|
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("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.resetAllMocks();
|
|
});
|
|
|
|
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"],
|
|
},
|
|
{},
|
|
{ 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);
|
|
});
|