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
132 lines
4.8 KiB
TypeScript
132 lines
4.8 KiB
TypeScript
import { z } from "zod";
|
|
|
|
export const executionWorkspaceStatusSchema = z.enum([
|
|
"active",
|
|
"idle",
|
|
"in_review",
|
|
"archived",
|
|
"cleanup_failed",
|
|
]);
|
|
|
|
export const executionWorkspaceConfigSchema = z.object({
|
|
environmentId: z.string().uuid().optional().nullable(),
|
|
provisionCommand: z.string().optional().nullable(),
|
|
teardownCommand: z.string().optional().nullable(),
|
|
cleanupCommand: z.string().optional().nullable(),
|
|
workspaceRuntime: z.record(z.unknown()).optional().nullable(),
|
|
desiredState: z.enum(["running", "stopped", "manual"]).optional().nullable(),
|
|
serviceStates: z.record(z.enum(["running", "stopped", "manual"])).optional().nullable(),
|
|
}).strict();
|
|
|
|
export const workspaceRuntimeControlTargetSchema = z.object({
|
|
workspaceCommandId: z.string().min(1).optional().nullable(),
|
|
runtimeServiceId: z.string().uuid().optional().nullable(),
|
|
serviceIndex: z.number().int().nonnegative().optional().nullable(),
|
|
}).strict();
|
|
|
|
export const executionWorkspaceCloseReadinessStateSchema = z.enum([
|
|
"ready",
|
|
"ready_with_warnings",
|
|
"blocked",
|
|
]);
|
|
|
|
export const executionWorkspaceCloseActionKindSchema = z.enum([
|
|
"archive_record",
|
|
"stop_runtime_services",
|
|
"cleanup_command",
|
|
"teardown_command",
|
|
"git_worktree_remove",
|
|
"git_branch_delete",
|
|
"remove_local_directory",
|
|
]);
|
|
|
|
export const executionWorkspaceCloseActionSchema = z.object({
|
|
kind: executionWorkspaceCloseActionKindSchema,
|
|
label: z.string(),
|
|
description: z.string(),
|
|
command: z.string().nullable(),
|
|
}).strict();
|
|
|
|
export const executionWorkspaceCloseLinkedIssueSchema = z.object({
|
|
id: z.string().uuid(),
|
|
identifier: z.string().nullable(),
|
|
title: z.string(),
|
|
status: z.string(),
|
|
isTerminal: z.boolean(),
|
|
}).strict();
|
|
|
|
export const executionWorkspaceCloseGitReadinessSchema = z.object({
|
|
repoRoot: z.string().nullable(),
|
|
workspacePath: z.string().nullable(),
|
|
branchName: z.string().nullable(),
|
|
baseRef: z.string().nullable(),
|
|
hasDirtyTrackedFiles: z.boolean(),
|
|
hasUntrackedFiles: z.boolean(),
|
|
dirtyEntryCount: z.number().int().nonnegative(),
|
|
untrackedEntryCount: z.number().int().nonnegative(),
|
|
aheadCount: z.number().int().nonnegative().nullable(),
|
|
behindCount: z.number().int().nonnegative().nullable(),
|
|
isMergedIntoBase: z.boolean().nullable(),
|
|
createdByRuntime: z.boolean(),
|
|
}).strict();
|
|
|
|
export const workspaceRuntimeServiceSchema = z.object({
|
|
id: z.string(),
|
|
companyId: z.string().uuid(),
|
|
projectId: z.string().uuid().nullable(),
|
|
projectWorkspaceId: z.string().uuid().nullable(),
|
|
executionWorkspaceId: z.string().uuid().nullable(),
|
|
issueId: z.string().uuid().nullable(),
|
|
scopeType: z.enum(["project_workspace", "execution_workspace", "run", "agent"]),
|
|
scopeId: z.string().nullable(),
|
|
serviceName: z.string(),
|
|
status: z.enum(["starting", "running", "stopped", "failed"]),
|
|
lifecycle: z.enum(["shared", "ephemeral"]),
|
|
reuseKey: z.string().nullable(),
|
|
command: z.string().nullable(),
|
|
cwd: z.string().nullable(),
|
|
port: z.number().int().nullable(),
|
|
url: z.string().nullable(),
|
|
provider: z.enum(["local_process", "adapter_managed"]),
|
|
providerRef: z.string().nullable(),
|
|
ownerAgentId: z.string().uuid().nullable(),
|
|
startedByRunId: z.string().uuid().nullable(),
|
|
lastUsedAt: z.coerce.date(),
|
|
startedAt: z.coerce.date(),
|
|
stoppedAt: z.coerce.date().nullable(),
|
|
stopPolicy: z.record(z.unknown()).nullable(),
|
|
healthStatus: z.enum(["unknown", "healthy", "unhealthy"]),
|
|
configIndex: z.number().int().nonnegative().nullable().optional(),
|
|
createdAt: z.coerce.date(),
|
|
updatedAt: z.coerce.date(),
|
|
}).strict();
|
|
export const executionWorkspaceCloseReadinessSchema = z.object({
|
|
workspaceId: z.string().uuid(),
|
|
state: executionWorkspaceCloseReadinessStateSchema,
|
|
blockingReasons: z.array(z.string()),
|
|
warnings: z.array(z.string()),
|
|
linkedIssues: z.array(executionWorkspaceCloseLinkedIssueSchema),
|
|
plannedActions: z.array(executionWorkspaceCloseActionSchema),
|
|
isDestructiveCloseAllowed: z.boolean(),
|
|
isSharedWorkspace: z.boolean(),
|
|
isProjectPrimaryWorkspace: z.boolean(),
|
|
git: executionWorkspaceCloseGitReadinessSchema.nullable(),
|
|
runtimeServices: z.array(workspaceRuntimeServiceSchema),
|
|
}).strict();
|
|
|
|
export const updateExecutionWorkspaceSchema = z.object({
|
|
name: z.string().min(1).optional(),
|
|
cwd: z.string().optional().nullable(),
|
|
repoUrl: z.string().optional().nullable(),
|
|
baseRef: z.string().optional().nullable(),
|
|
branchName: z.string().optional().nullable(),
|
|
providerRef: z.string().optional().nullable(),
|
|
status: executionWorkspaceStatusSchema.optional(),
|
|
cleanupEligibleAt: z.string().datetime().optional().nullable(),
|
|
cleanupReason: z.string().optional().nullable(),
|
|
config: executionWorkspaceConfigSchema.optional().nullable(),
|
|
metadata: z.record(z.unknown()).optional().nullable(),
|
|
}).strict();
|
|
|
|
export type UpdateExecutionWorkspace = z.infer<typeof updateExecutionWorkspaceSchema>;
|