mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-14 00:26:28 +01:00
## Thinking Path > - Paperclip manages work for AI agents. > - Personal MCP connections should remain enabled while an idle tenant sleeps. > - Unfinished OAuth, transfer and delivery work must retain its owner and deadline. > - Cloud can receive bounded metadata and incoming work while the tenant remains the company-scoped authorizer. > - Current identity, revision and delivery acknowledgments establish when ownership has transferred. > - This change preserves useful wake, retries and revocation while making settled ownership inspectable without writes. ## Linked Issues or Issue Description Refs: #19377 and #19750. Hosted companion: [paperclip-cloud#1217](https://github.com/paperclipai/paperclip-cloud/pull/1217). **What happened?** Enabled personal MCP grants and subscriptions could keep an otherwise idle tenant awake. Ignoring those records would lose discovery, authorization, delivery and revocation obligations. **Expected behavior** Unconsumed authorization codes, device requests, file handoffs and delivery work retain their original deadlines. Settled connections remain enabled and become quiet after the current external owner acknowledges responsibility. Incoming useful work resumes normal authorization and delivery; revocation still takes effect for the current company. **Steps to reproduce** Complete normal PKCE/device consent and company selection, synchronize client/device and revocation state, retain the connection while idle, then exercise useful tools/events and revocation. Sleep eligibility requires current incoming/deadline ownership throughout. ## What Changed - Add bounded signed client/device metadata and revocation synchronization with exact revision, identity and ACK checks, startup recovery and finite legacy-device cutover. - Preserve company selection, authorization and operation identity. Register grant work before its INSERT in the same transaction; retain rollback, expiry and retry behavior. - Require current managed identity/resource before hosted publication. Receipt-cleared re-enable must obtain a fresh source ACK before device creation. - Reuse read-only settings and inspection budgets; connect MCP owners to normal startup, drain and shutdown. - Bound metadata pages and the actual signed request body while preserving the default limits of other operations. - Generate migration 0440 after the merged Legacy migration. Preserve all 438 existing executable migrations and the journal prefix; retain the normal five newest snapshots. - Preserve the merged transaction-owner forwarding and regression coverage from #19750 through normal ancestry integration. ## Verification - Current own Shared/SDK, database, eval-kernel and Runner builds passed, together with all seven normal application TypeScript programs. Missing generated package exports/workspace links were restored through normal setup; the original setup failures were retained. No source, compiler option, test assertion or timeout was weakened. - Normal migration generation changed only the five intended MCP tables; its SQL is byte-identical to the reviewed MCP delta. Fresh reference databases and both retained master/Muse histories upgraded through 0440, preserving historical hashes, row fields, schema and idempotence. Direct assertions cover the Legacy null default and MCP null/zero defaults. Two selected history cases passed; the other 21 database cases were unselected. - All six current MCP lifecycle cases passed with zero skips: normal PKCE approval intent, ACK recovery after outage, mutation during publication, disable/re-enable with original expiry, company-deletion rollback/commit and key rotation. - All 81 checks in five current whole files passed with zero skips: OpenAPI 34, read-only settings 2, diagnostic catalog 25, PostgreSQL diagnostics 7 and dependency scheduling 13. PostgreSQL fixtures ran normal migrations before test imports. - Earlier canonical proof at App `cd1c8c6` / Cloud `9f67531` includes real 60-second rate and three 15-second quiet windows, useful work and three revokes. Later paired proof at App `43af514` / Cloud `914eb0f` plus its reviewed candidate includes normal DCR, PostgreSQL metadata, a 144,017-byte signed publication, actual ACK, cap/default-413 controls and a real 15-second quiet window. The relevant producer/signing/wire inputs remain byte-identical in this integration; shared changes are qualified above. These remain source-scoped observations, not a fresh full canonical run on the integrated tree. - All known test owners, process groups and OS sockets closed; an independent final PostgreSQL audit found no remaining test sessions. One dependency-test trace recorded 46 opens and 45 close events. Its cause is unknown; this is not claimed as proof of graceful closure. - Fresh exact-head remote checks passed: 59 successful and 4 skipped contexts, with a complete current 5/5 Greptile review and all seven review threads resolved. Targeted local checks do not constitute a new whole-repository test run. ## Risks App and Cloud must agree on identity, revision, namespace, deadlines and revocation. Partial rollout, unavailable authority or missing ACK must retain awake debt. Shared startup/shutdown and settings changed since the earlier canonical profile, so historical observations carry only within their stated source scope. No deployed Railway/Neon suspension, Cloud alarm, savings or complete hosted Dot/Muse acceptance is claimed. ## Model Used OpenAI `gpt-6.1-sol` produced code and verification, with a Codex coordinator reviewing and integrating the changes. The coordinator's exact runtime model ID and context-window sizes were not exposed. ## 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> Co-authored-by: Codex <noreply@openai.com>
219 lines
12 KiB
TypeScript
219 lines
12 KiB
TypeScript
import { PgDialect } from "drizzle-orm/pg-core";
|
|
import { readFileSync } from "node:fs";
|
|
import type { SQL } from "drizzle-orm";
|
|
import type { Db } from "@paperclipai/db";
|
|
import { describe, expect, it, vi } from "vitest";
|
|
import { readIdleSleepSafety, type IdleSleepDrainStatus } from "../services/idle-sleep-safety.js";
|
|
import { beginIdleTrackedWork } from "../services/task-admission.js";
|
|
|
|
const now = Date.UTC(2026, 10, 2);
|
|
const ownerId = "inventory-owned-hold";
|
|
const hold = (): IdleSleepDrainStatus => ({ ownerId, draining: true, startedAt: new Date(now - 1000),
|
|
expiresAt: new Date(now + 60_000), activeRuns: 0, pendingWakes: 0 });
|
|
const localNone = async () => "none" as const;
|
|
const collect = { collectDiagnostics: true } as const;
|
|
|
|
function database(present: string[] = [], change?: (row: Record<string, unknown>) => unknown,
|
|
schedules?: { routines?: unknown[]; issues?: unknown[] }) {
|
|
let keys: string[] = [];
|
|
const execute = vi.fn(async (statement: SQL) => {
|
|
const query = new PgDialect().sqlToQuery(statement).sql;
|
|
if (query.startsWith("SET LOCAL")) return [];
|
|
if (query.includes("FROM routine_triggers t JOIN routines r")) return schedules?.routines ?? [];
|
|
if (query.includes("FROM issues i JOIN companies c")) return schedules?.issues ?? [];
|
|
if (query.includes("WHERE status NOT IN ('active', 'paused', 'archived')")) return [{ blocked: false }];
|
|
if (query.endsWith(" AS blocked")) return [{ blocked: present.length > 0 }];
|
|
keys = [...query.matchAll(/ AS "([^"]+)"(?=, EXISTS |$)/g)].map(match => match[1]!);
|
|
const row = Object.fromEntries(keys.map(key => [key, present.includes(key)]));
|
|
return change ? change(row) : [row];
|
|
});
|
|
const transaction = vi.fn(async (run: (tx: unknown) => Promise<unknown>) => run({ execute }));
|
|
return { db: { transaction } as unknown as Db, transaction, execute, keys: () => keys };
|
|
}
|
|
|
|
describe("owned idle sleep diagnostics", () => {
|
|
it("reports simultaneous blockers from every predicate in one safe snapshot", async () => {
|
|
const f = database(["agent_api_keys", "heartbeat_runs", "chat_deliveries", "muse_mailbox_items", "budget_evaluation_work"]);
|
|
const result = await readIdleSleepSafety(f.db, hold, () => now, ownerId, localNone,
|
|
undefined, undefined, false, false, collect);
|
|
expect(result.backgroundWork).toBe("present");
|
|
expect(result.diagnostics?.complete).toBe(true);
|
|
expect(result.diagnostics?.checks.filter(check => check.state === "present").map(check => check.reason))
|
|
.toEqual(["agent_api_keys", "budget_evaluation_work", "chat_deliveries", "heartbeat_runs", "muse_mailbox_items"]);
|
|
expect(f.keys()).toHaveLength(75);
|
|
expect(f.keys()).toEqual(expect.arrayContaining(["mcp_file_tickets", "mcp_authorization_handoffs"]));
|
|
expect(new Set(f.keys()).size).toBe(f.keys().length);
|
|
const inventory = readFileSync(new URL("../../../doc/plans/2026-11-02-sleep-blocker-inventory.md", import.meta.url), "utf8");
|
|
const documented = [...inventory.matchAll(/^\| `([a-z0-9_.]+)` \|/gm)].map(match => match[1]);
|
|
expect(f.keys().filter(key => !documented.includes(key))).toEqual([]);
|
|
expect(f.transaction).toHaveBeenCalledWith(expect.any(Function), { isolationLevel: "repeatable read", accessMode: "read only" });
|
|
expect(f.execute).toHaveBeenCalledTimes(2);
|
|
});
|
|
|
|
it("can report each registered predicate independently, including every retained-table family", async () => {
|
|
const active: string[] = [];
|
|
const f = database(active);
|
|
const read = () => readIdleSleepSafety(f.db, hold, () => now, ownerId, localNone,
|
|
undefined, undefined, false, false, collect);
|
|
await read();
|
|
for (const key of f.keys()) {
|
|
active.splice(0, active.length, key);
|
|
const result = await read();
|
|
expect(result.backgroundWork, key).toBe("present");
|
|
expect(result.diagnostics?.checks.filter(check => check.state === "present"), key)
|
|
.toEqual([{ reason: key, state: "present" }]);
|
|
}
|
|
});
|
|
|
|
const routine = { id: "trigger", routine_id: "routine", company_id: "company", kind: "schedule",
|
|
setup_pending: false, cron_expression: "*/15 * * * *", timezone: "UTC", scoped: true,
|
|
next_run_at: new Date(now + 600_000), routine_updated: new Date(now), trigger_updated: new Date(now) };
|
|
const issue = { id: "issue", company_id: "company", status: "backlog", updated_at: new Date(now),
|
|
assignee_agent_id: "agent", assignee_user_id: null, checkout_run_id: null, execution_run_id: null,
|
|
execution_policy: null, execution_state: null, unblock_descriptor: null, conversation_agent_id: null,
|
|
monitor_next_check_at: null, monitor_wake_requested_at: null, monitor_attempt_count: 0,
|
|
company_status: "active", company_updated: new Date(now), agent_status: "idle", agent_updated: new Date(now),
|
|
scoped: true, unsafe_dependencies: false, dependency_ready: false, untouched_onboarding: false,
|
|
response_driven_wait: false, unblock_request_finished: false, response_wait_generation: null };
|
|
const scheduledRead = (f: ReturnType<typeof database>, diagnostics = true) => readIdleSleepSafety(f.db, hold,
|
|
() => now, ownerId, localNone, undefined, undefined, true, true, diagnostics ? collect : undefined);
|
|
|
|
it.each(["routines", "issues"] as const)("marks an overflowing %s inspection unknown without relaxing ordinary eligibility", async family => {
|
|
const f = database([], undefined, { [family]: Array(10_001).fill(family === "routines" ? routine : issue) });
|
|
expect(await scheduledRead(f, false)).toEqual({ version: 1, backgroundWork: "present" });
|
|
const result = await scheduledRead(f);
|
|
expect(result.backgroundWork).toBe("unknown");
|
|
expect(result.diagnostics?.complete).toBe(false);
|
|
expect(result.diagnostics?.checks).toContainEqual({ reason: `${family}.schedule`, state: "unknown" });
|
|
});
|
|
|
|
it.each(["routines", "issues"] as const)("fully inspects a %s catalog at the 10,000-row bound", async family => {
|
|
const f = database([], undefined, { [family]: Array(10_000).fill(family === "routines" ? routine : issue) });
|
|
const result = await scheduledRead(f);
|
|
expect(result.backgroundWork).toBe("none");
|
|
expect(result.diagnostics?.complete).toBe(true);
|
|
expect(result.diagnostics?.checks).toContainEqual({ reason: `${family}.schedule`, state: "none" });
|
|
});
|
|
|
|
it.each(["routines", "issues"] as const)("retains an actual %s blocker as known work", async family => {
|
|
const f = database([], undefined, { [family]: [family === "routines" ? { ...routine, next_run_at: new Date(now) }
|
|
: { ...issue, status: "todo" }] });
|
|
const result = await scheduledRead(f);
|
|
expect(result.backgroundWork).toBe("present");
|
|
expect(result.diagnostics?.complete).toBe(true);
|
|
expect(result.diagnostics?.checks).toContainEqual({ reason: `${family}.schedule`, state: "present" });
|
|
});
|
|
|
|
it.each(["routines", "issues"] as const)("keeps known durable work present alongside an incomplete %s inspection", async family => {
|
|
const f = database(["heartbeat_runs"], undefined, { [family]: Array(10_001).fill(family === "routines" ? routine : issue) });
|
|
const result = await scheduledRead(f);
|
|
expect(result.backgroundWork).toBe("present");
|
|
expect(result.diagnostics?.complete).toBe(false);
|
|
expect(result.diagnostics?.checks).toEqual(expect.arrayContaining([
|
|
{ reason: "heartbeat_runs", state: "present" }, { reason: `${family}.schedule`, state: "unknown" },
|
|
]));
|
|
});
|
|
|
|
it("preserves ordinary local and plugin short circuits and response shape", async () => {
|
|
const f = database();
|
|
const plugins = vi.fn(async () => ({ backgroundWork: "present" as const, pluginIds: [] }));
|
|
expect(await readIdleSleepSafety(f.db, hold, () => now, ownerId, async () => "present", plugins))
|
|
.toEqual({ version: 1, backgroundWork: "present" });
|
|
expect(plugins).not.toHaveBeenCalled();
|
|
expect(f.transaction).not.toHaveBeenCalled();
|
|
expect(await readIdleSleepSafety(f.db, hold, () => now, ownerId, localNone, plugins))
|
|
.toEqual({ version: 1, backgroundWork: "present" });
|
|
expect(f.transaction).not.toHaveBeenCalled();
|
|
expect(await readIdleSleepSafety(f.db, hold, () => now, ownerId, localNone))
|
|
.toEqual({ version: 1, backgroundWork: "none" });
|
|
});
|
|
|
|
it("continues safe inspection after local and plugin blockers without starting a backup", async () => {
|
|
const f = database(["company_secret_proposals"]);
|
|
const backup = vi.fn(async () => true);
|
|
const plugins = vi.fn(async () => ({ backgroundWork: "present" as const, pluginIds: [] }));
|
|
const result = await readIdleSleepSafety(f.db, hold, () => now, ownerId, async record => {
|
|
record?.("local.accounting_spool", "present");
|
|
record?.("local.orphan_spool", "present");
|
|
return "present";
|
|
}, plugins, backup, false, false, collect);
|
|
expect(result.backgroundWork).toBe("present");
|
|
expect(result.diagnostics?.checks).toEqual(expect.arrayContaining([
|
|
{ reason: "company_secret_proposals", state: "present" },
|
|
{ reason: "local.accounting_spool", state: "present" },
|
|
{ reason: "local.orphan_spool", state: "present" },
|
|
{ reason: "plugins.runtime_drain", state: "present" },
|
|
{ reason: "backup.checkpoint", state: "not_checked" },
|
|
]));
|
|
expect(backup).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("does not run checkpoint actions or treat unperformed actions as quiet", async () => {
|
|
const f = database();
|
|
const backup = vi.fn(async () => true);
|
|
const result = await readIdleSleepSafety(f.db, hold, () => now, ownerId, localNone,
|
|
undefined, backup, false, false, collect);
|
|
expect(result.backgroundWork).toBe("unknown");
|
|
expect(result.diagnostics?.complete).toBe(true);
|
|
expect(result.diagnostics?.checks).toContainEqual({ reason: "backup.checkpoint", state: "not_checked" });
|
|
expect(backup).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it.each([undefined, "wrong-owner"])("never opens the DB for diagnostic owner %s", async owner => {
|
|
const f = database();
|
|
const result = await readIdleSleepSafety(f.db, hold, () => now, owner, localNone,
|
|
undefined, undefined, false, false, collect);
|
|
expect(result.backgroundWork).toBe("unknown");
|
|
expect(result.diagnostics?.complete).toBe(false);
|
|
expect(f.transaction).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("skips unsafe plugin RPCs while accepted local work is active", async () => {
|
|
const f = database();
|
|
const plugins = vi.fn();
|
|
const finish = beginIdleTrackedWork();
|
|
try {
|
|
const result = await readIdleSleepSafety(f.db, hold, () => now, ownerId, async () => "present",
|
|
plugins, undefined, false, false, collect);
|
|
expect(result.backgroundWork).toBe("unknown");
|
|
expect(result.diagnostics?.complete).toBe(false);
|
|
expect(result.diagnostics?.checks).toContainEqual({ reason: "plugins.runtime_drain", state: "not_checked" });
|
|
expect(plugins).not.toHaveBeenCalled();
|
|
} finally { finish(); }
|
|
});
|
|
|
|
it.each(["owner", "expiry", "generation"])("invalidates the observation after changed %s", async changed => {
|
|
const f = database();
|
|
let current = hold();
|
|
let clock = now;
|
|
let reads = 0;
|
|
const result = await readIdleSleepSafety(f.db, () => current, () => clock, ownerId, async () => {
|
|
if (++reads === 2) {
|
|
if (changed === "owner") current = { ...current, ownerId: "replacement" };
|
|
if (changed === "expiry") clock += 60_001;
|
|
if (changed === "generation") { const finish = beginIdleTrackedWork(); finish(); }
|
|
}
|
|
return "none";
|
|
}, undefined, undefined, false, false, collect);
|
|
expect(result.backgroundWork).toBe("unknown");
|
|
expect(result.diagnostics?.complete).toBe(false);
|
|
});
|
|
|
|
it.each([
|
|
(row: Record<string, unknown>) => [{ ...row, heartbeat_runs: "false" }],
|
|
(row: Record<string, unknown>) => [{ ...row, extra_private_field: "sensitive" }],
|
|
(row: Record<string, unknown>) => { delete row.heartbeat_runs; return [row]; },
|
|
() => [],
|
|
(row: Record<string, unknown>) => [row, row],
|
|
() => { throw new Error("private SQL, credential, spool path"); },
|
|
])("fails closed and redacts malformed/unavailable durable reads", async change => {
|
|
const f = database([], change);
|
|
const result = await readIdleSleepSafety(f.db, hold, () => now, ownerId, localNone,
|
|
undefined, undefined, false, false, collect);
|
|
expect(result.backgroundWork).toBe("unknown");
|
|
expect(result.diagnostics?.complete).toBe(false);
|
|
expect(result.diagnostics?.checks).toContainEqual({ reason: "durable.snapshot", state: "unknown" });
|
|
expect(JSON.stringify(result)).not.toMatch(/sensitive|private SQL|credential,|extra_private/);
|
|
});
|
|
});
|