mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-30 13:20:54 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Issue-thread interactions are how agents ask board users for typed decisions and structured answers inside an issue thread > - Confirmation interactions already become stale when a later board/user comment supersedes the pending decision > - Question interactions had the same workflow risk, because a board/user could answer in a comment while the old question card stayed pending > - This pull request extends the supersede-by-comment lifecycle to ask-user-question interactions and makes that status visible in the UI > - The benefit is agents get a clear continuation signal and users do not see stale question forms after the discussion has moved on ## Linked Issues or Issue Description No exact public GitHub issue was found. Bug report: **Pre-submission checklist** - [x] I have searched existing open and closed issues and this is not a duplicate. - [x] I am on the latest released version of Paperclip, or can reproduce on `master`. - [x] I have confirmed the error originates in Paperclip itself, not in an agent adapter, API provider, or local configuration. **What happened?** Pending `ask_user_questions` interactions could remain open after a later board/user comment changed or answered the request in-thread. That left a stale form visible and kept the interaction in a pending state even though the discussion had moved on. **Expected behavior** Question interactions should follow the same default supersede-on-comment behavior as confirmation interactions, with an explicit expired result that points to the superseding comment. **Steps to reproduce** 1. Create an `ask_user_questions` interaction on an issue. 2. Add a board/user comment created at or after that interaction. 3. Observe that before this change, the question interaction stayed pending instead of expiring as superseded by the comment. **Paperclip version or commit** Current `master` before this PR. **Deployment mode** Self-hosted server or local dev. The bug is in shared issue-thread interaction lifecycle handling. **Installation method** Built from source. **Agent adapter(s) involved** Not adapter-specific. This is a core issue-thread interaction bug. **Database mode** Applies to the normal Paperclip database-backed interaction lifecycle. **Access context** Board user comments supersede agent-created questions. **Relevant logs or output** No crash output. The stale pending interaction was visible in the issue thread state. **Relevant config (if applicable)** None. **Additional context** Confirmation-style interactions already supported this stale-by-comment behavior. This PR brings question interactions into the same lifecycle model. **Privacy checklist** - [x] I have reviewed all pasted output for PII and included no private instance links, local ticket ids, secrets, logs, or screenshots. ## What Changed - Added `supersedeOnUserComment` support to `ask_user_questions` payloads, defaulting it to `true` during interaction creation. - Expire pending question interactions when a later board/user comment supersedes them, including a result with `expirationReason: "superseded_by_comment"` and the superseding `commentId`. - Updated interaction summaries and cards so expired question requests show a clear amber state with a jump link to the comment and correct singular/plural copy. - Updated agent onboarding guidance to describe the new default and how to opt out. - Added shared, server, and UI test coverage for the new lifecycle behavior. ## Verification - `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 --reporter=dot` passed: 5 files, 73 tests. - `pnpm --filter @paperclipai/shared typecheck && pnpm --filter @paperclipai/server typecheck && pnpm --filter @paperclipai/ui typecheck` passed. - `pnpm exec vitest run server/src/__tests__/issue-thread-interactions-service.test.ts --reporter=dot && pnpm --filter @paperclipai/server typecheck` passed after the final type-safety cleanup. - Confirmed the branch is rebased on current `origin/master`. - Confirmed the diff does not touch `pnpm-lock.yaml`, `.github/workflows`, or database migrations. ## Risks - Low-to-medium risk: `ask_user_questions` now defaults to expiring after later board/user comments. Existing callers that need questions to stay open through discussion can set `supersedeOnUserComment: false`. - Expired question interactions store an empty `answers` array, so downstream consumers should treat the explicit `expirationReason` as the meaningful outcome. > 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-based coding agent in Paperclip CodexCoder runtime, with terminal and repository tool use. Exact context window is not exposed in 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 not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [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>
287 lines
8.2 KiB
TypeScript
287 lines
8.2 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");
|
|
|
|
expect(buildIssueThreadInteractionSummary({
|
|
id: "interaction-expired",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
kind: "ask_user_questions",
|
|
status: "expired",
|
|
continuationPolicy: "wake_assignee",
|
|
createdAt: "2026-04-06T12:00:00.000Z",
|
|
updatedAt: "2026-04-06T12:05: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: [],
|
|
expirationReason: "superseded_by_comment",
|
|
commentId: "11111111-1111-4111-8111-111111111111",
|
|
},
|
|
})).toBe("Question expired after comment");
|
|
});
|
|
|
|
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"]);
|
|
});
|
|
});
|