mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-19 12:10:37 +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
|
|
@ -3,12 +3,12 @@ import { Link } from "@/lib/router";
|
|||
import type { Issue, ExecutionWorkspace } from "@paperclipai/shared";
|
||||
import { useQuery } from "@tanstack/react-query";
|
||||
import { executionWorkspacesApi } from "../api/execution-workspaces";
|
||||
import { environmentsApi } from "../api/environments";
|
||||
import { instanceSettingsApi } from "../api/instanceSettings";
|
||||
import { useCompany } from "../context/CompanyContext";
|
||||
import { queryKeys } from "../lib/queryKeys";
|
||||
import { cn, projectWorkspaceUrl } from "../lib/utils";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Skeleton } from "@/components/ui/skeleton";
|
||||
import { Check, Copy, GitBranch, FolderOpen, Pencil, X } from "lucide-react";
|
||||
|
||||
/* -------------------------------------------------------------------------- */
|
||||
|
|
@ -27,12 +27,12 @@ function issueModeForExistingWorkspace(mode: string | null | undefined) {
|
|||
return "shared_workspace";
|
||||
}
|
||||
|
||||
function shouldPresentExistingWorkspaceSelection(issue: {
|
||||
executionWorkspaceId: string | null;
|
||||
executionWorkspacePreference: string | null;
|
||||
executionWorkspaceSettings: Issue["executionWorkspaceSettings"];
|
||||
currentExecutionWorkspace?: ExecutionWorkspace | null;
|
||||
}) {
|
||||
function shouldPresentExistingWorkspaceSelection(
|
||||
issue: Pick<
|
||||
Issue,
|
||||
"executionWorkspaceId" | "executionWorkspacePreference" | "executionWorkspaceSettings" | "currentExecutionWorkspace"
|
||||
>,
|
||||
) {
|
||||
const persistedMode =
|
||||
issue.currentExecutionWorkspace?.mode
|
||||
?? issue.executionWorkspaceSettings?.mode
|
||||
|
|
@ -157,25 +157,6 @@ function statusBadge(status: string) {
|
|||
);
|
||||
}
|
||||
|
||||
function IssueWorkspaceCardSkeleton() {
|
||||
return (
|
||||
<div className="rounded-lg border border-border p-3 space-y-3" data-testid="issue-workspace-card-skeleton">
|
||||
<div className="flex items-center justify-between gap-2">
|
||||
<div className="flex items-center gap-2">
|
||||
<Skeleton className="h-4 w-4 rounded-full" />
|
||||
<Skeleton className="h-4 w-36" />
|
||||
<Skeleton className="h-5 w-16 rounded-full" />
|
||||
</div>
|
||||
<Skeleton className="h-6 w-14" />
|
||||
</div>
|
||||
<div className="space-y-2">
|
||||
<Skeleton className="h-3 w-40" />
|
||||
<Skeleton className="h-3 w-full" />
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
/* -------------------------------------------------------------------------- */
|
||||
/* Main component */
|
||||
/* -------------------------------------------------------------------------- */
|
||||
|
|
@ -196,7 +177,16 @@ interface IssueWorkspaceCardProps {
|
|||
companyId: string | null;
|
||||
currentExecutionWorkspace?: ExecutionWorkspace | null;
|
||||
};
|
||||
project: { id: string; executionWorkspacePolicy?: { enabled?: boolean; defaultMode?: string | null; defaultProjectWorkspaceId?: string | null } | null; workspaces?: Array<{ id: string; isPrimary: boolean }> } | null;
|
||||
project: {
|
||||
id: string;
|
||||
executionWorkspacePolicy?: {
|
||||
enabled?: boolean;
|
||||
defaultMode?: string | null;
|
||||
defaultProjectWorkspaceId?: string | null;
|
||||
environmentId?: string | null;
|
||||
} | null;
|
||||
workspaces?: Array<{ id: string; isPrimary: boolean }>;
|
||||
} | null;
|
||||
onUpdate: (data: Record<string, unknown>) => void;
|
||||
initialEditing?: boolean;
|
||||
livePreview?: boolean;
|
||||
|
|
@ -215,17 +205,21 @@ export function IssueWorkspaceCard({
|
|||
const companyId = issue.companyId ?? selectedCompanyId;
|
||||
const [editing, setEditing] = useState(initialEditing);
|
||||
|
||||
const { data: experimentalSettings, isLoading: experimentalSettingsLoading } = useQuery({
|
||||
const { data: experimentalSettings } = useQuery({
|
||||
queryKey: queryKeys.instance.experimentalSettings,
|
||||
queryFn: () => instanceSettingsApi.getExperimental(),
|
||||
retry: false,
|
||||
});
|
||||
|
||||
const projectWorkspacePolicyEnabled = Boolean(project?.executionWorkspacePolicy?.enabled);
|
||||
const environmentsEnabled = experimentalSettings?.enableEnvironments === true;
|
||||
const policyEnabled = experimentalSettings?.enableIsolatedWorkspaces === true
|
||||
&& projectWorkspacePolicyEnabled;
|
||||
&& Boolean(project?.executionWorkspacePolicy?.enabled);
|
||||
|
||||
const workspace = issue.currentExecutionWorkspace as ExecutionWorkspace | null | undefined;
|
||||
const { data: environments } = useQuery({
|
||||
queryKey: queryKeys.environments.list(companyId!),
|
||||
queryFn: () => environmentsApi.list(companyId!),
|
||||
enabled: Boolean(companyId) && environmentsEnabled,
|
||||
});
|
||||
|
||||
const { data: reusableExecutionWorkspaces } = useQuery({
|
||||
queryKey: queryKeys.executionWorkspaces.list(companyId!, {
|
||||
|
|
@ -260,25 +254,39 @@ export function IssueWorkspaceCard({
|
|||
?? workspace
|
||||
?? null;
|
||||
|
||||
const configuredSelection = shouldPresentExistingWorkspaceSelection(issue)
|
||||
const currentSelection = shouldPresentExistingWorkspaceSelection(issue)
|
||||
? "reuse_existing"
|
||||
: (
|
||||
issue.executionWorkspacePreference
|
||||
?? issue.executionWorkspaceSettings?.mode
|
||||
?? defaultExecutionWorkspaceModeForProject(project)
|
||||
);
|
||||
const currentSelection = configuredSelection === "operator_branch" || configuredSelection === "agent_default"
|
||||
? "shared_workspace"
|
||||
: configuredSelection;
|
||||
|
||||
const [draftSelection, setDraftSelection] = useState(currentSelection);
|
||||
const [draftExecutionWorkspaceId, setDraftExecutionWorkspaceId] = useState(issue.executionWorkspaceId ?? "");
|
||||
const [draftEnvironmentId, setDraftEnvironmentId] = useState(issue.executionWorkspaceSettings?.environmentId ?? "");
|
||||
const projectEnvironmentId = environmentsEnabled
|
||||
? project?.executionWorkspacePolicy?.environmentId ?? null
|
||||
: null;
|
||||
const currentReusableEnvironmentId = selectedReusableExecutionWorkspace?.config?.environmentId ?? null;
|
||||
const currentEnvironmentId = environmentsEnabled
|
||||
? (
|
||||
(currentSelection === "reuse_existing" && currentReusableEnvironmentId)
|
||||
?? workspace?.config?.environmentId
|
||||
?? issue.executionWorkspaceSettings?.environmentId
|
||||
?? projectEnvironmentId
|
||||
)
|
||||
: null;
|
||||
const currentEnvironment =
|
||||
environments?.find((environment) => environment.id === currentEnvironmentId)
|
||||
?? null;
|
||||
|
||||
useEffect(() => {
|
||||
if (editing) return;
|
||||
setDraftSelection(currentSelection);
|
||||
setDraftExecutionWorkspaceId(issue.executionWorkspaceId ?? "");
|
||||
}, [currentSelection, editing, issue.executionWorkspaceId]);
|
||||
setDraftEnvironmentId(issue.executionWorkspaceSettings?.environmentId ?? "");
|
||||
}, [currentSelection, editing, issue.executionWorkspaceId, issue.executionWorkspaceSettings?.environmentId]);
|
||||
|
||||
const activeNonDefaultWorkspace = Boolean(workspace && workspace.mode !== "shared_workspace");
|
||||
|
||||
|
|
@ -298,6 +306,17 @@ export function IssueWorkspaceCard({
|
|||
});
|
||||
|
||||
const canSaveWorkspaceConfig = draftSelection !== "reuse_existing" || draftExecutionWorkspaceId.length > 0;
|
||||
const reuseExistingSelection = draftSelection === "reuse_existing";
|
||||
const selectedReusableEnvironmentId = configuredReusableWorkspace?.config?.environmentId ?? "";
|
||||
const runSelectableEnvironments = useMemo(
|
||||
() => environmentsEnabled ? (environments ?? []).filter((environment) => {
|
||||
if (environment.driver === "local" || environment.driver === "ssh") return true;
|
||||
if (environment.driver !== "sandbox") return false;
|
||||
const provider = typeof environment.config?.provider === "string" ? environment.config.provider : null;
|
||||
return provider !== null && provider !== "fake";
|
||||
}) : [],
|
||||
[environments, environmentsEnabled],
|
||||
);
|
||||
const draftWorkspaceBranchName =
|
||||
draftSelection === "reuse_existing" && configuredReusableWorkspace?.mode !== "shared_workspace"
|
||||
? configuredReusableWorkspace?.branchName ?? null
|
||||
|
|
@ -311,9 +330,11 @@ export function IssueWorkspaceCard({
|
|||
draftSelection === "reuse_existing"
|
||||
? issueModeForExistingWorkspace(configuredReusableWorkspace?.mode)
|
||||
: draftSelection,
|
||||
environmentId: draftSelection === "reuse_existing" ? null : draftEnvironmentId || null,
|
||||
},
|
||||
}), [
|
||||
configuredReusableWorkspace?.mode,
|
||||
draftEnvironmentId,
|
||||
draftExecutionWorkspaceId,
|
||||
draftSelection,
|
||||
]);
|
||||
|
|
@ -339,12 +360,9 @@ export function IssueWorkspaceCard({
|
|||
const handleCancel = useCallback(() => {
|
||||
setDraftSelection(currentSelection);
|
||||
setDraftExecutionWorkspaceId(issue.executionWorkspaceId ?? "");
|
||||
setDraftEnvironmentId(issue.executionWorkspaceSettings?.environmentId ?? "");
|
||||
setEditing(false);
|
||||
}, [currentSelection, issue.executionWorkspaceId]);
|
||||
|
||||
if (project && projectWorkspacePolicyEnabled && experimentalSettingsLoading) {
|
||||
return <IssueWorkspaceCardSkeleton />;
|
||||
}
|
||||
}, [currentSelection, issue.executionWorkspaceId, issue.executionWorkspaceSettings?.environmentId]);
|
||||
|
||||
if (!policyEnabled || !project) return null;
|
||||
|
||||
|
|
@ -362,7 +380,7 @@ export function IssueWorkspaceCard({
|
|||
{workspace ? statusBadge(workspace.status) : statusBadge("idle")}
|
||||
</div>
|
||||
<div className="flex items-center gap-1">
|
||||
{!livePreview && editing ? (
|
||||
{showEditingControls ? (
|
||||
<>
|
||||
<Button
|
||||
variant="ghost"
|
||||
|
|
@ -381,7 +399,7 @@ export function IssueWorkspaceCard({
|
|||
Save
|
||||
</Button>
|
||||
</>
|
||||
) : !livePreview ? (
|
||||
) : (
|
||||
<Button
|
||||
variant="ghost"
|
||||
size="sm"
|
||||
|
|
@ -390,7 +408,7 @@ export function IssueWorkspaceCard({
|
|||
>
|
||||
<Pencil className="h-3 w-3 mr-1" />Edit
|
||||
</Button>
|
||||
) : null}
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -415,6 +433,16 @@ export function IssueWorkspaceCard({
|
|||
<CopyableInline value={workspace.repoUrl} mono />
|
||||
</div>
|
||||
)}
|
||||
{environmentsEnabled && currentEnvironmentId && (
|
||||
<div className="text-muted-foreground" style={{ overflowWrap: "anywhere" }}>
|
||||
Environment: <span className="text-foreground">{currentEnvironment?.name ?? currentEnvironmentId}</span>
|
||||
{currentSelection === "reuse_existing" && currentReusableEnvironmentId === currentEnvironmentId
|
||||
? " · reused workspace"
|
||||
: !issue.executionWorkspaceSettings?.environmentId && projectEnvironmentId === currentEnvironmentId
|
||||
? " · project default"
|
||||
: null}
|
||||
</div>
|
||||
)}
|
||||
{!workspace && (
|
||||
<div className="text-muted-foreground">
|
||||
{currentSelection === "isolated_workspace"
|
||||
|
|
@ -453,7 +481,7 @@ export function IssueWorkspaceCard({
|
|||
)}
|
||||
|
||||
{/* Editing controls */}
|
||||
{showEditingControls && (
|
||||
{editing && (
|
||||
<div className="space-y-2 pt-1">
|
||||
<select
|
||||
className="w-full rounded border border-border bg-transparent px-2 py-1.5 text-xs outline-none"
|
||||
|
|
@ -494,6 +522,42 @@ export function IssueWorkspaceCard({
|
|||
</select>
|
||||
)}
|
||||
|
||||
{environmentsEnabled ? (
|
||||
<>
|
||||
<select
|
||||
className={cn(
|
||||
"w-full rounded border border-border bg-transparent px-2 py-1.5 text-xs outline-none",
|
||||
reuseExistingSelection && "cursor-not-allowed opacity-70",
|
||||
)}
|
||||
value={reuseExistingSelection ? selectedReusableEnvironmentId : draftEnvironmentId}
|
||||
onChange={(e) => setDraftEnvironmentId(e.target.value)}
|
||||
disabled={reuseExistingSelection}
|
||||
>
|
||||
<option value="">
|
||||
{reuseExistingSelection
|
||||
? configuredReusableWorkspace
|
||||
? "No environment on reused workspace"
|
||||
: "Select an existing workspace to inspect its environment"
|
||||
: projectEnvironmentId
|
||||
? "Project default environment"
|
||||
: "No environment"}
|
||||
</option>
|
||||
{runSelectableEnvironments.map((environment) => (
|
||||
<option key={environment.id} value={environment.id}>
|
||||
{environment.name} · {environment.driver}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
{reuseExistingSelection && (
|
||||
<div className="text-[11px] text-muted-foreground">
|
||||
{configuredReusableWorkspace
|
||||
? "Environment selection is locked while reusing an existing workspace. The next run will use that workspace's persisted environment config."
|
||||
: "Choose an existing workspace first. Its persisted environment config will determine the next run."}
|
||||
</div>
|
||||
)}
|
||||
</>
|
||||
) : null}
|
||||
|
||||
{/* Current workspace summary when editing */}
|
||||
{workspace && (
|
||||
<div className="text-[11px] text-muted-foreground space-y-0.5 pt-1 border-t border-border/50">
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue