e4995bbb1c
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - The environments subsystem already models execution environments, but before this branch there was no end-to-end SSH-backed runtime path for agents to actually run work against a remote box > - That meant agents could be configured around environment concepts without a reliable way to execute adapter sessions remotely, sync workspace state, and preserve run context across supported adapters > - We also need environment selection to participate in normal Paperclip control-plane behavior: agent defaults, project/issue selection, route validation, and environment probing > - Because this capability is still experimental, the UI surface should be easy to hide and easy to remove later without undoing the underlying implementation > - This pull request adds SSH environment execution support across the runtime, adapters, routes, schema, and tests, then puts the visible environment-management UI behind an experimental flag > - The benefit is that we can validate real SSH-backed agent execution now while keeping the user-facing controls safely gated until the feature is ready to come out of experimentation ## What Changed - Added SSH-backed execution target support in the shared adapter runtime, including remote workspace preparation, skill/runtime asset sync, remote session handling, and workspace restore behavior after runs. - Added SSH execution coverage for supported local adapters, plus remote execution tests across Claude, Codex, Cursor, Gemini, OpenCode, and Pi. - Added environment selection and environment-management backend support needed for SSH execution, including route/service work, validation, probing, and agent default environment persistence. - Added CLI support for SSH environment lab verification and updated related docs/tests. - Added the `enableEnvironments` experimental flag and gated the environment UI behind it on company settings, agent configuration, and project configuration surfaces. ## Verification - `pnpm exec vitest run packages/adapters/claude-local/src/server/execute.remote.test.ts packages/adapters/cursor-local/src/server/execute.remote.test.ts packages/adapters/gemini-local/src/server/execute.remote.test.ts packages/adapters/opencode-local/src/server/execute.remote.test.ts packages/adapters/pi-local/src/server/execute.remote.test.ts` - `pnpm exec vitest run server/src/__tests__/environment-routes.test.ts` - `pnpm exec vitest run server/src/__tests__/instance-settings-routes.test.ts` - `pnpm exec vitest run ui/src/lib/new-agent-hire-payload.test.ts ui/src/lib/new-agent-runtime-config.test.ts` - `pnpm -r typecheck` - `pnpm build` - Manual verification on a branch-local dev server: - enabled the experimental flag - created an SSH environment - created a Linux Claude agent using that environment - confirmed a run executed on the Linux box and synced workspace changes back ## Risks - Medium: this touches runtime execution flow across multiple adapters, so regressions would likely show up in remote session setup, workspace sync, or environment selection precedence. - The UI flag reduces exposure, but the underlying runtime and route changes are still substantial and rely on migration correctness. - The change set is broad across adapters, control-plane services, migrations, and UI gating, so review should pay close attention to environment-selection precedence and remote workspace lifecycle behavior. ## Model Used - OpenAI Codex via Paperclip's local Codex adapter, GPT-5-class coding model with tool use and code execution in the local repo workspace. The local adapter does not surface a more specific public model version string in this branch workflow. ## 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
235 lines
9.8 KiB
TypeScript
235 lines
9.8 KiB
TypeScript
import type {
|
|
ExecutionWorkspaceMode,
|
|
ExecutionWorkspaceStrategy,
|
|
IssueExecutionWorkspaceSettings,
|
|
ProjectExecutionWorkspaceDefaultMode,
|
|
ProjectExecutionWorkspacePolicy,
|
|
} from "@paperclipai/shared";
|
|
import { asString, parseObject } from "../adapters/utils.js";
|
|
|
|
type ParsedExecutionWorkspaceMode = Exclude<ExecutionWorkspaceMode, "inherit" | "reuse_existing">;
|
|
|
|
function cloneRecord(value: Record<string, unknown> | null | undefined): Record<string, unknown> | null {
|
|
if (!value) return null;
|
|
return { ...value };
|
|
}
|
|
|
|
function parseExecutionWorkspaceStrategy(raw: unknown): ExecutionWorkspaceStrategy | null {
|
|
const parsed = parseObject(raw);
|
|
const type = asString(parsed.type, "");
|
|
if (type !== "project_primary" && type !== "git_worktree" && type !== "adapter_managed" && type !== "cloud_sandbox") {
|
|
return null;
|
|
}
|
|
return {
|
|
type,
|
|
...(typeof parsed.baseRef === "string" ? { baseRef: parsed.baseRef } : {}),
|
|
...(typeof parsed.branchTemplate === "string" ? { branchTemplate: parsed.branchTemplate } : {}),
|
|
...(typeof parsed.worktreeParentDir === "string" ? { worktreeParentDir: parsed.worktreeParentDir } : {}),
|
|
...(typeof parsed.provisionCommand === "string" ? { provisionCommand: parsed.provisionCommand } : {}),
|
|
...(typeof parsed.teardownCommand === "string" ? { teardownCommand: parsed.teardownCommand } : {}),
|
|
};
|
|
}
|
|
|
|
export function parseProjectExecutionWorkspacePolicy(raw: unknown): ProjectExecutionWorkspacePolicy | null {
|
|
const parsed = parseObject(raw);
|
|
if (Object.keys(parsed).length === 0) return null;
|
|
const enabled = typeof parsed.enabled === "boolean" ? parsed.enabled : false;
|
|
const workspaceStrategy = parseExecutionWorkspaceStrategy(parsed.workspaceStrategy);
|
|
const defaultMode = asString(parsed.defaultMode, "");
|
|
const defaultProjectWorkspaceId =
|
|
typeof parsed.defaultProjectWorkspaceId === "string" ? parsed.defaultProjectWorkspaceId : undefined;
|
|
const environmentId = typeof parsed.environmentId === "string" ? parsed.environmentId : undefined;
|
|
const allowIssueOverride =
|
|
typeof parsed.allowIssueOverride === "boolean" ? parsed.allowIssueOverride : undefined;
|
|
const normalizedDefaultMode = (() => {
|
|
if (
|
|
defaultMode === "shared_workspace" ||
|
|
defaultMode === "isolated_workspace" ||
|
|
defaultMode === "operator_branch" ||
|
|
defaultMode === "adapter_default"
|
|
) {
|
|
return defaultMode as ProjectExecutionWorkspaceDefaultMode;
|
|
}
|
|
if (defaultMode === "project_primary") return "shared_workspace";
|
|
if (defaultMode === "isolated") return "isolated_workspace";
|
|
return undefined;
|
|
})();
|
|
return {
|
|
enabled,
|
|
...(normalizedDefaultMode ? { defaultMode: normalizedDefaultMode } : {}),
|
|
...(allowIssueOverride !== undefined ? { allowIssueOverride } : {}),
|
|
...(defaultProjectWorkspaceId ? { defaultProjectWorkspaceId } : {}),
|
|
...(environmentId !== undefined ? { environmentId } : {}),
|
|
...(workspaceStrategy ? { workspaceStrategy } : {}),
|
|
...(parsed.workspaceRuntime && typeof parsed.workspaceRuntime === "object" && !Array.isArray(parsed.workspaceRuntime)
|
|
? { workspaceRuntime: { ...(parsed.workspaceRuntime as Record<string, unknown>) } }
|
|
: {}),
|
|
...(parsed.branchPolicy && typeof parsed.branchPolicy === "object" && !Array.isArray(parsed.branchPolicy)
|
|
? { branchPolicy: { ...(parsed.branchPolicy as Record<string, unknown>) } }
|
|
: {}),
|
|
...(parsed.pullRequestPolicy && typeof parsed.pullRequestPolicy === "object" && !Array.isArray(parsed.pullRequestPolicy)
|
|
? { pullRequestPolicy: { ...(parsed.pullRequestPolicy as Record<string, unknown>) } }
|
|
: {}),
|
|
...(parsed.runtimePolicy && typeof parsed.runtimePolicy === "object" && !Array.isArray(parsed.runtimePolicy)
|
|
? { runtimePolicy: { ...(parsed.runtimePolicy as Record<string, unknown>) } }
|
|
: {}),
|
|
...(parsed.cleanupPolicy && typeof parsed.cleanupPolicy === "object" && !Array.isArray(parsed.cleanupPolicy)
|
|
? { cleanupPolicy: { ...(parsed.cleanupPolicy as Record<string, unknown>) } }
|
|
: {}),
|
|
};
|
|
}
|
|
|
|
export function gateProjectExecutionWorkspacePolicy(
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null,
|
|
isolatedWorkspacesEnabled: boolean,
|
|
): ProjectExecutionWorkspacePolicy | null {
|
|
if (!isolatedWorkspacesEnabled) return null;
|
|
return projectPolicy;
|
|
}
|
|
|
|
export function parseIssueExecutionWorkspaceSettings(raw: unknown): IssueExecutionWorkspaceSettings | null {
|
|
const parsed = parseObject(raw);
|
|
if (Object.keys(parsed).length === 0) return null;
|
|
const workspaceStrategy = parseExecutionWorkspaceStrategy(parsed.workspaceStrategy);
|
|
const mode = asString(parsed.mode, "");
|
|
const normalizedMode = (() => {
|
|
if (
|
|
mode === "inherit" ||
|
|
mode === "shared_workspace" ||
|
|
mode === "isolated_workspace" ||
|
|
mode === "operator_branch" ||
|
|
mode === "reuse_existing" ||
|
|
mode === "agent_default"
|
|
) {
|
|
return mode;
|
|
}
|
|
if (mode === "project_primary") return "shared_workspace";
|
|
if (mode === "isolated") return "isolated_workspace";
|
|
return "";
|
|
})();
|
|
return {
|
|
...(normalizedMode
|
|
? { mode: normalizedMode as IssueExecutionWorkspaceSettings["mode"] }
|
|
: {}),
|
|
...(typeof parsed.environmentId === "string" ? { environmentId: parsed.environmentId } : {}),
|
|
...(workspaceStrategy ? { workspaceStrategy } : {}),
|
|
...(parsed.workspaceRuntime && typeof parsed.workspaceRuntime === "object" && !Array.isArray(parsed.workspaceRuntime)
|
|
? { workspaceRuntime: { ...(parsed.workspaceRuntime as Record<string, unknown>) } }
|
|
: {}),
|
|
};
|
|
}
|
|
|
|
export function resolveExecutionWorkspaceEnvironmentId(input: {
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null;
|
|
issueSettings: IssueExecutionWorkspaceSettings | null;
|
|
workspaceConfig: { environmentId?: string | null } | null;
|
|
agentDefaultEnvironmentId: string | null;
|
|
defaultEnvironmentId: string;
|
|
}) {
|
|
if (input.workspaceConfig?.environmentId !== undefined) {
|
|
return input.workspaceConfig.environmentId ?? input.defaultEnvironmentId;
|
|
}
|
|
if (input.issueSettings?.environmentId !== undefined) {
|
|
return input.issueSettings.environmentId ?? input.defaultEnvironmentId;
|
|
}
|
|
if (input.projectPolicy?.environmentId !== undefined) {
|
|
return input.projectPolicy.environmentId ?? input.defaultEnvironmentId;
|
|
}
|
|
if (input.agentDefaultEnvironmentId !== null) {
|
|
return input.agentDefaultEnvironmentId;
|
|
}
|
|
return input.defaultEnvironmentId;
|
|
}
|
|
|
|
export function defaultIssueExecutionWorkspaceSettingsForProject(
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null,
|
|
): IssueExecutionWorkspaceSettings | null {
|
|
if (!projectPolicy?.enabled) return null;
|
|
return {
|
|
mode:
|
|
projectPolicy.defaultMode === "isolated_workspace"
|
|
? "isolated_workspace"
|
|
: projectPolicy.defaultMode === "operator_branch"
|
|
? "operator_branch"
|
|
: projectPolicy.defaultMode === "adapter_default"
|
|
? "agent_default"
|
|
: "shared_workspace",
|
|
};
|
|
}
|
|
|
|
export function issueExecutionWorkspaceModeForPersistedWorkspace(
|
|
mode: string | null | undefined,
|
|
): IssueExecutionWorkspaceSettings["mode"] {
|
|
if (mode === null || mode === undefined) {
|
|
return "agent_default";
|
|
}
|
|
if (mode === "isolated_workspace" || mode === "operator_branch" || mode === "shared_workspace") {
|
|
return mode;
|
|
}
|
|
if (mode === "adapter_managed" || mode === "cloud_sandbox") {
|
|
return "agent_default";
|
|
}
|
|
return "shared_workspace";
|
|
}
|
|
|
|
export function resolveExecutionWorkspaceMode(input: {
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null;
|
|
issueSettings: IssueExecutionWorkspaceSettings | null;
|
|
legacyUseProjectWorkspace: boolean | null;
|
|
}): ParsedExecutionWorkspaceMode {
|
|
const issueMode = input.issueSettings?.mode;
|
|
if (issueMode && issueMode !== "inherit" && issueMode !== "reuse_existing") {
|
|
return issueMode;
|
|
}
|
|
if (input.projectPolicy?.enabled) {
|
|
if (input.projectPolicy.defaultMode === "isolated_workspace") return "isolated_workspace";
|
|
if (input.projectPolicy.defaultMode === "operator_branch") return "operator_branch";
|
|
if (input.projectPolicy.defaultMode === "adapter_default") return "agent_default";
|
|
return "shared_workspace";
|
|
}
|
|
if (input.legacyUseProjectWorkspace === false) {
|
|
return "agent_default";
|
|
}
|
|
return "shared_workspace";
|
|
}
|
|
|
|
export function buildExecutionWorkspaceAdapterConfig(input: {
|
|
agentConfig: Record<string, unknown>;
|
|
projectPolicy: ProjectExecutionWorkspacePolicy | null;
|
|
issueSettings: IssueExecutionWorkspaceSettings | null;
|
|
mode: ParsedExecutionWorkspaceMode;
|
|
legacyUseProjectWorkspace: boolean | null;
|
|
}): Record<string, unknown> {
|
|
const nextConfig = { ...input.agentConfig };
|
|
const projectHasPolicy = Boolean(input.projectPolicy?.enabled);
|
|
const issueHasWorkspaceOverrides = Boolean(
|
|
input.issueSettings?.mode ||
|
|
input.issueSettings?.workspaceStrategy ||
|
|
input.issueSettings?.workspaceRuntime,
|
|
);
|
|
const hasWorkspaceControl = projectHasPolicy || issueHasWorkspaceOverrides || input.legacyUseProjectWorkspace === false;
|
|
|
|
if (hasWorkspaceControl) {
|
|
if (input.mode === "isolated_workspace") {
|
|
const strategy =
|
|
input.issueSettings?.workspaceStrategy ??
|
|
input.projectPolicy?.workspaceStrategy ??
|
|
parseExecutionWorkspaceStrategy(nextConfig.workspaceStrategy) ??
|
|
({ type: "git_worktree" } satisfies ExecutionWorkspaceStrategy);
|
|
nextConfig.workspaceStrategy = strategy as unknown as Record<string, unknown>;
|
|
} else {
|
|
delete nextConfig.workspaceStrategy;
|
|
}
|
|
|
|
if (input.mode === "agent_default") {
|
|
delete nextConfig.workspaceRuntime;
|
|
} else if (input.issueSettings?.workspaceRuntime) {
|
|
nextConfig.workspaceRuntime = cloneRecord(input.issueSettings.workspaceRuntime) ?? undefined;
|
|
} else if (input.projectPolicy?.workspaceRuntime) {
|
|
nextConfig.workspaceRuntime = cloneRecord(input.projectPolicy.workspaceRuntime) ?? undefined;
|
|
}
|
|
}
|
|
|
|
return nextConfig;
|
|
}
|