Files
PaperClipAI/packages/adapter-utils
Priya RamanandPaperclip c881bc460c feat(sandbox): add fixed duplex observability with a redacted telemetry surface
Add the closed telemetry contract for the sandbox duplex transport: the two
fixed spans, the four guarded counters, and the one transport event. A new
provider-scoped facade maps each record to the fixed names and dimension keys.
It maps the raw provider key through a one-value allowlist before every sink, so
a plugin key never reaches a span, a counter, or the event; a non-approved key
maps to the constant other.

Wire the facade into the transport selection path and the broker. The selection
path records the channel-open span, the fallback counter, and the transport
event, and it maps each readiness failure to a fixed fallback reason. The broker
records one request span with latency per delivered request and one loss record
per terminal loss, classified as pre_dispatch or post_dispatch.

Keep the per-request debug output off the duplex path: suppress the route and
query proxy logs and pass no free-form logger to the broker, so no route, query,
body, token, or raw provider error rides a log line, a span, an event, or a
counter. Every recorder call sits inside an error swallow, so a telemetry
failure never breaks the request path. The default recorder is a no-op, so the
surface stays inert until the host binds a real recorder.

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-08-20 04:57:22 +00: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.