mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-16 19:00:38 +09:00
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
This commit is contained in:
Devin Foley
GitHub
parent
641eb44949
commit
70679a3321
91 changed files with 10469 additions and 1498 deletions
251
server/src/services/plugin-environment-driver.ts
Normal file
251
server/src/services/plugin-environment-driver.ts
Normal file
|
|
@ -0,0 +1,251 @@
|
|||
import type { Db } from "@paperclipai/db";
|
||||
import type { EnvironmentProbeResult, PluginEnvironmentConfig } from "@paperclipai/shared";
|
||||
import type {
|
||||
PluginEnvironmentExecuteParams,
|
||||
PluginEnvironmentExecuteResult,
|
||||
PluginEnvironmentLease,
|
||||
PluginEnvironmentRealizeWorkspaceParams,
|
||||
PluginEnvironmentRealizeWorkspaceResult,
|
||||
} from "@paperclipai/plugin-sdk";
|
||||
import { unprocessable } from "../errors.js";
|
||||
import { pluginRegistryService } from "./plugin-registry.js";
|
||||
import type { PluginWorkerManager } from "./plugin-worker-manager.js";
|
||||
|
||||
export function pluginDriverProviderKey(config: Pick<PluginEnvironmentConfig, "pluginKey" | "driverKey">): string {
|
||||
return `${config.pluginKey}:${config.driverKey}`;
|
||||
}
|
||||
|
||||
export async function resolvePluginEnvironmentDriver(input: {
|
||||
db: Db;
|
||||
workerManager: PluginWorkerManager;
|
||||
config: PluginEnvironmentConfig;
|
||||
}) {
|
||||
const pluginRegistry = pluginRegistryService(input.db);
|
||||
const plugin = await pluginRegistry.getByKey(input.config.pluginKey);
|
||||
if (!plugin || plugin.status !== "ready") {
|
||||
throw new Error(`Plugin environment driver "${pluginDriverProviderKey(input.config)}" is not ready.`);
|
||||
}
|
||||
const driver = plugin.manifestJson.environmentDrivers?.find(
|
||||
(candidate) => candidate.driverKey === input.config.driverKey,
|
||||
);
|
||||
if (!driver) {
|
||||
throw new Error(`Plugin "${input.config.pluginKey}" does not declare environment driver "${input.config.driverKey}".`);
|
||||
}
|
||||
if (!input.workerManager.isRunning(plugin.id)) {
|
||||
throw new Error(`Plugin environment driver "${pluginDriverProviderKey(input.config)}" has no running worker.`);
|
||||
}
|
||||
return { plugin, driver };
|
||||
}
|
||||
|
||||
export async function resolvePluginEnvironmentDriverByKey(input: {
|
||||
db: Db;
|
||||
workerManager: PluginWorkerManager;
|
||||
driverKey: string;
|
||||
}) {
|
||||
const pluginRegistry = pluginRegistryService(input.db);
|
||||
const plugins = await pluginRegistry.list();
|
||||
for (const plugin of plugins) {
|
||||
if (plugin.status !== "ready") continue;
|
||||
const driver = plugin.manifestJson.environmentDrivers?.find(
|
||||
(candidate) => candidate.driverKey === input.driverKey && candidate.kind === "sandbox_provider",
|
||||
);
|
||||
if (!driver) continue;
|
||||
if (!input.workerManager.isRunning(plugin.id)) continue;
|
||||
return { plugin, driver };
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
export async function listReadyPluginEnvironmentDrivers(input: {
|
||||
db: Db;
|
||||
workerManager?: PluginWorkerManager;
|
||||
}) {
|
||||
if (!input.workerManager) return [];
|
||||
const pluginRegistry = pluginRegistryService(input.db);
|
||||
const plugins = await pluginRegistry.list();
|
||||
return plugins.flatMap((plugin) => {
|
||||
if (plugin.status !== "ready" || !input.workerManager?.isRunning(plugin.id)) return [];
|
||||
return (plugin.manifestJson.environmentDrivers ?? [])
|
||||
.filter((driver) => driver.kind === "sandbox_provider")
|
||||
.map((driver) => ({
|
||||
pluginId: plugin.id,
|
||||
pluginKey: plugin.pluginKey,
|
||||
driverKey: driver.driverKey,
|
||||
displayName: driver.displayName,
|
||||
description: driver.description,
|
||||
}));
|
||||
});
|
||||
}
|
||||
|
||||
export async function validatePluginEnvironmentDriverConfig(input: {
|
||||
db: Db;
|
||||
workerManager: PluginWorkerManager;
|
||||
config: PluginEnvironmentConfig;
|
||||
}): Promise<PluginEnvironmentConfig> {
|
||||
const { plugin } = await resolvePluginEnvironmentDriver(input);
|
||||
const result = await input.workerManager.call(plugin.id, "environmentValidateConfig", {
|
||||
driverKey: input.config.driverKey,
|
||||
config: input.config.driverConfig,
|
||||
});
|
||||
|
||||
if (!result.ok) {
|
||||
throw unprocessable(
|
||||
result.errors?.[0] ?? `Plugin environment driver "${pluginDriverProviderKey(input.config)}" rejected its config.`,
|
||||
{
|
||||
errors: result.errors ?? [],
|
||||
warnings: result.warnings ?? [],
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
return {
|
||||
...input.config,
|
||||
driverConfig: result.normalizedConfig ?? input.config.driverConfig,
|
||||
};
|
||||
}
|
||||
|
||||
export async function probePluginEnvironmentDriver(input: {
|
||||
db: Db;
|
||||
workerManager: PluginWorkerManager;
|
||||
companyId: string;
|
||||
environmentId: string;
|
||||
config: PluginEnvironmentConfig;
|
||||
}): Promise<EnvironmentProbeResult> {
|
||||
const { plugin } = await resolvePluginEnvironmentDriver(input);
|
||||
const result = await input.workerManager.call(plugin.id, "environmentProbe", {
|
||||
driverKey: input.config.driverKey,
|
||||
companyId: input.companyId,
|
||||
environmentId: input.environmentId,
|
||||
config: input.config.driverConfig,
|
||||
});
|
||||
|
||||
return {
|
||||
ok: result.ok,
|
||||
driver: "plugin",
|
||||
summary: result.summary ?? `Plugin environment driver "${pluginDriverProviderKey(input.config)}" probe ${result.ok ? "passed" : "failed"}.`,
|
||||
details: {
|
||||
pluginKey: input.config.pluginKey,
|
||||
driverKey: input.config.driverKey,
|
||||
diagnostics: result.diagnostics ?? [],
|
||||
metadata: result.metadata ?? {},
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export async function probePluginSandboxProviderDriver(input: {
|
||||
db: Db;
|
||||
workerManager: PluginWorkerManager;
|
||||
companyId: string;
|
||||
environmentId: string;
|
||||
provider: string;
|
||||
config: Record<string, unknown>;
|
||||
}): Promise<EnvironmentProbeResult> {
|
||||
const resolved = await resolvePluginEnvironmentDriverByKey({
|
||||
db: input.db,
|
||||
workerManager: input.workerManager,
|
||||
driverKey: input.provider,
|
||||
});
|
||||
if (!resolved) {
|
||||
return {
|
||||
ok: false,
|
||||
driver: "sandbox",
|
||||
summary: `Sandbox provider "${input.provider}" is not installed or its plugin worker is not running.`,
|
||||
details: {
|
||||
provider: input.provider,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
const result = await input.workerManager.call(resolved.plugin.id, "environmentProbe", {
|
||||
driverKey: input.provider,
|
||||
companyId: input.companyId,
|
||||
environmentId: input.environmentId,
|
||||
config: input.config,
|
||||
});
|
||||
|
||||
return {
|
||||
ok: result.ok,
|
||||
driver: "sandbox",
|
||||
summary: result.summary ?? `Sandbox provider "${input.provider}" probe ${result.ok ? "passed" : "failed"}.`,
|
||||
details: {
|
||||
provider: input.provider,
|
||||
pluginKey: resolved.plugin.pluginKey,
|
||||
diagnostics: result.diagnostics ?? [],
|
||||
metadata: result.metadata ?? {},
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export async function resumePluginEnvironmentLease(input: {
|
||||
db: Db;
|
||||
workerManager: PluginWorkerManager;
|
||||
companyId: string;
|
||||
environmentId: string;
|
||||
config: PluginEnvironmentConfig;
|
||||
providerLeaseId: string;
|
||||
leaseMetadata?: Record<string, unknown>;
|
||||
}): Promise<PluginEnvironmentLease> {
|
||||
const { plugin } = await resolvePluginEnvironmentDriver(input);
|
||||
return await input.workerManager.call(plugin.id, "environmentResumeLease", {
|
||||
driverKey: input.config.driverKey,
|
||||
companyId: input.companyId,
|
||||
environmentId: input.environmentId,
|
||||
config: input.config.driverConfig,
|
||||
providerLeaseId: input.providerLeaseId,
|
||||
leaseMetadata: input.leaseMetadata,
|
||||
});
|
||||
}
|
||||
|
||||
export async function destroyPluginEnvironmentLease(input: {
|
||||
db: Db;
|
||||
workerManager: PluginWorkerManager;
|
||||
companyId: string;
|
||||
environmentId: string;
|
||||
config: PluginEnvironmentConfig;
|
||||
providerLeaseId: string | null;
|
||||
leaseMetadata?: Record<string, unknown>;
|
||||
}): Promise<void> {
|
||||
const { plugin } = await resolvePluginEnvironmentDriver(input);
|
||||
await input.workerManager.call(plugin.id, "environmentDestroyLease", {
|
||||
driverKey: input.config.driverKey,
|
||||
companyId: input.companyId,
|
||||
environmentId: input.environmentId,
|
||||
config: input.config.driverConfig,
|
||||
providerLeaseId: input.providerLeaseId,
|
||||
leaseMetadata: input.leaseMetadata,
|
||||
});
|
||||
}
|
||||
|
||||
export async function realizePluginEnvironmentWorkspace(input: {
|
||||
db: Db;
|
||||
workerManager: PluginWorkerManager;
|
||||
pluginId?: string | null;
|
||||
params: PluginEnvironmentRealizeWorkspaceParams;
|
||||
config: PluginEnvironmentConfig;
|
||||
}): Promise<PluginEnvironmentRealizeWorkspaceResult> {
|
||||
const { plugin } = input.pluginId
|
||||
? { plugin: { id: input.pluginId } }
|
||||
: await resolvePluginEnvironmentDriver({
|
||||
db: input.db,
|
||||
workerManager: input.workerManager,
|
||||
config: input.config,
|
||||
});
|
||||
return await input.workerManager.call(plugin.id, "environmentRealizeWorkspace", input.params);
|
||||
}
|
||||
|
||||
export async function executePluginEnvironmentCommand(input: {
|
||||
db: Db;
|
||||
workerManager: PluginWorkerManager;
|
||||
pluginId?: string | null;
|
||||
params: PluginEnvironmentExecuteParams;
|
||||
config: PluginEnvironmentConfig;
|
||||
}): Promise<PluginEnvironmentExecuteResult> {
|
||||
const { plugin } = input.pluginId
|
||||
? { plugin: { id: input.pluginId } }
|
||||
: await resolvePluginEnvironmentDriver({
|
||||
db: input.db,
|
||||
workerManager: input.workerManager,
|
||||
config: input.config,
|
||||
});
|
||||
return await input.workerManager.call(plugin.id, "environmentExecute", input.params);
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue