mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-30 05:16:50 +01:00
<!-- entire-trail-link-start --> https://entire.com/gh/paperclipai/-/trails/58/changes/paperclip/58 <!-- entire-trail-link-end --> ## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agent timers must start due work and preserve queue admission rules. > - The server woke their scan on every heartbeat interval, even with no eligible timer. > - Idle scans keep the database and instance active. > - This pull request derives the next deadline from saved policy and work records. > - Supported producer transactions notify the shared coordinator when eligibility changes. > - An idle timer worker stops scanning and resumes when real work or a deadline requires it. ## Linked Issues or Issue Description Refs #17863. This is slice 63 of the recurring-work migration and follows the merged issue-monitor deadline PR. Related: #16632 changes timer issue scope; #16881 changes live-run eligibility. This PR preserves the current admission policy. Those policy changes are separate work. A future time-sensitive predicate must expose its next transition deadline. **What existing behavior does this improve?** Agent timer heartbeat scheduling in the server. **Current behavior** A recurring heartbeat wakes the timer scan even when companies are paused, timers are disabled, or no actionable task exists. **Proposed behavior** Register the earliest eligible interval or positive daily-cap reset deadline. Re-read on supported producer commits and startup. Leave no recurring database scan when no timer obligation remains. ## What Changed - Keep policy and deadline calculation in the heartbeat queue. Scheduling retains company, reporting-chain, worktree, and CAS gates. - Use the existing deadline coordinator. Remove only the timer wake from the server heartbeat loop. - Notify before existing transaction writes that change eligibility or deadlines. Cover configuration, lifecycle, company budgets, task ownership, recovery, conversations, accounting corrections, and completion. - Use the lifecycle status-change hook for saved hire rejection. Cover checkout's second adoption transaction after an initial failed CAS. - Preserve pending work through idle and maintenance drains. Check cancellation between due agents. Reconstruct on restart. - Document the supported writer model and producer inventory. Add no schema, table, or provider branch. ## Verification - **1,710 passing cases across 49 complete files**, no skips, on accepted source `32db86c1974dcbf794f01a8c5e42024e2ad071fc`. Coverage includes real timer policy/CAS/producers, monitor and shared deadline consumers, native reconstruction, Slack lifecycle, skills/settings/configuration, queue isolation and agent lifecycle. - Database build, production server typechecking/build, module boundaries, target migration order and Runner profile identity pass. Twenty-nine fresh PostgreSQL 17 schemas plus per-file fixtures applied all 412 journal entries through index 413; all selected source hashes and temporary fixture imports were restored exactly. - Four new deadline composition cases verify future/overdue timing, minimum scan spacing and disarming. A controlled mutation dropping only the inherited continuation option fails; the composed source passes with identical assertions and timers. - Normal parent reconciliation preserves task-drain expiry and both deadline contracts. The final monitor-parent publication changes only its audit, preserving every qualified runtime and selected test source. - Historical failures and review corrections remain in [the timer audit](doc/idle-agent-timers.md). No full local repository-suite, live provider, measured suspend/wake, external-alarm or fleet-savings claim. Final-head CI/security, exact-head Greptile 5/5 and actionable Ponytail findings remain separate merge gates. ## Risks - Process-local notifications cover supported service/API writers in one server process. Direct SQL and independent replicas need an explicit ingress contract. Startup reconstruction is not live cross-process notification. - Notifications can batch for up to the configured heartbeat interval. Known deadlines retain their scheduler path; failed reconciliation retains bounded retry. - Enabled timers without an actionable-work requirement remain real recurring obligations. Zero caps require policy changes; positive reached caps use UTC midnight. - The timer fixture substitutes adapter enqueue. Existing admission tests also pass, but this is not deployed provider or sleep qualification. - Cloud does not gain legacy agent timer alarms in this PR. Existing sleep-safety blockers remain. No database/host suspension or fleet savings claim is made. - Parent-stack CI and review must pass before merge. This PR does not authorize merging its dependencies. ## Model Used OpenAI Codex (GPT-6-based coding agent), using repository inspection, normal Git merges, composition proofs, a controlled red/green regression and complete PostgreSQL integration suites. No subagents were used in this reconciliation. ## 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 - [ ] All Paperclip CI gates are green - [ ] 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> Co-authored-by: Codex <noreply@openai.com>
78 lines
4.9 KiB
TypeScript
78 lines
4.9 KiB
TypeScript
import { agents, applyPendingMigrations, companies, createDb, issues, routines, routineTriggers } from "@paperclipai/db";
|
|
import { sql } from "drizzle-orm";
|
|
import type { Db } from "@paperclipai/db";
|
|
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from "vitest";
|
|
import { getEmbeddedPostgresTestSupport, startEmbeddedPostgresTestDatabase } from "./helpers/embedded-postgres.js";
|
|
import type { createDeliveryWorkCoordinator } from "../services/delivery-work-coordinator.js";
|
|
import { DELIVERY_QUEUES, type DeliveryQueue } from "../services/delivery-work-notifications.js";
|
|
import { heartbeatService } from "../services/heartbeat.js";
|
|
import { routineService } from "../services/routines.js";
|
|
import { resolveExternalTestDatabaseUrl } from "./helpers/external-test-database.js";
|
|
import { registerScheduledWork } from "../services/scheduled-work.js";
|
|
|
|
const external = resolveExternalTestDatabaseUrl("PAPERCLIP_SCHEDULED_WORK_TEST_DATABASE_URL");
|
|
const support = external ? { supported: true } : await getEmbeddedPostgresTestSupport();
|
|
describe.skipIf(!support.supported)("scheduled deadline database queries", () => {
|
|
let database: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>>;
|
|
let db: Db;
|
|
beforeAll(async () => {
|
|
if (external) await applyPendingMigrations(external);
|
|
else database = await startEmbeddedPostgresTestDatabase("paperclip-scheduled-deadlines");
|
|
db = createDb(external ?? database.connectionString);
|
|
}, 30_000);
|
|
afterEach(() => vi.useRealTimers());
|
|
afterAll(async () => { await db?.$client.end(); await database?.cleanup(); });
|
|
|
|
it("retains eligible overdue routines while excluding inactive and mismatched work", async () => {
|
|
vi.useFakeTimers({ toFake: ["Date"] });
|
|
const now = Date.now();
|
|
const at = (minutes: number) => new Date(now + minutes * 60_000);
|
|
const [company, pausedCompany] = await db.insert(companies).values([
|
|
{ name: "Active schedules", issuePrefix: "SCH" },
|
|
{ name: "Paused schedules", issuePrefix: "PAU", status: "paused" },
|
|
]).returning();
|
|
const [agent] = await db.insert(agents).values({ companyId: company!.id, name: "Scheduled agent" }).returning();
|
|
const [active, paused, otherCompany] = await db.insert(routines).values([
|
|
{ companyId: company!.id, title: "Active routine" },
|
|
{ companyId: company!.id, title: "Paused routine", status: "paused" },
|
|
{ companyId: pausedCompany!.id, title: "Paused company routine" },
|
|
]).returning();
|
|
const trigger = { companyId: company!.id, routineId: active!.id, kind: "schedule", cronExpression: "0 * * * *", timezone: "UTC" };
|
|
await db.insert(routineTriggers).values([
|
|
{ ...trigger, nextRunAt: at(10) },
|
|
{ ...trigger, enabled: false, nextRunAt: at(1) },
|
|
{ ...trigger, archived: true, nextRunAt: at(2) },
|
|
{ ...trigger, routineId: paused!.id, nextRunAt: at(3) },
|
|
{ ...trigger, companyId: pausedCompany!.id, nextRunAt: at(4) },
|
|
{ ...trigger, companyId: pausedCompany!.id, routineId: otherCompany!.id, nextRunAt: at(5) },
|
|
{ ...trigger, nextRunAt: at(-1) },
|
|
]);
|
|
const monitor = { companyId: company!.id, title: "Monitor", status: "in_progress", assigneeAgentId: agent!.id };
|
|
await db.insert(issues).values([
|
|
{ ...monitor, monitorNextCheckAt: at(15) },
|
|
{ ...monitor, status: "done", monitorNextCheckAt: at(1) },
|
|
{ ...monitor, assigneeUserId: "fixture-user", monitorNextCheckAt: at(2) },
|
|
{ ...monitor, assigneeAgentId: null, monitorNextCheckAt: at(3) },
|
|
{ ...monitor, companyId: pausedCompany!.id, monitorNextCheckAt: at(4) },
|
|
{ ...monitor, monitorNextCheckAt: at(-1) },
|
|
]);
|
|
type Task = Parameters<ReturnType<typeof createDeliveryWorkCoordinator>["register"]>[1];
|
|
const tasks = new Map<DeliveryQueue, Task>();
|
|
registerScheduledWork({ register: (queue, task) => {
|
|
tasks.set(queue, task);
|
|
return { ready: Promise.resolve(), wake: () => {} };
|
|
} }, { retryMs: 60_000, tickAgentTimers: async () => {}, nextAgentTimerAt: async () => null, tickIssueMonitors: async () => {},
|
|
nextIssueMonitorAt: () => heartbeatService(db).nextIssueMonitorAt(), tickRoutines: async () => {}, canRun: () => true,
|
|
nextRoutineRunAt: () => routineService(db).nextScheduledTriggerAt() });
|
|
for (const task of tasks.values()) await task.run(new AbortController().signal);
|
|
expect(await routineService(db).nextScheduledTriggerAt()).toBe(at(-1).getTime());
|
|
expect(tasks.get(DELIVERY_QUEUES.routineSchedules)!.nextRunAt!()).toBeGreaterThan(now);
|
|
expect(await heartbeatService(db).nextIssueMonitorAt()).toBe(at(-1).getTime());
|
|
expect(tasks.get(DELIVERY_QUEUES.issueMonitors)!.nextRunAt!()).toBe(now + 60_000);
|
|
await db.execute(sql`truncate table companies restart identity cascade`);
|
|
vi.setSystemTime(at(2));
|
|
for (const task of tasks.values()) await task.run(new AbortController().signal);
|
|
for (const task of tasks.values()) expect(task.nextRunAt!()).toBeNull();
|
|
});
|
|
});
|