mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-11 05:11:49 +01:00
Permit idle sleep with consumed retries and passive worktrees (#15907)
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work.
> - Idle sleep must wait for accepted work and durable cleanup.
> - The retry dispatcher keeps its due date after it promotes a retry.
> - Finished retries and passive local directories can therefore look
like pending work.
> - This pull request requires completion proof and permits known
passive directory records.
> - It retains the records and keeps real work and unknown state awake.
## Linked Issues or Issue Description
Related: #15897 and #15851. The open runtime-service work in #13413
retains its separate service and ingress guarantees. This patch does not
change those checks.
**What happened?**
Idle sleep treats a consumed retry date as pending work. It also blocks
on every retained execution workspace, including a local directory
without runtime activity.
**Steps to reproduce**
1. Promote a scheduled retry, then finish its run without accounting
debt. Retain its scheduled retry date.
2. Retain a local primary directory or Git worktree without runtime
configuration, commands, or cleanup due.
3. Request an owned idle safety report. The report returns `present` for
this history.
**Paperclip version or commit**
Reproduced on master at 4b59e2a2ec.
**Deployment mode**
Server with PostgreSQL. The regression tests use embedded PostgreSQL.
## What Changed
- Permit terminal runs with a finish time at or after their retry date
and no accounting debt. Apply that proof to linked wake,
answer-delivery, and verified failed-lease history.
- Permit known passive local primary directories and Git worktrees. Keep
due cleanup, commands, runtime configuration, shared project runtime
inheritance, pending reopen, runtime owners, and unfamiliar state awake.
- Retain retry dates, workspace records, files, and metadata. Document
the proof and retention limits.
## Verification
- Passed all 200 tests in `pnpm exec vitest run
server/src/__tests__/idle-sleep-safety.test.ts` against embedded
PostgreSQL.
- Passed the 52 retry dispatcher tests.
- Passed `pnpm -r typecheck` and `pnpm build`. After the provider
correction, server typecheck and build passed again.
- Full CI is green for commit
`0510669439e855b90a4e03a2fc7827503cea507f`, including all test shards,
typecheck, build, and browser end-to-end tests. One browser test
initially raced its comment write; the failed jobs passed on retry
without a source change.
- Local `pnpm test:run` recorded 18,721 passed, 105 skipped, and four
failures in existing AI-login, Git-fixture, and native runner-recovery
tests; it exited before the remaining workspace and serialized groups.
The AI-login test passed alone. Both Git fixtures passed with
command-scoped `init.defaultBranch=master`. The native recovery failure
also occurs on the parent revision on this Mac. These suites pass in CI.
- Greptile Apex scored the final commit 5/5. Its provider-coverage
comment was addressed and the review thread resolved.
- Reviewed the diff for secrets, private data, generated files, and
unrelated changes.
## Risks
- Missing finish times, later retry dates, active children, and
accounting debt continue to block sleep. Failed lease history still
requires an exact provider termination receipt.
- Future cleanup eligibility can wait for the next wake. Due cleanup
blocks sleep. Storage must remain attached across sleep and keep its
backup policy.
- Shared directories with a project workspace and unfamiliar providers,
strategies, modes, or configuration remain conservative blockers.
- No migration, provider teardown, retry scheduling change, or tenant
data deletion.
## Model Used
OpenAI Codex, GPT-6, with repository tools and code execution. The
runtime does not expose a more specific model snapshot or context-window
size.
## 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
- [ ] I have run tests locally and they pass (focused tests pass; the
full local run has the environmental failures documented above)
- [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>
This commit is contained in:
1 parent
2223b7de9e
commit
d49cbf4c4f
3 files changed
+197
-19
No files matched your search
@@ -6,7 +6,7 @@ import {
|
||||
agentInstructionWorkingCopies, agents, agentApiKeys, agentWakeupRequests, companies, companySecretProposals, createDb,
|
||||
adapterAuthSessions, environments, environmentLeases, executionWorkspaces,
|
||||
heartbeatRuns, issues, issueWatchdogs, issueThreadInteractions, issueQuestionResponseDeliveries,
|
||||
projects, routines, toolApplications, toolConnections, type Db,
|
||||
projects, projectWorkspaces, routines, toolApplications, toolConnections, workspaceOperations, executionWorkspaceRuntimeLeases, type Db,
|
||||
} from "@paperclipai/db";
|
||||
import { getEmbeddedPostgresTestSupport, startEmbeddedPostgresTestDatabase } from "./helpers/embedded-postgres.js";
|
||||
import { readIdleSleepSafety, type IdleSleepDrainStatus } from "../services/idle-sleep-safety.js";
|
||||
@@ -185,6 +185,37 @@ if (!support.supported) console.warn(`Skipping idle sleep Postgres tests: ${supp
|
||||
return { companyId, agentId, runId };
|
||||
}
|
||||
|
||||
it.each(["succeeded", "failed", "cancelled", "timed_out", "interrupted"])(
|
||||
"permits a finished %s run with a consumed retry date without changing history", async status => {
|
||||
const { runId } = await seed();
|
||||
const scheduledRetryAt = new Date(now - 1000);
|
||||
await db.update(heartbeatRuns).set({ status, finishedAt: new Date(now), scheduledRetryAt }).where(eq(heartbeatRuns.id, runId));
|
||||
expect(await read()).toEqual(none);
|
||||
expect(await db.select().from(heartbeatRuns).where(eq(heartbeatRuns.id, runId)))
|
||||
.toMatchObject([{ status, scheduledRetryAt }]);
|
||||
},
|
||||
);
|
||||
|
||||
it.each([
|
||||
{ status: "scheduled_retry", finishedAt: new Date(now) },
|
||||
{ status: "queued", finishedAt: new Date(now) },
|
||||
{ status: "running", finishedAt: new Date(now) },
|
||||
{ status: "failed", finishedAt: null },
|
||||
{ status: "failed", finishedAt: new Date(now), costAccountingPending: true },
|
||||
{ status: "failed", finishedAt: new Date(now - 2000) },
|
||||
])("retains retry work without terminal consumption proof: %j", async change => {
|
||||
const { runId } = await seed();
|
||||
await db.update(heartbeatRuns).set({ scheduledRetryAt: new Date(now - 1000), ...change }).where(eq(heartbeatRuns.id, runId));
|
||||
expect(await read()).toEqual(present);
|
||||
});
|
||||
|
||||
it("keeps a live retry child awake after its parent's schedule is consumed", async () => {
|
||||
const { companyId, agentId, runId } = await seed();
|
||||
await db.update(heartbeatRuns).set({ finishedAt: new Date(now), scheduledRetryAt: new Date(now - 1000) }).where(eq(heartbeatRuns.id, runId));
|
||||
await db.insert(heartbeatRuns).values({ companyId, agentId, invocationSource: "on_demand", status: "scheduled_retry", retryOfRunId: runId, scheduledRetryAt: new Date(now + 1000) });
|
||||
expect(await read()).toEqual(present);
|
||||
});
|
||||
|
||||
async function seedQuestionDelivery(change: Partial<typeof issueQuestionResponseDeliveries.$inferInsert> = {}) {
|
||||
const seeded = await seed();
|
||||
await db.update(heartbeatRuns).set({ finishedAt: new Date(now) }).where(eq(heartbeatRuns.id, seeded.runId));
|
||||
@@ -521,6 +552,14 @@ if (!support.supported) console.warn(`Skipping idle sleep Postgres tests: ${supp
|
||||
.toMatchObject([{ status: "failed", cleanupStatus: "success" }]);
|
||||
});
|
||||
|
||||
it("permits consumed retry history only with exact failed-lease termination proof", async () => {
|
||||
const { lease, runId } = await seedFinishedFailedLease();
|
||||
await db.update(heartbeatRuns).set({ scheduledRetryAt: new Date(now - 1000) }).where(eq(heartbeatRuns.id, runId));
|
||||
expect(await read()).toEqual(none);
|
||||
await db.update(environmentLeases).set({ metadata: {} }).where(eq(environmentLeases.id, lease.id));
|
||||
expect(await read()).toEqual(present);
|
||||
});
|
||||
|
||||
it.each([
|
||||
"cleanup_failed", "cleanup_unknown", "unreleased", "retained_policy", "reusable_policy",
|
||||
"active", "pending_cleanup", "missing_receipt", "wrong_company", "wrong_run", "wrong_lease",
|
||||
@@ -670,12 +709,92 @@ if (!support.supported) console.warn(`Skipping idle sleep Postgres tests: ${supp
|
||||
expect(await read()).toEqual(present);
|
||||
});
|
||||
|
||||
it("reports retained execution workspaces that may need delayed cleanup", async () => {
|
||||
async function seedRetainedWorkspace(change: Partial<typeof executionWorkspaces.$inferInsert> = {}) {
|
||||
const { companyId } = await seed();
|
||||
const [project] = await db.insert(projects).values({ companyId, name: "Fixture project" }).returning();
|
||||
await db.insert(executionWorkspaces).values({
|
||||
companyId, projectId: project!.id, name: "Fixture workspace", mode: "isolated",
|
||||
strategyType: "git_worktree", status: "closed", cleanupEligibleAt: new Date(now + 86_400_000),
|
||||
const [workspace] = await db.insert(executionWorkspaces).values({
|
||||
companyId, projectId: project!.id, name: "Fixture workspace", mode: "isolated_workspace",
|
||||
strategyType: "git_worktree", status: "active", providerType: "git_worktree",
|
||||
cwd: "/tmp/fixture-retained-worktree", providerRef: "/tmp/fixture-retained-worktree",
|
||||
...change,
|
||||
}).returning();
|
||||
return workspace!;
|
||||
}
|
||||
|
||||
it.each(["local_fs", "git_worktree"].flatMap(providerType =>
|
||||
["active", "idle", "in_review", "archived"].map(status => ({ providerType, status }))))(
|
||||
"permits a passive local directory without removing retained data: %j", async ({ providerType, status }) => {
|
||||
const metadata = { config: {
|
||||
environmentId: randomUUID(), provisionCommand: null, runtimeProvisionCommand: null,
|
||||
teardownCommand: null, cleanupCommand: null, workspaceRuntime: null,
|
||||
desiredState: null, serviceStates: null,
|
||||
}, retainedFixture: true };
|
||||
const strategyType = providerType === "local_fs" ? "project_primary" : "git_worktree";
|
||||
const workspace = await seedRetainedWorkspace({ providerType, strategyType, status, metadata, cleanupEligibleAt: new Date(Date.UTC(2099, 0, 1)) });
|
||||
expect(await read()).toEqual(none);
|
||||
expect(await db.select().from(executionWorkspaces).where(eq(executionWorkspaces.id, workspace.id)))
|
||||
.toMatchObject([{ status, metadata, cwd: workspace.cwd, cleanupEligibleAt: workspace.cleanupEligibleAt }]);
|
||||
},
|
||||
);
|
||||
|
||||
it.each([null, {}, { config: null }, { config: {} }, { config: { desiredState: "stopped", serviceStates: {} } }])(
|
||||
"permits passive local configuration: %j", async metadata => {
|
||||
await seedRetainedWorkspace({ metadata });
|
||||
expect(await read()).toEqual(none);
|
||||
},
|
||||
);
|
||||
|
||||
it.each([
|
||||
{ providerType: "cloud_sandbox" }, { providerType: "future_provider" },
|
||||
{ strategyType: "adapter_managed" }, { strategyType: "future_strategy" },
|
||||
{ mode: "future_mode" },
|
||||
{ providerRef: "another-resource" }, { status: "cleanup_failed" }, { status: "future_state" },
|
||||
{ cleanupEligibleAt: new Date(now) }, { metadata: { reopenPendingConsumption: true } },
|
||||
{ metadata: { reopenPendingConsumption: "unknown" } },
|
||||
{ metadata: { config: [] } }, { metadata: { config: "malformed" } },
|
||||
{ metadata: { config: { workspaceRuntime: {} } } },
|
||||
{ metadata: { config: { workspaceRuntime: { services: [] } } } },
|
||||
{ metadata: { config: { desiredState: "running" } } },
|
||||
{ metadata: { config: { desiredState: "manual" } } },
|
||||
{ metadata: { config: { serviceStates: { web: "stopped" } } } },
|
||||
{ metadata: { config: { provisionCommand: "echo fixture" } } },
|
||||
{ metadata: { config: { runtimeProvisionCommand: "echo fixture" } } },
|
||||
{ metadata: { config: { teardownCommand: "echo fixture" } } },
|
||||
{ metadata: { config: { cleanupCommand: "echo fixture" } } },
|
||||
{ metadata: { config: { futureWorker: true } } },
|
||||
])("retains a directory with work or unfamiliar state: %j", async change => {
|
||||
await seedRetainedWorkspace(change);
|
||||
expect(await read()).toEqual(present);
|
||||
});
|
||||
|
||||
it("fails closed for malformed directory metadata", async () => {
|
||||
const workspace = await seedRetainedWorkspace();
|
||||
await db.execute(sql`UPDATE execution_workspaces SET metadata = '[]'::jsonb WHERE id = ${workspace.id}`);
|
||||
expect(await read()).toEqual(present);
|
||||
});
|
||||
|
||||
it("retains a shared directory that can inherit project runtime configuration", async () => {
|
||||
const workspace = await seedRetainedWorkspace();
|
||||
const [projectWorkspace] = await db.insert(projectWorkspaces).values({
|
||||
companyId: workspace.companyId, projectId: workspace.projectId, name: "Shared fixture",
|
||||
metadata: { runtimeConfig: { workspaceRuntime: { services: [] } } },
|
||||
}).returning();
|
||||
await db.update(executionWorkspaces).set({ mode: "shared_workspace", projectWorkspaceId: projectWorkspace!.id })
|
||||
.where(eq(executionWorkspaces.id, workspace.id));
|
||||
expect(await read()).toEqual(present);
|
||||
});
|
||||
|
||||
it("retains a local directory with an unfinished operation", async () => {
|
||||
const workspace = await seedRetainedWorkspace();
|
||||
await db.insert(workspaceOperations).values({ companyId: workspace.companyId, executionWorkspaceId: workspace.id, phase: "cleanup", status: "running" });
|
||||
expect(await read()).toEqual(present);
|
||||
});
|
||||
|
||||
it("retains a local directory with a runtime owner", async () => {
|
||||
const workspace = await seedRetainedWorkspace();
|
||||
await db.insert(executionWorkspaceRuntimeLeases).values({
|
||||
companyId: workspace.companyId, executionWorkspaceId: workspace.id,
|
||||
ownerKey: "fixture-owner", lastAction: "use", expiresAt: new Date(Date.UTC(2099, 0, 1)),
|
||||
});
|
||||
expect(await read()).toEqual(present);
|
||||
});
|
||||
|
||||
Reference in new issue
Block a user