mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-16 10:50:38 +09:00
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - Operators supervise that work through issues, comments, approvals, and the board UI. > - Some agent proposals need structured board/user decisions, not hidden markdown conventions or heavyweight governed approvals. > - Issue-thread interactions already provide a natural thread-native surface for proposed tasks and questions. > - This pull request extends that surface with request confirmations, richer interaction cards, and agent/plugin/MCP helpers. > - The benefit is that plan approvals and yes/no decisions become explicit, auditable, and resumable without losing the single-issue workflow. ## What Changed - Added persisted issue-thread interactions for suggested tasks, structured questions, and request confirmations. - Added board UI cards for interaction review, selection, question answers, and accept/reject confirmation flows. - Added MCP and plugin SDK helpers for creating interaction cards from agents/plugins. - Updated agent wake instructions, onboarding assets, Paperclip skill docs, and public docs to prefer structured confirmations for issue-scoped decisions. - Rebased the branch onto `public-gh/master` and renumbered branch migrations to `0063` and `0064`; the idempotency migration uses `ADD COLUMN IF NOT EXISTS` for old branch users. ## Verification - `git diff --check public-gh/master..HEAD` - `pnpm exec vitest run packages/adapter-utils/src/server-utils.test.ts packages/mcp-server/src/tools.test.ts packages/shared/src/issue-thread-interactions.test.ts ui/src/lib/issue-thread-interactions.test.ts ui/src/lib/issue-chat-messages.test.ts ui/src/components/IssueThreadInteractionCard.test.tsx ui/src/components/IssueChatThread.test.tsx server/src/__tests__/issue-thread-interaction-routes.test.ts server/src/__tests__/issue-thread-interactions-service.test.ts server/src/services/issue-thread-interactions.test.ts` -> 9 files / 79 tests passed - `pnpm -r typecheck` -> passed, including `packages/db` migration numbering check ## Risks - Medium: this adds a new issue-thread interaction model across db/shared/server/ui/plugin surfaces. - Migration risk is reduced by placing this branch after current master migrations (`0063`, `0064`) and making the idempotency column add idempotent for users who applied the old branch numbering. - UI interaction behavior is covered by component tests, but this PR does not include browser screenshots. > 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, GPT-5-class coding agent runtime. Exact model ID and context window are not exposed in this Paperclip run; tool use and local shell/code execution were 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] 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 --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
287 lines
9.7 KiB
TypeScript
287 lines
9.7 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import type { ServerAdapterModule } from "../adapters/index.js";
|
|
|
|
const mocks = vi.hoisted(() => {
|
|
const externalRecords = new Map<string, any>();
|
|
|
|
return {
|
|
externalRecords,
|
|
execFile: vi.fn((_file: string, _args: string[], optionsOrCallback: unknown, maybeCallback?: unknown) => {
|
|
const callback = typeof optionsOrCallback === "function" ? optionsOrCallback : maybeCallback;
|
|
if (typeof callback === "function") {
|
|
callback(null, "", "");
|
|
}
|
|
return {
|
|
kill: vi.fn(),
|
|
on: vi.fn(),
|
|
};
|
|
}),
|
|
listAdapterPlugins: vi.fn(),
|
|
addAdapterPlugin: vi.fn((record: any) => {
|
|
externalRecords.set(record.type, record);
|
|
}),
|
|
removeAdapterPlugin: vi.fn((type: string) => {
|
|
externalRecords.delete(type);
|
|
}),
|
|
getAdapterPluginByType: vi.fn((type: string) => externalRecords.get(type)),
|
|
getAdapterPluginsDir: vi.fn(),
|
|
getDisabledAdapterTypes: vi.fn(),
|
|
setAdapterDisabled: vi.fn(),
|
|
loadExternalAdapterPackage: vi.fn(),
|
|
buildExternalAdapters: vi.fn(async () => []),
|
|
reloadExternalAdapter: vi.fn(),
|
|
getUiParserSource: vi.fn(),
|
|
getOrExtractUiParserSource: vi.fn(),
|
|
};
|
|
});
|
|
|
|
vi.mock("node:child_process", () => ({
|
|
execFile: mocks.execFile,
|
|
}));
|
|
|
|
vi.mock("../services/adapter-plugin-store.js", () => ({
|
|
listAdapterPlugins: mocks.listAdapterPlugins,
|
|
addAdapterPlugin: mocks.addAdapterPlugin,
|
|
removeAdapterPlugin: mocks.removeAdapterPlugin,
|
|
getAdapterPluginByType: mocks.getAdapterPluginByType,
|
|
getAdapterPluginsDir: mocks.getAdapterPluginsDir,
|
|
getDisabledAdapterTypes: mocks.getDisabledAdapterTypes,
|
|
setAdapterDisabled: mocks.setAdapterDisabled,
|
|
}));
|
|
|
|
vi.mock("../adapters/plugin-loader.js", () => ({
|
|
buildExternalAdapters: mocks.buildExternalAdapters,
|
|
loadExternalAdapterPackage: mocks.loadExternalAdapterPackage,
|
|
getUiParserSource: mocks.getUiParserSource,
|
|
getOrExtractUiParserSource: mocks.getOrExtractUiParserSource,
|
|
reloadExternalAdapter: mocks.reloadExternalAdapter,
|
|
}));
|
|
|
|
function registerRouteMocks() {
|
|
vi.doMock("node:child_process", () => ({
|
|
execFile: mocks.execFile,
|
|
}));
|
|
|
|
vi.doMock("../services/adapter-plugin-store.js", () => ({
|
|
listAdapterPlugins: mocks.listAdapterPlugins,
|
|
addAdapterPlugin: mocks.addAdapterPlugin,
|
|
removeAdapterPlugin: mocks.removeAdapterPlugin,
|
|
getAdapterPluginByType: mocks.getAdapterPluginByType,
|
|
getAdapterPluginsDir: mocks.getAdapterPluginsDir,
|
|
getDisabledAdapterTypes: mocks.getDisabledAdapterTypes,
|
|
setAdapterDisabled: mocks.setAdapterDisabled,
|
|
}));
|
|
|
|
vi.doMock("../adapters/plugin-loader.js", () => ({
|
|
buildExternalAdapters: mocks.buildExternalAdapters,
|
|
loadExternalAdapterPackage: mocks.loadExternalAdapterPackage,
|
|
getUiParserSource: mocks.getUiParserSource,
|
|
getOrExtractUiParserSource: mocks.getOrExtractUiParserSource,
|
|
reloadExternalAdapter: mocks.reloadExternalAdapter,
|
|
}));
|
|
}
|
|
|
|
const EXTERNAL_ADAPTER_TYPE = "external_admin_test";
|
|
const EXTERNAL_PACKAGE_NAME = "paperclip-external-adapter";
|
|
let adapterRoutes: typeof import("../routes/adapters.js").adapterRoutes;
|
|
let errorHandler: typeof import("../middleware/index.js").errorHandler;
|
|
let registerServerAdapter: typeof import("../adapters/registry.js").registerServerAdapter;
|
|
let unregisterServerAdapter: typeof import("../adapters/registry.js").unregisterServerAdapter;
|
|
let setOverridePaused: typeof import("../adapters/registry.js").setOverridePaused;
|
|
|
|
function createAdapter(type = EXTERNAL_ADAPTER_TYPE): ServerAdapterModule {
|
|
return {
|
|
type,
|
|
models: [],
|
|
execute: async () => ({ exitCode: 0, signal: null, timedOut: false }),
|
|
testEnvironment: async () => ({
|
|
adapterType: type,
|
|
status: "pass",
|
|
checks: [],
|
|
testedAt: new Date(0).toISOString(),
|
|
}),
|
|
};
|
|
}
|
|
|
|
function installedRecord(type = EXTERNAL_ADAPTER_TYPE) {
|
|
return {
|
|
packageName: EXTERNAL_PACKAGE_NAME,
|
|
type,
|
|
installedAt: new Date(0).toISOString(),
|
|
};
|
|
}
|
|
|
|
function createApp(actor: Express.Request["actor"]) {
|
|
if (!adapterRoutes || !errorHandler) {
|
|
throw new Error("adapter route test dependencies were not loaded");
|
|
}
|
|
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
req.actor = actor;
|
|
next();
|
|
});
|
|
app.use("/api", adapterRoutes());
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
function boardMember(membershipRole: "admin" | "operator" | "viewer"): Express.Request["actor"] {
|
|
return {
|
|
type: "board",
|
|
userId: `${membershipRole}-user`,
|
|
userName: null,
|
|
userEmail: null,
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["company-1"],
|
|
memberships: [
|
|
{
|
|
companyId: "company-1",
|
|
membershipRole,
|
|
status: "active",
|
|
},
|
|
],
|
|
};
|
|
}
|
|
|
|
const instanceAdmin: Express.Request["actor"] = {
|
|
type: "board",
|
|
userId: "instance-admin",
|
|
userName: null,
|
|
userEmail: null,
|
|
source: "session",
|
|
isInstanceAdmin: true,
|
|
companyIds: [],
|
|
memberships: [],
|
|
};
|
|
|
|
function sendMutatingRequest(app: express.Express, name: string) {
|
|
switch (name) {
|
|
case "install":
|
|
return request(app)
|
|
.post("/api/adapters/install")
|
|
.send({ packageName: EXTERNAL_PACKAGE_NAME });
|
|
case "disable":
|
|
return request(app)
|
|
.patch(`/api/adapters/${EXTERNAL_ADAPTER_TYPE}`)
|
|
.send({ disabled: true });
|
|
case "override":
|
|
return request(app)
|
|
.patch("/api/adapters/claude_local/override")
|
|
.send({ paused: true });
|
|
case "delete":
|
|
return request(app).delete(`/api/adapters/${EXTERNAL_ADAPTER_TYPE}`);
|
|
case "reload":
|
|
return request(app).post(`/api/adapters/${EXTERNAL_ADAPTER_TYPE}/reload`);
|
|
case "reinstall":
|
|
return request(app).post(`/api/adapters/${EXTERNAL_ADAPTER_TYPE}/reinstall`);
|
|
default:
|
|
throw new Error(`Unknown mutating adapter route: ${name}`);
|
|
}
|
|
}
|
|
|
|
function seedInstalledExternalAdapter() {
|
|
mocks.externalRecords.set(EXTERNAL_ADAPTER_TYPE, installedRecord());
|
|
unregisterServerAdapter(EXTERNAL_ADAPTER_TYPE);
|
|
registerServerAdapter(createAdapter());
|
|
}
|
|
|
|
describe("adapter management route authorization", () => {
|
|
beforeEach(async () => {
|
|
vi.resetModules();
|
|
vi.doUnmock("node:child_process");
|
|
vi.doUnmock("../services/adapter-plugin-store.js");
|
|
vi.doUnmock("../adapters/plugin-loader.js");
|
|
vi.doUnmock("../routes/adapters.js");
|
|
vi.doUnmock("../routes/authz.js");
|
|
vi.doUnmock("../middleware/index.js");
|
|
vi.doUnmock("../adapters/registry.js");
|
|
registerRouteMocks();
|
|
vi.doMock("../routes/authz.js", async () => vi.importActual("../routes/authz.js"));
|
|
|
|
const [routes, middleware, registry] = await Promise.all([
|
|
vi.importActual<typeof import("../routes/adapters.js")>("../routes/adapters.js"),
|
|
vi.importActual<typeof import("../middleware/index.js")>("../middleware/index.js"),
|
|
vi.importActual<typeof import("../adapters/registry.js")>("../adapters/registry.js"),
|
|
]);
|
|
adapterRoutes = routes.adapterRoutes;
|
|
errorHandler = middleware.errorHandler;
|
|
registerServerAdapter = registry.registerServerAdapter;
|
|
unregisterServerAdapter = registry.unregisterServerAdapter;
|
|
setOverridePaused = registry.setOverridePaused;
|
|
vi.clearAllMocks();
|
|
mocks.externalRecords.clear();
|
|
|
|
unregisterServerAdapter(EXTERNAL_ADAPTER_TYPE);
|
|
setOverridePaused("claude_local", false);
|
|
mocks.listAdapterPlugins.mockImplementation(() => [...mocks.externalRecords.values()]);
|
|
mocks.getAdapterPluginsDir.mockReturnValue("/tmp/paperclip-adapter-route-authz-test");
|
|
mocks.getDisabledAdapterTypes.mockReturnValue([]);
|
|
mocks.setAdapterDisabled.mockReturnValue(true);
|
|
mocks.buildExternalAdapters.mockResolvedValue([]);
|
|
mocks.loadExternalAdapterPackage.mockResolvedValue(createAdapter());
|
|
mocks.reloadExternalAdapter.mockImplementation(async (type: string) => createAdapter(type));
|
|
}, 20_000);
|
|
|
|
afterEach(() => {
|
|
unregisterServerAdapter(EXTERNAL_ADAPTER_TYPE);
|
|
setOverridePaused("claude_local", false);
|
|
});
|
|
|
|
it.each([
|
|
"install",
|
|
"disable",
|
|
"override",
|
|
"delete",
|
|
"reload",
|
|
"reinstall",
|
|
])("rejects %s for a non-instance-admin board user with company membership", async (routeName) => {
|
|
seedInstalledExternalAdapter();
|
|
const app = createApp(boardMember("admin"));
|
|
|
|
const res = await sendMutatingRequest(app, routeName);
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(403);
|
|
});
|
|
|
|
it.each([
|
|
["install", 201],
|
|
["disable", 200],
|
|
["override", 200],
|
|
["delete", 200],
|
|
["reload", 200],
|
|
["reinstall", 200],
|
|
] as const)("allows instance admins to reach %s", async (routeName, expectedStatus) => {
|
|
if (routeName !== "install") {
|
|
seedInstalledExternalAdapter();
|
|
}
|
|
const app = createApp(instanceAdmin);
|
|
|
|
const res = await sendMutatingRequest(app, routeName);
|
|
|
|
expect(res.status, JSON.stringify(res.body)).toBe(expectedStatus);
|
|
});
|
|
|
|
it.each(["viewer", "operator"] as const)(
|
|
"does not let a company %s trigger adapter npm install or reload",
|
|
async (membershipRole) => {
|
|
seedInstalledExternalAdapter();
|
|
const app = createApp(boardMember(membershipRole));
|
|
|
|
const install = await request(app)
|
|
.post("/api/adapters/install")
|
|
.send({ packageName: EXTERNAL_PACKAGE_NAME });
|
|
const reload = await request(app).post(`/api/adapters/${EXTERNAL_ADAPTER_TYPE}/reload`);
|
|
|
|
expect(install.status, JSON.stringify(install.body)).toBe(403);
|
|
expect(reload.status, JSON.stringify(reload.body)).toBe(403);
|
|
expect(mocks.execFile).not.toHaveBeenCalled();
|
|
expect(mocks.loadExternalAdapterPackage).not.toHaveBeenCalled();
|
|
expect(mocks.reloadExternalAdapter).not.toHaveBeenCalled();
|
|
},
|
|
);
|
|
});
|