mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-20 18:26:40 +01:00
## 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>
106 lines
3.9 KiB
TypeScript
106 lines
3.9 KiB
TypeScript
import { AsyncLocalStorage } from "node:async_hooks";
|
|
|
|
/**
|
|
* Per-operation durable-storage request statistics, collected without
|
|
* threading a sink through every provider call. A caller opens a collector
|
|
* around a save or restore; every S3 request sent inside it adds its SDK
|
|
* attempts and retry delay, and the multipart uploader adds its own backoff.
|
|
* Counts only: no keys, paths or provider text. The run log and save timing
|
|
* record them so a slow or retried storage call is visible.
|
|
*/
|
|
export type StorageRequestStats = {
|
|
/** S3 requests sent (each may take several SDK attempts). */
|
|
requests: number;
|
|
/** SDK attempts across those requests. */
|
|
attempts: number;
|
|
/** Requests that ultimately failed. */
|
|
failedRequests: number;
|
|
/** Time the SDK spent waiting between its own retries. */
|
|
retryDelayMs: number;
|
|
/** Multipart parts uploaded. */
|
|
parts: number;
|
|
/** Part sends the backend rate-limited (503, 429, SlowDown). */
|
|
throttled: number;
|
|
/** Time the multipart uploader waited before resending a part. */
|
|
backoffMs: number;
|
|
};
|
|
|
|
const current = new AsyncLocalStorage<StorageRequestStats>();
|
|
|
|
export function newStorageRequestStats(): StorageRequestStats {
|
|
return { requests: 0, attempts: 0, failedRequests: 0, retryDelayMs: 0, parts: 0, throttled: 0, backoffMs: 0 };
|
|
}
|
|
|
|
/** Runs `work` with `stats` collecting every durable-storage request it sends. */
|
|
export function collectStorageRequestStats<T>(stats: StorageRequestStats, work: () => Promise<T>): Promise<T> {
|
|
return current.run(stats, work);
|
|
}
|
|
|
|
const progress = new AsyncLocalStorage<() => void>();
|
|
|
|
/**
|
|
* Runs `work` calling `onProgress` each time the store answers a request,
|
|
* takes a multipart part, or a resend starts its wait. A caller uses it to
|
|
* tell a slow transfer from a stalled one when the provider sends a file
|
|
* source itself and no stream chunk is visible.
|
|
*/
|
|
export function observeStorageProgress<T>(onProgress: () => void, work: () => Promise<T>): Promise<T> {
|
|
return progress.run(onProgress, work);
|
|
}
|
|
|
|
function noteProgress(): void {
|
|
try { progress.getStore()?.(); } catch { return; }
|
|
}
|
|
|
|
function metadataOf(value: unknown): { attempts?: unknown; totalRetryDelay?: unknown } | undefined {
|
|
if (!value || typeof value !== "object") return undefined;
|
|
const metadata = (value as { $metadata?: unknown }).$metadata;
|
|
return metadata && typeof metadata === "object" ? metadata as { attempts?: unknown; totalRetryDelay?: unknown } : undefined;
|
|
}
|
|
|
|
const count = (value: unknown, fallback: number) =>
|
|
typeof value === "number" && Number.isFinite(value) && value >= 0 ? value : fallback;
|
|
|
|
/** Records one S3 request's outcome from its SDK response or error metadata. */
|
|
export function recordStorageRequest(outcome: unknown, failed: boolean): void {
|
|
noteProgress();
|
|
const stats = current.getStore();
|
|
if (!stats) return;
|
|
const metadata = metadataOf(outcome);
|
|
stats.requests += 1;
|
|
stats.attempts += count(metadata?.attempts, 1);
|
|
stats.retryDelayMs += count(metadata?.totalRetryDelay, 0);
|
|
if (failed) stats.failedRequests += 1;
|
|
}
|
|
|
|
export function recordStoragePart(): void {
|
|
noteProgress();
|
|
const stats = current.getStore();
|
|
if (stats) stats.parts += 1;
|
|
}
|
|
|
|
/** Records a part send the backend rate-limited (503, 429, SlowDown), including a final one. */
|
|
export function recordStorageThrottle(): void {
|
|
const stats = current.getStore();
|
|
if (stats) stats.throttled += 1;
|
|
}
|
|
|
|
/** Records a wait before resending a part. */
|
|
export function recordStorageBackoff(waitMs: number): void {
|
|
noteProgress();
|
|
const stats = current.getStore();
|
|
if (stats) stats.backoffMs += count(waitMs, 0);
|
|
}
|
|
|
|
/** Counts a request sent outside the failure-diagnostics wrapper (cleanup), keeping its error handling. */
|
|
export async function withStorageRequestStats<T>(send: () => Promise<T>): Promise<T> {
|
|
try {
|
|
const result = await send();
|
|
recordStorageRequest(result, false);
|
|
return result;
|
|
} catch (error) {
|
|
recordStorageRequest(error, true);
|
|
throw error;
|
|
}
|
|
}
|