Files
PaperClipAI/server/src/__tests__/question-response-delivery.test.ts
T
DottaandPaperclip 5f0da562db fix(server): wake chat lifecycle milestones from committed changes (#17606)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Connected chats show safe notices when a run starts, waits,
finishes, or fails.
> - A recurring scan projected these notices even when no eligible work
existed.
> - Eligibility depends on committed run state, conversation lineage,
and current authority.
> - Existing database rows can reconstruct that work after restart.
> - This PR wakes a scoped worker from those writes and removes
lifecycle polling.
> - Native progress events keep their separate existing owner until the
next migration.

## Linked Issues or Issue Description

**What happened?**

The chat maintenance timer repeatedly scanned run lifecycle state. Empty
and settled instances still queried the database. A run-status event
alone cannot replace the scan: prompt receipts, continuation receipts,
identity changes, and restored authority can make a run eligible later.

**What did you expect?**

Committed changes wake projection. Startup reconstructs eligible work. A
completed pass stops until another relevant change arrives. Failed work
retains recovery without scanning settled history forever.

**Steps to reproduce**

Configure an automatic chat endpoint. Finish its work, or leave it
unused. Observe recurring lifecycle projection queries from the chat
maintenance callback.

Stacked on #17592. Related foundation: #15625. This PR owns lifecycle
milestones only.

## What Changed

- Preserve upstream coalesced Cloud membership writes together with
locked membership restoration and its committed chat notification.

- Signal milestone eligibility from the real Slack account-link
transaction.

- Register the lifecycle worker with the existing delivery coordinator.
Remove lifecycle projection from the periodic chat callback. Keep native
progress in a separately named lane and preserve the explicit combined
API.
- Reconstruct company/issue scopes from the existing selector. Drain
bounded batches with company fairness. Retry failures, retain writes
through drain/resume, and disarm settled work.
- Signal from supported run, presentation, interaction, receipt,
lineage, conversation, recovery, and authority writers. Preserve their
transaction ownership, including nested savepoints and uncertain
settlement. No new table is added.
- Preserve provider authorization, authored-final suppression,
responsible-user continuity, deduplication, the 24-hour selection
window, and raw-output restrictions. Keep provider interpretation in its
owner.
- Preserve PostgreSQL timestamp precision in lifecycle pagination.
Rejected submillisecond candidates must not repeat the same page and
starve later notices.
- Document producer coverage and alternate-writer dispositions in
`doc/plans/2026-10-25-chat-run-milestone-sleep-audit.md`.

## Verification

Published head: `1d056f68c5b1005933b9e12de8745bf1c4cbeeca`, targeting
master after #17592 merged at
`7d75ae0569e41786640cf09647ae8849411d2f22`. A normal merge integrates
the actual landed parent. The entire 77-path milestone patch is
binary-identical to the locally verified preparation across that
ancestry reconciliation; both unrelated master paths are preserved. The
four earlier producer/test integration conflicts retain scoped milestone
and voice notices, current onboarding completion admission, and expanded
identity query/read-scope coverage.

- **330 distinct selected cases pass on the verified unchanged patch:**
305 across 14 complete suites (all five milestone worker suites, run
identity, board claim, Cloud provisioning, auth session routes, Cloud
actor authentication, stale-lock recovery, GitHub credentials, project
Git authorization, and app admission wiring), plus 25 selected real chat
producer cases. The remaining 1,590 chat integration cases were skipped,
not passed.
- The real producer cases cover saved milestone discovery, GitHub and
Slack identity changes, account-link rollback/reconfirmation, ordinary
ingress reactivation, post-close action/delivery receipt settlement, all
ten authority-restoration paths including Cloud synchronization, and
changed native review metadata.
- Worker coverage verifies outer commit, rollback, uncertain-write
recovery, restart, bounded batching/fairness, timestamp precision,
retries, drain/resume, and settled SQL quiet. Authorization and existing
publication deduplication remain with their owning services.
- Server production typechecking, build, and module-boundary checks
pass. The tests above were executed separately. Production typechecking
excludes `src/__tests__` and does not replace those runs. Each database
owner uses its own newly created and app-migrated PostgreSQL fixture.
- [Current-parent acceptance and preserved failure
ledger](https://github.com/paperclipai/paperclip/blob/1d056f68c5b1005933b9e12de8745bf1c4cbeeca/doc/plans/2026-10-25-chat-run-milestone-sleep-audit.md#current-parent-integration-and-acceptance-october-28)
records commands, counts, producer scope, conflict dispositions, and
limits. Earlier combined-stack counts and failures keep their original
revision scope; local acceptance does not erase old CI failures.
- No new migration, queue table, dependency, workflow, or shared
scheduler contract is introduced. Parent migration 0397, bounded consent
recovery, voice cleanup/retention repairs, and runner checkpoint
restoration remain present.
- **Exact-head Greptile is 5/5 and all 55 current checks are clean.** No
Ponytail review is present, which is an explicitly authorized
nonblocker; no failing review is waived. Older reviews and parent checks
are not current passes. Actual failing Ponytail findings must be fixed;
an absent/stopped/paused turn without a verdict is an authorized
nonblocker. Active unfinished Ponytail uses its original request/start
timer, with a 25-minute monitor cutoff respecting the user's 30-minute
maximum.
- No complete local repository matrix, live provider tenant, external
alarm, physical host/database suspension, or fleet savings claim is
made. Native progress remains a separate following slice.

## Risks

- A future eligibility writer must notify the existing projection
boundary. Independent SQL writers or another active server process are
outside this process-local signal contract.
- Authority and lineage remain sensitive. The worker uses the existing
selectors and publication policy; it does not grant execution or
disclosure authority.
- Native progress and other publication maintenance still have recurring
work. This PR removes one reason, not the entire chat maintenance timer.
- Worker quiet does not prove database suspension, host sleep, or
external alarm coverage. Cloud sleep blockers remain unchanged.
- Merge eligibility requires passing current-head CI and Greptile 5/5
after this actual-master reconciliation. Subsequent stack slices retain
their own gates.

## Model Used

OpenAI Codex, GPT-6 family. The exact serving model ID and
context-window size are not exposed. Used repository inspection,
reasoning, shell execution, PostgreSQL tests, browser E2Es and GitHub
tools.

## 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 available in this session)
- [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 the documented focused 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-28 11:07:54 -05:00

1251 lines
40 KiB
TypeScript

import { randomUUID } from "node:crypto";
import { eq } from "drizzle-orm";
import {
afterAll,
afterEach,
beforeAll,
describe,
expect,
it,
vi,
} from "vitest";
import {
activityLog,
agentWakeupRequests,
agents,
companies,
createDb,
goals,
heartbeatRuns,
issueComments,
issueQuestionResponseDeliveries,
issueThreadInteractions,
issues,
} from "@paperclipai/db";
import {
getEmbeddedPostgresTestSupport,
startEmbeddedPostgresTestDatabase,
} from "./helpers/embedded-postgres.js";
import { resolveExternalTestDatabaseUrl } from "./helpers/external-test-database.js";
import { issueThreadInteractionService } from "../services/issue-thread-interactions.js";
import {
buildQuestionResponseDeliveryEnvelope,
formatQuestionResponseSteeringMessage,
questionResponseDeliveryService,
} from "../services/question-response-delivery.js";
const externalDatabaseUrl = resolveExternalTestDatabaseUrl("PAPERCLIP_QUESTION_DELIVERY_TEST_DATABASE_URL");
const embeddedPostgresSupport = externalDatabaseUrl ? { supported: true } : await getEmbeddedPostgresTestSupport();
const describeEmbeddedPostgres = embeddedPostgresSupport.supported
? describe
: describe.skip;
const DIRECT_ADAPTER_TYPES = [
"acpx_local",
"claude_local",
"codex_local",
"cursor_cloud",
"cursor",
"gemini_local",
"grok_local",
"hermes_gateway",
"hermes_local",
"kimi_local",
"openclaw_gateway",
"opencode_local",
"pi_local",
"process",
"http",
"external_test_adapter",
] as const;
describeEmbeddedPostgres("question response delivery", () => {
let db!: ReturnType<typeof createDb>;
let tempDb: Awaited<
ReturnType<typeof startEmbeddedPostgresTestDatabase>
> | null = null;
beforeAll(async () => {
if (!externalDatabaseUrl) {
tempDb = await startEmbeddedPostgresTestDatabase("paperclip-question-delivery-");
}
db = createDb(externalDatabaseUrl ?? tempDb!.connectionString);
}, 20_000);
afterEach(async () => {
await db.delete(issueQuestionResponseDeliveries);
await db.delete(issueThreadInteractions);
await db.delete(issueComments);
await db.delete(activityLog);
await db.delete(heartbeatRuns);
await db.delete(agentWakeupRequests);
await db.delete(issues);
await db.delete(goals);
await db.delete(agents);
await db.delete(companies);
});
afterAll(async () => {
await db?.$client.end();
await tempDb?.cleanup();
});
async function seed(
args: {
adapterType?: string;
runtimeMode?: "legacy" | "native";
sourceStatus?: string;
successorStatus?: "queued" | "running";
sourceCommentBody?: string;
attachSourceCommentToInteraction?: boolean;
} = {},
) {
const companyId = randomUUID();
const agentId = randomUUID();
const goalId = randomUUID();
const issueId = randomUUID();
const sourceRunId = randomUUID();
const successorRunId = args.successorStatus ? randomUUID() : null;
await db.insert(companies).values({
id: companyId,
name: "Question delivery",
issuePrefix: `Q${companyId.replace(/-/g, "").slice(0, 6).toUpperCase()}`,
requireBoardApprovalForNewAgents: false,
});
await db.insert(agents).values({
id: agentId,
companyId,
name: "Runner",
role: "engineer",
status: "active",
adapterType: args.adapterType ?? "codex_local",
adapterConfig: {},
runtimeConfig: {},
permissions: {},
});
await db.insert(goals).values({
id: goalId,
companyId,
title: "Test",
level: "task",
status: "active",
});
await db.insert(issues).values({
id: issueId,
companyId,
goalId,
title: "Deliver answers",
status: "in_progress",
priority: "medium",
assigneeAgentId: agentId,
});
await db.insert(heartbeatRuns).values({
id: sourceRunId,
companyId,
agentId,
invocationSource: "manual",
status: args.sourceStatus ?? "succeeded",
runtimeMode: args.runtimeMode ?? "native",
driverKind: "codex",
contextSnapshot: { issueId },
...(args.sourceStatus === "running"
? { startedAt: new Date() }
: { finishedAt: new Date() }),
});
if (successorRunId && args.successorStatus) {
await db.insert(heartbeatRuns).values({
id: successorRunId,
companyId,
agentId,
invocationSource: "manual",
status: args.successorStatus,
runtimeMode: args.runtimeMode ?? "native",
driverKind: "codex",
contextSnapshot: { issueId },
...(args.successorStatus === "running"
? { startedAt: new Date() }
: {}),
});
}
const sourceCommentId = args.sourceCommentBody ? randomUUID() : null;
if (sourceCommentId) {
await db.insert(issueComments).values({
id: sourceCommentId,
companyId,
issueId,
authorUserId: "external-user",
body: args.sourceCommentBody!,
});
}
const interactionSvc = issueThreadInteractionService(db);
const interaction = await interactionSvc.create(
{ id: issueId, companyId },
{
kind: "ask_user_questions",
continuationPolicy: "wake_assignee",
sourceCommentId:
args.attachSourceCommentToInteraction === false
? null
: sourceCommentId,
sourceRunId,
payload: {
version: 1,
title: "Server choices",
questions: [
{
id: "purpose",
prompt: "What is it for?",
selectionMode: "single",
required: true,
options: [
{ id: "custom", label: "Write an answer", freeText: true },
],
},
{
id: "runtime",
prompt: "Which runtime?",
selectionMode: "single",
required: true,
options: [
{ id: "node", label: "Node.js" },
{ id: "bun", label: "Bun" },
],
},
{
id: "features",
prompt: "Which features?",
selectionMode: "multi",
allowOther: true,
options: [
{ id: "health", label: "Health check" },
{ id: "logs", label: "Request logs" },
],
},
],
questionSet: {
schema: "paperclip.question_set.v1",
title: "Server choices",
questions: [
{
id: "purpose",
header: "Purpose",
prompt: "What is it for?",
required: true,
answerMode: "text",
},
{
id: "runtime",
header: "Runtime",
prompt: "Which runtime?",
required: true,
answerMode: "single_select",
options: [
{ id: "node", label: "Node.js" },
{ id: "bun", label: "Bun" },
],
},
{
id: "features",
header: "Features",
prompt: "Which features?",
required: false,
answerMode: "multi_select",
options: [
{ id: "health", label: "Health check" },
{ id: "logs", label: "Request logs" },
],
customAnswer: { enabled: true, label: "Other" },
},
],
},
},
},
{ agentId, runId: sourceRunId },
);
const answered = await interactionSvc.answerQuestions(
{ id: issueId, companyId, status: "in_progress" },
interaction.id,
{
answers: [
{ questionId: "purpose", optionIds: [], otherText: "Internal API" },
{ questionId: "runtime", optionIds: ["node"] },
{
questionId: "features",
optionIds: ["health", "logs"],
otherText: "Metrics",
},
],
},
{ userId: "board-user" },
);
return {
companyId,
agentId,
issueId,
sourceRunId,
sourceCommentId,
successorRunId,
interaction: answered,
};
}
it("queues an answer to a running successor instead of automatically steering", async () => {
const seeded = await seed({ successorStatus: "running" });
const steer = vi.fn().mockResolvedValue({ turnId: "unexpected" });
const wakeup = vi.fn().mockImplementation(async () => {
await db.insert(agentWakeupRequests).values({ companyId: seeded.companyId, agentId: seeded.agentId,
source: "automation", reason: "issue_commented", status: "deferred_issue_execution",
idempotencyKey: `question-response:${seeded.interaction.id}`,
payload: { issueId: seeded.issueId, mutation: "interaction", interactionId: seeded.interaction.id,
interactionStatus: "answered" } });
return null;
});
const service = questionResponseDeliveryService(db, { heartbeat: { wakeup } as never, steer });
const first = await service.deliver(seeded.interaction.id);
const second = await service.deliver(seeded.interaction.id);
expect(steer).not.toHaveBeenCalled();
expect(wakeup).toHaveBeenCalledTimes(1);
expect(wakeup).toHaveBeenCalledWith(seeded.agentId, expect.objectContaining({
payload: expect.objectContaining({ interactionId: seeded.interaction.id, interactionStatus: "answered" }),
}));
expect(first).toMatchObject({ status: "fallback_queued", mode: "wake_fallback" });
expect(second).toMatchObject({ mode: "wake_fallback", duplicate: true });
});
it.each(["native", "legacy"] as const)(
"never mixes an external-chat question response into another live chat run in %s mode",
async (runtimeMode) => {
const seeded = await seed({
runtimeMode,
sourceStatus: "running",
successorStatus: "running",
sourceCommentBody:
"External request whose complete trailing instructions must survive the response continuation.",
attachSourceCommentToInteraction: false,
});
if (!seeded.sourceCommentId) {
throw new Error("Expected a source comment for the external-chat run");
}
expect(seeded.interaction.sourceCommentId).toBeNull();
await db
.update(heartbeatRuns)
.set({
contextSnapshot: {
issueId: seeded.issueId,
source: "chat:slack",
commentId: seeded.sourceCommentId,
wakeCommentId: seeded.sourceCommentId,
wakeCommentIds: [seeded.sourceCommentId],
},
})
.where(eq(heartbeatRuns.id, seeded.sourceRunId));
await db
.update(heartbeatRuns)
.set({
contextSnapshot: {
issueId: seeded.issueId,
source: "chat:telegram",
wakeCommentId: randomUUID(),
},
})
.where(eq(heartbeatRuns.id, seeded.successorRunId!));
await db
.update(issues)
.set({ executionRunId: seeded.successorRunId })
.where(eq(issues.id, seeded.issueId));
const [dedicatedRun] = await db
.insert(heartbeatRuns)
.values({
id: randomUUID(),
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "queued",
runtimeMode: "native",
driverKind: "codex",
contextSnapshot: {
issueId: seeded.issueId,
interactionId: seeded.interaction.id,
sourceRunId: seeded.sourceRunId,
source: "issue.interaction.respond",
},
})
.returning();
if (!dedicatedRun) throw new Error("Expected dedicated continuation run");
const wakeup = vi.fn().mockResolvedValue(dedicatedRun);
const cancelRun = vi.fn().mockResolvedValue({
id: seeded.sourceRunId,
status: "cancelled",
});
const steer = vi.fn();
const resolveNativeQuestion = vi
.fn()
.mockResolvedValue("queued" as const);
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup, cancelRun } as never,
steer,
resolveNativeQuestion,
}).deliver(seeded.interaction.id);
expect(resolveNativeQuestion).not.toHaveBeenCalled();
expect(steer).not.toHaveBeenCalled();
expect(cancelRun).toHaveBeenCalledWith(
seeded.sourceRunId,
"Superseded by a dedicated external-chat answer continuation",
expect.objectContaining({
errorCode: "external_chat_continuation",
resultJson: expect.objectContaining({
interactionId: seeded.interaction.id,
externalChatContinuation: true,
}),
terminationGraceMs: 2_000,
}),
);
expect(cancelRun.mock.invocationCallOrder[0]).toBeLessThan(
wakeup.mock.invocationCallOrder[0]!,
);
expect(wakeup).toHaveBeenCalledWith(
seeded.agentId,
expect.objectContaining({
allowRunCoalescing: false,
idempotencyKey: `question-response:${seeded.interaction.id}`,
payload: expect.objectContaining({
externalChatContinuation: true,
sourceCommentId: seeded.sourceCommentId,
wakeCommentId: seeded.sourceCommentId,
wakeCommentIds: [seeded.sourceCommentId],
}),
contextSnapshot: expect.objectContaining({
externalChatContinuation: true,
sourceCommentId: seeded.sourceCommentId,
wakeCommentId: seeded.sourceCommentId,
wakeCommentIds: [seeded.sourceCommentId],
}),
}),
);
expect(outcome).toMatchObject({
status: "fallback_queued",
mode: "wake_fallback",
targetRunId: dedicatedRun.id,
});
expect(dedicatedRun.id).not.toBe(seeded.sourceRunId);
const [delivery] = await db
.select()
.from(issueQuestionResponseDeliveries);
expect(delivery).toMatchObject({
lastErrorCode: "steering_external_chat_context_incompatible",
targetRunId: dedicatedRun.id,
});
},
);
it("does not promote a source-run wake comment from another issue", async () => {
const seeded = await seed();
const goalId = await db
.select({ goalId: issues.goalId })
.from(issues)
.where(eq(issues.id, seeded.issueId))
.then((rows) => rows[0]?.goalId);
if (!goalId) throw new Error("Expected source issue goal");
const otherIssueId = randomUUID();
const otherCommentId = randomUUID();
await db.insert(issues).values({
id: otherIssueId,
companyId: seeded.companyId,
goalId,
title: "Unrelated issue",
status: "todo",
priority: "medium",
});
await db.insert(issueComments).values({
id: otherCommentId,
companyId: seeded.companyId,
issueId: otherIssueId,
authorUserId: "external-user",
body: "This other issue must remain outside the continuation.",
});
await db
.update(heartbeatRuns)
.set({
contextSnapshot: {
issueId: seeded.issueId,
source: "chat:slack",
wakeCommentId: otherCommentId,
wakeCommentIds: [otherCommentId],
},
})
.where(eq(heartbeatRuns.id, seeded.sourceRunId));
const fallbackRunId = randomUUID();
await db.insert(heartbeatRuns).values({
id: fallbackRunId,
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "queued",
runtimeMode: "native",
driverKind: "codex",
contextSnapshot: {
issueId: seeded.issueId,
interactionId: seeded.interaction.id,
source: "issue.interaction.respond",
},
});
const wakeup = vi.fn().mockResolvedValue({
id: fallbackRunId,
driverKind: "codex",
});
const resolveNativeQuestion = vi.fn().mockResolvedValue("queued" as const);
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
resolveNativeQuestion,
}).deliver(seeded.interaction.id);
expect(resolveNativeQuestion).not.toHaveBeenCalled();
expect(outcome).toMatchObject({
mode: "wake_fallback",
targetRunId: fallbackRunId,
});
const wakeOptions = wakeup.mock.calls[0]?.[1];
expect(wakeOptions?.payload).toMatchObject({ sourceCommentId: null });
expect(wakeOptions?.payload).not.toHaveProperty("wakeCommentId");
expect(wakeOptions?.payload).not.toHaveProperty("wakeCommentIds");
expect(wakeOptions?.contextSnapshot).toMatchObject({
sourceCommentId: null,
});
expect(wakeOptions?.contextSnapshot).not.toHaveProperty("wakeCommentId");
expect(wakeOptions?.contextSnapshot).not.toHaveProperty("wakeCommentIds");
});
it("resolves an in-flight native input request before creating a continuation", async () => {
const seeded = await seed({
adapterType: "paperclip_runner",
runtimeMode: "native",
sourceStatus: "running",
});
const wakeup = vi.fn();
const resolveNativeQuestion = vi.fn().mockResolvedValue("queued" as const);
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
resolveNativeQuestion,
}).deliver(seeded.interaction.id);
expect(outcome).toMatchObject({
status: "delivered",
mode: "steered",
targetRunId: seeded.sourceRunId,
});
expect(resolveNativeQuestion).toHaveBeenCalledWith(
expect.objectContaining({
id: seeded.interaction.id,
status: "answered",
}),
);
expect(wakeup).not.toHaveBeenCalled();
});
it("keeps native input delivery pending while its PRP session is unavailable", async () => {
const seeded = await seed({
adapterType: "paperclip_runner",
runtimeMode: "native",
sourceStatus: "running",
});
const wakeup = vi.fn();
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
resolveNativeQuestion: vi.fn().mockResolvedValue("pending" as const),
}).deliver(seeded.interaction.id);
expect(outcome).toBeNull();
expect(wakeup).not.toHaveBeenCalled();
const [delivery] = await db.select().from(issueQuestionResponseDeliveries);
expect(delivery).toMatchObject({
status: "pending",
attemptCount: 1,
errorCount: 0,
lastErrorCode: "native_question_session_unavailable",
});
});
it("coalesces into a queued successor without creating another wake", async () => {
const seeded = await seed({ successorStatus: "queued" });
const successor = await db
.select()
.from(heartbeatRuns)
.where(eq(heartbeatRuns.id, seeded.successorRunId!))
.then((rows) => rows[0]!);
const wakeup = vi.fn().mockResolvedValue(successor);
const steer = vi.fn();
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer,
}).deliver(seeded.interaction.id);
expect(outcome).toMatchObject({
status: "delivered",
mode: "coalesced",
targetRunId: successor.id,
});
expect(steer).not.toHaveBeenCalled();
expect(wakeup).toHaveBeenCalledTimes(1);
expect(wakeup.mock.calls[0]?.[1]).toMatchObject({
idempotencyKey: `question-response:${seeded.interaction.id}`,
contextSnapshot: {
interactionId: seeded.interaction.id,
interactionStatus: "answered",
},
});
});
it("never steers into the source run and keeps a skipped wake retryable", async () => {
const seeded = await seed({ sourceStatus: "running" });
const wakeup = vi.fn().mockResolvedValue(null);
const steer = vi.fn();
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer,
}).deliver(seeded.interaction.id);
expect(outcome).toBeNull();
expect(steer).not.toHaveBeenCalled();
expect(wakeup).toHaveBeenCalledTimes(1);
expect(JSON.stringify(wakeup.mock.calls[0])).not.toContain("Internal API");
expect(JSON.stringify(wakeup.mock.calls[0])).not.toContain("Node.js");
const [delivery] = await db.select().from(issueQuestionResponseDeliveries);
expect(delivery).toMatchObject({
status: "pending",
attemptCount: 1,
lastErrorCode: "question_response_wake_skipped",
});
});
it("delivers after wake suppression outlasts the bounded error retry limit", async () => {
const seeded = await seed({ sourceStatus: "running" });
const fallbackRunId = randomUUID();
let wakeAttempts = 0;
const wakeup = vi.fn().mockImplementation(async () => {
wakeAttempts += 1;
if (wakeAttempts <= 5) return null;
return db
.insert(heartbeatRuns)
.values({
id: fallbackRunId,
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "queued",
runtimeMode: "legacy",
driverKind: "codex",
contextSnapshot: { issueId: seeded.issueId },
})
.returning()
.then((rows) => rows[0]!);
});
const service = questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer: vi.fn(),
});
for (let attempt = 0; attempt < 5; attempt += 1) {
await expect(service.deliver(seeded.interaction.id)).resolves.toBeNull();
}
const delivered = await service.deliver(seeded.interaction.id);
expect(delivered).toMatchObject({
status: "fallback_queued",
mode: "wake_fallback",
targetRunId: fallbackRunId,
});
const [delivery] = await db.select().from(issueQuestionResponseDeliveries);
expect(delivery).toMatchObject({
status: "fallback_queued",
attemptCount: 6,
errorCount: 0,
targetRunId: fallbackRunId,
});
});
it("preserves the actual-error retry budget after prolonged wake suppression", async () => {
const seeded = await seed({ sourceStatus: "running" });
const fallbackRunId = randomUUID();
let wakeAttempts = 0;
const wakeup = vi.fn().mockImplementation(async () => {
wakeAttempts += 1;
if (wakeAttempts <= 5) return null;
if (wakeAttempts === 6)
throw new Error("scheduler temporarily unavailable");
return db
.insert(heartbeatRuns)
.values({
id: fallbackRunId,
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "queued",
runtimeMode: "legacy",
driverKind: "codex",
contextSnapshot: { issueId: seeded.issueId },
})
.returning()
.then((rows) => rows[0]!);
});
const service = questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer: vi.fn(),
});
for (let attempt = 0; attempt < 5; attempt += 1) {
await expect(service.deliver(seeded.interaction.id)).resolves.toBeNull();
}
await expect(service.deliver(seeded.interaction.id)).resolves.toBeNull();
const [afterError] = await db
.select()
.from(issueQuestionResponseDeliveries);
expect(afterError).toMatchObject({
status: "pending",
attemptCount: 6,
errorCount: 1,
lastErrorCode: "scheduler temporarily unavailable",
});
await expect(service.deliver(seeded.interaction.id)).resolves.toMatchObject(
{
status: "fallback_queued",
targetRunId: fallbackRunId,
},
);
const [delivered] = await db.select().from(issueQuestionResponseDeliveries);
expect(delivered).toMatchObject({
status: "fallback_queued",
attemptCount: 7,
errorCount: 1,
targetRunId: fallbackRunId,
});
});
it("enforces one durable wake per question-response idempotency key", async () => {
const seeded = await seed({ sourceStatus: "running" });
const idempotencyKey = `question-response:${seeded.interaction.id}`;
const request = {
companyId: seeded.companyId,
agentId: seeded.agentId,
source: "automation",
triggerDetail: "system",
reason: "issue_commented",
idempotencyKey,
} as const;
await db
.insert(agentWakeupRequests)
.values({ ...request, status: "queued" });
await expect(
db.insert(agentWakeupRequests).values({
...request,
status: "coalesced",
}),
).rejects.toMatchObject({ cause: { code: "23505" } });
// Suppression receipts are intentionally outside the fence so the outbox
// can retry after scheduling is enabled again.
await expect(
db.insert(agentWakeupRequests).values({
...request,
status: "skipped",
finishedAt: new Date(),
}),
).resolves.toBeDefined();
});
it("reuses the winning wake when a concurrent insert hits the idempotency fence", async () => {
const seeded = await seed({ sourceStatus: "running" });
const fallbackRunId = randomUUID();
const wakeup = vi
.fn()
.mockImplementation(
async (
_agentId: string,
options: { idempotencyKey?: string | null },
) => {
const request = {
companyId: seeded.companyId,
agentId: seeded.agentId,
source: "automation",
triggerDetail: "system",
reason: "issue_commented",
idempotencyKey: options.idempotencyKey,
} as const;
const [winner] = await db
.insert(agentWakeupRequests)
.values({
...request,
status: "queued",
})
.returning();
await db.insert(heartbeatRuns).values({
id: fallbackRunId,
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "queued",
runtimeMode: "legacy",
driverKind: "codex",
wakeupRequestId: winner!.id,
contextSnapshot: { issueId: seeded.issueId },
});
await db
.update(agentWakeupRequests)
.set({ runId: fallbackRunId })
.where(eq(agentWakeupRequests.id, winner!.id));
// Model the losing claimant reaching the same transactional insert after
// the winner commits. The service must recover the winner's receipt.
await db.insert(agentWakeupRequests).values({
...request,
status: "coalesced",
});
throw new Error("unreachable");
},
);
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer: vi.fn(),
}).deliver(seeded.interaction.id);
expect(outcome).toMatchObject({
status: "fallback_queued",
mode: "wake_fallback",
targetRunId: fallbackRunId,
});
expect(wakeup).toHaveBeenCalledTimes(1);
const [delivery] = await db.select().from(issueQuestionResponseDeliveries);
expect(delivery).toMatchObject({
status: "fallback_queued",
attemptCount: 1,
errorCount: 0,
targetRunId: fallbackRunId,
});
});
it("settles against a canonical wake from the previous assignee without retrying forever", async () => {
const seeded = await seed({ sourceStatus: "running" });
const replacementAgentId = randomUUID();
await db.insert(agents).values({
id: replacementAgentId,
companyId: seeded.companyId,
name: "Replacement runner",
role: "engineer",
status: "active",
adapterType: "codex_local",
adapterConfig: {},
runtimeConfig: {},
permissions: {},
});
await db
.update(issues)
.set({ assigneeAgentId: replacementAgentId })
.where(eq(issues.id, seeded.issueId));
await db.insert(agentWakeupRequests).values({
companyId: seeded.companyId,
agentId: seeded.agentId,
source: "automation",
triggerDetail: "system",
reason: "issue_commented",
status: "queued",
idempotencyKey: `question-response:${seeded.interaction.id}`,
});
const wakeup = vi.fn();
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer: vi.fn(),
}).deliver(seeded.interaction.id);
expect(wakeup).not.toHaveBeenCalled();
expect(outcome).toMatchObject({
status: "fallback_queued",
mode: "wake_fallback",
targetRunId: null,
});
const [delivery] = await db.select().from(issueQuestionResponseDeliveries);
expect(delivery).toMatchObject({
status: "fallback_queued",
attemptCount: 1,
errorCount: 0,
});
});
it("reuses a durable wake receipt instead of issuing a duplicate continuation", async () => {
const seeded = await seed({ sourceStatus: "running" });
const [wakeRequest] = await db
.insert(agentWakeupRequests)
.values({
companyId: seeded.companyId,
agentId: seeded.agentId,
source: "automation",
triggerDetail: "system",
reason: "issue_commented",
status: "queued",
idempotencyKey: `question-response:${seeded.interaction.id}`,
})
.returning();
const [wakeRun] = await db
.insert(heartbeatRuns)
.values({
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "queued",
runtimeMode: "legacy",
wakeupRequestId: wakeRequest!.id,
contextSnapshot: { issueId: seeded.issueId },
})
.returning();
await db
.update(agentWakeupRequests)
.set({ runId: wakeRun!.id })
.where(eq(agentWakeupRequests.id, wakeRequest!.id));
const wakeup = vi.fn();
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer: vi.fn(),
}).deliver(seeded.interaction.id);
expect(outcome).toMatchObject({
status: "delivered",
mode: "coalesced",
targetRunId: wakeRun!.id,
});
expect(wakeup).not.toHaveBeenCalled();
});
it("recovers a completed wake when receipt finalization was interrupted", async () => {
const seeded = await seed({ sourceStatus: "running" });
const [wakeRequest] = await db
.insert(agentWakeupRequests)
.values({
companyId: seeded.companyId,
agentId: seeded.agentId,
source: "automation",
triggerDetail: "system",
reason: "issue_commented",
status: "completed",
idempotencyKey: `question-response:${seeded.interaction.id}`,
finishedAt: new Date(),
})
.returning();
const [wakeRun] = await db
.insert(heartbeatRuns)
.values({
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "succeeded",
runtimeMode: "legacy",
wakeupRequestId: wakeRequest!.id,
contextSnapshot: { issueId: seeded.issueId },
finishedAt: new Date(),
})
.returning();
await db
.update(agentWakeupRequests)
.set({ runId: wakeRun!.id })
.where(eq(agentWakeupRequests.id, wakeRequest!.id));
const wakeup = vi.fn();
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer: vi.fn(),
}).deliver(seeded.interaction.id);
expect(outcome).toMatchObject({
status: "fallback_queued",
mode: "wake_fallback",
targetRunId: wakeRun!.id,
});
expect(wakeup).not.toHaveBeenCalled();
const [delivery] = await db.select().from(issueQuestionResponseDeliveries);
expect(delivery).toMatchObject({
status: "fallback_queued",
errorCount: 0,
targetRunId: wakeRun!.id,
});
});
it("keeps a long wake claim leased while the side effect is active", async () => {
const seeded = await seed({ sourceStatus: "running" });
// Each call gets its own resolver. A second, unexpected call fails at
// once instead of sharing one resolver with the first call and hanging.
const wakeResolvers: Array<(value: null) => void> = [];
const wakeup = vi.fn(() => {
if (wakeResolvers.length > 0) {
throw new Error(
"wakeup was invoked a second time for the same claim; a re-entrant delivery must fail at once, not hang",
);
}
return new Promise<null>((resolve) => {
wakeResolvers.push(resolve);
});
});
// The renewal timer and the sweep both read time from this injected
// clock. The test moves the clock by hand, so the assertions below do
// not depend on the speed of a database round trip or a timer callback.
let clock = new Date("2026-01-01T00:00:00.000Z");
const service = questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer: vi.fn(),
now: () => clock,
claimStaleMs: 40,
claimRefreshMs: 5,
});
const deliveryPromise = service.deliver(seeded.interaction.id);
await vi.waitFor(() => expect(wakeup).toHaveBeenCalledTimes(1));
const [claimedRow] = await db
.select()
.from(issueQuestionResponseDeliveries)
.where(
eq(
issueQuestionResponseDeliveries.interactionId,
seeded.interaction.id,
),
);
const claimedAt = claimedRow!.lastAttemptAt!.getTime();
// Move the clock past claimStaleMs, then wait for a real renewal tick to
// pick it up. This proves the renewal ran. It does not only assert that
// a fixed real-time sleep was long enough.
clock = new Date(clock.getTime() + 1000);
await vi.waitFor(async () => {
const [row] = await db
.select()
.from(issueQuestionResponseDeliveries)
.where(
eq(
issueQuestionResponseDeliveries.interactionId,
seeded.interaction.id,
),
);
expect(row?.lastAttemptAt?.getTime()).toBeGreaterThan(claimedAt);
});
await expect(service.sweepPending()).resolves.toMatchObject({ scanned: 0 });
wakeResolvers[0]!(null);
await expect(deliveryPromise).resolves.toBeNull();
expect(wakeup).toHaveBeenCalledTimes(1);
const [delivery] = await db
.select()
.from(issueQuestionResponseDeliveries)
.where(
eq(
issueQuestionResponseDeliveries.interactionId,
seeded.interaction.id,
),
);
expect(delivery).toMatchObject({ status: "pending", attemptCount: 1 });
});
it("fences a stale worker after a newer claim generation takes ownership", async () => {
const seeded = await seed({ sourceStatus: "running" });
let releaseFirstWake!: (value: { id: string; driverKind: string }) => void;
const firstWakeup = vi.fn(
() =>
new Promise<{ id: string; driverKind: string }>((resolve) => {
releaseFirstWake = resolve;
}),
);
const firstService = questionResponseDeliveryService(db, {
heartbeat: { wakeup: firstWakeup } as never,
steer: vi.fn(),
claimStaleMs: 40,
claimRefreshMs: 5,
});
const firstDelivery = firstService.deliver(seeded.interaction.id);
await vi.waitFor(() => expect(firstWakeup).toHaveBeenCalledTimes(1));
// Simulate recovery after the first worker stopped renewing. The next
// claim increments attemptCount, which is the fencing generation.
await db
.update(issueQuestionResponseDeliveries)
.set({
status: "pending",
lastAttemptAt: new Date(0),
})
.where(
eq(
issueQuestionResponseDeliveries.interactionId,
seeded.interaction.id,
),
);
const secondRunId = randomUUID();
const secondWakeup = vi.fn().mockImplementation(async () =>
db
.insert(heartbeatRuns)
.values({
id: secondRunId,
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "queued",
runtimeMode: "legacy",
driverKind: "codex",
contextSnapshot: { issueId: seeded.issueId },
})
.returning()
.then((rows) => rows[0]!),
);
const secondOutcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup: secondWakeup } as never,
steer: vi.fn(),
}).deliver(seeded.interaction.id);
expect(secondOutcome).toMatchObject({
status: "fallback_queued",
targetRunId: secondRunId,
duplicate: false,
});
releaseFirstWake({ id: randomUUID(), driverKind: "codex" });
await expect(firstDelivery).resolves.toMatchObject({
status: "fallback_queued",
targetRunId: secondRunId,
duplicate: true,
});
const [delivery] = await db.select().from(issueQuestionResponseDeliveries);
expect(delivery).toMatchObject({
status: "fallback_queued",
targetRunId: secondRunId,
attemptCount: 2,
});
const deliveryEvents = await db
.select()
.from(activityLog)
.where(eq(activityLog.action, "issue.question_response_delivered"));
expect(deliveryEvents).toHaveLength(1);
});
it.each(DIRECT_ADAPTER_TYPES)(
"keeps %s on the existing wake path without invoking native steering",
async (adapterType) => {
const seeded = await seed({
adapterType,
runtimeMode: "legacy",
successorStatus: "running",
});
const fallbackRunId = randomUUID();
const wakeup = vi.fn().mockImplementation(async () =>
db
.insert(heartbeatRuns)
.values({
id: fallbackRunId,
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "queued",
runtimeMode: "legacy",
contextSnapshot: { issueId: seeded.issueId },
})
.returning()
.then((rows) => rows[0]!),
);
const steer = vi.fn();
const outcome = await questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer,
}).deliver(seeded.interaction.id);
expect(outcome).toMatchObject({
status: "fallback_queued",
mode: "wake_fallback",
targetRunId: fallbackRunId,
});
expect(steer).not.toHaveBeenCalled();
expect(wakeup).toHaveBeenCalledTimes(1);
expect(wakeup.mock.calls[0]?.[1]).toMatchObject({
idempotencyKey: `question-response:${seeded.interaction.id}`,
contextSnapshot: {
issueId: seeded.issueId,
interactionId: seeded.interaction.id,
interactionStatus: "answered",
},
});
},
);
it("queues once without probing successor steering", async () => {
const seeded = await seed({ successorStatus: "running" });
const fallbackRunId = randomUUID();
const steer = vi.fn().mockRejectedValue(
Object.assign(new Error("unsupported"), {
code: "steering_unsupported",
}),
);
const wakeup = vi.fn().mockImplementation(async () =>
db
.insert(heartbeatRuns)
.values({
id: fallbackRunId,
companyId: seeded.companyId,
agentId: seeded.agentId,
invocationSource: "automation",
status: "queued",
driverKind: "codex",
contextSnapshot: { issueId: seeded.issueId },
})
.returning()
.then((rows) => rows[0]!),
);
const service = questionResponseDeliveryService(db, {
heartbeat: { wakeup } as never,
steer,
});
const first = await service.deliver(seeded.interaction.id);
const second = await service.deliver(seeded.interaction.id);
expect(first).toMatchObject({
status: "fallback_queued",
mode: "wake_fallback",
targetRunId: fallbackRunId,
});
expect(second?.duplicate).toBe(true);
expect(steer).not.toHaveBeenCalled();
expect(wakeup).toHaveBeenCalledTimes(1);
});
it("formats text, select labels, multi-select, and custom answers in order", async () => {
const seeded = await seed();
const envelope = buildQuestionResponseDeliveryEnvelope(seeded.interaction);
expect(envelope.response).toEqual({
schema: "paperclip.question_response.v1",
answers: {
purpose: { text: "Internal API" },
runtime: { selectedOptionIds: ["node"] },
features: {
selectedOptionIds: ["health", "logs"],
customText: "Metrics",
},
},
});
expect(formatQuestionResponseSteeringMessage(envelope)).toBe(
[
"Answered questions",
"",
"- Purpose — What is it for?: Internal API",
"- Runtime — Which runtime?: Node.js",
"- Features — Which features?: Health check, Request logs, Metrics",
].join("\n"),
);
});
});