Files
PaperClipAI/server/src/__tests__/managed-config.test.ts
T
Devin FoleyandPaperclip 216d3d2680 Managed-instance config: fail-closed PAPERCLIP_MANAGED_CONFIG parsing and read-time settings overlay (#10058)
**Builds on.** #10055 — the `catalogVersion` this config document pins
is the feature-catalog artifact #10055 emits.

**Summary.** Instances operated by a managed hosting control plane can
now receive instance configuration through a single environment
variable, `PAPERCLIP_MANAGED_CONFIG` (versioned JSON: `mode`,
`catalogVersion`, `features`, `plugins.autoInstall`). When the variable
is absent the instance is self-hosted and nothing changes. When present,
parsing is strict and **fail-closed**: blank value, malformed JSON,
unknown feature key, a feature key this build's feature catalog does not
mark tier `managed`, missing required section, or unsupported version
refuses startup with a precise error — a typo that silently does nothing
is how a security control quietly fails. Managed feature values are
overlaid **at read time** inside the instance settings service (never
persisted), so a DB restore or manual row edit cannot resurrect a
disabled capability; responses expose per-key `managedKeys` metadata
(`managed: true`, `managedBy`) so clients can render locked state.

## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - Paperclip runs both self-hosted and under managed hosting, where an
operator's control plane owns instance configuration
> - Today instance feature settings live only in the tenant database; a
hosting control plane has no way to enforce a configuration that
tenant-side writes or restores cannot undo
> - Managed configuration will carry security posture, so delivery must
be atomic and parsing must fail closed — a typo that silently does
nothing is how a security control quietly fails
> - This pull request adds strict parsing of one
`PAPERCLIP_MANAGED_CONFIG` env var and overlays its feature values at
read time inside the settings service, never persisting them
> - The benefit is a minimal, auditable managed-hosting contract: absent
var ⇒ self-hosted instances are byte-for-byte unchanged; present ⇒
deterministic, locked configuration surfaced to clients via per-key
managed metadata

## Linked Issues or Issue Description

Refs #966 — this PR delivers that issue's "managed config injection"
hook, via a strict env-var contract rather than the config-file path it
sketches; the issue's other hooks (identity header, health, usage
webhook, lifecycle, external secrets, IAM auth) are out of scope, so the
PR refs rather than closes it.

*Mechanism differs from #966's proposal, so the `feature_request` fields
are also filled in:*

- **Problem or motivation:** managed hosting deployments need to
centrally enable/disable instance features; DB-stored settings can be
edited, restored, or migrated back to permissive values, and nothing
marks a value as operator-enforced.
- **Proposed solution:** one versioned JSON env var; fail-closed parse
at startup; read-time overlay in the settings service (precedence:
managed value over stored value over schema default); `managedKeys`
metadata in settings responses so clients can render locked state.
- **Alternatives considered:** per-feature env vars (non-atomic across a
half-updated env set, unbounded env surface); seeding the DB at boot
(persisted values can be edited or restored over, and cannot express
"forced"); lenient warn-and-drop parsing (fails open — unacceptable for
a security-bearing control).
- **Roadmap alignment:** supports the in-progress "Cloud deployments"
milestone in `ROADMAP.md`.

## What Changed

- New `server/src/services/managed-config.ts` (pure parser over the env
record)
- Startup parse ordered before the first `instanceSettingsService`
construction in `server/src/index.ts`
- Read-time merge + `managedKeys` in the settings service
- Shared validator updates

## Verification

- 29 parser/overlay tests (fail-closed matrix incl. blank/whitespace
env, missing sections, catalog-tier mismatch, empty-section happy path):
`pnpm vitest run src/__tests__/managed-config.test.ts
src/__tests__/instance-settings-managed-overlay.test.ts` (from
`server/`)
- 40 existing settings route/service tests green: `pnpm vitest run
src/__tests__/instance-settings-routes.test.ts
src/__tests__/instance-settings-service.test.ts` (from `server/`)
- 15 shared validator tests: `pnpm vitest run
src/validators/instance.test.ts` (from `packages/shared/`)
- Server `tsc --noEmit` clean: `pnpm typecheck` (from `server/`)

## Risks

- Self-hosted instances (no `PAPERCLIP_MANAGED_CONFIG` set) are
byte-for-byte unchanged — the parser only runs when the variable is
present.
- For managed instances, a malformed document now refuses startup by
design (fail-closed). This is an intentional behavioral guarantee, not a
regression: the control plane owns the variable and a precise startup
error is the contract.
- Overlay values are never persisted, so no migration or data-shape
risk.

## Model Used

Claude Fable 5 (`claude-fable-5`), extended thinking, agentic tool use;
independently peer-reviewed by a second AI agent before push.

## 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
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-07-22 19:48:43 -07:00

247 lines
9.3 KiB
TypeScript

import { describe, expect, it } from "vitest";
import {
MANAGED_CONFIG_ENV_KEY,
getManagedInstanceConfig,
managedFeatureKeySet,
parseManagedConfigEnv,
} from "../services/managed-config.js";
function envWith(raw: string | undefined) {
return { [MANAGED_CONFIG_ENV_KEY]: raw };
}
function validDoc(overrides: Record<string, unknown> = {}) {
return JSON.stringify({
v: 1,
mode: "cloud",
catalogVersion: "2026.720.0",
features: { enableApps: false, enablePipelines: true },
plugins: { autoInstall: ["daytona", "kubernetes"] },
...overrides,
});
}
describe("managedFeatureKeySet", () => {
it("contains exactly the boolean flags of the experimental schema", () => {
const keys = managedFeatureKeySet();
expect(keys.has("enableApps")).toBe(true);
expect(keys.has("enableWorktreeRunExecution")).toBe(true);
// Server-managed bookkeeping fields are not overlayable features.
expect(keys.has("worktreeRunExecutionActivatedAt")).toBe(false);
expect(keys.has("worktreeRunExecutionActivationInstanceId")).toBe(false);
expect(keys.has("issueGraphLivenessAutoRecoveryLookbackHours")).toBe(false);
});
});
describe("parseManagedConfigEnv", () => {
it("returns null when the env var is absent (self-hosted)", () => {
expect(parseManagedConfigEnv({})).toBeNull();
expect(parseManagedConfigEnv(envWith(undefined))).toBeNull();
});
it("throws when the env var is present but blank (fail closed)", () => {
expect(() => parseManagedConfigEnv(envWith(""))).toThrow(/is set but blank/);
expect(() => parseManagedConfigEnv(envWith(" "))).toThrow(/is set but blank/);
expect(() => parseManagedConfigEnv(envWith("\n\t"))).toThrow(/is set but blank/);
});
it("parses a complete valid document", () => {
const config = parseManagedConfigEnv(envWith(validDoc()));
expect(config).toEqual({
v: 1,
mode: "cloud",
catalogVersion: "2026.720.0",
features: { enableApps: false, enablePipelines: true },
plugins: { autoInstall: ["daytona", "kubernetes"] },
});
});
it("accepts empty features {} and autoInstall [] sections", () => {
const config = parseManagedConfigEnv(
envWith(validDoc({ features: {}, plugins: { autoInstall: [] } })),
);
expect(config).toEqual({
v: 1,
mode: "cloud",
catalogVersion: "2026.720.0",
features: {},
plugins: { autoInstall: [] },
});
});
it("throws when the features section is missing (fail closed)", () => {
const doc = { v: 1, mode: "cloud", catalogVersion: "2026.720.0", plugins: { autoInstall: [] } };
expect(() => parseManagedConfigEnv(envWith(JSON.stringify(doc)))).toThrow(
/requires a "features" object/,
);
});
it("throws when the plugins section or autoInstall is missing (fail closed)", () => {
const noPlugins = {
v: 1,
mode: "cloud",
catalogVersion: "2026.720.0",
features: {},
};
expect(() => parseManagedConfigEnv(envWith(JSON.stringify(noPlugins)))).toThrow(
/requires a "plugins" object/,
);
expect(() => parseManagedConfigEnv(envWith(validDoc({ plugins: {} })))).toThrow(
/requires a "plugins.autoInstall" array/,
);
});
it("returns a frozen document", () => {
const config = parseManagedConfigEnv(envWith(validDoc()));
expect(Object.isFrozen(config)).toBe(true);
expect(Object.isFrozen(config?.features)).toBe(true);
expect(Object.isFrozen(config?.plugins.autoInstall)).toBe(true);
});
it("throws on invalid JSON", () => {
expect(() => parseManagedConfigEnv(envWith("{not json"))).toThrow(
/PAPERCLIP_MANAGED_CONFIG is not valid JSON/,
);
});
it("throws on non-object documents", () => {
expect(() => parseManagedConfigEnv(envWith("[]"))).toThrow(/must be a JSON object/);
expect(() => parseManagedConfigEnv(envWith("42"))).toThrow(/must be a JSON object/);
expect(() => parseManagedConfigEnv(envWith("null"))).toThrow(/must be a JSON object/);
expect(() => parseManagedConfigEnv(envWith('"cloud"'))).toThrow(/must be a JSON object/);
});
it("throws on an unknown top-level key", () => {
expect(() => parseManagedConfigEnv(envWith(validDoc({ extra: true })))).toThrow(
/unknown top-level key "extra"/,
);
});
it("throws on an unsupported v", () => {
expect(() => parseManagedConfigEnv(envWith(validDoc({ v: 2 })))).toThrow(
/unsupported "v" 2; this build supports v=1/,
);
expect(() => parseManagedConfigEnv(envWith(validDoc({ v: "1" })))).toThrow(/unsupported "v"/);
expect(() =>
parseManagedConfigEnv(
envWith(JSON.stringify({ mode: "cloud", catalogVersion: "x" })),
),
).toThrow(/unsupported "v"/);
});
it("throws on a non-cloud mode", () => {
expect(() => parseManagedConfigEnv(envWith(validDoc({ mode: "self-hosted" })))).toThrow(
/invalid "mode" "self-hosted"; expected "cloud"/,
);
expect(() =>
parseManagedConfigEnv(envWith(JSON.stringify({ v: 1, catalogVersion: "x" }))),
).toThrow(/invalid "mode"/);
});
it("throws on a missing or empty catalogVersion", () => {
expect(() =>
parseManagedConfigEnv(envWith(JSON.stringify({ v: 1, mode: "cloud" }))),
).toThrow(/non-empty string "catalogVersion"/);
expect(() => parseManagedConfigEnv(envWith(validDoc({ catalogVersion: "" })))).toThrow(
/non-empty string "catalogVersion"/,
);
expect(() => parseManagedConfigEnv(envWith(validDoc({ catalogVersion: 7 })))).toThrow(
/non-empty string "catalogVersion"/,
);
});
it("throws on a non-object features section", () => {
expect(() => parseManagedConfigEnv(envWith(validDoc({ features: ["enableApps"] })))).toThrow(
/"features" must be an object/,
);
});
it("throws on an unknown feature key", () => {
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ features: { enableTimeTravel: true } }))),
).toThrow(/unknown feature key "enableTimeTravel"/);
// A server-managed bookkeeping field is not an overlayable feature.
expect(() =>
parseManagedConfigEnv(
envWith(validDoc({ features: { worktreeRunExecutionActivatedAt: true } })),
),
).toThrow(/unknown feature key "worktreeRunExecutionActivatedAt"/);
});
it("throws on a feature key the catalog does not mark tier \"managed\"", () => {
// `enableStreamlinedLeftNavigation` is a real schema flag, but its catalog
// tier is `preference` (tenant-controllable) — a managed-config document
// targeting it has incompatible catalog semantics and must fail closed.
expect(() =>
parseManagedConfigEnv(
envWith(validDoc({ features: { enableStreamlinedLeftNavigation: true } })),
),
).toThrow(
/"features" key "enableStreamlinedLeftNavigation" has tier "preference".*only tier "managed" keys/,
);
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ features: { enableDecisions: false } }))),
).toThrow(/has tier "preference"/);
});
it("throws on non-boolean feature values", () => {
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ features: { enableApps: "true" } }))),
).toThrow(/"features.enableApps" must be a boolean/);
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ features: { enableApps: 1 } }))),
).toThrow(/"features.enableApps" must be a boolean/);
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ features: { enableApps: null } }))),
).toThrow(/"features.enableApps" must be a boolean/);
});
it("throws on malformed plugins sections", () => {
expect(() => parseManagedConfigEnv(envWith(validDoc({ plugins: [] })))).toThrow(
/"plugins" must be an object/,
);
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ plugins: { install: [] } }))),
).toThrow(/"plugins" has unknown key "install"/);
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ plugins: { autoInstall: "daytona" } }))),
).toThrow(/"plugins.autoInstall" must be an array/);
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ plugins: { autoInstall: [""] } }))),
).toThrow(/non-empty strings/);
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ plugins: { autoInstall: [" daytona"] } }))),
).toThrow(/non-empty strings/);
expect(() =>
parseManagedConfigEnv(envWith(validDoc({ plugins: { autoInstall: [42] } }))),
).toThrow(/non-empty strings/);
expect(() =>
parseManagedConfigEnv(
envWith(validDoc({ plugins: { autoInstall: ["daytona", "daytona"] } })),
),
).toThrow(/duplicate entry "daytona"/);
});
});
describe("getManagedInstanceConfig", () => {
it("caches by raw env value and reparses when it changes", () => {
const raw = validDoc();
const first = getManagedInstanceConfig(envWith(raw));
const second = getManagedInstanceConfig(envWith(raw));
expect(second).toBe(first);
const changed = getManagedInstanceConfig(
envWith(validDoc({ catalogVersion: "2026.721.0" })),
);
expect(changed?.catalogVersion).toBe("2026.721.0");
expect(changed).not.toBe(first);
expect(getManagedInstanceConfig(envWith(undefined))).toBeNull();
});
it("rethrows parse failures on every call instead of caching them", () => {
expect(() => getManagedInstanceConfig(envWith("{bad"))).toThrow(/not valid JSON/);
expect(() => getManagedInstanceConfig(envWith("{bad"))).toThrow(/not valid JSON/);
});
});