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
171 lines
4.8 KiB
TypeScript
171 lines
4.8 KiB
TypeScript
import type { Server } from "node:http";
|
|
import express from "express";
|
|
import request from "supertest";
|
|
import { afterAll, beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const mockActivityService = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
forIssue: vi.fn(),
|
|
runsForIssue: vi.fn(),
|
|
issuesForRun: vi.fn(),
|
|
create: vi.fn(),
|
|
}));
|
|
|
|
const mockHeartbeatService = vi.hoisted(() => ({
|
|
getRun: vi.fn(),
|
|
}));
|
|
|
|
const mockIssueService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
getByIdentifier: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../services/activity.js", () => ({
|
|
activityService: () => mockActivityService,
|
|
normalizeActivityLimit: (limit: number | undefined) => {
|
|
if (!Number.isFinite(limit)) return 100;
|
|
return Math.max(1, Math.min(500, Math.floor(limit ?? 100)));
|
|
},
|
|
}));
|
|
|
|
vi.mock("../services/index.js", () => ({
|
|
issueService: () => mockIssueService,
|
|
heartbeatService: () => mockHeartbeatService,
|
|
}));
|
|
|
|
let server: Server | null = null;
|
|
|
|
async function createApp(
|
|
actor: Record<string, unknown> = {
|
|
type: "board",
|
|
userId: "user-1",
|
|
companyIds: ["company-1"],
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
},
|
|
) {
|
|
const [{ errorHandler }, { activityRoutes }] = await Promise.all([
|
|
import("../middleware/index.js"),
|
|
import("../routes/activity.js"),
|
|
]);
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
(req as any).actor = actor;
|
|
next();
|
|
});
|
|
app.use("/api", activityRoutes({} as any));
|
|
app.use(errorHandler);
|
|
server = app.listen(0);
|
|
return server;
|
|
}
|
|
|
|
describe("activity routes", () => {
|
|
afterAll(async () => {
|
|
if (!server) return;
|
|
await new Promise<void>((resolve, reject) => {
|
|
server?.close((err) => {
|
|
if (err) reject(err);
|
|
else resolve();
|
|
});
|
|
});
|
|
server = null;
|
|
});
|
|
|
|
beforeEach(() => {
|
|
vi.resetModules();
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("limits company activity lists by default", async () => {
|
|
mockActivityService.list.mockResolvedValue([]);
|
|
|
|
const app = await createApp();
|
|
const res = await request(app).get("/api/companies/company-1/activity");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockActivityService.list).toHaveBeenCalledWith({
|
|
companyId: "company-1",
|
|
agentId: undefined,
|
|
entityType: undefined,
|
|
entityId: undefined,
|
|
limit: 100,
|
|
});
|
|
});
|
|
|
|
it("caps requested company activity list limits", async () => {
|
|
mockActivityService.list.mockResolvedValue([]);
|
|
|
|
const app = await createApp();
|
|
const res = await request(app).get("/api/companies/company-1/activity?limit=5000&entityType=issue");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockActivityService.list).toHaveBeenCalledWith({
|
|
companyId: "company-1",
|
|
agentId: undefined,
|
|
entityType: "issue",
|
|
entityId: undefined,
|
|
limit: 500,
|
|
});
|
|
});
|
|
|
|
it("resolves issue identifiers before loading runs", async () => {
|
|
mockIssueService.getByIdentifier.mockResolvedValue({
|
|
id: "issue-uuid-1",
|
|
companyId: "company-1",
|
|
});
|
|
mockActivityService.runsForIssue.mockResolvedValue([
|
|
{
|
|
runId: "run-1",
|
|
adapterType: "codex_local",
|
|
},
|
|
]);
|
|
|
|
const app = await createApp();
|
|
const res = await request(app).get("/api/issues/PAP-475/runs");
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(mockIssueService.getByIdentifier).toHaveBeenCalledWith("PAP-475");
|
|
expect(mockIssueService.getById).not.toHaveBeenCalled();
|
|
expect(mockActivityService.runsForIssue).toHaveBeenCalledWith("company-1", "issue-uuid-1");
|
|
expect(res.body).toEqual([{ runId: "run-1", adapterType: "codex_local" }]);
|
|
});
|
|
|
|
it("requires company access before creating activity events", async () => {
|
|
const app = await createApp();
|
|
const res = await request(app)
|
|
.post("/api/companies/company-2/activity")
|
|
.send({
|
|
actorId: "user-1",
|
|
action: "test.event",
|
|
entityType: "issue",
|
|
entityId: "issue-1",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(mockActivityService.create).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires company access before listing issues for another company's run", async () => {
|
|
mockHeartbeatService.getRun.mockResolvedValue({
|
|
id: "run-2",
|
|
companyId: "company-2",
|
|
});
|
|
|
|
const app = await createApp();
|
|
const res = await request(app).get("/api/heartbeat-runs/run-2/issues");
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(mockActivityService.issuesForRun).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects anonymous heartbeat run issue lookups before run existence checks", async () => {
|
|
const app = await createApp({ type: "none", source: "none" });
|
|
const res = await request(app).get("/api/heartbeat-runs/missing-run/issues");
|
|
|
|
expect(res.status).toBe(401);
|
|
expect(mockHeartbeatService.getRun).not.toHaveBeenCalled();
|
|
expect(mockActivityService.issuesForRun).not.toHaveBeenCalled();
|
|
});
|
|
});
|