forked from farhoodlabs/paperclip
a957394420
## 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>
313 lines
8.6 KiB
TypeScript
313 lines
8.6 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const mockAccessService = vi.hoisted(() => ({
|
|
hasPermission: vi.fn(),
|
|
canUser: vi.fn(),
|
|
isInstanceAdmin: vi.fn(),
|
|
getMembership: vi.fn(),
|
|
ensureMembership: vi.fn(),
|
|
listMembers: vi.fn(),
|
|
setMemberPermissions: vi.fn(),
|
|
promoteInstanceAdmin: vi.fn(),
|
|
demoteInstanceAdmin: vi.fn(),
|
|
listUserCompanyAccess: vi.fn(),
|
|
setUserCompanyAccess: vi.fn(),
|
|
setPrincipalGrants: vi.fn(),
|
|
}));
|
|
|
|
const mockAgentService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
}));
|
|
|
|
const mockBoardAuthService = vi.hoisted(() => ({
|
|
createCliAuthChallenge: vi.fn(),
|
|
describeCliAuthChallenge: vi.fn(),
|
|
approveCliAuthChallenge: vi.fn(),
|
|
cancelCliAuthChallenge: vi.fn(),
|
|
resolveBoardAccess: vi.fn(),
|
|
assertCurrentBoardKey: vi.fn(),
|
|
revokeBoardApiKey: vi.fn(),
|
|
}));
|
|
|
|
const mockLogActivity = vi.hoisted(() => vi.fn());
|
|
const mockStorage = vi.hoisted(() => ({
|
|
headObject: vi.fn(),
|
|
}));
|
|
|
|
function registerModuleMocks() {
|
|
vi.doMock("../routes/access.js", async () => vi.importActual("../routes/access.js"));
|
|
vi.doMock("../routes/authz.js", async () => vi.importActual("../routes/authz.js"));
|
|
vi.doMock("../middleware/index.js", async () => vi.importActual("../middleware/index.js"));
|
|
|
|
vi.doMock("../services/access.js", () => ({
|
|
accessService: () => mockAccessService,
|
|
}));
|
|
|
|
vi.doMock("../services/activity-log.js", () => ({
|
|
logActivity: mockLogActivity,
|
|
}));
|
|
|
|
vi.doMock("../services/agents.js", () => ({
|
|
agentService: () => mockAgentService,
|
|
}));
|
|
|
|
vi.doMock("../services/board-auth.js", () => ({
|
|
boardAuthService: () => mockBoardAuthService,
|
|
}));
|
|
|
|
vi.doMock("../services/index.js", () => ({
|
|
accessService: () => mockAccessService,
|
|
agentService: () => mockAgentService,
|
|
boardAuthService: () => mockBoardAuthService,
|
|
deduplicateAgentName: vi.fn(),
|
|
logActivity: mockLogActivity,
|
|
notifyHireApproved: vi.fn(),
|
|
}));
|
|
|
|
vi.doMock("../storage/index.js", () => ({
|
|
getStorageService: () => mockStorage,
|
|
}));
|
|
}
|
|
|
|
function createSelectChain(rows: unknown[]) {
|
|
const query = {
|
|
then(resolve: (value: unknown[]) => unknown) {
|
|
return Promise.resolve(rows).then(resolve);
|
|
},
|
|
leftJoin() {
|
|
return query;
|
|
},
|
|
orderBy() {
|
|
return query;
|
|
},
|
|
where() {
|
|
return query;
|
|
},
|
|
};
|
|
return {
|
|
from() {
|
|
return query;
|
|
},
|
|
};
|
|
}
|
|
|
|
function createDbStub(...selectResponses: unknown[][]) {
|
|
const createdInvite = {
|
|
id: "invite-1",
|
|
companyId: "company-1",
|
|
inviteType: "company_join",
|
|
allowedJoinTypes: "agent",
|
|
defaultsPayload: null,
|
|
expiresAt: new Date("2099-03-07T00:10:00.000Z"),
|
|
invitedByUserId: null,
|
|
tokenHash: "hash",
|
|
revokedAt: null,
|
|
acceptedAt: null,
|
|
createdAt: new Date("2099-03-07T00:00:00.000Z"),
|
|
updatedAt: new Date("2099-03-07T00:00:00.000Z"),
|
|
};
|
|
const returning = vi.fn().mockResolvedValue([createdInvite]);
|
|
const values = vi.fn().mockReturnValue({ returning });
|
|
const insert = vi.fn().mockReturnValue({ values });
|
|
let selectCall = 0;
|
|
const select = vi.fn((selection?: unknown) =>
|
|
createSelectChain(
|
|
selection === undefined
|
|
? [createdInvite]
|
|
: (selectResponses[selectCall++] ?? []),
|
|
),
|
|
);
|
|
return {
|
|
insert,
|
|
select,
|
|
__insertValues: values,
|
|
};
|
|
}
|
|
|
|
async function createApp(actor: Record<string, unknown>, db: Record<string, unknown>) {
|
|
const [{ accessRoutes }, { errorHandler }] = await Promise.all([
|
|
import("../routes/access.js"),
|
|
import("../middleware/index.js"),
|
|
]);
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
(req as any).actor = actor;
|
|
next();
|
|
});
|
|
app.use(
|
|
"/api",
|
|
accessRoutes(db as any, {
|
|
deploymentMode: "local_trusted",
|
|
deploymentExposure: "private",
|
|
bindHost: "127.0.0.1",
|
|
allowedHostnames: [],
|
|
}),
|
|
);
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
describe("POST /companies/:companyId/openclaw/invite-prompt", () => {
|
|
const companyBranding = {
|
|
name: "Acme AI",
|
|
brandColor: "#225577",
|
|
logoAssetId: "logo-1",
|
|
};
|
|
const logoAsset = {
|
|
companyId: "company-1",
|
|
objectKey: "company-1/assets/companies/logo-1",
|
|
contentType: "image/png",
|
|
byteSize: 3,
|
|
originalFilename: "logo.png",
|
|
};
|
|
|
|
beforeEach(() => {
|
|
vi.resetModules();
|
|
vi.doUnmock("../services/access.js");
|
|
vi.doUnmock("../services/activity-log.js");
|
|
vi.doUnmock("../services/agents.js");
|
|
vi.doUnmock("../services/board-auth.js");
|
|
vi.doUnmock("../services/index.js");
|
|
vi.doUnmock("../storage/index.js");
|
|
vi.doUnmock("../routes/access.js");
|
|
vi.doUnmock("../routes/authz.js");
|
|
vi.doUnmock("../middleware/index.js");
|
|
registerModuleMocks();
|
|
vi.resetAllMocks();
|
|
mockAccessService.canUser.mockResolvedValue(false);
|
|
mockAgentService.getById.mockReset();
|
|
mockLogActivity.mockResolvedValue(undefined);
|
|
mockStorage.headObject.mockResolvedValue({ exists: true, contentLength: 3, contentType: "image/png" });
|
|
});
|
|
|
|
it("rejects non-CEO agent callers", async () => {
|
|
const db = createDbStub();
|
|
mockAgentService.getById.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
role: "engineer",
|
|
});
|
|
const app = await createApp(
|
|
{
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "company-1",
|
|
source: "agent_key",
|
|
},
|
|
db,
|
|
);
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/company-1/openclaw/invite-prompt")
|
|
.send({});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("Only CEO agents");
|
|
});
|
|
|
|
it("allows CEO agent callers and creates an agent-only invite", async () => {
|
|
const db = createDbStub([companyBranding], [logoAsset]);
|
|
mockAgentService.getById.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
role: "ceo",
|
|
});
|
|
const app = await createApp(
|
|
{
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "company-1",
|
|
source: "agent_key",
|
|
},
|
|
db,
|
|
);
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/company-1/openclaw/invite-prompt")
|
|
.send({ agentMessage: "Join and configure OpenClaw gateway." });
|
|
|
|
expect([200, 201]).toContain(res.status);
|
|
expect(res.body.companyName).toBe("Acme AI");
|
|
expect(res.body.onboardingTextPath).toContain("/api/invites/");
|
|
expect((db as any).__insertValues).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
companyId: "company-1",
|
|
inviteType: "company_join",
|
|
allowedJoinTypes: "agent",
|
|
}),
|
|
);
|
|
});
|
|
|
|
it("includes companyName in invite summary responses", async () => {
|
|
const db = createDbStub([companyBranding], [logoAsset]);
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
companyIds: ["company-1"],
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
},
|
|
db,
|
|
);
|
|
|
|
const res = await request(app).get("/api/invites/pcp_invite_test");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.companyName).toBe("Acme AI");
|
|
expect(res.body.companyBrandColor).toBe("#225577");
|
|
expect(res.body.companyLogoUrl).toBe("/api/invites/pcp_invite_test/logo");
|
|
expect(res.body.inviteType).toBe("company_join");
|
|
expect(res.body.allowedJoinTypes).toBe("agent");
|
|
});
|
|
|
|
it("allows board callers with invite permission", async () => {
|
|
const db = createDbStub([companyBranding], [logoAsset]);
|
|
mockAccessService.canUser.mockResolvedValue(true);
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
companyIds: ["company-1"],
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
},
|
|
db,
|
|
);
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/company-1/openclaw/invite-prompt")
|
|
.send({});
|
|
|
|
expect([200, 201]).toContain(res.status);
|
|
expect(res.body.companyName).toBe("Acme AI");
|
|
expect(res.body.inviteUrl).toContain("/invite/");
|
|
expect(res.body.onboardingTextPath).toContain("/api/invites/");
|
|
}, 15_000);
|
|
|
|
it("rejects board callers without invite permission", async () => {
|
|
const db = createDbStub();
|
|
mockAccessService.canUser.mockResolvedValue(false);
|
|
const app = await createApp(
|
|
{
|
|
type: "board",
|
|
userId: "user-1",
|
|
companyIds: ["company-1"],
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
},
|
|
db,
|
|
);
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/company-1/openclaw/invite-prompt")
|
|
.send({});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toBe("Permission denied");
|
|
});
|
|
});
|