mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-16 10:50:38 +09:00
## 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
363 lines
12 KiB
TypeScript
363 lines
12 KiB
TypeScript
import { Router, type Request } from "express";
|
|
import type { Db } from "@paperclipai/db";
|
|
import {
|
|
addApprovalCommentSchema,
|
|
createApprovalSchema,
|
|
requestApprovalRevisionSchema,
|
|
resolveApprovalSchema,
|
|
resubmitApprovalSchema,
|
|
} from "@paperclipai/shared";
|
|
import { validate } from "../middleware/validate.js";
|
|
import { logger } from "../middleware/logger.js";
|
|
import {
|
|
approvalService,
|
|
heartbeatService,
|
|
issueApprovalService,
|
|
logActivity,
|
|
secretService,
|
|
} from "../services/index.js";
|
|
import { assertBoard, assertCompanyAccess, getActorInfo } from "./authz.js";
|
|
import { redactEventPayload } from "../redaction.js";
|
|
import type { PluginWorkerManager } from "../services/plugin-worker-manager.js";
|
|
|
|
function redactApprovalPayload<T extends { payload: Record<string, unknown> }>(approval: T): T {
|
|
return {
|
|
...approval,
|
|
payload: redactEventPayload(approval.payload) ?? {},
|
|
};
|
|
}
|
|
|
|
export function approvalRoutes(
|
|
db: Db,
|
|
options: { pluginWorkerManager?: PluginWorkerManager } = {},
|
|
) {
|
|
const router = Router();
|
|
const svc = approvalService(db);
|
|
const heartbeat = heartbeatService(db, {
|
|
pluginWorkerManager: options.pluginWorkerManager,
|
|
});
|
|
const issueApprovalsSvc = issueApprovalService(db);
|
|
const secretsSvc = secretService(db);
|
|
const strictSecretsMode = process.env.PAPERCLIP_SECRETS_STRICT_MODE === "true";
|
|
|
|
async function requireApprovalAccess(req: Request, id: string) {
|
|
const approval = await svc.getById(id);
|
|
if (!approval) {
|
|
return null;
|
|
}
|
|
assertCompanyAccess(req, approval.companyId);
|
|
return approval;
|
|
}
|
|
|
|
router.get("/companies/:companyId/approvals", async (req, res) => {
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
const status = req.query.status as string | undefined;
|
|
const result = await svc.list(companyId, status);
|
|
res.json(result.map((approval) => redactApprovalPayload(approval)));
|
|
});
|
|
|
|
router.get("/approvals/:id", async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const approval = await svc.getById(id);
|
|
if (!approval) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, approval.companyId);
|
|
res.json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.post("/companies/:companyId/approvals", validate(createApprovalSchema), async (req, res) => {
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
const rawIssueIds = req.body.issueIds;
|
|
const issueIds = Array.isArray(rawIssueIds)
|
|
? rawIssueIds.filter((value: unknown): value is string => typeof value === "string")
|
|
: [];
|
|
const uniqueIssueIds = Array.from(new Set(issueIds));
|
|
const { issueIds: _issueIds, ...approvalInput } = req.body;
|
|
const normalizedPayload =
|
|
approvalInput.type === "hire_agent"
|
|
? await secretsSvc.normalizeHireApprovalPayloadForPersistence(
|
|
companyId,
|
|
approvalInput.payload,
|
|
{ strictMode: strictSecretsMode },
|
|
)
|
|
: approvalInput.payload;
|
|
|
|
const actor = getActorInfo(req);
|
|
const approval = await svc.create(companyId, {
|
|
...approvalInput,
|
|
payload: normalizedPayload,
|
|
requestedByUserId: actor.actorType === "user" ? actor.actorId : null,
|
|
requestedByAgentId:
|
|
approvalInput.requestedByAgentId ?? (actor.actorType === "agent" ? actor.actorId : null),
|
|
status: "pending",
|
|
decisionNote: null,
|
|
decidedByUserId: null,
|
|
decidedAt: null,
|
|
updatedAt: new Date(),
|
|
});
|
|
|
|
if (uniqueIssueIds.length > 0) {
|
|
await issueApprovalsSvc.linkManyForApproval(approval.id, uniqueIssueIds, {
|
|
agentId: actor.agentId,
|
|
userId: actor.actorType === "user" ? actor.actorId : null,
|
|
});
|
|
}
|
|
|
|
await logActivity(db, {
|
|
companyId,
|
|
actorType: actor.actorType,
|
|
actorId: actor.actorId,
|
|
agentId: actor.agentId,
|
|
action: "approval.created",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { type: approval.type, issueIds: uniqueIssueIds },
|
|
});
|
|
|
|
res.status(201).json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.get("/approvals/:id/issues", async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const approval = await svc.getById(id);
|
|
if (!approval) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, approval.companyId);
|
|
const issues = await issueApprovalsSvc.listIssuesForApproval(id);
|
|
res.json(issues);
|
|
});
|
|
|
|
router.post("/approvals/:id/approve", validate(resolveApprovalSchema), async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
if (!(await requireApprovalAccess(req, id))) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
const decidedByUserId = req.actor.userId ?? "board";
|
|
const { approval, applied } = await svc.approve(id, decidedByUserId, req.body.decisionNote);
|
|
|
|
if (applied) {
|
|
const linkedIssues = await issueApprovalsSvc.listIssuesForApproval(approval.id);
|
|
const linkedIssueIds = linkedIssues.map((issue) => issue.id);
|
|
const primaryIssueId = linkedIssueIds[0] ?? null;
|
|
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.approved",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: {
|
|
type: approval.type,
|
|
requestedByAgentId: approval.requestedByAgentId,
|
|
linkedIssueIds,
|
|
},
|
|
});
|
|
|
|
if (approval.requestedByAgentId) {
|
|
try {
|
|
const wakeRun = await heartbeat.wakeup(approval.requestedByAgentId, {
|
|
source: "automation",
|
|
triggerDetail: "system",
|
|
reason: "approval_approved",
|
|
payload: {
|
|
approvalId: approval.id,
|
|
approvalStatus: approval.status,
|
|
issueId: primaryIssueId,
|
|
issueIds: linkedIssueIds,
|
|
},
|
|
requestedByActorType: "user",
|
|
requestedByActorId: req.actor.userId ?? "board",
|
|
contextSnapshot: {
|
|
source: "approval.approved",
|
|
approvalId: approval.id,
|
|
approvalStatus: approval.status,
|
|
issueId: primaryIssueId,
|
|
issueIds: linkedIssueIds,
|
|
taskId: primaryIssueId,
|
|
wakeReason: "approval_approved",
|
|
},
|
|
});
|
|
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.requester_wakeup_queued",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: {
|
|
requesterAgentId: approval.requestedByAgentId,
|
|
wakeRunId: wakeRun?.id ?? null,
|
|
linkedIssueIds,
|
|
},
|
|
});
|
|
} catch (err) {
|
|
logger.warn(
|
|
{
|
|
err,
|
|
approvalId: approval.id,
|
|
requestedByAgentId: approval.requestedByAgentId,
|
|
},
|
|
"failed to queue requester wakeup after approval",
|
|
);
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.requester_wakeup_failed",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: {
|
|
requesterAgentId: approval.requestedByAgentId,
|
|
linkedIssueIds,
|
|
error: err instanceof Error ? err.message : String(err),
|
|
},
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
res.json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.post("/approvals/:id/reject", validate(resolveApprovalSchema), async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
if (!(await requireApprovalAccess(req, id))) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
const decidedByUserId = req.actor.userId ?? "board";
|
|
const { approval, applied } = await svc.reject(id, decidedByUserId, req.body.decisionNote);
|
|
|
|
if (applied) {
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.rejected",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { type: approval.type },
|
|
});
|
|
}
|
|
|
|
res.json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.post(
|
|
"/approvals/:id/request-revision",
|
|
validate(requestApprovalRevisionSchema),
|
|
async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
if (!(await requireApprovalAccess(req, id))) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
const decidedByUserId = req.actor.userId ?? "board";
|
|
const approval = await svc.requestRevision(id, decidedByUserId, req.body.decisionNote);
|
|
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "approval.revision_requested",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { type: approval.type },
|
|
});
|
|
|
|
res.json(redactApprovalPayload(approval));
|
|
},
|
|
);
|
|
|
|
router.post("/approvals/:id/resubmit", validate(resubmitApprovalSchema), async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
|
|
if (req.actor.type === "agent" && req.actor.agentId !== existing.requestedByAgentId) {
|
|
res.status(403).json({ error: "Only requesting agent can resubmit this approval" });
|
|
return;
|
|
}
|
|
|
|
const normalizedPayload = req.body.payload
|
|
? existing.type === "hire_agent"
|
|
? await secretsSvc.normalizeHireApprovalPayloadForPersistence(
|
|
existing.companyId,
|
|
req.body.payload,
|
|
{ strictMode: strictSecretsMode },
|
|
)
|
|
: req.body.payload
|
|
: undefined;
|
|
const approval = await svc.resubmit(id, normalizedPayload);
|
|
const actor = getActorInfo(req);
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: actor.actorType,
|
|
actorId: actor.actorId,
|
|
agentId: actor.agentId,
|
|
action: "approval.resubmitted",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { type: approval.type },
|
|
});
|
|
res.json(redactApprovalPayload(approval));
|
|
});
|
|
|
|
router.get("/approvals/:id/comments", async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const approval = await svc.getById(id);
|
|
if (!approval) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, approval.companyId);
|
|
const comments = await svc.listComments(id);
|
|
res.json(comments);
|
|
});
|
|
|
|
router.post("/approvals/:id/comments", validate(addApprovalCommentSchema), async (req, res) => {
|
|
const id = req.params.id as string;
|
|
const approval = await svc.getById(id);
|
|
if (!approval) {
|
|
res.status(404).json({ error: "Approval not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, approval.companyId);
|
|
const actor = getActorInfo(req);
|
|
const comment = await svc.addComment(id, req.body.body, {
|
|
agentId: actor.agentId ?? undefined,
|
|
userId: actor.actorType === "user" ? actor.actorId : undefined,
|
|
});
|
|
|
|
await logActivity(db, {
|
|
companyId: approval.companyId,
|
|
actorType: actor.actorType,
|
|
actorId: actor.actorId,
|
|
agentId: actor.agentId,
|
|
action: "approval.comment_added",
|
|
entityType: "approval",
|
|
entityId: approval.id,
|
|
details: { commentId: comment.id },
|
|
});
|
|
|
|
res.status(201).json(comment);
|
|
});
|
|
|
|
return router;
|
|
}
|