Files
PaperClipAI/server/src/services/execution-allowlist.test.ts
T
Devin Foley 0044fa8904 Let tenants edit env vars on managed sandbox environments; add managed-sandbox-only mode (#11200)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - Environments give each agent run an execution target: the local
host, SSH, or a sandbox provider
> - A managed deployment can provision one platform-managed sandbox
environment through the `PAPERCLIP_MANAGED_CONFIG` `environments`
section
> - That row is fully locked today. A tenant cannot add environment
variables for their agents. There is also no way to hide local execution
— run selection falls back to the local row
> - A platform that manages the sandbox for its tenants needs both: the
tenant adds env vars (and nothing else), and local execution is neither
visible nor reachable
> - This pull request opens exactly one tenant edit (env vars) on the
managed sandbox row, and adds an `enableManagedSandboxOnly` mode that
hides local and makes run selection fail closed
> - The benefit is a complete managed-sandbox experience with no change
for self-hosted instances

## Linked Issues or Issue Description

**Subsystem affected**

Environments (managed sandbox provisioning, environment routes, run
environment selection) and the environments UI.

**Problem or motivation**

Platform-provisioned sandbox environments
(`metadata.managedByPaperclip`) reject every write on cloud-managed
instances. Agents often need environment variables inside their sandbox.
The tenant has no way to set them on the managed row. Separately, an
operator cannot remove local execution: the environment list always
shows the local row, and run selection falls back to it when no default
is set.

**Proposed solution**

Allow an envVars-only PATCH on the managed sandbox row, and echo those
env vars back for editing. Add a managed-tier feature
(`enableManagedSandboxOnly`) that hides the local environment from all
read surfaces and redirects local-landing run selection to the managed
sandbox environment, failing closed when it is unavailable.

**Alternatives considered**

UI-only hiding of the local row. This was rejected: it does not stop a
run from resolving to local, so it is presentation without enforcement.
Full unlock of the managed row was also rejected: name, driver, and
config stay platform-owned so boot reconciliation cannot fight tenant
edits.

## What Changed

- `server/src/routes/environments.ts`: the platform-provisioned write
floor admits an envVars-only PATCH on the generalized managed sandbox
row (sandbox driver, `managedByPaperclip`, not legacy kubernetes-marker
rows). Name, driver, config, status, metadata, and DELETE stay rejected.
The read floor stops blanking env vars on that row; credential-shaped
config keys stay redacted for every actor. Legacy kubernetes-marker rows
keep the full floor.
- Same file: under `enableManagedSandboxOnly`, the environments list and
the by-id read omit the local row for every actor, including instance
admins.
- `server/src/services/execution-workspace-policy.ts`:
`resolveExecutionWorkspaceEnvironmentId` gains the managed-sandbox-only
inputs. A selection that lands on the local environment is redirected to
the managed sandbox environment. With no active managed row it throws
`ManagedSandboxUnavailableError` — never local. Non-local selections
(ssh, user-created sandboxes) are untouched.
- `server/src/services/heartbeat.ts`: the run path reads the flag, looks
up the managed row (`findManagedSandboxEnvironment`, new read-only
finder in `environments.ts`), and passes both to the resolver. Mirrors
the forced-kubernetes precedent, which keeps precedence when both
regimes are on.
- `server/src/services/managed-environments.ts`: after a successful
reconcile, the instance default environment moves to the managed sandbox
row when the current default is unset, local, or dangling. A
tenant-chosen custom environment is never overridden.
- `packages/shared`: new `enableManagedSandboxOnly` key (schema default
false, catalog tier `managed`, cloudDefault false, selfHostedDefault
false) and the matching interface field.
- UI: managed rows show a "Managed by Paperclip" lock badge; editing one
opens a dedicated env-vars-only editor that sends the one PATCH shape
the server admits (the old full form failed with a 403 on save). New
`ui/src/lib/managed-sandbox-environment.ts` mirrors the local filter for
cached lists (applied in the project picker; the agent picker already
excluded local). The experimental settings page gains the toggle at its
alphabetical card position. `environmentsApi.update` now declares the
`envVars` field it already sent.
- Tests: environment route floor coverage (envVars-only accepted, mixed
bodies rejected, legacy rows still blanked and locked, local hidden and
404 under the flag, self-hosted unchanged), an embedded-postgres service
test pinning that boot reconciliation never touches tenant env vars,
resolver redirect/fail-closed cases, managed-environments
default-stamping cases, and UI lib/settings tests.

## Verification

- `pnpm --filter @paperclipai/server exec vitest run
src/__tests__/environment-routes.test.ts
src/__tests__/environment-service.test.ts
src/__tests__/execution-workspace-policy.test.ts
src/services/managed-environments.test.ts` — all pass.
- `pnpm --filter @paperclipai/shared exec vitest run` — 425 pass
(catalog/schema default parity is pinned by an existing test).
- `pnpm --filter @paperclipai/ui exec tsc --noEmit` and the affected UI
suites (CompanyEnvironments, InstanceExperimentalSettings incl.
card-order test, new lib test) — all pass.
- Full workspace `pnpm test`: 3,414 passed. 17 files report failures on
this machine; the identical 17 fail on a clean `origin/master` worktree
in the same environment (git-worktree/skills/embedded-postgres
environment dependencies and plugin-SDK zero-test collections). One
additional file (`issue-monitor-scheduler.test.ts`) failed one
timing-sensitive test in one of two full-suite runs and passes 7/7 in
isolation on this branch — a flake in a domain this diff does not touch.
The branch introduces no new failures.
- Self-hosted zero-delta: every new behavior is gated on the
cloud-managed instance check or the new flag, which defaults to false in
schema and catalog; pinned by the "does not floor platform-marked rows
on self-hosted instances" and flag-off tests.

## Risks

- Behavior is opt-in twice over: the write-floor exception applies only
to rows the managed-config provisioner stamps, and the hiding/forcing
applies only when `enableManagedSandboxOnly` is on (default false
everywhere). Self-hosted instances see no change.
- The env-vars echo is scoped to the generalized managed sandbox row;
legacy kubernetes-marker rows keep the blanket floor because
pre-generalization builds may have written platform values there.
- Fail-closed run selection means a managed instance with the flag on
and an archived managed row (provider plugin down) refuses runs with a
precise error instead of running locally. That is the intended posture.

## Model Used

Claude Fable 5 (`claude-fable-5`), extended thinking, agentic tool use
via Claude Code CLI.

## 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 searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-08-11 11:40:57 -07:00

136 lines
5.2 KiB
TypeScript

import { describe, expect, it } from "vitest";
import {
KUBERNETES_PROVIDER_KEY,
evaluateExecutionAllowlist,
type ExecutionEnvironmentCandidate,
} from "./execution-allowlist.js";
const localEnv: ExecutionEnvironmentCandidate = {
driver: "local",
provider: null,
};
const kubernetesEnv: ExecutionEnvironmentCandidate = {
driver: "sandbox",
provider: KUBERNETES_PROVIDER_KEY,
};
const fakeSandboxEnv: ExecutionEnvironmentCandidate = {
driver: "sandbox",
provider: "fake",
};
const sshEnv: ExecutionEnvironmentCandidate = {
driver: "ssh",
provider: null,
};
describe("evaluateExecutionAllowlist", () => {
describe('executionMode "any" (unrestricted, default)', () => {
it("allows the local environment", () => {
const result = evaluateExecutionAllowlist({ executionMode: "any" }, localEnv);
expect(result.allowed).toBe(true);
});
it("allows the kubernetes sandbox environment", () => {
const result = evaluateExecutionAllowlist({ executionMode: "any" }, kubernetesEnv);
expect(result.allowed).toBe(true);
});
it("allows a non-kubernetes sandbox environment", () => {
const result = evaluateExecutionAllowlist({ executionMode: "any" }, fakeSandboxEnv);
expect(result.allowed).toBe(true);
});
it("treats absent executionMode as unrestricted", () => {
expect(evaluateExecutionAllowlist({}, localEnv).allowed).toBe(true);
expect(evaluateExecutionAllowlist({ executionMode: undefined }, localEnv).allowed).toBe(true);
});
});
describe('executionMode "kubernetes" (forced sandbox)', () => {
it("allows ONLY a kubernetes sandbox_provider environment", () => {
const result = evaluateExecutionAllowlist({ executionMode: "kubernetes" }, kubernetesEnv);
expect(result.allowed).toBe(true);
});
it("DENIES the local environment", () => {
const result = evaluateExecutionAllowlist({ executionMode: "kubernetes" }, localEnv);
expect(result.allowed).toBe(false);
if (!result.allowed) {
expect(result.reason).toMatch(/kubernetes/i);
expect(result.deniedDriver).toBe("local");
}
});
it("DENIES an ssh environment", () => {
const result = evaluateExecutionAllowlist({ executionMode: "kubernetes" }, sshEnv);
expect(result.allowed).toBe(false);
});
it("DENIES a non-kubernetes sandbox provider (e.g. fake)", () => {
const result = evaluateExecutionAllowlist({ executionMode: "kubernetes" }, fakeSandboxEnv);
expect(result.allowed).toBe(false);
if (!result.allowed) {
expect(result.deniedProvider).toBe("fake");
}
});
it("DENIES a sandbox driver with no provider", () => {
const result = evaluateExecutionAllowlist(
{ executionMode: "kubernetes" },
{ driver: "sandbox", provider: null },
);
expect(result.allowed).toBe(false);
});
});
describe("managedSandboxOnly (deny local execution)", () => {
const daytonaSandboxEnv: ExecutionEnvironmentCandidate = { driver: "sandbox", provider: "daytona" };
it("DENIES the local driver", () => {
const result = evaluateExecutionAllowlist({ managedSandboxOnly: true }, localEnv);
expect(result.allowed).toBe(false);
if (!result.allowed) {
expect(result.deniedDriver).toBe("local");
expect(result.reason).toMatch(/managed sandbox only/i);
}
});
it("ALLOWS the platform-managed (daytona) sandbox and the tenant's own sandbox/ssh", () => {
// Unlike kubernetes mode, managed-sandbox-only does not pin one
// provider: it only forbids local. Tenant-owned sandbox and ssh
// environments run on the tenant's own infrastructure, not Paperclip's.
expect(evaluateExecutionAllowlist({ managedSandboxOnly: true }, daytonaSandboxEnv).allowed).toBe(true);
expect(evaluateExecutionAllowlist({ managedSandboxOnly: true }, sshEnv).allowed).toBe(true);
});
it("still denies local even when combined with executionMode any/undefined", () => {
expect(evaluateExecutionAllowlist({ executionMode: "any", managedSandboxOnly: true }, localEnv).allowed).toBe(false);
});
it("does not affect local when the mode is off", () => {
expect(evaluateExecutionAllowlist({ managedSandboxOnly: false }, localEnv).allowed).toBe(true);
expect(evaluateExecutionAllowlist({}, localEnv).allowed).toBe(true);
});
});
describe("isExecutionForcedToKubernetes helper", () => {
it("reflects the policy", async () => {
const { isExecutionForcedToKubernetes } = await import("./execution-allowlist.js");
expect(isExecutionForcedToKubernetes({ executionMode: "kubernetes" })).toBe(true);
expect(isExecutionForcedToKubernetes({ executionMode: "any" })).toBe(false);
expect(isExecutionForcedToKubernetes({})).toBe(false);
});
});
describe("isLocalExecutionDenied helper", () => {
it("reflects the policy", async () => {
const { isLocalExecutionDenied } = await import("./execution-allowlist.js");
expect(isLocalExecutionDenied({ managedSandboxOnly: true })).toBe(true);
expect(isLocalExecutionDenied({ managedSandboxOnly: false })).toBe(false);
expect(isLocalExecutionDenied({})).toBe(false);
});
});
});