mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-19 07:42:38 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Agents use the `download_artifact` tool to copy a saved API artifact into their workspace > - The server reads the artifact bytes from storage before it installs the file > - This storage read has no deadline. A stalled storage response or stream keeps the tool call open > - The provider MCP client stops the call after about five minutes with the error "The operation timed out." > - This pull request puts a 60-second deadline on the storage read and returns a clear, retryable error > - The benefit is that the agent gets a fast, clear result and can retry, and does not wait for five minutes ## Linked Issues or Issue Description **What happened?** Some `download_artifact` calls stopped for four to five minutes. Then the agent got only "The operation timed out." In one case, a retry of the same 1 MB artifact completed in about 20 seconds. **Expected behavior** A stalled storage read must fail quickly. The error must tell the agent that no file was written and that it can retry the same download. **Steps to reproduce** 1. Give `PaperclipRunnerToolAuthority` a storage service whose `getObject` never resolves, or whose stream sends one chunk and then stops. 2. Call `download_artifact` for an artifact in that storage. 3. The call does not settle. Nothing aborts the storage request. **Root cause** `#readApiFile` called `storage.getObject(...)` without a `signal` and read the stream with no deadline. Other storage reads in the runner, for example chat attachment reads, already have a deadline. ## What Changed - `server/src/services/native-runtime/paperclip-runner-tool-authority.ts`: the artifact branch of `#readApiFile` now uses a 60-second `AbortSignal.timeout`. It sends the signal to `storage.getObject`. It destroys the stream when the deadline expires. Every storage stream gets an error listener before it can be destroyed, so a late reply cannot raise an uncaught `AbortError`. It returns HTTP 504 with code `artifact_storage_timeout` and the message "Artifact storage read did not finish within 60 seconds. No file was written; retry the same download." - A new optional binding field, `storageReadTimeoutMs`, sets the deadline for tests. The default is 60 seconds. The production callers do not change. - `server/src/services/native-runtime/artifact-transfer.integration.test.ts`: a new regression test covers a storage response that never arrives and a stream that stops after one chunk. ## Verification - Failing before the first fix: `cd server && npx vitest run src/services/native-runtime/artifact-transfer.integration.test.ts -t "stalls"` failed with `Error: Test timed out in 15000ms.` The `download_artifact` call never settled. - Failing before the late-reply fix: the same test now also covers a storage reply that arrives after the deadline, with a real `createReadStream` that gets the aborted signal. It failed with an uncaught `AbortError` (`ABORT_ERR`). - Passing after both fixes: the same command passes. Each stalled call fails in less than 5 seconds with the retryable error. All storage signals are aborted. No uncaught error occurs. The workspace has no files. - `npx vitest run src/services/native-runtime/artifact-transfer.integration.test.ts src/services/native-runtime/paperclip-runner-tool-authority.test.ts`: 49 passed. - `npx vitest run src/services/native-runtime/runner-api-artifacts.integration.test.ts src/services/native-runtime/runner-api-artifacts.test.ts src/services/native-runtime/issue-document-batch.integration.test.ts`: 38 passed (first revision). - `pnpm run typecheck` (server): passed. - `pnpm verify` selects a very large set of files for this module. I did not run the full set locally. CI covers it. ## Risks - Low risk. The deadline applies only to the artifact read from storage, and artifacts are at most 10 MiB. A healthy read takes seconds. - A very slow but working storage provider that needs more than 60 seconds for 10 MiB now gets a retryable error. - The error occurs before any file write, so no partial file stays in the workspace. - This change does not fix a slow storage provider. It makes the failure fast and clear. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), with tool use and code execution in a sandboxed workspace. ## 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 - [ ] 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 - [ ] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>