mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-19 07:42:38 +01:00
fix(cloud): let an online move proceed when Cloud supplies the database listener (#22263)
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Hosted Paperclip servers can move from a server with a volume to a volume-free server, which allows deploys without downtime > - Before the move, Core checks that the volume-free configuration is complete > - That check requires `PAPERCLIP_DATABASE_LISTEN_URL` on the running volume server, but only the volume-free replacement uses it, and Cloud supplies it when it configures that replacement > - Many older servers never had the setting, so they cannot move online even when all their data is ready > - This pull request stops an unset listener from blocking, and keeps a listener that points at another database as a blocker > - The benefit is that older servers can move online ## Linked Issues or Issue Description **What existing behavior does this improve?** The online move refuses a volume server that has no `PAPERCLIP_DATABASE_LISTEN_URL`. **Subsystem affected** Server: ephemeral enrollment readiness (`server/src/services/ephemeral-enrollment.ts`). **Current behavior** The eligibility read and preparation report `volume_free_database_listener_required` for every server that has no listener setting. **Proposed behavior** An unset listener does not block. A listener that does not match the runtime database still blocks with the same name. **Reason and benefit** The replacement server receives the listener from Cloud. On staging, this check alone blocks 18 servers whose data is otherwise ready. **Breaking changes** None. The startup contract for a running volume-free server is unchanged. ## What Changed - `services/ephemeral-enrollment.ts`: when the only configuration failure is the listener, and the listener is unset, the readiness check passes. The listener check is the last check in `assertEphemeralServerConfig`, so all earlier settings were already valid. - `services/ephemeral-enrollment.test.ts`: tests for an unset listener (eligible, and preparation succeeds) and a mismatched listener (still blocked). ## Verification - `npx vitest run src/services/ephemeral-enrollment.test.ts src/routes/ephemeral-enrollment.test.ts`: 29/29 pass. ## Risks - Low. Cloud's online arming passes `PAPERCLIP_DATABASE_LISTEN_URL` with the replacement's variables. If the replacement did not get the setting, the existing startup contract would still refuse to boot it, and the move would not complete. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`) in Claude Code, with tool use (shell, file edits, browser). ## 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 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
3dffb2c9dd
commit
12fc89b1f7
4 files changed
+49
-4
No files matched your search
@@ -17,6 +17,17 @@ it("requires shared storage and stable secrets without changing volume-backed st
|
||||
}
|
||||
expect(() => assertEphemeralServerConfig({ ...config, storageProvider: "local_disk" }, env)).toThrow("shared S3");
|
||||
});
|
||||
it("waives an absent listener only for a caller that opts in, and still requires a postgres runtime database", () => {
|
||||
const unset = { ...env, PAPERCLIP_DATABASE_LISTEN_URL: "" };
|
||||
expect(() => assertEphemeralServerConfig(config, unset)).toThrow(/PAPERCLIP_DATABASE_LISTEN_URL/);
|
||||
expect(assertEphemeralServerConfig(config, unset, { allowMissingListener: true })).toBeNull();
|
||||
expect(() => assertEphemeralServerConfig({ ...config, databaseUrl: "not a url" }, unset, { allowMissingListener: true }))
|
||||
.toThrow(/an external postgres DATABASE_URL is required/);
|
||||
expect(() => assertEphemeralServerConfig({ ...config, databaseUrl: "mysql://runtime@db.test/tenant" }, unset, { allowMissingListener: true }))
|
||||
.toThrow(/an external postgres DATABASE_URL is required/);
|
||||
expect(() => assertEphemeralServerConfig(config, { ...env, PAPERCLIP_DATABASE_LISTEN_URL: "postgres://runtime:fixture@other.test/tenant" },
|
||||
{ allowMissingListener: true })).toThrow(/direct connection to the same database/);
|
||||
});
|
||||
it("never connects the listener with migration privileges, another tenant, or through a transaction pooler", () => {
|
||||
for (const url of [env.PAPERCLIP_DATABASE_LISTEN_URL.replace("runtime:", "migration:"),
|
||||
env.PAPERCLIP_DATABASE_LISTEN_URL.replace("/tenant", "/neighbor"), config.databaseUrl,
|
||||
|
||||
@@ -65,7 +65,6 @@ it.each([
|
||||
["PAPERCLIP_DURABLE_AGENT_FILES", "volume_free_storage_flags_required"],
|
||||
["PAPERCLIP_SHARED_UI_ASSETS", "volume_free_storage_flags_required"],
|
||||
["PAPERCLIP_SECRETS_MASTER_KEY", "volume_free_master_key_required"],
|
||||
["PAPERCLIP_DATABASE_LISTEN_URL", "volume_free_database_listener_required"],
|
||||
])("names a missing %s as a blocker in preparation and in the eligibility read", async (setting, blocker) => {
|
||||
vi.stubEnv(setting, "");
|
||||
await expect(prepareOnlineEphemeralEnrollment(db, attempt, control)).rejects.toMatchObject({ status: 409, details: { blockers: [blocker] } });
|
||||
@@ -127,3 +126,28 @@ it("names the skill blocker once when installations and packages both still need
|
||||
owners.eligibility.mockResolvedValue({ eligible: false, blockers: ["skills_require_migration"] });
|
||||
await expect(readOnlineEphemeralEnrollmentEligibility(db)).resolves.toMatchObject({ blockers: ["skills_require_migration"] });
|
||||
});
|
||||
|
||||
it("accepts a volume server without a listener because Cloud supplies it to the replacement", async () => {
|
||||
vi.stubEnv("PAPERCLIP_DATABASE_LISTEN_URL", "");
|
||||
await expect(readOnlineEphemeralEnrollmentEligibility(db)).resolves.toEqual({ eligible: true, blockers: [], ephemeralServer: false });
|
||||
await expect(prepareOnlineEphemeralEnrollment(db, attempt, control)).resolves.toMatchObject({ enrollmentReady: false, decisionSigningSecret: key });
|
||||
});
|
||||
|
||||
it("still names a listener that points somewhere else", async () => {
|
||||
vi.stubEnv("PAPERCLIP_DATABASE_LISTEN_URL", "postgres://fixture:fixture@other.test/database");
|
||||
await expect(readOnlineEphemeralEnrollmentEligibility(db)).resolves.toMatchObject({ eligible: false, blockers: ["volume_free_database_listener_required"] });
|
||||
});
|
||||
|
||||
it("does not waive an unparseable runtime database because the listener is unset", async () => {
|
||||
vi.stubEnv("PAPERCLIP_DATABASE_LISTEN_URL", "");
|
||||
const config = await import("../config.js");
|
||||
const original = config.loadConfig;
|
||||
vi.spyOn(config, "loadConfig").mockReturnValue({ ...original(), databaseUrl: "not a url" } as never);
|
||||
await expect(readOnlineEphemeralEnrollmentEligibility(db)).resolves.toMatchObject({ eligible: false, blockers: ["volume_free_configuration_required"] });
|
||||
});
|
||||
|
||||
it("still names another missing setting when the listener is unset", async () => {
|
||||
vi.stubEnv("PAPERCLIP_DATABASE_LISTEN_URL", "");
|
||||
vi.stubEnv("PAPERCLIP_SHARED_UI_ASSETS", "");
|
||||
await expect(readOnlineEphemeralEnrollmentEligibility(db)).resolves.toMatchObject({ eligible: false, blockers: ["volume_free_storage_flags_required"] });
|
||||
});
|
||||
@@ -26,7 +26,7 @@ function volumeFreeConfigurationBlocker(): { blocker: string | null; decisionSig
|
||||
}
|
||||
try {
|
||||
assertEphemeralServerConfig(loadConfig(), { ...process.env, PAPERCLIP_EPHEMERAL_SERVER: "true",
|
||||
PAPERCLIP_DECISION_SIGNING_SECRET: decisionSigningSecret });
|
||||
PAPERCLIP_DECISION_SIGNING_SECRET: decisionSigningSecret }, { allowMissingListener: true });
|
||||
} catch (error) {
|
||||
const message = error instanceof Error ? error.message : "";
|
||||
return { blocker: configurationBlockers.find(([pattern]) => pattern.test(message))?.[1] ?? "volume_free_configuration_required" };
|
||||
|
||||
@@ -18,7 +18,8 @@ export { ephemeralServerEnabled };
|
||||
|
||||
/** Validate before consumers can generate a replacement local identity. Error
|
||||
* messages name settings only, never credential values or connection URLs. */
|
||||
export function assertEphemeralServerConfig(config: Pick<Config, "databaseUrl" | "storageProvider">, env = process.env): string | null {
|
||||
export function assertEphemeralServerConfig(config: Pick<Config, "databaseUrl" | "storageProvider">, env = process.env,
|
||||
options: { allowMissingListener?: boolean } = {}): string | null {
|
||||
if (env.PAPERCLIP_EPHEMERAL_SERVER !== "true") return null;
|
||||
const refuse = (reason: string): never => { throw new Error(`Volume-free server configuration: ${reason}`); };
|
||||
if (config.storageProvider !== "s3" || env.PAPERCLIP_DURABLE_AGENT_FILES !== "true" || env.PAPERCLIP_SHARED_UI_ASSETS !== "true") {
|
||||
@@ -31,7 +32,16 @@ export function assertEphemeralServerConfig(config: Pick<Config, "databaseUrl" |
|
||||
refuse("a stable PAPERCLIP_DECISION_SIGNING_SECRET of at least 32 characters is required; preserve the existing decision key during migration");
|
||||
}
|
||||
let runtime: URL, listener: URL;
|
||||
try { runtime = new URL(config.databaseUrl ?? ""); listener = new URL(env.PAPERCLIP_DATABASE_LISTEN_URL ?? ""); }
|
||||
const waiveListener = options.allowMissingListener === true && !env.PAPERCLIP_DATABASE_LISTEN_URL?.trim();
|
||||
const runtimeRequired = waiveListener ? "an external postgres DATABASE_URL is required"
|
||||
: "external DATABASE_URL and PAPERCLIP_DATABASE_LISTEN_URL are required";
|
||||
try { runtime = new URL(config.databaseUrl ?? ""); }
|
||||
catch { return refuse(runtimeRequired); }
|
||||
if (waiveListener) {
|
||||
if (!["postgres:", "postgresql:"].includes(runtime.protocol)) refuse(runtimeRequired);
|
||||
return null;
|
||||
}
|
||||
try { listener = new URL(env.PAPERCLIP_DATABASE_LISTEN_URL ?? ""); }
|
||||
catch { return refuse("external DATABASE_URL and PAPERCLIP_DATABASE_LISTEN_URL are required"); }
|
||||
if (![runtime, listener].every(url => ["postgres:", "postgresql:"].includes(url.protocol))
|
||||
|| runtime.username !== listener.username || runtime.password !== listener.password || runtime.pathname !== listener.pathname
|
||||
|
||||
Reference in new issue
Block a user