Files
PaperClipAI/server/src/services/question-response-delivery.ts
T
DottaandPaperclip 835a022936 perf(server): wake delivery queues from transaction-aware work signals (#15625)
## Thinking Path

> - Paperclip manages AI-agent work and its delivery to users and
agents.
> - Five delivery queues scan the database even when empty.
> - Each queue already has durable rows; empty polling wastes idle
hosting capacity.
> - Producers can register intent inside their existing database
transaction.
> - Central transaction tracking can wake consumers after the outer
commit without extra caller wrappers.
> - A lost response needs reconciliation against PostgreSQL before an
empty queue is safe to leave idle.
> - This change uses one scheduler for outstanding work and lets
settled, empty queues go quiet.

## Linked Issues or Issue Description

Supersedes the closed #15614. Related idle-safety work: #15522 and
#15599.

**What existing behavior does this improve?**

Delivery scheduling for feedback exports, chat completions, connection
continuations, question answers, and tool-action receipts.

**Current behavior**

Feedback scans every five seconds. Four delivery queues scan on the
heartbeat interval, normally 30 seconds. Startup and some event paths
also scan them.

**Proposed behavior**

Each producer awaits one intent registration before its queue write. The
existing `createDb` transaction boundary tracks nested savepoints and
wakes the consumer after outer settlement. Startup scans restore durable
work. Pending rows, failures, and unresolved transactions retain retry
deadlines. Empty, settled queues have no timer or recurring scan.

**Reason and benefit**

Normal delivery starts after commit. Central tracking removes
caller-specific post-commit plumbing. PostgreSQL transaction status
resolves lost responses without new tables or a permanent uncertainty
latch.

**Breaking changes**

No API or schema changes. The notification scope is one DB owner and its
dedicated child pools. Direct SQL, separate roots, and other processes
require an explicit wake/recovery integration. This path requires
PostgreSQL 14+ transaction-information functions; embedded PostgreSQL
uses 18.

## What Changed

- Add one named-deadline scheduler and app-owned coordinator for five
existing queues.
- Instrument `createDb().transaction()` centrally, including nested
savepoints. Dedicated child connections share their owner's signal
scope.
- Register work before the five queue insert paths. The first
registration obtains the outer XID; unrelated transactions issue no
extra SQL. Tool receipt insertion gains a small transaction around its
existing insert.
- Query `pg_xact_status` only for rejected, tracked transactions. Probe
before scanning the queue. Retain the idle hold while PostgreSQL still
reports an in-progress transaction or the probe fails. Release it after
settlement and reconciliation.
- Remove unconditional delivery recovery scans and caller-specific
completion post-commit actions. Retain the existing task-scoped
completion activity fast path and durable claims.
- Coalesce wakes without postponing an earlier deadline. Retry
outstanding rows and failures; suppress dispatch during idle drain while
allowing transaction and queue reconciliation; suppress both during warm
standby. Cancel deadlines and await active delivery sweeps on shutdown.
- Serialize feedback flushes. Vote routes return after saving. Uploads
have a 30-second deadline and shutdown cancellation; unfinished exports
remain recoverable.
- Document the writer contract and update the dated sleep inventory.

## Verification

- Final head: `a4609956841107ad60c4cb50fe2acb05636b1363`.
- Passed: all final-head hosted checks, with 54 successes and two
intentional skips. The full test matrix, typecheck, build, canary, and
aggregate verification passed in [run
37940948440](https://github.com/paperclipai/paperclip/actions/runs/37940948440).
- Passed: Greptile 5/5 on the same head, with a successful check run and
zero unresolved review threads. The branch is mergeable.
- Passed locally after the final rebase: 50 coordinator, scheduler, and
startup tests; server typecheck; server build.
- Passed locally before the final import-only rebase: repo-wide
typecheck and build; 237 PostgreSQL producer/delivery and database
signal tests; feedback, native-question, and idle-safety regression
tests.
- Real PostgreSQL tests hold transactions open after an injected client
response loss, then commit or abort. They verify that an empty scan
cannot clear an in-progress transaction. Another test terminates a real
backend and verifies recovery without replay.
- Coordinator tests cover an hour with no empty-queue timers,
pending/error retries, worker replacement, concurrent writes,
earliest-deadline preservation, rollback during idle drain, committed
work during drain, standby, and shutdown.
- Local `pnpm test:run` was started and stopped after embedded
PostgreSQL startup failures appeared. It did not finish and is not
reported as a pass. Later local database reruns had skipped suites;
those skips are not claimed as verification. The earlier PostgreSQL
tests did execute and pass, and the final hosted full matrix passed.

## Risks

- One XID query is added per transaction that registers delivery work.
Nested transactions share that ID. Registration must be awaited before
writing; new enqueue paths must follow this contract.
- Work signals are local to a DB owner and its dedicated child pools.
Independent roots, direct SQL, or other processes are not observed.
Startup scans recover already committed rows, but do not fence late
transactions from a previous process. Cross-process ownership and
database failover require separate work.
- A database outage or genuinely unresolved transaction keeps an idle
hold until status can be reconciled. No timer clears uncertainty by
assumption.
- These changes remove five empty polling loops. They do not implement
whole-instance sleep, database teardown, or an external waker. The
earliest deadline covers only the registered queues.
- Waiting tool reviews retain their existing retry cadence until their
receipts can be delivered.
- Feedback vote responses no longer wait for the remote upload. Sharing
consent and the saved vote response are unchanged.
- Real hosting-provider sleep and cost savings have not been measured.

## Model Used

OpenAI Codex, GPT-6. Used reasoning, repository inspection, code
editing, and command execution. The runtime did not expose the exact
model revision or context window.

## 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>
2026-10-09 10:01:26 -05:00

1349 lines
46 KiB
TypeScript

import { and, asc, desc, eq, inArray, isNull, lte, or, sql } from "drizzle-orm";
import type { Db } from "@paperclipai/db";
import {
agentWakeupRequests,
agents,
activityLog,
chatPublications,
heartbeatRuns,
issueComments,
issueQuestionResponseDeliveries,
issues,
issueThreadInteractions,
} from "@paperclipai/db";
import type {
AskUserQuestionsInteraction,
PaperclipQuestionSetPayload,
} from "@paperclipai/shared";
import type { PaperclipQuestionResponse } from "../vendor/paperclip-runner/index.js";
import { isUniqueViolation } from "../db-errors.js";
import { getTelemetryClient } from "../telemetry.js";
import { logger } from "../middleware/logger.js";
import { logActivity } from "./activity-log.js";
import type { heartbeatService } from "./heartbeat.js";
import { nativeSha256 } from "./native-runtime/canonical.js";
const DELIVERY_CLAIM_STALE_MS = 30_000;
const DELIVERY_CLAIM_REFRESH_MS = 10_000;
const MAX_DELIVERY_ATTEMPTS = 5;
const DELIVERY_CORRELATION_PREFIX = "question-response:";
const QUESTION_RESPONSE_WAKE_IDEMPOTENCY_CONSTRAINT =
"agent_wakeup_requests_question_response_delivery_idempotency_uq";
class DeliveryClaimUnavailableError extends Error {
constructor() {
super("question_response_delivery_claim_unavailable");
this.name = "DeliveryClaimUnavailableError";
}
}
const DURABLE_WAKE_REQUEST_STATUSES = [
"queued",
"claimed",
"running",
"succeeded",
"completed",
"coalesced",
"deferred_issue_execution",
"retrying",
"scheduled_retry",
] as const;
type QuestionInteractionRow = typeof issueThreadInteractions.$inferSelect;
type DeliveryRow = typeof issueQuestionResponseDeliveries.$inferSelect;
type Heartbeat = Pick<
ReturnType<typeof heartbeatService>,
"wakeup" | "cancelRun"
>;
type QuestionResponseSteer = (input: {
runId: string;
message: string;
correlationId: string;
}) => Promise<{ turnId?: string | null }>;
type NativeQuestionResponseResolver = (
interaction: AskUserQuestionsInteraction,
) => Promise<"not_native" | "pending" | "queued">;
export interface QuestionResponseDeliveryEnvelope {
schema: "paperclip.question_response_delivery.v1";
interactionId: string;
sourceRunId: string | null;
questionSet: PaperclipQuestionSetPayload;
response: PaperclipQuestionResponse;
}
export interface QuestionResponseDeliveryOutcome {
deliveryId: string;
status: DeliveryRow["status"];
mode: DeliveryRow["deliveryMode"];
targetRunId: string | null;
targetTurnId: string | null;
duplicate: boolean;
}
export interface QuestionResponseDeliveryServiceOptions {
heartbeat: Heartbeat;
/** Kept for caller compatibility. Answers never implicitly steer an active turn. */
steer?: QuestionResponseSteer;
/** Resolve the original in-flight native input request before considering a continuation run. */
resolveNativeQuestion?: NativeQuestionResponseResolver;
now?: () => Date;
/** Test-only lease timings. Production callers use the bounded defaults. */
claimStaleMs?: number;
claimRefreshMs?: number;
}
function record(value: unknown): Record<string, unknown> {
return value && typeof value === "object" && !Array.isArray(value)
? (value as Record<string, unknown>)
: {};
}
function compactLine(value: unknown): string | null {
if (typeof value !== "string") return null;
const normalized = value.replace(/\s+/g, " ").trim();
return normalized.length > 0 ? normalized : null;
}
function canonicalQuestionSet(
interaction: Pick<AskUserQuestionsInteraction, "title" | "payload">,
): PaperclipQuestionSetPayload {
if (interaction.payload.questionSet)
return structuredClone(interaction.payload.questionSet);
return {
schema: "paperclip.question_set.v1",
...(interaction.title ? { title: interaction.title } : {}),
...(interaction.payload.submitLabel
? { submitLabel: interaction.payload.submitLabel }
: {}),
questions: interaction.payload.questions.map((question) => {
const customOption = question.options.find(
(option) => option.freeText === true,
);
return {
id: question.id,
prompt: question.prompt,
...(question.helpText ? { helpText: question.helpText } : {}),
required: question.required === true,
answerMode:
question.selectionMode === "multi"
? ("multi_select" as const)
: ("single_select" as const),
options: question.options
.filter((option) => option.freeText !== true)
.map((option) => ({
id: option.id,
label: option.label,
...(option.description ? { description: option.description } : {}),
})),
...(customOption
? {
customAnswer: {
enabled: true as const,
label: customOption.label,
...(customOption.description
? { placeholder: customOption.description }
: {}),
},
}
: {}),
};
}),
};
}
export function buildQuestionResponseDeliveryEnvelope(
interaction: AskUserQuestionsInteraction,
): QuestionResponseDeliveryEnvelope {
if (
interaction.status !== "answered" ||
!interaction.result ||
interaction.result.cancelled === true
) {
throw new Error("question_response_interaction_not_answered");
}
const questionSet = canonicalQuestionSet(interaction);
const questionById = new Map(
questionSet.questions.map((question) => [question.id, question]),
);
const response: PaperclipQuestionResponse = {
schema: "paperclip.question_response.v1",
answers: Object.fromEntries(
interaction.result.answers.map((answer) => {
const question = questionById.get(answer.questionId);
return [
answer.questionId,
question?.answerMode === "text"
? { ...(answer.otherText ? { text: answer.otherText } : {}) }
: {
selectedOptionIds: answer.optionIds,
...(answer.otherText ? { customText: answer.otherText } : {}),
},
];
}),
),
};
return {
schema: "paperclip.question_response_delivery.v1",
interactionId: interaction.id,
sourceRunId: interaction.sourceRunId ?? null,
questionSet,
response,
};
}
function questionAnswerLines(
envelope: QuestionResponseDeliveryEnvelope,
): string[] {
const lines: string[] = [];
for (const question of envelope.questionSet.questions) {
const answer = envelope.response.answers[question.id];
if (!answer) continue;
const optionLabelById = new Map(
(question.options ?? []).map((option) => [option.id, option.label]),
);
const values = (answer.selectedOptionIds ?? []).map(
(optionId) => optionLabelById.get(optionId) ?? optionId,
);
const text = compactLine(answer.text);
const customText = compactLine(answer.customText);
if (text) values.push(text);
if (customText) values.push(customText);
const header = compactLine(question.header);
const prompt = compactLine(question.prompt);
const label =
header && prompt && header !== prompt
? `${header} — ${prompt}`
: (header ?? prompt ?? question.id);
lines.push(`- ${label}: ${values.join(", ") || "No answer"}`);
}
return lines;
}
export function formatQuestionResponseSummary(
envelope: QuestionResponseDeliveryEnvelope,
): string {
const lines = questionAnswerLines(envelope);
return lines.length > 0
? ["Resolved questions and answers:", ...lines].join("\n")
: "Resolved questions and answers.";
}
export function formatDurableQuestionResponseSummary(
interaction: AskUserQuestionsInteraction,
): string {
const existing = compactLine(interaction.result?.summaryMarkdown);
return (
existing ??
formatQuestionResponseSummary(
buildQuestionResponseDeliveryEnvelope(interaction),
)
);
}
export function formatQuestionResponseSteeringMessage(
envelope: QuestionResponseDeliveryEnvelope,
): string {
const lines = questionAnswerLines(envelope);
return lines.length > 0
? ["Answered questions", "", ...lines].join("\n")
: "Answered questions";
}
function hydrateQuestionInteraction(
row: QuestionInteractionRow,
): AskUserQuestionsInteraction {
return {
...row,
kind: "ask_user_questions",
status: row.status as AskUserQuestionsInteraction["status"],
continuationPolicy:
row.continuationPolicy as AskUserQuestionsInteraction["continuationPolicy"],
resolverPolicy: row.effectiveResolverPolicy,
requestedResolverPolicy: row.requestedResolverPolicy,
effectiveResolverPolicy: row.effectiveResolverPolicy,
resolverPolicyProvenance: row.resolverPolicyProvenance,
effectiveResolverPolicySource: row.effectiveResolverPolicySource,
legacyResolverPolicyAliases: { requested: null, effective: null },
payload: row.payload as AskUserQuestionsInteraction["payload"],
result: row.result as AskUserQuestionsInteraction["result"],
};
}
export function questionResponseDeliveryValues(
interaction: AskUserQuestionsInteraction,
) {
const envelope = buildQuestionResponseDeliveryEnvelope(interaction);
return {
companyId: interaction.companyId,
issueId: interaction.issueId,
interactionId: interaction.id,
sourceRunId: interaction.sourceRunId ?? null,
correlationId: `${DELIVERY_CORRELATION_PREFIX}${interaction.id}`,
payloadSha256: nativeSha256(envelope),
};
}
/**
* An intentional retired question source is not a failed execution incident.
* This is only a stop classification: the dedicated answer wake still needs
* its own fresh source/principal attestation before it can execute. Call while
* holding the task lock; no provider operation or successor is started here.
*/
export async function isRetiredExternalChatQuestionSource(
database: Db,
scope: { companyId: string; issueId: string; agentId: string; runId: string },
): Promise<boolean> {
const source = await database.select().from(heartbeatRuns).where(and(
eq(heartbeatRuns.id, scope.runId),
eq(heartbeatRuns.companyId, scope.companyId),
eq(heartbeatRuns.agentId, scope.agentId),
eq(heartbeatRuns.nativeIssueId, scope.issueId),
eq(heartbeatRuns.runtimeMode, "native"),
eq(heartbeatRuns.status, "cancelled"),
eq(heartbeatRuns.errorCode, "external_chat_continuation"),
)).limit(1).then(rows => rows[0] ?? null);
if (!source) return false;
const result = record(source.resultJson);
const cancellation = record(result.nativeCancellation);
const interactionId = result.interactionId;
const uuid = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
if (
result.externalChatContinuation !== true ||
typeof interactionId !== "string" || !uuid.test(interactionId) ||
cancellation.schema !== "paperclip.native-cancellation.v1" ||
cancellation.companyId !== scope.companyId ||
cancellation.runId !== scope.runId ||
cancellation.issueId !== scope.issueId ||
cancellation.scope !== "run" ||
cancellation.dispatchState !== "acknowledged" ||
typeof cancellation.intentId !== "string" ||
typeof cancellation.intentAuditId !== "string" || !uuid.test(cancellation.intentAuditId) ||
typeof cancellation.acknowledgementAuditId !== "string" || !uuid.test(cancellation.acknowledgementAuditId)
) return false;
const interaction = await database.select().from(issueThreadInteractions).where(and(
eq(issueThreadInteractions.id, interactionId),
eq(issueThreadInteractions.companyId, scope.companyId),
eq(issueThreadInteractions.issueId, scope.issueId),
eq(issueThreadInteractions.createdByAgentId, scope.agentId),
eq(issueThreadInteractions.sourceRunId, scope.runId),
eq(issueThreadInteractions.kind, "ask_user_questions"),
eq(issueThreadInteractions.status, "answered"),
)).limit(1).then(rows => rows[0] ?? null);
if (!interaction) return false;
let expected: ReturnType<typeof questionResponseDeliveryValues>;
try {
expected = questionResponseDeliveryValues(hydrateQuestionInteraction(interaction));
} catch {
return false;
}
const delivery = await database.select({ id: issueQuestionResponseDeliveries.id }).from(issueQuestionResponseDeliveries).where(and(
eq(issueQuestionResponseDeliveries.companyId, scope.companyId),
eq(issueQuestionResponseDeliveries.issueId, scope.issueId),
eq(issueQuestionResponseDeliveries.interactionId, interactionId),
eq(issueQuestionResponseDeliveries.sourceRunId, scope.runId),
eq(issueQuestionResponseDeliveries.correlationId, expected.correlationId),
eq(issueQuestionResponseDeliveries.payloadSha256, expected.payloadSha256),
)).limit(1);
if (!delivery.length) return false;
const audits = await database.select().from(activityLog).where(and(
eq(activityLog.companyId, scope.companyId),
eq(activityLog.agentId, scope.agentId),
eq(activityLog.runId, scope.runId),
eq(activityLog.entityType, "heartbeat_run"),
eq(activityLog.entityId, scope.runId),
eq(activityLog.actorType, "system"),
eq(activityLog.actorId, "native-session-cancellation"),
inArray(activityLog.id, [cancellation.intentAuditId, cancellation.acknowledgementAuditId]),
));
return audits.some(audit => audit.id === cancellation.intentAuditId &&
audit.action === "native.cancellation_intent_recorded" &&
record(audit.details).intentId === cancellation.intentId &&
record(audit.details).scope === "run") &&
audits.some(audit => audit.id === cancellation.acknowledgementAuditId &&
audit.action === "native.cancellation_dispatch_acknowledged" &&
record(audit.details).intentId === cancellation.intentId &&
record(audit.details).intentAuditId === cancellation.intentAuditId &&
record(audit.details).scope === "run");
}
function issueIdFromRun(
run: Pick<typeof heartbeatRuns.$inferSelect, "contextSnapshot">,
) {
const context = record(run.contextSnapshot);
return compactLine(context.issueId) ?? compactLine(context.taskId);
}
function sourceCommentIdFromRun(
run: Pick<typeof heartbeatRuns.$inferSelect, "contextSnapshot"> | null,
) {
const context = record(run?.contextSnapshot);
const batched = Array.isArray(context.wakeCommentIds)
? context.wakeCommentIds
.map((value) => compactLine(value))
.filter((value): value is string => Boolean(value))
: [];
return (
batched.at(-1) ??
compactLine(context.wakeCommentId) ??
compactLine(context.commentId)
);
}
function hasExternalChatOrigin(
run: Pick<typeof heartbeatRuns.$inferSelect, "contextSnapshot"> | null,
) {
const source = compactLine(record(run?.contextSnapshot).source);
return (
source?.startsWith("chat:") === true ||
source === "external_chat.interaction.resolve"
);
}
function actorForInteraction(interaction: QuestionInteractionRow) {
if (interaction.resolvedByUserId) {
return {
actorType: "user" as const,
actorId: interaction.resolvedByUserId,
};
}
if (interaction.resolvedByAgentId) {
return {
actorType: "agent" as const,
actorId: interaction.resolvedByAgentId,
};
}
return { actorType: "system" as const, actorId: "question-response-outbox" };
}
export function questionResponseDeliveryService(
db: Db,
options: QuestionResponseDeliveryServiceOptions,
) {
const resolveNativeQuestion = options.resolveNativeQuestion;
const now = options.now ?? (() => new Date());
const claimStaleMs = Math.max(
2,
options.claimStaleMs ?? DELIVERY_CLAIM_STALE_MS,
);
const claimRefreshMs = Math.max(
1,
Math.min(
options.claimRefreshMs ?? DELIVERY_CLAIM_REFRESH_MS,
Math.floor(claimStaleMs / 2),
),
);
async function claim(interactionId: string): Promise<DeliveryRow | null> {
const claimAt = now();
return db.transaction(async (tx) => {
const current = await tx
.select()
.from(issueQuestionResponseDeliveries)
.where(eq(issueQuestionResponseDeliveries.interactionId, interactionId))
.for("update")
.limit(1)
.then((rows) => rows[0] ?? null);
if (
!current ||
["delivered", "fallback_queued", "failed"].includes(current.status)
)
return null;
if (
current.status === "delivering" &&
current.lastAttemptAt &&
current.lastAttemptAt.getTime() > claimAt.getTime() - claimStaleMs
)
return null;
return tx
.update(issueQuestionResponseDeliveries)
.set({
status: "delivering",
attemptCount: sql`${issueQuestionResponseDeliveries.attemptCount} + 1`,
lastAttemptAt: claimAt,
updatedAt: claimAt,
})
.where(eq(issueQuestionResponseDeliveries.id, current.id))
.returning()
.then((rows) => rows[0] ?? null);
});
}
async function terminalOutcome(
interactionId: string,
): Promise<QuestionResponseDeliveryOutcome | null> {
const row = await db
.select()
.from(issueQuestionResponseDeliveries)
.where(eq(issueQuestionResponseDeliveries.interactionId, interactionId))
.limit(1)
.then((rows) => rows[0] ?? null);
if (
!row ||
!["delivered", "fallback_queued", "failed"].includes(row.status)
)
return null;
return {
deliveryId: row.id,
status: row.status,
mode: row.deliveryMode,
targetRunId: row.targetRunId,
targetTurnId: row.targetTurnId,
duplicate: true,
};
}
async function recordTerminal(input: {
delivery: DeliveryRow;
interaction: QuestionInteractionRow;
status: "delivered" | "fallback_queued" | "failed";
mode: "steered" | "coalesced" | "wake_fallback" | null;
targetRunId: string | null;
targetTurnId?: string | null;
adapter: string;
errorCode?: string | null;
}): Promise<QuestionResponseDeliveryOutcome> {
const at = now();
const updated = await db.transaction(async (tx) => {
const row = await tx
.update(issueQuestionResponseDeliveries)
.set({
status: input.status,
deliveryMode: input.mode,
targetRunId: input.targetRunId,
targetTurnId: input.targetTurnId ?? null,
acknowledgedAt: input.status === "failed" ? null : at,
lastErrorCode: input.errorCode ?? null,
updatedAt: at,
})
.where(
and(
eq(issueQuestionResponseDeliveries.id, input.delivery.id),
eq(issueQuestionResponseDeliveries.status, "delivering"),
eq(
issueQuestionResponseDeliveries.attemptCount,
input.delivery.attemptCount,
),
),
)
.returning()
.then((rows) => rows[0] ?? null);
if (!row) return null;
await logActivity(tx as unknown as Db, {
companyId: input.interaction.companyId,
actorType: "system",
actorId: "question-response-delivery",
agentId: input.interaction.resolvedByAgentId,
runId: input.targetRunId,
action:
input.status === "failed"
? "issue.question_response_delivery_failed"
: "issue.question_response_delivered",
entityType: "issue",
entityId: input.interaction.issueId,
details: {
deliveryId: row.id,
interactionId: input.interaction.id,
sourceRunId: input.interaction.sourceRunId,
targetRunId: input.targetRunId,
targetTurnId: input.targetTurnId ?? null,
correlationId: row.correlationId,
payloadSha256: row.payloadSha256,
deliveryStatus: input.status,
deliveryMode: input.mode,
adapter: input.adapter,
errorCode: input.errorCode ?? null,
},
});
return row;
});
const persisted =
updated ??
(await db
.select()
.from(issueQuestionResponseDeliveries)
.where(eq(issueQuestionResponseDeliveries.id, input.delivery.id))
.limit(1)
.then((rows) => rows[0] ?? null));
const result: DeliveryRow = persisted ?? input.delivery;
if (updated) {
getTelemetryClient()?.trackDynamic("question_response.delivery", {
adapter: input.adapter,
outcome: input.mode ?? "failed",
});
}
return {
deliveryId: result.id,
status: result.status,
mode: result.deliveryMode,
targetRunId: result.targetRunId,
targetTurnId: result.targetTurnId,
duplicate: !updated,
};
}
async function releaseForRetry(
delivery: DeliveryRow,
errorCode: string,
options: { bounded: boolean } = { bounded: true },
) {
const at = now();
const nextErrorCount = delivery.errorCount + (options.bounded ? 1 : 0);
const exhausted =
options.bounded && nextErrorCount >= MAX_DELIVERY_ATTEMPTS;
await db
.update(issueQuestionResponseDeliveries)
.set({
// Keep an exhausted claim owned until recordTerminal commits its outcome.
status: exhausted ? "delivering" : "pending",
...(options.bounded ? { errorCount: nextErrorCount } : {}),
lastErrorCode: errorCode,
updatedAt: at,
})
.where(
and(
eq(issueQuestionResponseDeliveries.id, delivery.id),
eq(issueQuestionResponseDeliveries.status, "delivering"),
eq(
issueQuestionResponseDeliveries.attemptCount,
delivery.attemptCount,
),
),
);
return exhausted;
}
async function withClaimLease<T>(
delivery: DeliveryRow,
operation: () => Promise<T>,
): Promise<T> {
let stopped = false;
let renewal = Promise.resolve();
const timer = setInterval(() => {
renewal = renewal
.then(async () => {
if (stopped) return;
const renewedAt = now();
const renewed = await db
.update(issueQuestionResponseDeliveries)
.set({
lastAttemptAt: renewedAt,
updatedAt: renewedAt,
})
.where(
and(
eq(issueQuestionResponseDeliveries.id, delivery.id),
eq(issueQuestionResponseDeliveries.status, "delivering"),
eq(
issueQuestionResponseDeliveries.attemptCount,
delivery.attemptCount,
),
),
)
.returning({ id: issueQuestionResponseDeliveries.id });
if (renewed.length === 0) stopped = true;
})
.catch((error) => {
logger.warn(
{ err: error, deliveryId: delivery.id },
"question response claim lease renewal failed",
);
});
}, claimRefreshMs);
timer.unref?.();
let result: T | undefined;
let operationError: unknown;
try {
result = await operation();
} catch (error) {
operationError = error;
} finally {
stopped = true;
clearInterval(timer);
await renewal;
}
// `attemptCount` is the claim generation. A stale worker must not continue
// after a sweep has reclaimed the row for a newer attempt, even if its
// external side effect eventually resolves. Confirm ownership after the
// side effect so a rejected native steer cannot fall through to a second
// wake after losing its claim.
let ownsClaim = false;
try {
ownsClaim = await db
.select({ id: issueQuestionResponseDeliveries.id })
.from(issueQuestionResponseDeliveries)
.where(
and(
eq(issueQuestionResponseDeliveries.id, delivery.id),
eq(issueQuestionResponseDeliveries.status, "delivering"),
eq(
issueQuestionResponseDeliveries.attemptCount,
delivery.attemptCount,
),
),
)
.limit(1)
.then((rows) => rows.length === 1);
} catch (error) {
logger.warn(
{ err: error, deliveryId: delivery.id },
"question response claim ownership check failed",
);
throw new DeliveryClaimUnavailableError();
}
if (!ownsClaim) throw new DeliveryClaimUnavailableError();
if (operationError !== undefined) throw operationError;
return result as T;
}
async function findDurableWakeRequest(input: {
companyId: string;
idempotencyKey: string;
}) {
const request = await db
.select({
agentId: agentWakeupRequests.agentId,
id: agentWakeupRequests.id,
runId: agentWakeupRequests.runId,
status: agentWakeupRequests.status,
})
.from(agentWakeupRequests)
.where(
and(
eq(agentWakeupRequests.companyId, input.companyId),
eq(agentWakeupRequests.idempotencyKey, input.idempotencyKey),
inArray(agentWakeupRequests.status, [
...DURABLE_WAKE_REQUEST_STATUSES,
]),
),
)
.orderBy(desc(agentWakeupRequests.createdAt))
.limit(1)
.then((rows) => rows[0] ?? null);
if (!request?.runId) return request ? { request, run: null } : null;
const run = await db
.select()
.from(heartbeatRuns)
.where(
and(
eq(heartbeatRuns.id, request.runId),
eq(heartbeatRuns.companyId, input.companyId),
eq(heartbeatRuns.agentId, request.agentId),
),
)
.limit(1)
.then((rows) => rows[0] ?? null);
return { request, run };
}
async function deliver(
interactionId: string,
): Promise<QuestionResponseDeliveryOutcome | null> {
const claimed = await claim(interactionId);
if (!claimed) return terminalOutcome(interactionId);
const interaction = await db
.select()
.from(issueThreadInteractions)
.where(
and(
eq(issueThreadInteractions.id, interactionId),
eq(issueThreadInteractions.companyId, claimed.companyId),
eq(issueThreadInteractions.issueId, claimed.issueId),
),
)
.limit(1)
.then((rows) => rows[0] ?? null);
if (
!interaction ||
interaction.kind !== "ask_user_questions" ||
interaction.status !== "answered"
) {
return recordTerminal({
delivery: claimed,
interaction:
interaction ??
({
id: interactionId,
companyId: claimed.companyId,
issueId: claimed.issueId,
sourceRunId: claimed.sourceRunId,
resolvedByAgentId: null,
} as QuestionInteractionRow),
status: "failed",
mode: null,
targetRunId: null,
adapter: "unknown",
errorCode: "question_response_interaction_invalid",
});
}
const [issue, agent, sourceRun, externalInteractionPublication] =
await Promise.all([
db
.select()
.from(issues)
.where(
and(
eq(issues.id, interaction.issueId),
eq(issues.companyId, interaction.companyId),
),
)
.limit(1)
.then((rows) => rows[0] ?? null),
interaction.createdByAgentId
? db
.select({ adapterType: agents.adapterType })
.from(agents)
.where(
and(
eq(agents.id, interaction.createdByAgentId),
eq(agents.companyId, interaction.companyId),
),
)
.limit(1)
.then((rows) => rows[0] ?? null)
: Promise.resolve(null),
interaction.sourceRunId
? db
.select()
.from(heartbeatRuns)
.where(
and(
eq(heartbeatRuns.id, interaction.sourceRunId),
eq(heartbeatRuns.companyId, interaction.companyId),
),
)
.limit(1)
.then((rows) => rows[0] ?? null)
: Promise.resolve(null),
db
.select({ id: chatPublications.id })
.from(chatPublications)
.where(
and(
eq(chatPublications.companyId, interaction.companyId),
eq(chatPublications.issueId, interaction.issueId),
eq(
sql<string>`${chatPublications.payload}->>'interactionId'`,
interaction.id,
),
),
)
.limit(1)
.then((rows) => rows[0] ?? null),
]);
const adapter = agent?.adapterType ?? "unknown";
if (
!issue ||
!issue.assigneeAgentId ||
issue.status === "done" ||
issue.status === "cancelled"
) {
return recordTerminal({
delivery: claimed,
interaction,
status: "failed",
mode: null,
targetRunId: null,
adapter,
errorCode: !issue
? "question_response_issue_missing"
: "question_response_target_unavailable",
});
}
const assigneeAgentId = issue.assigneeAgentId;
const inferredSourceCommentId =
sourceRun && issueIdFromRun(sourceRun) === interaction.issueId
? sourceCommentIdFromRun(sourceRun)
: null;
const sourceCommentCandidate =
interaction.sourceCommentId ?? inferredSourceCommentId;
const continuationSourceCommentId = sourceCommentCandidate
? await db
.select({ id: issueComments.id })
.from(issueComments)
.where(
and(
eq(issueComments.id, sourceCommentCandidate),
eq(issueComments.companyId, interaction.companyId),
eq(issueComments.issueId, interaction.issueId),
),
)
.limit(1)
.then((rows) => rows[0]?.id ?? null)
: null;
const liveRuns = await db
.select()
.from(heartbeatRuns)
.where(
and(
eq(heartbeatRuns.companyId, interaction.companyId),
eq(heartbeatRuns.agentId, assigneeAgentId),
inArray(heartbeatRuns.status, [
"queued",
"running",
"scheduled_retry",
]),
),
)
.orderBy(asc(heartbeatRuns.createdAt));
const issueRuns = liveRuns.filter(
(run) => issueIdFromRun(run) === interaction.issueId,
);
const issueRunIds = issueRuns.map((run) => run.id);
const interactionIdsFromRunContext = issueRuns
.map((run) => compactLine(record(run.contextSnapshot).interactionId))
.filter((value): value is string => Boolean(value));
const deliveryDerivedRuns =
issueRunIds.length > 0
? await db
.select({
interactionId: issueQuestionResponseDeliveries.interactionId,
targetRunId: issueQuestionResponseDeliveries.targetRunId,
})
.from(issueQuestionResponseDeliveries)
.where(
and(
eq(
issueQuestionResponseDeliveries.companyId,
interaction.companyId,
),
inArray(
issueQuestionResponseDeliveries.targetRunId,
issueRunIds,
),
inArray(issueQuestionResponseDeliveries.status, [
"delivering",
"delivered",
"fallback_queued",
]),
),
)
: [];
const derivedInteractionIds = [
...new Set([
...interactionIdsFromRunContext,
...deliveryDerivedRuns.map((row) => row.interactionId),
]),
];
const externallyPublishedInteractions =
derivedInteractionIds.length > 0
? await db
.select({
interactionId: sql<string>`${chatPublications.payload}->>'interactionId'`,
})
.from(chatPublications)
.where(
and(
eq(chatPublications.companyId, interaction.companyId),
eq(chatPublications.issueId, interaction.issueId),
inArray(chatPublications.state, [
"published",
"streaming",
"delivery_unknown",
]),
inArray(
sql<string>`${chatPublications.payload}->>'interactionId'`,
derivedInteractionIds,
),
),
)
: [];
const externalInteractionIds = new Set(
externallyPublishedInteractions.map((row) => row.interactionId),
);
const externallyDerivedRunIds = new Set([
...issueRuns
.filter((run) => {
const interactionId = compactLine(
record(run.contextSnapshot).interactionId,
);
return Boolean(
interactionId && externalInteractionIds.has(interactionId),
);
})
.map((run) => run.id),
...deliveryDerivedRuns
.filter((row) => externalInteractionIds.has(row.interactionId))
.map((row) => row.targetRunId)
.filter((runId): runId is string => Boolean(runId)),
]);
// A run already carrying any external-chat turn is not a safe target for
// another interaction's answer. Without per-output causality, steering or
// coalescing would mix both turns and could disclose one provider's work
// through another provider bot. Use a dedicated continuation instead.
const externalChatBoundary =
Boolean(externalInteractionPublication) ||
hasExternalChatOrigin(sourceRun) ||
issueRuns.some(hasExternalChatOrigin) ||
externallyDerivedRunIds.size > 0;
// `executionRunId` is the issue's authoritative active-run pointer. Fall
// back to the newest matching running row only for legacy/racy rows where
// the pointer has not been populated yet; choosing the oldest stale row
// could steer an answer into the wrong provider turn.
const successorRunning =
(issue.executionRunId
? issueRuns.find(
(run) =>
run.id === issue.executionRunId &&
run.status === "running" &&
run.id !== interaction.sourceRunId,
)
: null) ??
[...issueRuns]
.reverse()
.find(
(run) =>
run.status === "running" && run.id !== interaction.sourceRunId,
) ??
null;
const queuedSuccessor =
issueRuns.find(
(run) =>
(run.status === "queued" || run.status === "scheduled_retry") &&
run.id !== interaction.sourceRunId,
) ?? null;
const hydratedInteraction = hydrateQuestionInteraction(interaction);
const envelope = buildQuestionResponseDeliveryEnvelope(hydratedInteraction);
if (nativeSha256(envelope) !== claimed.payloadSha256) {
return recordTerminal({
delivery: claimed,
interaction,
status: "failed",
mode: null,
targetRunId: null,
adapter,
errorCode: "question_response_payload_digest_mismatch",
});
}
// A provider input request can keep its source process alive while it waits
// for an answer in either runtime mode. External chat answers intentionally
// continue in a fresh run so output from overlapping provider turns cannot
// be mixed. The old process must therefore release both the per-agent
// runner slot and the issue execution lock before the isolated continuation
// is enqueued. In particular, ACPX-backed local adapters may still persist
// as `legacy` runs even though their interaction is provider-native.
if (
externalChatBoundary &&
sourceRun?.id === interaction.sourceRunId &&
(sourceRun.status === "queued" || sourceRun.status === "running")
) {
try {
await withClaimLease(claimed, () =>
options.heartbeat.cancelRun(
sourceRun.id,
"Superseded by a dedicated external-chat answer continuation",
{
errorCode: "external_chat_continuation",
resultJson: {
interactionId: interaction.id,
externalChatContinuation: true,
},
eventMessage:
"source run cancelled for isolated external-chat answer continuation",
eventPayload: { interactionId: interaction.id },
terminationGraceMs: 2_000,
suppressImmediateRecovery: true,
},
),
);
} catch (error) {
if (error instanceof DeliveryClaimUnavailableError)
return terminalOutcome(interactionId);
const errorCode =
error instanceof Error && compactLine(error.message)
? compactLine(error.message)!.slice(0, 160)
: "external_chat_source_run_cancellation_failed";
const exhausted = await releaseForRetry(claimed, errorCode);
logger.warn(
{
err: error,
deliveryId: claimed.id,
interactionId,
sourceRunId: sourceRun.id,
attemptCount: claimed.attemptCount,
errorCount: claimed.errorCount + 1,
exhausted,
},
"external-chat answer continuation will retry after source run cancellation failure",
);
if (!exhausted) return null;
return recordTerminal({
delivery: claimed,
interaction,
status: "failed",
mode: null,
targetRunId: sourceRun.id,
adapter,
errorCode,
});
}
}
if (resolveNativeQuestion && !externalChatBoundary) {
try {
const nativeDisposition = await withClaimLease(claimed, () =>
resolveNativeQuestion(hydratedInteraction),
);
if (nativeDisposition === "queued") {
return recordTerminal({
delivery: claimed,
interaction,
status: "delivered",
mode: "steered",
targetRunId: interaction.sourceRunId,
adapter,
});
}
if (nativeDisposition === "pending") {
await releaseForRetry(
claimed,
"native_question_session_unavailable",
{ bounded: false },
);
return null;
}
} catch (error) {
if (error instanceof DeliveryClaimUnavailableError)
return terminalOutcome(interactionId);
const errorCode =
error instanceof Error && compactLine(error.message)
? compactLine(error.message)!.slice(0, 160)
: "native_question_delivery_failed";
const exhausted = await releaseForRetry(claimed, errorCode);
logger.warn(
{
err: error,
deliveryId: claimed.id,
interactionId,
attemptCount: claimed.attemptCount,
errorCount: claimed.errorCount + 1,
exhausted,
},
"native question response delivery will retry",
);
if (!exhausted) return null;
return recordTerminal({
delivery: claimed,
interaction,
status: "failed",
mode: null,
targetRunId: interaction.sourceRunId,
adapter,
errorCode,
});
}
}
// An answer to an older question is new input, not implicit permission to
// steer another active turn. Only the queue's explicit Steer action delivers it.
const steeringErrorCode = successorRunning && externalChatBoundary
? "steering_external_chat_context_incompatible" : null;
const actor = actorForInteraction(interaction);
// This is a new, migration-fenced namespace. The partial unique index on
// agent_wakeup_requests makes the wake transaction itself idempotent, so a
// reclaimed stale worker cannot create a second continuation run.
const wakeIdempotencyKey = `question-response:${interaction.id}`;
try {
const existingWake = await findDurableWakeRequest({
companyId: interaction.companyId,
idempotencyKey: wakeIdempotencyKey,
});
const wakeRun =
existingWake?.run ??
(existingWake
? null
: await withClaimLease(claimed, () =>
options.heartbeat.wakeup(assigneeAgentId, {
source: "automation",
triggerDetail: "system",
reason: "issue_commented",
payload: {
issueId: issue.id,
interactionId: interaction.id,
interactionKind: interaction.kind,
interactionStatus: interaction.status,
sourceCommentId: continuationSourceCommentId,
sourceRunId: interaction.sourceRunId,
externalChatContinuation: externalChatBoundary,
...(continuationSourceCommentId
? {
wakeCommentId: continuationSourceCommentId,
wakeCommentIds: [continuationSourceCommentId],
}
: {}),
mutation: "interaction",
},
idempotencyKey: wakeIdempotencyKey,
allowRunCoalescing: !externalChatBoundary,
requestedByActorType: actor.actorType,
requestedByActorId: actor.actorId,
contextSnapshot: {
issueId: issue.id,
taskId: issue.id,
interactionId: interaction.id,
interactionKind: interaction.kind,
interactionStatus: interaction.status,
sourceCommentId: continuationSourceCommentId,
sourceRunId: interaction.sourceRunId,
externalChatContinuation: externalChatBoundary,
...(continuationSourceCommentId
? {
wakeCommentId: continuationSourceCommentId,
wakeCommentIds: [continuationSourceCommentId],
}
: {}),
wakeReason: "issue_commented",
source: "issue.interaction.respond",
},
}),
));
const durableWake =
existingWake ??
(wakeRun
? null
: await findDurableWakeRequest({
companyId: interaction.companyId,
idempotencyKey: wakeIdempotencyKey,
}));
if (!wakeRun && !durableWake) {
const errorCode = "question_response_wake_skipped";
// Scheduling suppression is an availability state, not a delivery
// failure. Keep the durable receipt retryable until the suppression is
// lifted; the bounded limit remains reserved for actual wake errors.
await releaseForRetry(claimed, errorCode, { bounded: false });
return null;
}
const eligibleQueuedSuccessor = externalChatBoundary
? null
: queuedSuccessor;
const targetRun =
wakeRun ?? durableWake?.run ?? eligibleQueuedSuccessor ?? null;
const coalesced = Boolean(
eligibleQueuedSuccessor && targetRun?.id === eligibleQueuedSuccessor.id,
);
return recordTerminal({
delivery: claimed,
interaction,
status: coalesced ? "delivered" : "fallback_queued",
mode: coalesced ? "coalesced" : "wake_fallback",
targetRunId: targetRun?.id ?? null,
adapter: targetRun?.driverKind ?? adapter,
errorCode: steeringErrorCode,
});
} catch (error) {
if (error instanceof DeliveryClaimUnavailableError)
return terminalOutcome(interactionId);
if (
isUniqueViolation(error, QUESTION_RESPONSE_WAKE_IDEMPOTENCY_CONSTRAINT)
) {
// A concurrent claimant won the transactional wake fence after our
// preflight lookup. Reuse its committed receipt instead of consuming
// an error retry or issuing another continuation.
const durableWake = await findDurableWakeRequest({
companyId: interaction.companyId,
idempotencyKey: wakeIdempotencyKey,
});
if (durableWake) {
const eligibleQueuedSuccessor = externalChatBoundary
? null
: queuedSuccessor;
const targetRun = durableWake.run ?? eligibleQueuedSuccessor ?? null;
const coalesced = Boolean(
eligibleQueuedSuccessor &&
targetRun?.id === eligibleQueuedSuccessor.id,
);
return recordTerminal({
delivery: claimed,
interaction,
status: coalesced ? "delivered" : "fallback_queued",
mode: coalesced ? "coalesced" : "wake_fallback",
targetRunId: targetRun?.id ?? null,
adapter: targetRun?.driverKind ?? adapter,
errorCode: steeringErrorCode,
});
}
}
const errorCode =
error instanceof Error && compactLine(error.message)
? compactLine(error.message)!.slice(0, 160)
: "question_response_wake_failed";
const exhausted = await releaseForRetry(claimed, errorCode);
logger.warn(
{
err: error,
deliveryId: claimed.id,
interactionId,
attemptCount: claimed.attemptCount,
errorCount: claimed.errorCount + 1,
exhausted,
},
"question response delivery will retry after wake failure",
);
if (!exhausted) return null;
return recordTerminal({
delivery: claimed,
interaction,
status: "failed",
mode: null,
targetRunId: null,
adapter,
errorCode,
});
}
}
async function sweepPending(limit = 50) {
const sweepAt = now();
const staleAt = new Date(sweepAt.getTime() - claimStaleMs);
await db
.update(issueQuestionResponseDeliveries)
.set({
status: "pending",
updatedAt: sweepAt,
})
.where(
and(
eq(issueQuestionResponseDeliveries.status, "delivering"),
or(
isNull(issueQuestionResponseDeliveries.lastAttemptAt),
lte(issueQuestionResponseDeliveries.lastAttemptAt, staleAt),
),
),
);
const ids = await db
.select({ interactionId: issueQuestionResponseDeliveries.interactionId })
.from(issueQuestionResponseDeliveries)
.where(eq(issueQuestionResponseDeliveries.status, "pending"))
.orderBy(asc(issueQuestionResponseDeliveries.createdAt))
.limit(limit)
.then((rows) => rows.map((row) => row.interactionId));
const counts = {
scanned: ids.length,
steered: 0,
coalesced: 0,
wakeFallback: 0,
failed: 0,
};
for (const id of ids) {
const outcome = await deliver(id);
if (outcome?.mode === "steered") counts.steered += 1;
else if (outcome?.mode === "coalesced") counts.coalesced += 1;
else if (outcome?.mode === "wake_fallback") counts.wakeFallback += 1;
else if (outcome?.status === "failed") counts.failed += 1;
}
return counts;
}
async function hasPending() {
return (await db.select({ id: issueQuestionResponseDeliveries.id }).from(issueQuestionResponseDeliveries)
.where(inArray(issueQuestionResponseDeliveries.status, ["pending", "delivering"])).limit(1)).length > 0;
}
return { deliver, sweepPending, hasPending };
}