Files
PaperClipAI/ui/src/lib/issue-thread-interactions.ts
T
Dotta 46760cc588 fix(chat): honor dismissal for all composer requests (#17218)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Task conversations show requests in the feed and above the message
composer.
> - Earlier fixes kept dismissed questions in history, but excluded
completion reviews and other request kinds.
> - Closing those forms left a pending badge, and the server could still
demand a response.
> - This pull request saves human dismissal and removes the request from
composer reminders and ordinary completion gates.
> - People can continue the conversation and reopen the request from
history.

## Linked Issues or Issue Description

Related work: #15229 and #15392.

**What happened?**

Dismissing a completion review closed its form but left it counted as
pending. It could return after reload, block a retry, or cause the agent
to demand another response. Raw runtime requests could also lose their
only usable control when dismissed.

**Expected behavior**

Dismissal leaves an accessible request in the feed and clears the
composer form and pending count. It persists after reload. It does not
submit an answer, approve an action, or wake the agent.

**Steps to reproduce**

1. Open a task with a pending completion review or another composer
request.
2. Dismiss the request, then reload the task.
3. Check that the composer stays clear and the feed entry can reopen the
request.

## What Changed

- Add nullable dismissal fields and a human-only dismissal endpoint with
company, private-task access, resolver, and locked review-policy checks.
- Persist saved-request dismissal on the server. Keep browser
persistence for raw runtime requests and existing question dismissals.
- Keep confirmations, choices, item verdicts, suggested tasks, and
runtime requests accessible in the feed.
- Exclude dismissed ordinary requests from completion and retry gates.
Tell agents not to repeat deferred requests.
- Preserve tool, secret, connection, plan, company-policy, and
configured review authorization gates. Expire deferred non-question
requests when their task completes.
- Preserve the selected form when another dismissal finishes saving.
Keep reopened reviews visible through delayed comment refreshes.
- Add a completion-review Storybook test drive and update design, API,
database, and capability documentation.

## Verification

- `pnpm -r typecheck`: passed. The final UI changes also passed the UI
typecheck.
- `pnpm build`: passed. The final UI changes also passed the UI
production build.
- Focused UI and transcript tests: 550 passed across nine files after
merging the current base branch.
- Focused database, completion, and prompt tests: 105 passed across
three files, including two review-policy regressions that failed before
the fix. The tests reject a review requester excluded by current policy,
preserve the pending gate on denial, and permit an independent reviewer
to defer the request.
- Route regression suite: 81 passed, including denial before reading or
mutating a private-task request.
- `pnpm check:token-gates`: passed.
- Map and Storybook structural checks: passed; 30 map/catalog script
tests passed.
- Browser: used the production task-thread components in the
completion-review fixture. Dismissed, reloaded, reopened from the feed,
and dismissed again. No pending badge or composer takeover remained.
Story callbacks simulate API saves; separate server tests cover
persistence and permissions.
- `pnpm test:run`: stopped after the general-server group reported one
failure in `workspace-runtime.test.ts`: "returns a bounded structured
conflict and exposes only same-company workspace references". The same
test passed in isolation (1 passed, 178 skipped). The cause of the
full-suite failure is not established. The full PR CI suite subsequently
passed on e243cbb001; its two authorization review findings are fixed in
9e1b4478b3. Fresh [full
CI](https://github.com/paperclipai/paperclip/actions/runs/39871944846)
passes on 9e1b4478b3, including the previously failing server and
browser shards. All 54 executed checks passed; two optional Storybook
deployment/visual jobs were skipped. The legacy security status also
passed. Fresh Greptile review is 5/5, the security scan passes, and no
review threads remain open. This full CI run settles the merge gate; the
earlier local workspace-suite failure remains recorded above because its
cause was not established.
- Additional verification: the original failing browser journey passed
locally after the delayed-refresh fix. The expanded page-reload case
also passes on 9e1b4478b3 (52.7s): dismiss, reload, reopen, approve, and
receive the actual tool failure in the continuing task. It exposed a
fixture reading an accepted request before tool execution finished; the
fixture now waits for a stored execution result. The first reload
attempt stopped on a still-loading page at the default five-second
assertion; the reload now uses the suite’s navigation allowance. A
controlled server-restart run timed out waiting for server health before
the UI assertions. Local route-suite runs timed out during concurrent
module loading; sequential imports passed all 81 tests, including the
privacy regression.
- Initial verification failures: a missing SDK build and a story fixture
type error were fixed. PostgreSQL bootstrap then failed because the host
had exhausted its semaphore allowance. After explicit operator approval,
64 verified abandoned PostgreSQL semaphore sets were reclaimed; no live
process was stopped. The database regressions then passed. The
raw-runtime regression exposed a missing feed control; the
implementation now preserves that entry and the regression passes.

## Risks

- Apply the additive database migration before the new server code. It
adds two nullable columns and does not change existing decisions.
- A dismissal is shared task attention state. Only a human with task
read access and current resolver/review authority can persist it. Review
policy is checked under the task lock. The operation is idempotent and
records the dismissing user.
- Raw runtime dismissal remains specific to a browser. Saved interaction
dismissal persists across browsers.
- A deferred review is not an approval. Tests retain protected-action
and configured review gates.
- The browser walkthrough uses a fixture. This branch has not been
deployed to a live instance.

## Model Used

OpenAI Codex, GPT-6, with code execution and browser tools. The exact
backend model ID and context-window size are not exposed in this
session.

## 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
2026-10-22 18:37:36 -05:00

470 lines
18 KiB
TypeScript

export type {
AskUserQuestionsAnswer,
AskUserQuestionsInteraction,
AskUserQuestionsPayload,
AskUserQuestionsQuestion,
AskUserQuestionsQuestionOption,
AskUserQuestionsResult,
ConnectionIntentInteraction,
ConnectionIntentPayload,
ConnectionIntentResult,
IssueThreadInteraction,
IssueThreadInteractionActorFields,
IssueThreadInteractionBase,
IssueThreadInteractionContinuationPolicy,
IssueThreadInteractionStatus,
RequestCheckboxConfirmationInteraction,
RequestCheckboxConfirmationOption,
RequestCheckboxConfirmationPayload,
RequestCheckboxConfirmationResult,
RequestConfirmationInteraction,
RequestConfirmationIssueDocumentTarget,
RequestConfirmationPayload,
RequestConfirmationResult,
RequestConfirmationSecretProposalPayload,
RequestConfirmationSecretProposalResult,
RequestConfirmationTarget,
RequestConfirmationToolActionPayload,
RequestConfirmationToolActionResult,
RequestItemVerdictsInteraction,
RequestItemVerdictsItem,
RequestItemVerdictsPayload,
RequestItemVerdictsResult,
RequestItemVerdictsResultItem,
RequestItemVerdictValue,
SubmitIssueThreadInteractionVerdicts,
SuggestedTaskDraft,
SuggestTasksInteraction,
SuggestTasksPayload,
SuggestTasksResult,
SuggestTasksResultCreatedTask,
} from "@paperclipai/shared";
import type {
AskUserQuestionsAnswer,
AskUserQuestionsInteraction,
AskUserQuestionsQuestion,
ConnectionIntentInteraction,
IssueThreadInteraction,
RequestCheckboxConfirmationPayload,
RequestCheckboxConfirmationResult,
RequestConfirmationInteraction,
RequestConfirmationTarget,
RequestItemVerdictsInteraction,
RequestItemVerdictsPayload,
RequestItemVerdictsResult,
RequestItemVerdictValue,
SuggestedTaskDraft,
SuggestTasksInteraction,
SuggestTasksResultCreatedTask,
} from "@paperclipai/shared";
export function isInteractionPreparingApproval(interaction: IssueThreadInteraction): boolean {
return interaction.status === "pending"
&& interaction.acceptanceBlocker === "workspace_sync_pending";
}
/** Keep recovery affordances aligned with the server's deferredInteractionCondition. */
export function isDeferredConversationInteraction(interaction: IssueThreadInteraction): boolean {
if (!interaction.dismissedAt || interaction.effectiveResolverPolicySource !== "requested") return false;
if (interaction.kind === "connection_intent") return false;
const payload = interaction.payload;
return !("toolAction" in payload || "secretProposal" in payload || "connectionAuthorization" in payload)
&& !("target" in payload && payload.target?.type === "issue_document");
}
/** Poll only while an approval is preparing; retain each surface's idle cadence. */
export function interactionReadinessRefetchInterval(
interactions: IssueThreadInteraction[] | undefined,
fallback: number | false = false,
): number | false {
return interactions?.some(isInteractionPreparingApproval) ? 2_000 : fallback;
}
export interface SuggestedTaskTreeNode {
task: SuggestedTaskDraft;
children: SuggestedTaskTreeNode[];
}
/**
* These takeovers already expose a deliberate non-accept path in their form.
* Showing the composer's generic Skip beside Reject/Revise duplicates that
* escape hatch and makes the action hierarchy ambiguous.
*/
export function interactionReplacesComposerSkip(
interaction: IssueThreadInteraction,
): boolean {
return interaction.kind === "request_confirmation"
|| interaction.kind === "request_checkbox_confirmation"
|| interaction.kind === "suggest_tasks";
}
export function isIssueThreadInteraction(
value: unknown,
): value is IssueThreadInteraction {
if (!value || typeof value !== "object") return false;
const candidate = value as Partial<IssueThreadInteraction>;
return typeof candidate.id === "string"
&& typeof candidate.companyId === "string"
&& typeof candidate.issueId === "string"
&& (
candidate.kind === "suggest_tasks"
|| candidate.kind === "ask_user_questions"
|| candidate.kind === "request_confirmation"
|| candidate.kind === "request_checkbox_confirmation"
|| candidate.kind === "request_item_verdicts"
|| candidate.kind === "connection_intent"
);
}
export interface ItemVerdictProgress {
total: number;
decided: number;
approved: number;
rejected: number;
deferred: number;
/** ids in payload order that still have no verdict. */
pendingItemIds: string[];
}
/**
* Derive the `M of N decided` progress for a per-item verdict interaction from
* its payload (the full item roster) and result (verdicts accumulated so far).
* Present-tense verdict values (`approve`/`reject`/`defer`) are what the server
* stores in `result.items[].verdict` (see PAP-13247).
*/
export function getItemVerdictProgress(args: {
payload: RequestItemVerdictsPayload;
result?: RequestItemVerdictsResult | null;
}): ItemVerdictProgress {
const { payload, result } = args;
const resolvedById = new Map<string, RequestItemVerdictValue>(
(result?.items ?? []).map((item) => [item.id, item.verdict] as const),
);
let approved = 0;
let rejected = 0;
let deferred = 0;
const pendingItemIds: string[] = [];
for (const item of payload.items) {
const verdict = resolvedById.get(item.id);
if (verdict === "approve") approved += 1;
else if (verdict === "reject") rejected += 1;
else if (verdict === "defer") deferred += 1;
else pendingItemIds.push(item.id);
}
const decided = approved + rejected + deferred;
return { total: payload.items.length, decided, approved, rejected, deferred, pendingItemIds };
}
export function buildItemVerdictsSummary(
interaction: RequestItemVerdictsInteraction,
): string {
const progress = getItemVerdictProgress({
payload: interaction.payload,
result: interaction.result,
});
if (interaction.status === "answered") {
const parts = [`${progress.decided} decided`];
if (progress.approved > 0) parts.push(`${progress.approved} approved`);
if (progress.rejected > 0) parts.push(`${progress.rejected} rejected`);
if (progress.deferred > 0) parts.push(`${progress.deferred} deferred`);
return parts.join(" · ");
}
if (interaction.status === "expired") {
const outcome = interaction.result?.outcome;
if (outcome === "superseded_by_comment") return "Verdicts expired after comment";
if (outcome === "stale_target") return "Verdicts expired after target changed";
return "Verdicts expired";
}
return `${progress.decided} of ${progress.total} decided`;
}
export function getCheckboxConfirmationSelectedLabels(args: {
payload: RequestCheckboxConfirmationPayload;
result?: RequestCheckboxConfirmationResult | null;
}): string[] {
const { payload, result } = args;
const selectedIds = result?.selectedOptionIds ?? [];
const optionLabelById = new Map(
payload.options.map((option) => [option.id, option.label] as const),
);
return selectedIds
.map((optionId) => optionLabelById.get(optionId))
.filter((label): label is string => typeof label === "string");
}
export function normalizeRequestConfirmationTargetHref(href: string) {
const value = href.trim();
if (value.startsWith("#")) return value;
if (value.startsWith("/")) return value.startsWith("//") ? null : value;
return /^https?:\/\//i.test(value) ? value : null;
}
export function getRequestConfirmationTargetHref({
issueId,
target,
}: {
issueId: string;
target: RequestConfirmationTarget;
}) {
if (target.href) {
const safeHref = normalizeRequestConfirmationTargetHref(target.href);
if (safeHref) return safeHref;
}
if (target.type === "issue_document") {
const targetIssueId = target.issueId ?? issueId;
return `/issues/${targetIssueId}#document-${encodeURIComponent(target.key)}`;
}
return null;
}
export function buildIssueThreadInteractionSummary(
interaction: IssueThreadInteraction,
) {
const administrativeOutcome = interaction.result && "outcome" in interaction.result
? interaction.result.outcome
: null;
if (administrativeOutcome === "skipped") return "Skipped interaction";
if (administrativeOutcome === "withdrawn") return "Withdrawn interaction";
if (administrativeOutcome === "issue_closed") return "Expired when issue closed";
if (administrativeOutcome === "addressee_deleted") return "Cancelled when addressee was deleted";
if (interaction.kind === "suggest_tasks") {
const count = interaction.payload.tasks.length;
if (interaction.status === "accepted") {
const createdCount = interaction.result?.createdTasks?.length ?? 0;
const skippedCount = interaction.result?.skippedClientKeys?.length ?? 0;
if (skippedCount > 0) {
return `Accepted ${createdCount} of ${count} tasks`;
}
return createdCount === 1 ? "Accepted 1 task" : `Accepted ${createdCount} tasks`;
}
if (interaction.status === "rejected") {
return count === 1 ? "Rejected 1 task" : `Rejected ${count} tasks`;
}
return count === 1 ? "Suggested 1 task" : `Suggested ${count} tasks`;
}
if (interaction.kind === "request_confirmation") {
if (interaction.status === "accepted") return "Confirmed request";
if (interaction.status === "rejected") {
const rejectLabel = interaction.payload.rejectLabel?.trim();
return rejectLabel ? `Selected “${rejectLabel}”` : "Declined request";
}
if (interaction.status === "expired") {
const outcome = interaction.result?.outcome;
if (outcome === "superseded_by_comment") return "Confirmation expired after comment";
if (outcome === "stale_target") return "Confirmation expired after target changed";
return "Confirmation expired";
}
return "Requested confirmation";
}
if (interaction.kind === "request_checkbox_confirmation") {
const optionCount = interaction.payload.options.length;
if (interaction.status === "accepted") {
const selectedCount = interaction.result?.selectedOptionIds?.length ?? 0;
if (selectedCount === 0) return "Confirmed with no options selected";
return selectedCount === 1
? `Confirmed 1 of ${optionCount} options`
: `Confirmed ${selectedCount} of ${optionCount} options`;
}
if (interaction.status === "rejected") return "Declined selection";
if (interaction.status === "expired") {
const outcome = interaction.result?.outcome;
if (outcome === "superseded_by_comment") return "Selection expired after comment";
if (outcome === "stale_target") return "Selection expired after target changed";
return "Selection expired";
}
return optionCount === 1
? "Requested a selection from 1 option"
: `Requested a selection from ${optionCount} options`;
}
if (interaction.kind === "request_item_verdicts") {
return buildItemVerdictsSummary(interaction);
}
if (interaction.kind === "connection_intent") {
if (interaction.status === "accepted") return `${interaction.payload.serviceName} connected`;
if (interaction.status === "rejected") return `${interaction.payload.serviceName} declined`;
if (interaction.status === "expired") {
return interaction.result?.outcome === "superseded"
? `${interaction.payload.serviceName} request superseded`
: `${interaction.payload.serviceName} request expired`;
}
return `Connect ${interaction.payload.serviceName}`;
}
const count = interaction.payload.questions.length;
if (interaction.status === "answered") {
return count === 1 ? "Answered 1 question" : `Answered ${count} questions`;
}
if (interaction.status === "cancelled") {
return count === 1 ? "Cancelled 1 question" : `Cancelled ${count} questions`;
}
if (interaction.status === "expired") {
if (interaction.result?.expirationReason === "superseded_by_comment") {
return count === 1 ? "Question expired after comment" : "Questions expired after comment";
}
return count === 1 ? "Question expired" : "Questions expired";
}
return count === 1 ? "Asked 1 question" : `Asked ${count} questions`;
}
/** Readable model input for a durable answer delivered into a successor run. */
export function buildAnsweredQuestionsDeliveryText(
interaction: AskUserQuestionsInteraction,
): string {
const questionSet = interaction.payload.questionSet;
const legacyQuestionById = new Map(
interaction.payload.questions.map((question) => [question.id, question] as const),
);
const canonicalQuestionById = new Map(
(questionSet?.questions ?? []).map((question) => [question.id, question] as const),
);
const lines = (interaction.result?.answers ?? []).map((answer) => {
const canonical = canonicalQuestionById.get(answer.questionId);
const legacy = legacyQuestionById.get(answer.questionId);
const optionLabels = new Map(
(canonical?.options ?? legacy?.options ?? []).map((option) => [option.id, option.label] as const),
);
const values = answer.optionIds.map((optionId) => optionLabels.get(optionId) ?? optionId);
if (answer.otherText?.trim()) values.push(answer.otherText.trim());
const prompt = canonical?.prompt ?? legacy?.prompt ?? answer.questionId;
const label = canonical?.header && canonical.header !== prompt
? `${canonical.header} — ${prompt}`
: prompt;
return `- ${label}: ${values.join(", ") || "No answer"}`;
});
return ["Answered questions", ...(lines.length > 0 ? ["", ...lines] : [])].join("\n");
}
export function buildSuggestedTaskTree(
tasks: readonly SuggestedTaskDraft[],
): SuggestedTaskTreeNode[] {
const nodes = new Map<string, SuggestedTaskTreeNode>();
for (const task of tasks) {
nodes.set(task.clientKey, { task, children: [] });
}
const roots: SuggestedTaskTreeNode[] = [];
for (const task of tasks) {
const node = nodes.get(task.clientKey);
if (!node) continue;
const parentNode = task.parentClientKey ? nodes.get(task.parentClientKey) : null;
if (parentNode) {
parentNode.children.push(node);
continue;
}
roots.push(node);
}
return roots;
}
export function countSuggestedTaskNodes(node: SuggestedTaskTreeNode): number {
return 1 + node.children.reduce((sum, child) => sum + countSuggestedTaskNodes(child), 0);
}
export function collectSuggestedTaskClientKeys(node: SuggestedTaskTreeNode): string[] {
return [
node.task.clientKey,
...node.children.flatMap((child) => collectSuggestedTaskClientKeys(child)),
];
}
export function getQuestionAnswerLabels(args: {
question: AskUserQuestionsQuestion;
answers: readonly AskUserQuestionsAnswer[];
}) {
const { question, answers } = args;
const answer = answers.find((candidate) => candidate.questionId === question.id);
const selectedIds = answer?.optionIds ?? [];
const optionLabelById = new Map(
question.options.map((option) => [option.id, option.label] as const),
);
const labels = selectedIds
.map((optionId) => optionLabelById.get(optionId))
.filter((label): label is string => typeof label === "string");
const otherText = answer?.otherText?.trim();
if (otherText) labels.push(`Other: ${otherText}`);
return labels;
}
/**
* A single `ask_user_questions` question is degenerate when it offers *no way at
* all* to answer — hiding it therefore strands nothing the user could have
* resolved. Structural only, no semantic guessing about the wording:
*
* - its `prompt` is empty / whitespace-only, OR
* - it presents nothing to respond to: no first-class free-text option (the
* PAP-419 `freeText` flag) AND no selectable fixed option.
*
* A question with even a single fixed option is answerable (the user selects it
* and submits), so it is NOT degenerate and must keep rendering — otherwise a
* hidden-but-pending interaction would strand the assignee waiting on a response
* that can never arrive. Legitimate shapes all pass: yes/no, multi-select,
* free-text, and single-option acknowledgements.
*/
function isDegenerateAskUserQuestion(question: AskUserQuestionsQuestion): boolean {
if (question.prompt.trim().length === 0) return true;
const hasFreeTextOption = question.options.some((option) => option.freeText === true);
if (hasFreeTextOption) return false;
const selectableOptionCount = question.options.filter(
(option) => option.freeText !== true,
).length;
return selectableOptionCount === 0;
}
/**
* Structural render guard for `ask_user_questions` cards. A card is degenerate —
* safe to never draw because it strands nothing the user could resolve — when it
* offers no answerable question: it has zero questions, OR every question is
* degenerate (see {@link isDegenerateAskUserQuestion}: blank prompt, or no
* option and no free-text). A card with any answerable question — including a
* single fixed option — always renders.
*
* UI-only: the interaction is still created and stored server-side (audit
* intact); callers use this purely to decide whether to draw the card. Returns
* false for any other interaction kind — the guard is scoped to
* `ask_user_questions`.
*/
export function isDegenerateAskUserQuestions(
interaction: IssueThreadInteraction,
): boolean {
if (interaction.kind !== "ask_user_questions") return false;
const questions = interaction.payload.questions;
if (questions.length === 0) return true;
return questions.every(isDegenerateAskUserQuestion);
}
/**
* A stale sibling `ask_user_questions` that the server auto-expired when its own
* creator posted a newer one on the same issue (PAP-437). The replacement card
* is already in the thread, so this expired shell adds nothing and is never
* drawn. Gated on `status === "expired"` so a still-pending card is never hidden
* (PAP-424 / 00b136f45: hiding a pending question would strand the assignee).
* Distinct from `superseded_by_comment`, which keeps its stale notice.
*/
export function isSupersededByNewerSiblingInteraction(
interaction: IssueThreadInteraction,
): boolean {
if (interaction.kind !== "ask_user_questions") return false;
if (interaction.status !== "expired") return false;
return interaction.result?.expirationReason === "superseded_by_newer_interaction";
}
/**
* Single enforcement point for whether an interaction card should be suppressed
* from every thread surface. Routing all render sites through this one predicate
* keeps composition backbones and the card in lockstep, so a suppressed card
* never leaves an empty slot in one place while another still draws it.
*/
export function shouldHideInteractionCard(
interaction: IssueThreadInteraction,
): boolean {
return (
isDegenerateAskUserQuestions(interaction)
|| isSupersededByNewerSiblingInteraction(interaction)
);
}