mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-23 17:33:51 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Email connects agent tasks to durable incoming and outgoing messages. > - The email worker scans the database every second, even with no inboxes. > - These queries prevent idle database connections from closing. > - This pull request wakes email work from committed writes and known deadlines. > - Empty email installations stop polling. Existing delivery and catch-up guarantees remain. ## Linked Issues or Issue Description Refs #15625. Related standby work: #15314. **What existing behavior does this improve?** The AgentMail background worker and its database traffic when idle. **Current behavior** Every instance queries active email endpoints each second. Active inboxes also scan delivery queues each second even when no work is due. **Proposed behavior** Scan once at startup. Wake after endpoint and queue transactions settle. Restore the next retry or catch-up deadline from existing rows. An instance with no active inboxes has no recurring email queries or timer. **Reason and benefit** Thousands of empty instances should not keep their databases awake to discover that email is still unconfigured. ## What Changed - Use the shared transaction-aware coordinator for email work, including changes made by separate service objects on the same database owner. - Signal endpoint activation and control changes, incoming events, and outgoing sends inside their transactions. - Add an optional deadline to the coordinator. Email uses persisted retry times, mailbox catch-up times, and socket reconnect times. Only the first pending send in each conversation determines its send deadline. - Preserve startup recovery, lease fences, idempotency, standby suppression, idle drain, and shutdown. - Update the sleep inventory and add quiet-idle, commit, activation, retry, and lifecycle tests. ## Verification - Focused coordinator, email idle, and warm standby tests: 20 passed locally. - Database-backed email integration suite: 41 passed locally with real PostgreSQL and a simulated AgentMail provider. - After review, the updated delayed-reply regression passed separately: 1 selected test passed, 40 intentionally filtered out. It verifies no scans before the first reply deadline and delivery of both replies in order. - `pnpm -r typecheck` and `pnpm build` passed locally. - The local `pnpm test:run` was interrupted after its checkout was removed externally. Completed local checks above are preserved. The [final-commit hosted CI matrix](https://github.com/paperclipai/paperclip/actions/runs/37997072212) passed: 54 successful checks, 2 expected Storybook skips, no failures. It includes the full general and serialized test matrix, runner checks, browser tests, build, typecheck, and canary packaging. - Greptile: 5/5 on `ec98f3b86ee476d75e0edf3366b357377ea09d69`, with no actionable findings. ## Risks - New email producers must register work inside their write transaction. No new tables or migrations are required. - Signals are local to one database owner and its dedicated pools. Independent processes and direct SQL do not emit them. Startup recovers existing work; configured inboxes also retain their recovery deadline. - Active inboxes still catch up each minute. WebSocket mode still renews its lease every 20 seconds. This change does not provide external waking or make active sockets sleep. - Provider calls were simulated in tests. No live email was sent. ## Model Used OpenAI Codex, GPT-6, with reasoning, repository inspection, code execution, and test tools. The exact deployment 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 --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
105 lines
4.4 KiB
TypeScript
105 lines
4.4 KiB
TypeScript
import { subscribeDatabaseWork, databaseWorkPending, reconcileDatabaseWork } from "@paperclipai/db";
|
|
import { createWorkScheduler } from "./work-scheduler.js";
|
|
import { type DeliveryQueue } from "./delivery-work-notifications.js";
|
|
import { beginIdleTrackedWork } from "./task-admission.js";
|
|
|
|
export function createDeliveryWorkCoordinator(input: {
|
|
owner: object;
|
|
canRun: () => boolean;
|
|
// Idle drain may reconcile admitted writes without dispatching new work.
|
|
// Warm standby can disable both operations.
|
|
canReconcile?: () => boolean;
|
|
onError: (error: unknown, queue: DeliveryQueue) => void;
|
|
}) {
|
|
const scheduler = createWorkScheduler();
|
|
const workers = new Map<DeliveryQueue, { wake: () => void; stop: () => Promise<void> }>();
|
|
let stopped = false;
|
|
|
|
return {
|
|
// Only these registered tasks are represented; not yet the whole instance.
|
|
nextWakeAt: scheduler.nextWakeAt,
|
|
register(queue: DeliveryQueue, task: {
|
|
retryMs: number;
|
|
run: (signal: AbortSignal) => Promise<unknown>;
|
|
hasPending: () => Promise<boolean>;
|
|
// Optional maintenance/retry deadline restored from durable state.
|
|
nextRunAt?: () => number | null;
|
|
}) {
|
|
if (stopped) throw new Error("Delivery coordinator is stopped");
|
|
if (workers.has(queue)) throw new Error(`Delivery worker already registered: ${queue}`);
|
|
let dirty = false;
|
|
let scheduledAt: number | null = null;
|
|
let running: Promise<void> | null = null;
|
|
let workerStopped = false;
|
|
let controller: AbortController | null = null;
|
|
let finishIntent: (() => void) | undefined;
|
|
function schedule(delay: number) {
|
|
if (workerStopped) return;
|
|
const at = Date.now() + delay;
|
|
if (scheduledAt !== null && scheduledAt <= at) return;
|
|
scheduledAt = at;
|
|
scheduler.schedule(queue, at, start);
|
|
}
|
|
function start() {
|
|
if (workerStopped || running) return;
|
|
scheduler.cancel(queue);
|
|
scheduledAt = null;
|
|
if (!input.canRun() && !(input.canReconcile?.() ?? false)) { schedule(task.retryMs); return; }
|
|
dirty = false;
|
|
const finish = beginIdleTrackedWork();
|
|
const attempt = new AbortController();
|
|
controller = attempt;
|
|
running = Promise.resolve().then(() => reconcileDatabaseWork(input.owner, queue))
|
|
.then(() => workerStopped || !input.canRun() ? undefined : task.run(attempt.signal)).then(() => workerStopped ? false : task.hasPending()).then(pending => {
|
|
if (pending || databaseWorkPending(input.owner, queue)) schedule(task.retryMs);
|
|
else { finishIntent?.(); finishIntent = undefined; }
|
|
const next = task.nextRunAt?.();
|
|
if (next != null) schedule(Math.max(0, next - Date.now()));
|
|
}).catch(error => {
|
|
schedule(task.retryMs);
|
|
// Logging must never turn a recoverable sweep failure into an
|
|
// unhandled rejection or prevent other queues from running.
|
|
try { if (!workerStopped) input.onError(error, queue); } catch { /* Recovery remains scheduled. */ }
|
|
}).finally(() => {
|
|
running = null;
|
|
controller = null;
|
|
finish();
|
|
if (dirty) schedule(0);
|
|
});
|
|
}
|
|
function wake() {
|
|
if (workerStopped) return;
|
|
dirty = true;
|
|
if (!running) schedule(0);
|
|
}
|
|
const unsubscribe = subscribeDatabaseWork(input.owner, queue, event => {
|
|
if (workerStopped) return;
|
|
if (databaseWorkPending(input.owner, queue)) {
|
|
finishIntent ??= beginIdleTrackedWork();
|
|
// Give the transaction time to settle. Its settlement notification
|
|
// replaces this deadline with an immediate wake on the normal path.
|
|
if (!running) schedule(task.retryMs);
|
|
}
|
|
if (event === "settled") wake();
|
|
});
|
|
const worker = { wake, async stop() {
|
|
workerStopped = true;
|
|
controller?.abort(new Error("Delivery worker stopped"));
|
|
unsubscribe();
|
|
scheduler.cancel(queue);
|
|
await running;
|
|
finishIntent?.(); finishIntent = undefined;
|
|
} };
|
|
workers.set(queue, worker);
|
|
const ready = Promise.resolve().then(() => { start(); return running; });
|
|
return { ready, wake };
|
|
},
|
|
async stop() {
|
|
stopped = true;
|
|
scheduler.stop();
|
|
await Promise.all(Array.from(workers.values(), worker => worker.stop()));
|
|
workers.clear();
|
|
},
|
|
};
|
|
}
|