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 > - A fast-moving control plane needs stable local tests and repeatable local maintenance tools so contributors can safely split and review work > - Several route suites needed stronger isolation, Codex manual model selection needed a faster-mode option, and local browser cleanup missed Playwright's headless shell binary > - Storybook static output also needed to be preserved as a generated review artifact from the working branch > - This pull request groups the test/local-dev maintenance pieces so they can be reviewed separately from product runtime changes > - The benefit is more predictable contributor verification and cleaner local maintenance without mixing these changes into feature PRs ## What Changed - Added stable Vitest runner support and serialized route/authz test isolation. - Fixed workspace runtime authz route mocks and stabilized Claude/company-import related assertions. - Allowed Codex fast mode for manually selected models. - Broadened the agent browser cleanup script to detect `chrome-headless-shell` as well as Chrome for Testing. - Preserved generated Storybook static output from the source branch. ## Verification - `pnpm exec vitest run src/__tests__/workspace-runtime-routes-authz.test.ts src/__tests__/claude-local-execute.test.ts --config vitest.config.ts` from `server/` passed: 2 files, 19 tests. - `pnpm exec vitest run src/server/codex-args.test.ts --config vitest.config.ts` from `packages/adapters/codex-local/` passed: 1 file, 3 tests. - `bash -n scripts/kill-agent-browsers.sh && scripts/kill-agent-browsers.sh --dry` passed; dry-run detected `chrome-headless-shell` processes without killing them. - `test -f ui/storybook-static/index.html && test -f ui/storybook-static/assets/forms-editors.stories-Dry7qwx2.js` passed. - `git diff --check public-gh/master..pap-2228-test-local-maintenance -- . ':(exclude)ui/storybook-static'` passed. - `pnpm exec vitest run cli/src/__tests__/company-import-export-e2e.test.ts --config cli/vitest.config.ts` did not complete in the isolated split worktree because `paperclipai run` exited during build prep with `TS2688: Cannot find type definition file for 'react'`; this appears to be caused by the worktree dependency symlink setup, not the code under test. - Confirmed this PR does not include `pnpm-lock.yaml`. ## Risks - Medium risk: the stable Vitest runner changes how route/authz tests are scheduled. - Generated `ui/storybook-static` files are large and contain minified third-party output; `git diff --check` reports whitespace inside those generated assets, so reviewers may choose to drop or regenerate that artifact before merge. - No database migrations. > 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 coding agent based on GPT-5, with shell, git, Paperclip API, and GitHub CLI tool use in the local Paperclip workspace. ## 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 - [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 Note: screenshot checklist item is not applicable to source UI behavior; the included Storybook static output is generated artifact preservation from the source branch. --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
546 lines
15 KiB
TypeScript
546 lines
15 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> = {},
|
|
routeOverrides: {
|
|
db?: unknown;
|
|
jobDeps?: unknown;
|
|
toolDeps?: unknown;
|
|
bridgeDeps?: 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(
|
|
(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";
|
|
|
|
function boardActor(overrides: Record<string, unknown> = {}) {
|
|
return {
|
|
type: "board",
|
|
userId: "user-1",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: [companyA],
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function readyPlugin() {
|
|
mockRegistry.getById.mockResolvedValue({
|
|
id: pluginId,
|
|
pluginKey: "paperclip.example",
|
|
version: "1.0.0",
|
|
status: "ready",
|
|
});
|
|
}
|
|
|
|
describe.sequential("plugin install and upgrade authz", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
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.sequential("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.sequential("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("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: {},
|
|
renderEnvironment: null,
|
|
});
|
|
});
|
|
|
|
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");
|
|
});
|
|
});
|