## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - After a remote native turn is accepted, the executor saves the provider's harness state to durable storage, so another web server can continue the same conversation. > - That save runs under a fixed 300 s total deadline (`AbortSignal.timeout(300_000)`). The deadline covers archive capture, digest, encryption, the upload, any storage-outage wait and a full verifying read-back. > - On staging, five accepted runs failed this save 337–388 s after it began. The run then reported `native_workspace_sync_out_failed` with "The operation was aborted" or tar-stream's "already finalized or destroyed", and workspace copy-back went to retry. > - #19906 fixed the same fixed-deadline rule on the restore side. The write side still uses it. Since #20772/#20871 the save also waits out storage throttling and outages for up to five minutes, which cannot finish inside a five-minute total. > - This pull request bounds the upload and the read-back by inactivity instead of total time. A slow transfer continues while the store makes progress. A transfer that stops fails with a named code. > - The benefit is that an accepted turn no longer loses its provider backup only because the backup is large or the store is slow. ## Linked Issues or Issue Description Refs #19906 (same idle-deadline rule for failover-backup restores), #20772 and #20871 (file-source resends and storage-outage waits during the save), #19108 (stops tar-stream from hiding the real abort), #18932 (durable harness backups). **What happened?** On staging, five native per-turn runs failed within one hour, all after the provider turn was accepted. In each run, `harness_state.backup.persist` failed after 359,588 / 365,422 / 387,471 / 383,801 / 337,335 ms, and `session.checkpoint.persist` failed with it. The only fixed limit on that path is `AbortSignal.timeout(300_000)` around `persistNativeHarnessBackup` in `native-session-executor.ts`. The durations sit just above 300 s, plus a variable sandbox sync-out step before the save. Errors were reported as "The operation was aborted" and, before #19108, as "already finalized or destroyed". **Expected behavior** An accepted turn saves its provider backup while the store keeps making progress, even when the total time is more than five minutes. A write or read-back that stalls fails with a named, diagnosable code. A failed save publishes no backup. **Steps to reproduce** 1. Persist a native harness backup through a store that takes upload chunks slowly, so the full save takes longer than the deadline. 2. With the executor's fixed total deadline, the save fails with "The operation was aborted" and publishes nothing. 3. A store that stops taking bytes, with no caller deadline, waits indefinitely. ## What Changed - `native-harness-backup-storage.ts`: generalize `withDownloadProgressDeadline` into `withTransferProgressDeadline`. It still wraps `getObject` exactly as before, and it now also wraps `putFile` with a five-minute idle timer: - A provider that reads the stream body (local disk) renews it with each chunk it takes. - A provider that sends the file source itself (S3 with `sourceFile`, which never reads the stream) renews it with each request the store answers, each multipart part it takes, and each resend or outage wait that starts. - After the last of them the timer stays armed until the store answers, so a write that never completes is named too. - `persistNativeHarnessBackup` gains `transferIdleTimeoutMs` and `persistMaxMs` (default 30 minutes). The outer bound wraps the whole save, including the storage-outage wait. With an idle limit, a stalled upload throws `native_harness_storage_upload_stalled`, a stalled read-back throws `native_harness_storage_download_stalled`, and the whole save throws `native_harness_storage_persist_deadline_exceeded` at the outer bound. Caller cancellation keeps its own reason, and a storage outage that outlasts its own budget still surfaces as the storage error. Callers that pass no idle limit (controller archive, offline migration, preservation) are unchanged. - `storage/request-stats.ts`: add `observeStorageProgress(onProgress, work)`, an `AsyncLocalStorage` observer called from the existing `recordStorageRequest`, `recordStoragePart` and `recordStorageBackoff` hooks. It is scoped to the wrapped `putFile` call only, and a throwing observer is ignored. Stats collection is unchanged. - `native-session-executor.ts`: the per-turn backup passes `NATIVE_HARNESS_UPLOAD_IDLE_TIMEOUT_MS` (five minutes) instead of `AbortSignal.timeout(300_000)`. - Restore behavior and error codes are unchanged: `withDownloadProgressDeadline` now delegates to the shared helper with the same defaults. - `doc/database-backups.md`: document the write-side idle limit, what counts as progress, and the new codes. Previous-release story (`rules/upgrade-safe-run-state.mdc`): no persisted shape changes. Backup rows, references, receipts and checkpoints are unchanged. A deploy that lands during a save stops the process, and the pending row is never published, as before. ## Verification Run from `server/` (provider env vars unset): - `pnpm exec vitest run src/services/native-runtime/native-harness-backup-upload-deadline.integration.test.ts`: 6 tests passed. They use embedded PostgreSQL, local-disk storage and an incompressible 1 MB acpx backup. - "keeps saving a backup whose upload outlasts the idle window while the store keeps taking bytes". Under the former fixed-total policy the same slow upload fails with "The operation was aborted" and publishes nothing. With the idle limit it completes after more than twice the window and restores. - "names an upload that stops taking bytes and publishes no backup", then saves the same source once the store responds. - "keeps a file-source upload going while the store answers its requests, and names one that stops". The fake store never reads the stream and records each request answer the way the S3 provider does. - "names a read-back that stops sending bytes and publishes no backup". - "stops at the outer bound while an upload still progresses". - "lets Stop end a progressing upload with its own reason". - RED, part 1: with `native-harness-backup-storage.ts` and `request-stats.ts` reverted to `master`, 4 tests fail. Three stall tests hang until the 10 s test timeout, and the outer-bound test resolves instead of rejecting. - RED, part 2: with only the progress observer disabled, the file-source test fails with `native_harness_storage_upload_stalled` on an upload that is still progressing. - `native-harness-backup-*` suites, `native-harness-online-preservation`, `src/storage/`, `storage-request-stats` and `storage-s3-multipart-backoff`: 200 of 201 passed. The one failure, `native-harness-backup-cleanup.test.ts` ("removes retired backups containing immutable skills…", expected mode 256 to be 292), fails the same way on unmodified `master` in this sandbox. - `native-session-executor.test.ts`: 1541 of 1542 passed. The new assertion checks that the per-turn backup passes `transferIdleTimeoutMs` and no fixed signal, and flipping it fails the `opencode-new-durable*` cases. The one failure, "compares export process compatibility without changing conversation identity (changed: false)" (`db.transaction is not a function`), fails the same way on unmodified `master`. - `node scripts/typecheck-layers.mjs`: no errors in `server/`. The local filtered install lacked some CLI/UI/demo packages, which reported unrelated errors. CI covers the full typecheck. Not verified: a live staging run with this build. The staging evidence shows the save failing just after 300 s on several runs. It does not show which step was slow (upload, read-back or local capture), so the fix removes the fixed total for every step on that path. ## Risks - A save that progresses very slowly can now take longer than five minutes. Before, it failed. The settle step waits for it, up to the 30-minute outer bound. - A local step that hangs (for example a stalled disk during capture) is now cut off at 30 minutes instead of 5 minutes, with `native_harness_storage_persist_deadline_exceeded`. - For S3 file-source uploads, progress is measured per request, not per byte. A single request that takes more than five minutes counts as stalled. For a 16 MiB single PUT, that is a store slower than about 55 KB/s. Multipart parts are 8 MiB, eight in flight. - If a successor takes over during a long save, the existing fence checks before and after the upload reject it with `owner_superseded`, and nothing is published. This is unchanged behavior. ## Model Used - Provider: Anthropic. Model: Claude Opus 5.5 (`claude-opus-5-5`), with tool use (shell, file edits) in Claude Code. ## 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 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: paperclipbugbot <356415228+paperclipbugbot@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
8.3 KiB
Automatic database backups
How automatic logical backups run and how to restore one. Other database guidance is in DATABASE.md.
Paperclip can run automatic logical database backups on a timer. These backups cover non-system database schemas, including migration history and plugin-owned database schemas. Defaults:
- enabled
- every 60 minutes
- retain 30 days
- backup dir:
~/.paperclip/instances/default/data/backups
Automatic backups are disabled for isolated worktree instances created with
paperclipai worktree init or paperclipai worktree:make. Existing worktree
configs are migrated to the disabled setting when their server next starts. The
main/default instance keeps the normal enabled-by-default behavior.
Configure these in:
pnpm paperclipai configure --section database
Run a one-off backup manually:
pnpm paperclipai db:backup
# or:
pnpm db:backup
Environment overrides:
PAPERCLIP_DB_BACKUP_ENABLED=true|falsePAPERCLIP_DB_BACKUP_INTERVAL_MINUTES=<minutes>PAPERCLIP_DB_BACKUP_IDLE_CHECKPOINT_ENABLED=1enables verified final backups for owned idle sleep, with restart catch-up. Off by default; see idle sleep safety for the hosting and storage contract.PAPERCLIP_DB_BACKUP_RETENTION_DAYS=<days>PAPERCLIP_DB_BACKUP_DIR=/absolute/or/~/pathPAPERCLIP_DB_BACKUP_MAX_AGE_HOURS=<hours>controls the/api/healthstale-backup warning thresholdPAPERCLIP_DB_BACKUP_ALERT_FILE=/path/to/failure-markerlets external cron wrappers surface the last failed backup in/api/healthPAPERCLIP_WORKSPACE_REAPER_COOLDOWN_DAYS=<days>sets how long the terminal-workspace reaper waits after an issue tree becomes terminal before it archives the execution workspace and deletes the worktree. A person can reopen the work inside this window. The default is1. A value of0disables the cooldown and restores immediate reaping. A negative or non-numeric value falls back to the default.PAPERCLIP_WORKSPACE_COMPACTION_DELAY_HOURS=<hours>sets how long the reaper waits after an issue tree becomes terminal before it removes regenerable files from the workspace (see Terminal workspace compaction). The default is1. A value of0compacts on the next sweep. A negative, empty, or non-numeric value falls back to the default.PAPERCLIP_WORKSPACE_COMPACTION_ENABLED=falseturns compaction off. Any other value keeps it on.PAPERCLIP_SKILL_PACKAGE_STORAGE_ENABLED=falsedisables external writes and automatic package maintenance for a coordinated rolling upgrade. Default: enabled. Legacy conversion runs automatically in bounded batches, outside turn preparation. Existing external packages remain readable with the override. See package storage and acquisition.PAPERCLIP_SKILL_VERSION_RETENTION_KEEP=<count>sets how many of the newest materialized versions of each skill stay on disk (see Skill Version Snapshot Retention). The default is0. A negative, empty, or non-numeric value falls back to the default.PAPERCLIP_SKILL_VERSION_RETENTION_GRACE_MINUTES=<minutes>sets how long a materialized skill version stays after its last use. The default is60. A negative, empty, or non-numeric value falls back to the default.PAPERCLIP_NATIVE_HARNESS_BACKUP_EXPIRATION_DAYS=<days>sets how long an issue stays closed before the failover backups of its native sessions expire (seedoc/recoverable-disk-cleanup.md). The default is7and the minimum is1. A negative, empty, or non-numeric value falls back to the default.PAPERCLIP_NATIVE_HARNESS_BACKUP_EXPIRATION_ENABLED=falseturns expiry off, andPAPERCLIP_NATIVE_HARNESS_BACKUP_EXPIRATION_DRY_RUN=trueonly reports candidates. A resumed session restores its failover backup from durable storage before the provider starts. Each read has a five-minute idle limit instead of a short total limit: a large or slow backup keeps restoring while bytes flow. A read that makes no progress for five minutes fails withnative_harness_storage_download_stalledand publishes no partial backup. The whole restore, including local decrypt, digest and extraction, has a 30-minute outer limit (native_harness_storage_restore_deadline_exceeded). Stop ends the restore. The per-turn backup that saves provider state after an accepted turn follows the same rule. Its upload and its verifying read-back each have a five-minute idle limit instead of a fixed five-minute total, so a large backup or a slow store keeps saving while the store makes progress. For an upload, progress is a chunk the store takes or, when the store sends the file itself (S3), a request it answers, a part it takes or a resend that starts its wait. An upload with no progress for five minutes fails withnative_harness_storage_upload_stalled, a stalled read-back withnative_harness_storage_download_stalled, and neither publishes a backup. The whole backup, including archive capture, encryption and any storage-outage wait, has a 30-minute outer limit (native_harness_storage_persist_deadline_exceeded).PAPERCLIP_NATIVE_RUNNER_EVIDENCE_RETENTION_DAYS=<days>sets how long native session continuity-break archives and quarantined session state are kept (seedoc/recoverable-disk-cleanup.md). The default is7and the minimum is1. A negative, empty, or non-numeric value falls back to the default. The backup expiration enabled and dry-run switches apply to it as well.PAPERCLIP_NATIVE_WORKSPACE_SYNC_RETENTION_DAYS=<days>sets how long a settled run's native workspace sync folder (descriptor, manifest and seed archives under<instance>/native-workspace-sync/<run>) is kept (seedoc/recoverable-disk-cleanup.md). The default is7and the minimum is1. A negative, empty, or non-numeric value falls back to the default.PAPERCLIP_NATIVE_WORKSPACE_SYNC_RETENTION_ENABLED=falseturns retention off, andPAPERCLIP_NATIVE_WORKSPACE_SYNC_RETENTION_DRY_RUN=trueonly reports candidates.PAPERCLIP_GIT_RESTORE_POINTS_ENABLED=truelets git cache expiration remove closed worktrees with unpushed or uncommitted work after saving an encrypted restore point (seedoc/recoverable-disk-cleanup.md). It is off by default.PAPERCLIP_GIT_RESTORE_POINT_TERMINAL_DELAY_DAYS=<days>sets how long the issues that use the workspace (the source issue and descendants bound to it) must be closed first. The default is3. A negative, empty, or non-numeric value falls back to the default.PAPERCLIP_GIT_RESTORE_POINT_IDLE_DAYS=<days>sets how long an open issue tree's worktree must go untouched before it is removed the same way; runs restore it automatically. The default is7, and0turns this off.PAPERCLIP_TASK_DIRECTORY_RETENTION_ENABLED=truelets the terminal workspace reaper save and remove plain task directories under<instance>/isolated-workspaces/once their issue tree has been closed forPAPERCLIP_GIT_RESTORE_POINT_TERMINAL_DELAY_DAYS, and remove orphaned ones (seedoc/recoverable-disk-cleanup.md). It is off by default and runs as a dry run untilPAPERCLIP_TASK_DIRECTORY_RETENTION_DRY_RUN=false. Removal needsPAPERCLIP_GIT_RESTORE_POINTS_ENABLED=true, because the files are saved in an encrypted restore point first and restored on reopen.PAPERCLIP_TASK_DIRECTORY_ORPHAN_GRACE_DAYS=<days>sets how long an orphaned directory's issue tree must be closed and its contents unchanged. The default is7and the minimum is1. A negative, empty, or non-numeric value falls back to the default.PAPERCLIP_GIT_RESTORE_POINT_RETENTION_DAYS=<days>sets how long a git workspace restore point is kept after its issue tree closes (seedoc/recoverable-disk-cleanup.md). The default is90and the minimum is1. A negative, empty, or non-numeric value falls back to the default.
Without PAPERCLIP_DB_BACKUP_ALERT_FILE, health checks look for
db-backup-to-s3.failure in the backup directory, beside the backup directory,
and in the default sibling health/ directory.
DB backups are not full instance filesystem backups. For full local disaster recovery, also back up local storage files and the local encrypted secrets key if those providers are enabled.