Files
paperclip/server/src/runtime-api.ts
T
Devin Foley 70679a3321 Add sandbox environment support (#4415)
## Thinking Path

> - Paperclip orchestrates AI agents for zero-human companies.
> - The environment/runtime layer decides where agent work executes and
how the control plane reaches those runtimes.
> - Today Paperclip can run locally and over SSH, but sandboxed
execution needs a first-class environment model instead of one-off
adapter behavior.
> - We also want sandbox providers to be pluggable so the core does not
hardcode every provider implementation.
> - This branch adds the Sandbox environment path, the provider
contract, and a deterministic fake provider plugin.
> - That required synchronized changes across shared contracts, plugin
SDK surfaces, server runtime orchestration, and the UI
environment/workspace flows.
> - The result is that sandbox execution becomes a core control-plane
capability while keeping provider implementations extensible and
testable.

## What Changed

- Added sandbox runtime support to the environment execution path,
including runtime URL discovery, sandbox execution targeting,
orchestration, and heartbeat integration.
- Added plugin-provider support for sandbox environments so providers
can be supplied via plugins instead of hardcoded server logic.
- Added the fake sandbox provider plugin with deterministic behavior
suitable for local and automated testing.
- Updated shared types, validators, plugin protocol definitions, and SDK
helpers to carry sandbox provider and workspace-runtime contracts across
package boundaries.
- Updated server routes and services so companies can create sandbox
environments, select them for work, and execute work through the sandbox
runtime path.
- Updated the UI environment and workspace surfaces to expose sandbox
environment configuration and selection.
- Added test coverage for sandbox runtime behavior, provider seams,
environment route guards, orchestration, and the fake provider plugin.

## Verification

- Ran locally before the final fixture-only scrub:
  - `pnpm -r typecheck`
  - `pnpm test:run`
  - `pnpm build`
- Ran locally after the final scrub amend:
  - `pnpm vitest run server/src/__tests__/runtime-api.test.ts`
- Reviewer spot checks:
  - create a sandbox environment backed by the fake provider plugin
  - run work through that environment
- confirm sandbox provider execution does not inherit host secrets
implicitly

## Risks

- This touches shared contracts, plugin SDK plumbing, server runtime
orchestration, and UI environment/workspace flows, so regressions would
likely show up as cross-layer mismatches rather than isolated type
errors.
- Runtime URL discovery and sandbox callback selection are sensitive to
host/bind configuration; if that logic is wrong, sandbox-backed
callbacks may fail even when execution succeeds.
- The fake provider plugin is intentionally deterministic and
test-oriented; future providers may expose capability gaps that this
branch does not yet cover.

## Model Used

- OpenAI Codex coding agent on a GPT-5-class backend in the
Paperclip/Codex harness. Exact backend model ID is not exposed
in-session. Tool-assisted workflow with shell execution, file editing,
git history inspection, and local test execution.

## 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 run tests locally and they pass
- [x] I have added or updated tests where applicable
- [ ] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-04-24 12:15:53 -07:00

136 lines
3.9 KiB
TypeScript

import os from "node:os";
function normalizeHost(value: string | null | undefined): string {
return (value ?? "").trim();
}
function isLoopbackHost(host: string): boolean {
const normalized = normalizeHost(host).toLowerCase();
return normalized === "127.0.0.1" || normalized === "localhost" || normalized === "::1";
}
function isWildcardHost(host: string): boolean {
const normalized = normalizeHost(host).toLowerCase();
return normalized === "0.0.0.0" || normalized === "::";
}
function formatOrigin(protocol: string, host: string, port: number): string {
const normalizedHost = host.includes(":") && !host.startsWith("[") && !host.endsWith("]")
? `[${host}]`
: host;
return `${protocol}//${normalizedHost}:${port}`;
}
function pushCandidate(
candidates: string[],
seen: Set<string>,
rawUrl: string | null | undefined,
): void {
const trimmed = rawUrl?.trim();
if (!trimmed) return;
try {
const normalized = new URL(trimmed).origin;
if (seen.has(normalized)) return;
seen.add(normalized);
candidates.push(normalized);
} catch {
// Ignore malformed candidates.
}
}
export function choosePrimaryRuntimeApiUrl(input: {
authPublicBaseUrl?: string | null;
allowedHostnames: string[];
bindHost: string;
port: number;
}): string {
const explicitPublicBaseUrl = input.authPublicBaseUrl?.trim();
if (explicitPublicBaseUrl) {
try {
return new URL(explicitPublicBaseUrl).origin;
} catch {
// Fall through to derived candidates if config parsing drifted.
}
}
const allowedHostname = input.allowedHostnames
.map((value) => value.trim())
.find(Boolean);
if (allowedHostname) {
return formatOrigin("http:", allowedHostname, input.port);
}
const bindHost = normalizeHost(input.bindHost);
if (bindHost && !isWildcardHost(bindHost)) {
return formatOrigin("http:", bindHost, input.port);
}
return formatOrigin("http:", "localhost", input.port);
}
export function buildRuntimeApiCandidateUrls(input: {
authPublicBaseUrl?: string | null;
allowedHostnames: string[];
bindHost: string;
port: number;
networkInterfacesMap?: NodeJS.Dict<os.NetworkInterfaceInfo[]>;
}): string[] {
const candidates: string[] = [];
const seen = new Set<string>();
const explicitPublicBaseUrl = input.authPublicBaseUrl?.trim() ?? "";
const explicitOrigin = (() => {
if (!explicitPublicBaseUrl) return null;
try {
return new URL(explicitPublicBaseUrl).origin;
} catch {
return null;
}
})();
const protocol = explicitOrigin ? new URL(explicitOrigin).protocol : "http:";
pushCandidate(candidates, seen, explicitOrigin);
for (const rawHost of input.allowedHostnames) {
const host = normalizeHost(rawHost);
if (!host) continue;
pushCandidate(candidates, seen, formatOrigin(protocol, host, input.port));
}
const bindHost = normalizeHost(input.bindHost);
if (bindHost && !isWildcardHost(bindHost)) {
pushCandidate(candidates, seen, formatOrigin(protocol, bindHost, input.port));
}
if (explicitOrigin) {
const hostname = new URL(explicitOrigin).hostname;
if (isLoopbackHost(hostname)) {
pushCandidate(candidates, seen, formatOrigin(protocol, "host.docker.internal", input.port));
}
}
const interfaces = input.networkInterfacesMap ?? os.networkInterfaces();
for (const entries of Object.values(interfaces)) {
for (const entry of entries ?? []) {
if (entry.internal) continue;
const host = normalizeHost(entry.address);
if (!host || isLoopbackHost(host) || isWildcardHost(host)) continue;
pushCandidate(candidates, seen, formatOrigin(protocol, host, input.port));
}
}
if (candidates.length === 0) {
pushCandidate(
candidates,
seen,
choosePrimaryRuntimeApiUrl({
authPublicBaseUrl: input.authPublicBaseUrl,
allowedHostnames: input.allowedHostnames,
bindHost: input.bindHost,
port: input.port,
}),
);
}
return candidates;
}