4d5322c821
## 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>
271 lines
8.1 KiB
TypeScript
271 lines
8.1 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import {
|
|
acceptIssueThreadInteractionSchema,
|
|
createIssueThreadInteractionSchema,
|
|
} from "./validators/issue.js";
|
|
|
|
describe("issue thread interaction schemas", () => {
|
|
it("parses request_confirmation payloads with default no-wake continuation", () => {
|
|
const parsed = createIssueThreadInteractionSchema.parse({
|
|
kind: "request_confirmation",
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Apply this plan?",
|
|
acceptLabel: "Apply",
|
|
rejectLabel: "Revise",
|
|
rejectRequiresReason: true,
|
|
rejectReasonLabel: "What needs to change?",
|
|
declineReasonPlaceholder: "Optional: tell the agent what you'd change.",
|
|
detailsMarkdown: "The current plan document will be accepted as-is.",
|
|
supersedeOnUserComment: true,
|
|
},
|
|
});
|
|
|
|
expect(parsed).toMatchObject({
|
|
kind: "request_confirmation",
|
|
continuationPolicy: "none",
|
|
payload: {
|
|
prompt: "Apply this plan?",
|
|
acceptLabel: "Apply",
|
|
rejectLabel: "Revise",
|
|
rejectRequiresReason: true,
|
|
rejectReasonLabel: "What needs to change?",
|
|
allowDeclineReason: true,
|
|
declineReasonPlaceholder: "Optional: tell the agent what you'd change.",
|
|
supersedeOnUserComment: true,
|
|
},
|
|
});
|
|
});
|
|
|
|
it("accepts issue document targets for request_confirmation interactions", () => {
|
|
const parsed = createIssueThreadInteractionSchema.parse({
|
|
kind: "request_confirmation",
|
|
continuationPolicy: "wake_assignee_on_accept",
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Accept the latest plan revision?",
|
|
allowDeclineReason: false,
|
|
target: {
|
|
type: "issue_document",
|
|
issueId: "11111111-1111-4111-8111-111111111111",
|
|
documentId: "22222222-2222-4222-8222-222222222222",
|
|
key: "plan",
|
|
revisionId: "33333333-3333-4333-8333-333333333333",
|
|
revisionNumber: 2,
|
|
label: "Plan v2",
|
|
href: "/issues/PAP-123#document-plan",
|
|
},
|
|
},
|
|
});
|
|
|
|
expect(parsed.kind).toBe("request_confirmation");
|
|
if (parsed.kind !== "request_confirmation") return;
|
|
expect(parsed.payload.target).toMatchObject({
|
|
type: "issue_document",
|
|
key: "plan",
|
|
revisionNumber: 2,
|
|
label: "Plan v2",
|
|
href: "/issues/PAP-123#document-plan",
|
|
});
|
|
});
|
|
|
|
it("accepts custom targets for request_confirmation interactions", () => {
|
|
for (const href of [
|
|
"https://example.com/checklist",
|
|
"http://example.com/checklist",
|
|
"/PAP/issues/PAP-123#document-plan",
|
|
"#document-plan",
|
|
]) {
|
|
const parsed = createIssueThreadInteractionSchema.parse({
|
|
kind: "request_confirmation",
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Proceed with the external checklist?",
|
|
target: {
|
|
type: "custom",
|
|
key: "external-checklist",
|
|
revisionId: "checklist-v1",
|
|
revisionNumber: 1,
|
|
label: "Checklist v1",
|
|
href,
|
|
},
|
|
},
|
|
});
|
|
|
|
expect(parsed.kind).toBe("request_confirmation");
|
|
if (parsed.kind !== "request_confirmation") return;
|
|
expect(parsed.payload.target).toMatchObject({
|
|
type: "custom",
|
|
key: "external-checklist",
|
|
label: "Checklist v1",
|
|
href,
|
|
});
|
|
}
|
|
});
|
|
|
|
it("rejects unsafe request_confirmation target hrefs", () => {
|
|
const base = {
|
|
kind: "request_confirmation",
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Proceed?",
|
|
target: {
|
|
type: "custom",
|
|
key: "external-checklist",
|
|
revisionId: "checklist-v1",
|
|
label: "Checklist v1",
|
|
},
|
|
},
|
|
} as const;
|
|
|
|
for (const href of [
|
|
"javascript:alert(1)",
|
|
"data:text/html,hi",
|
|
"//evil.example/path",
|
|
"file:///tmp/x",
|
|
"mailto:user@example.com",
|
|
"slack://channel?id=1",
|
|
"vscode://file/tmp/x",
|
|
"ftp://example.com/file",
|
|
]) {
|
|
expect(() => createIssueThreadInteractionSchema.parse({
|
|
...base,
|
|
payload: {
|
|
...base.payload,
|
|
target: {
|
|
...base.payload.target,
|
|
href,
|
|
},
|
|
},
|
|
})).toThrow("href must be a root-relative path, same-page fragment, or http(s) URL");
|
|
}
|
|
});
|
|
|
|
it("parses request_checkbox_confirmation payloads with checkbox defaults", () => {
|
|
const parsed = createIssueThreadInteractionSchema.parse({
|
|
kind: "request_checkbox_confirmation",
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Which items should be archived?",
|
|
options: [
|
|
{ id: "item-1", label: "Draft report" },
|
|
{ id: "item-2", label: "Old screenshot", description: "Captured during QA." },
|
|
],
|
|
defaultSelectedOptionIds: ["item-2"],
|
|
minSelected: 0,
|
|
maxSelected: 2,
|
|
acceptLabel: "Archive selected",
|
|
rejectRequiresReason: true,
|
|
target: {
|
|
type: "issue_document",
|
|
key: "plan",
|
|
revisionId: "33333333-3333-4333-8333-333333333333",
|
|
revisionNumber: 2,
|
|
},
|
|
},
|
|
});
|
|
|
|
expect(parsed).toMatchObject({
|
|
kind: "request_checkbox_confirmation",
|
|
continuationPolicy: "wake_assignee",
|
|
payload: {
|
|
allowDeclineReason: true,
|
|
defaultSelectedOptionIds: ["item-2"],
|
|
minSelected: 0,
|
|
maxSelected: 2,
|
|
},
|
|
});
|
|
});
|
|
|
|
it("rejects invalid request_checkbox_confirmation option references and bounds", () => {
|
|
const base = {
|
|
kind: "request_checkbox_confirmation",
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Which items should be archived?",
|
|
options: [
|
|
{ id: "item-1", label: "Draft report" },
|
|
{ id: "item-2", label: "Old screenshot" },
|
|
],
|
|
},
|
|
} as const;
|
|
|
|
expect(() => createIssueThreadInteractionSchema.parse({
|
|
...base,
|
|
payload: {
|
|
...base.payload,
|
|
options: [
|
|
{ id: "item-1", label: "Draft report" },
|
|
{ id: "item-1", label: "Duplicate" },
|
|
],
|
|
},
|
|
})).toThrow("Option ids must be unique within one checkbox confirmation");
|
|
|
|
expect(() => createIssueThreadInteractionSchema.parse({
|
|
...base,
|
|
payload: {
|
|
...base.payload,
|
|
defaultSelectedOptionIds: ["missing"],
|
|
},
|
|
})).toThrow("defaultSelectedOptionIds must reference existing option ids");
|
|
|
|
expect(() => createIssueThreadInteractionSchema.parse({
|
|
...base,
|
|
payload: {
|
|
...base.payload,
|
|
defaultSelectedOptionIds: ["item-1"],
|
|
minSelected: 2,
|
|
},
|
|
})).toThrow("defaultSelectedOptionIds must satisfy minSelected");
|
|
|
|
expect(() => createIssueThreadInteractionSchema.parse({
|
|
...base,
|
|
payload: {
|
|
...base.payload,
|
|
minSelected: 2,
|
|
maxSelected: 1,
|
|
},
|
|
})).toThrow("maxSelected must be greater than or equal to minSelected");
|
|
});
|
|
|
|
it("rejects unsafe request_checkbox_confirmation target hrefs", () => {
|
|
const base = {
|
|
kind: "request_checkbox_confirmation",
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Which items should be archived?",
|
|
options: [{ id: "item-1", label: "Draft report" }],
|
|
target: {
|
|
type: "custom",
|
|
key: "external-checklist",
|
|
revisionId: "checklist-v1",
|
|
label: "Checklist v1",
|
|
},
|
|
},
|
|
} as const;
|
|
|
|
for (const href of ["file:///tmp/x", "slack://channel?id=1", "vscode://file/tmp/x"]) {
|
|
expect(() => createIssueThreadInteractionSchema.parse({
|
|
...base,
|
|
payload: {
|
|
...base.payload,
|
|
target: {
|
|
...base.payload.target,
|
|
href,
|
|
},
|
|
},
|
|
})).toThrow("href must be a root-relative path, same-page fragment, or http(s) URL");
|
|
}
|
|
});
|
|
|
|
it("accepts empty checkbox selections and rejects duplicate selected option ids", () => {
|
|
expect(acceptIssueThreadInteractionSchema.parse({ selectedOptionIds: [] })).toEqual({
|
|
selectedOptionIds: [],
|
|
});
|
|
|
|
expect(() => acceptIssueThreadInteractionSchema.parse({
|
|
selectedOptionIds: ["item-1", "item-1"],
|
|
})).toThrow("selectedOptionIds must be unique");
|
|
});
|
|
});
|