Files
PaperClipAI/packages/adapter-utils
Devin FoleyandPaperclip 513ea231a2 feat(adapter-utils): add sandbox sync progress plumbing + onProgress threading
Foundation for sandbox/SSH sync status updates. Adds a shared throttled
progress reporter and threads an optional onProgress sink end-to-end so the
byte-counting transport rewrites can attach counters without further changes
to execution-target.ts or the adapters.

- New runtime-progress helper: emits a line only on a 10% step crossing or
  after ~2s, and always emits the terminal completion line. Unit-tested.
- prepareAdapterExecutionTargetRuntime gains an optional onProgress, forwarded
  to both the remote-managed and command-managed branches; the returned
  restoreWorkspace now accepts restoreWorkspace(onProgress?).
- Managed-runtime prepare/restore signatures accept onProgress (passthrough;
  byte counting handled by the sandbox/SSH child tasks).
- 7 local adapters pass an onProgress adapting onLog into prepare + restore.

onProgress is optional everywhere; existing callers and tests are unaffected.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-06-19 11:33:32 -07:00
..
2026-03-12 13:09:22 -05:00

@paperclipai/adapter-utils

Shared utilities for Paperclip adapters: process spawning, environment injection, sandbox/SSH transport, workspace sync, and the round-trip helpers that move code between the local execution-workspace cwd and wherever the agent actually runs.

For the adapter-author guide see docs/adapters/creating-an-adapter.md and the in-repo notes at packages/adapters/AUTHORING.md.

No-remote-git contract

The local execution-workspace cwd is the only persistence boundary across runs. No adapter may depend on a git remote for cross-run state.

Adapters that run the agent on a different host should use the SSH round-trip helpers in src/ssh.ts:

  • prepareWorkspaceForSshExecution({ spec, localDir, remoteDir }) — bundles the local cwd (tracked files, dirty edits, untracked additions, and the git history needed to reconstruct it) to remoteDir before the run starts. Runs with no git remote configured.
  • restoreWorkspaceFromSshExecution({ spec, localDir, remoteDir, ... }) — syncs the remote cwd back into localDir after the run, including any new commits the agent created. Also runs with no git remote configured.

prepareRemoteManagedRuntime in src/remote-managed-runtime.ts wraps both calls for adapters that want a per-run remote workspace and an automatic restoreWorkspace() finally hook.

The invariant is pinned by the no-remote-git contract case in src/ssh-fixture.test.ts, which asserts that a remote-only commit propagates to the local worktree through the prepare → restore round-trip with no git remote configured at any point. Do not regress that test.