mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-25 02:26:12 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agent work is coordinated through issues, comments, interactions, and approval-style handoffs. > - Existing issue-thread interactions could ask questions, suggest tasks, and request confirmation, but they did not support a structured checkbox confirmation payload for choosing one or more options. > - That gap made board/user confirmations harder to validate consistently across API callers, plugin helpers, CLI tooling, and the UI. > - This pull request adds the shared checkbox confirmation contract, server handling, client helpers, and issue-thread UI needed to render and submit structured selections. > - The benefit is that agents can request bounded multi-select confirmations in the same audited issue-thread flow as other Paperclip interactions. ## Linked Issues or Issue Description - No public GitHub issue found for this exact branch. Internal Paperclip issue: PAP-10415 / PAP-10441 requested creating this PR for the checkbox confirmation issue-thread UI component work. - GitHub duplicate search performed for checkbox confirmation / issue-thread interaction PRs; no matching open PR was found. - Related issue search result `#7497` was unrelated company file cleanup work, so it is not linked as a related issue. ## What Changed - Added shared types, validators, constants, and tests for `request_checkbox_confirmation` interactions. - Extended server issue-thread interaction service and routes for checkbox confirmation creation, validation, expiration, and response handling. - Added CLI, MCP, and plugin SDK helper coverage so external callers can create the new interaction shape consistently. - Updated the issue-thread interaction UI to render checkbox confirmations with min/max bounds, selection summaries, stale-target states, and accept/decline flows. - Documented the checkbox confirmation interaction contract in the Paperclip skill/API reference. ## Verification - Rebased cleanly on `paperclipai/paperclip` `master` fetched into `public-gh/master` at `a4fa0eaf5`. - Confirmed the PR diff does not include `pnpm-lock.yaml` or `.github/workflows` changes. - Ran focused tests with `NODE_ENV=test`: ```sh NODE_ENV=test pnpm run preflight:workspace-links NODE_ENV=test pnpm exec vitest run packages/shared/src/issue-thread-interactions.test.ts server/src/__tests__/issue-thread-interaction-routes.test.ts server/src/__tests__/issue-thread-interactions-service.test.ts ui/src/components/IssueThreadInteractionCard.test.tsx ui/src/lib/issue-thread-interactions.test.ts cli/src/__tests__/issue-subresources.test.ts cli/src/__tests__/project-goal.test.ts packages/mcp-server/src/tools.test.ts packages/plugins/sdk/tests/testing-actions.test.ts ``` Result: 8 test files passed, 78 tests passed. - CI on latest head `63b9e55` is green. - Greptile Review passed on latest head; GraphQL review-thread check shows all Greptile threads resolved. ## Risks - Medium surface area because the interaction contract touches shared validators, server routes/services, UI rendering, CLI, MCP, plugin SDK helpers, and docs. - No database migrations are included. - `pnpm-lock.yaml` is intentionally excluded per repository lockfile policy. - UI screenshots are not attached because the task explicitly requested not to add design screenshots or images unless they were part of the work; component tests cover the new rendering and interaction states. > 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 repository file access, shell command execution, git/GitHub CLI tooling, and Paperclip control-plane API access. Exact hosted model ID/context-window metadata is not exposed inside this runtime. ## 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] 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] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
259 lines
7.4 KiB
TypeScript
259 lines
7.4 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import {
|
|
buildIssueThreadInteractionSummary,
|
|
buildSuggestedTaskTree,
|
|
collectSuggestedTaskClientKeys,
|
|
countSuggestedTaskNodes,
|
|
getCheckboxConfirmationSelectedLabels,
|
|
getRequestConfirmationTargetHref,
|
|
getQuestionAnswerLabels,
|
|
normalizeRequestConfirmationTargetHref,
|
|
} from "./issue-thread-interactions";
|
|
|
|
describe("buildSuggestedTaskTree", () => {
|
|
it("preserves parent-child relationships from client keys", () => {
|
|
const roots = buildSuggestedTaskTree([
|
|
{
|
|
clientKey: "root",
|
|
title: "Root",
|
|
},
|
|
{
|
|
clientKey: "child",
|
|
parentClientKey: "root",
|
|
title: "Child",
|
|
},
|
|
{
|
|
clientKey: "grandchild",
|
|
parentClientKey: "child",
|
|
title: "Grandchild",
|
|
},
|
|
]);
|
|
|
|
expect(roots).toHaveLength(1);
|
|
expect(roots[0]?.task.clientKey).toBe("root");
|
|
expect(roots[0]?.children[0]?.task.clientKey).toBe("child");
|
|
expect(countSuggestedTaskNodes(roots[0]!)).toBe(3);
|
|
expect(collectSuggestedTaskClientKeys(roots[0]!)).toEqual(["root", "child", "grandchild"]);
|
|
});
|
|
});
|
|
|
|
describe("issue thread interaction helpers", () => {
|
|
it("summarizes task and question interactions", () => {
|
|
expect(buildIssueThreadInteractionSummary({
|
|
id: "interaction-1",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
kind: "suggest_tasks",
|
|
status: "pending",
|
|
continuationPolicy: "wake_assignee",
|
|
createdAt: "2026-04-06T12:00:00.000Z",
|
|
updatedAt: "2026-04-06T12:00:00.000Z",
|
|
payload: {
|
|
version: 1,
|
|
tasks: [
|
|
{ clientKey: "task-1", title: "One" },
|
|
{ clientKey: "task-2", title: "Two" },
|
|
],
|
|
},
|
|
})).toBe("Suggested 2 tasks");
|
|
|
|
expect(buildIssueThreadInteractionSummary({
|
|
id: "interaction-accepted",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
kind: "suggest_tasks",
|
|
status: "accepted",
|
|
continuationPolicy: "wake_assignee",
|
|
createdAt: "2026-04-06T12:00:00.000Z",
|
|
updatedAt: "2026-04-06T12:00:00.000Z",
|
|
payload: {
|
|
version: 1,
|
|
tasks: [
|
|
{ clientKey: "task-1", title: "One" },
|
|
{ clientKey: "task-2", title: "Two" },
|
|
],
|
|
},
|
|
result: {
|
|
version: 1,
|
|
createdTasks: [{ clientKey: "task-1", issueId: "child-1" }],
|
|
skippedClientKeys: ["task-2"],
|
|
},
|
|
})).toBe("Accepted 1 of 2 tasks");
|
|
|
|
expect(buildIssueThreadInteractionSummary({
|
|
id: "interaction-2",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
kind: "ask_user_questions",
|
|
status: "pending",
|
|
continuationPolicy: "wake_assignee",
|
|
createdAt: "2026-04-06T12:00:00.000Z",
|
|
updatedAt: "2026-04-06T12:00:00.000Z",
|
|
payload: {
|
|
version: 1,
|
|
questions: [
|
|
{
|
|
id: "question-1",
|
|
prompt: "Pick one",
|
|
selectionMode: "single",
|
|
options: [{ id: "option-1", label: "Option 1" }],
|
|
},
|
|
],
|
|
},
|
|
})).toBe("Asked 1 question");
|
|
|
|
expect(buildIssueThreadInteractionSummary({
|
|
id: "interaction-answered",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
kind: "ask_user_questions",
|
|
status: "answered",
|
|
continuationPolicy: "wake_assignee",
|
|
createdAt: "2026-04-06T12:00:00.000Z",
|
|
updatedAt: "2026-04-06T12:00:00.000Z",
|
|
payload: {
|
|
version: 1,
|
|
questions: [
|
|
{
|
|
id: "question-1",
|
|
prompt: "Pick one",
|
|
selectionMode: "single",
|
|
options: [{ id: "option-1", label: "Option 1" }],
|
|
},
|
|
],
|
|
},
|
|
result: {
|
|
version: 1,
|
|
answers: [{ questionId: "question-1", optionIds: ["option-1"] }],
|
|
},
|
|
})).toBe("Answered 1 question");
|
|
});
|
|
|
|
it("summarizes checkbox confirmation interactions by count", () => {
|
|
const base = {
|
|
id: "interaction-checkbox",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
kind: "request_checkbox_confirmation" as const,
|
|
continuationPolicy: "wake_assignee" as const,
|
|
createdAt: "2026-04-06T12:00:00.000Z",
|
|
updatedAt: "2026-04-06T12:00:00.000Z",
|
|
payload: {
|
|
version: 1 as const,
|
|
prompt: "Pick items",
|
|
options: [
|
|
{ id: "a", label: "A" },
|
|
{ id: "b", label: "B" },
|
|
{ id: "c", label: "C" },
|
|
],
|
|
},
|
|
};
|
|
|
|
expect(buildIssueThreadInteractionSummary({ ...base, status: "pending" }))
|
|
.toBe("Requested a selection from 3 options");
|
|
|
|
expect(buildIssueThreadInteractionSummary({
|
|
...base,
|
|
status: "accepted",
|
|
result: { version: 1, outcome: "accepted", selectedOptionIds: ["a", "c"] },
|
|
})).toBe("Confirmed 2 of 3 options");
|
|
|
|
expect(buildIssueThreadInteractionSummary({
|
|
...base,
|
|
status: "accepted",
|
|
result: { version: 1, outcome: "accepted", selectedOptionIds: [] },
|
|
})).toBe("Confirmed with no options selected");
|
|
|
|
expect(buildIssueThreadInteractionSummary({
|
|
...base,
|
|
status: "expired",
|
|
result: { version: 1, outcome: "stale_target" },
|
|
})).toBe("Selection expired after target changed");
|
|
});
|
|
|
|
it("maps selected checkbox option ids back to labels", () => {
|
|
const labels = getCheckboxConfirmationSelectedLabels({
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Pick items",
|
|
options: [
|
|
{ id: "a", label: "Alpha" },
|
|
{ id: "b", label: "Bravo" },
|
|
{ id: "c", label: "Charlie" },
|
|
],
|
|
},
|
|
result: { version: 1, outcome: "accepted", selectedOptionIds: ["c", "a", "missing"] },
|
|
});
|
|
|
|
expect(labels).toEqual(["Charlie", "Alpha"]);
|
|
});
|
|
|
|
it("allows only safe confirmation target hrefs for rendering", () => {
|
|
for (const href of [
|
|
"https://example.com/checklist",
|
|
"http://example.com/checklist",
|
|
"/PAP/issues/PAP-123#document-plan",
|
|
"#document-plan",
|
|
]) {
|
|
expect(normalizeRequestConfirmationTargetHref(href)).toBe(href);
|
|
}
|
|
|
|
for (const href of [
|
|
"file:///tmp/x",
|
|
"mailto:user@example.com",
|
|
"slack://channel?id=1",
|
|
"vscode://file/tmp/x",
|
|
"ftp://example.com/file",
|
|
"//evil.example/path",
|
|
]) {
|
|
expect(normalizeRequestConfirmationTargetHref(href)).toBeNull();
|
|
}
|
|
});
|
|
|
|
it("does not return unsafe custom target hrefs from accepted payloads", () => {
|
|
expect(getRequestConfirmationTargetHref({
|
|
issueId: "issue-1",
|
|
target: {
|
|
type: "custom",
|
|
key: "unsafe-target",
|
|
label: "Unsafe target",
|
|
href: "file:///tmp/x",
|
|
},
|
|
})).toBeNull();
|
|
|
|
expect(getRequestConfirmationTargetHref({
|
|
issueId: "issue-1",
|
|
target: {
|
|
type: "issue_document",
|
|
issueId: "issue-2",
|
|
key: "plan",
|
|
revisionId: "11111111-1111-4111-8111-111111111111",
|
|
href: "slack://channel?id=1",
|
|
},
|
|
})).toBe("/issues/issue-2#document-plan");
|
|
});
|
|
|
|
it("maps stored option ids back to labels for answered summaries", () => {
|
|
const labels = getQuestionAnswerLabels({
|
|
question: {
|
|
id: "question-1",
|
|
prompt: "Pick options",
|
|
selectionMode: "multi",
|
|
options: [
|
|
{ id: "option-1", label: "Option 1" },
|
|
{ id: "option-2", label: "Option 2" },
|
|
],
|
|
},
|
|
answers: [
|
|
{
|
|
questionId: "question-1",
|
|
optionIds: ["option-2", "option-1"],
|
|
otherText: "A written answer",
|
|
},
|
|
],
|
|
});
|
|
|
|
expect(labels).toEqual(["Option 2", "Option 1", "Other: A written answer"]);
|
|
});
|
|
});
|