feat(deploy): recover from production_instance_exists and surface plan-feature errors#289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wyattjoh wants to merge 25 commits into from
Closed

feat(deploy): recover from production_instance_exists and surface plan-feature errors #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
91a6fe0
refactor(errors): parse Clerk error envelope into structured ApiError…
wyattjoh May 13, 2026
8dfb8b5
feat(errors): add fromResponse factories to ApiError subclasses
wyattjoh May 13, 2026
9ab0662
refactor(plapi): construct PlapiError via fromResponse
wyattjoh May 13, 2026
c90bf4f
refactor(fapi): construct FapiError via fromResponse
wyattjoh May 13, 2026
1ae6d36
refactor(keyless): construct BapiError via fromResponse
wyattjoh May 13, 2026
0090584
refactor(bapi): construct BapiError via fromResponse
wyattjoh May 13, 2026
f352c6f
refactor(users): construct BapiError via fromResponse
wyattjoh May 13, 2026
4f9ddc2
test: construct ApiError subclasses via fromBody in fixtures
wyattjoh May 13, 2026
bf05f3e
refactor(cli): read structured ApiError fields in the global handler
wyattjoh May 13, 2026
5466ad3
feat(deploy): implement resumable deploy wizard
wyattjoh May 6, 2026
e482fef
fix(deploy): address review feedback on resumable wizard
wyattjoh May 6, 2026
3847ef2
refactor(deploy): isolate lifecycle api calls
wyattjoh May 6, 2026
50cf7ea
feat(deploy): resolve production state from API
wyattjoh May 6, 2026
5c766e6
fix(deploy): route test failures through api path
wyattjoh May 6, 2026
e830ef6
fix(deploy): remove gutter tone plumbing
wyattjoh May 6, 2026
61e1dc3
fix(deploy): require human mode for production setup
wyattjoh May 12, 2026
9c99950
refactor(deploy): route lifecycle test failures through api mock
wyattjoh May 12, 2026
371a082
refactor(deploy): extract mock api into its own module
wyattjoh May 13, 2026
c878c51
refactor(deploy): construct simulated PlapiError via fromBody
wyattjoh May 13, 2026
0b70486
refactor(plapi): drop unused is_secondary from CreateProductionInstan…
wyattjoh May 13, 2026
0fd13de
feat(deploy/mock): inject production_instance_exists and unsupported …
wyattjoh May 13, 2026
3cbc0c5
feat(deploy): recover from production_instance_exists by resuming liv…
wyattjoh May 13, 2026
afe3cda
feat(deploy): friendlier error for unsupported subscription plan feat…
wyattjoh May 13, 2026
9218f4a
refactor(plapi): allow null active_domain and guard in deploy wizard
wyattjoh May 13, 2026
fae8e67
docs(deploy): document live-error recovery paths and add changeset
wyattjoh May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/deploy-error-recovery.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": minor
---

Surface Clerk API error codes and metadata as structured fields on `PlapiError` / `BapiError` / `FapiError`, and use them to add two recovery paths in `clerk deploy`: resume from server state when a production instance already exists, and present a friendly upgrade hint when the development instance uses features the current subscription plan doesn't allow.
78 changes: 48 additions & 30 deletions packages/cli-core/src/cli-program.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -44,6 +45,23 @@ test("users list exposes common filters and pagination options", () => {
);
});

test("deploy exposes the expected options", () => {
const program = createProgram();
const deploy = program.commands.find((command) => command.name() === "deploy")!;
const optionNames = deploy.options.map((option) => option.long);

expect(optionNames).toEqual([
"--debug",
"--test-force-production-instance",
"--test-fail-production-instance-check",
"--test-fail-domain-lookup",
"--test-fail-validate-cloning",
"--test-fail-create-production-instance",
"--test-fail-dns-verification",
"--test-fail-oauth-save",
]);
});

describe("parseIntegerOption (via users list --limit / --offset)", () => {
function parseUsersList(args: readonly string[]) {
return createProgram().parseAsync(["users", "list", ...args], { from: "user" });
Expand DownExpand Up@@ -140,7 +158,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Your plan does not support these features");
expect(result).toContain("Unsupported features: saml, custom_roles");
});
Expand All@@ -155,7 +173,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Unknown config key: sesion");
expect(result).toContain("Did you mean: session");
expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +189,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("This feature is not enabled on this instance");
expect(result).toContain("Feature: organizations");
});
Expand All@@ -186,7 +204,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Invalid value for session.lifetime");
expect(result).toContain("Parameter: session.lifetime");
});
Expand All@@ -201,7 +219,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Cannot clear this key");
expect(result).toContain("Parameter: sign_up.mode");
});
Expand All@@ -216,14 +234,15 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Value is not in the allowed set");
expect(result).toContain("Parameter: branding.logo_url");
});

// --- Multiple errors ---
// The structured path reads from the first parsed error only.

test("formats multiple errors joined by newlines", () => {
test("formats multiple errors: surfaces first error with its meta", () => {
const body = JSON.stringify({
errors: [
{
Expand All@@ -238,13 +257,9 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Invalid session lifetime");
expect(result).toContain("Unknown key: bogus");
expect(result).toContain("Did you mean: session");
// Two errors separated by newline
const lines = result.split("\n");
expect(lines.length).toBeGreaterThanOrEqual(2);
expect(result).toContain("Parameter: session.lifetime");
});

// --- Error without meta ---
Expand All@@ -253,32 +268,34 @@ describe("formatApiBody", () => {
const body = JSON.stringify({
errors: [{ code: "resource_not_found", message: "Instance not found" }],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe("Instance not found");
});

// --- Fallback paths ---
// --- Bodies without a Clerk errors array ---
// parseApiBody falls back to truncateBody(body) as the message when there
// is no errors[0], so formatStructuredError returns the truncated body string.

test("falls back to parsed.error when no errors array", () => {
test("returns truncated body when no errors array (error field only)", () => {
const body = JSON.stringify({ error: "Something went wrong" });
const result = formatApiBody(body, false);
expect(result).toBe("Something went wrong");
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe(body);
});

test("falls back to parsed.message when no errors array or error field", () => {
test("returns truncated body when no errors array (message field only)", () => {
const body = JSON.stringify({ message: "Bad request" });
const result = formatApiBody(body, false);
expect(result).toBe("Bad request");
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe(body);
});

test("truncates non-JSON body over 200 chars", () => {
const body = "x".repeat(300);
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe("x".repeat(200) + "...");
});

test("returns short non-JSON body as-is", () => {
const result = formatApiBody("Bad Request", false);
const result = formatApiBody(new ApiError(400, "Bad Request"), false);
expect(result).toBe("Bad Request");
});

Expand All@@ -287,28 +304,29 @@ describe("formatApiBody", () => {
test("verbose mode returns full pretty-printed JSON", () => {
const obj = { errors: [{ code: "test", message: "test msg" }] };
const body = JSON.stringify(obj);
const result = formatApiBody(body, true);
const result = formatApiBody(new ApiError(400, body), true);
expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
});

test("verbose mode returns raw body for non-JSON", () => {
const result = formatApiBody("not json", true);
const result = formatApiBody(new ApiError(400, "not json"), true);
expect(result).toBe("\nnot json");
});

// --- Edge cases ---

test("handles empty errors array by falling through", () => {
test("handles empty errors array by returning truncated body", () => {
const body = JSON.stringify({ errors: [], message: "fallback" });
const result = formatApiBody(body, false);
expect(result).toBe("fallback");
const result = formatApiBody(new ApiError(400, body), false);
// No errors[0] so parseApiBody falls back to truncateBody(body)
expect(result).toBe(body);
});

test("handles error with empty meta", () => {
const body = JSON.stringify({
errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe("Bad value");
});

Expand All@@ -322,7 +340,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe("Plan limitation");
});
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(deploy): recover from production_instance_exists and surface plan-feature errors#289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wyattjoh
wants to merge
25
commits into

from

 Closed


feat(deploy): recover from production_instance_exists and surface plan-feature errors
#289
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
91a6fe0

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
8dfb8b5

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
9ab0662

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
c90bf4f

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
1ae6d36

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
0090584

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
f352c6f

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
4f9ddc2

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
bf05f3e

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
5466ad3

feat(deploy): implement resumable deploy wizard


wyattjoh May 6, 2026
e482fef

fix(deploy): address review feedback on resumable wizard


wyattjoh May 6, 2026
3847ef2

refactor(deploy): isolate lifecycle api calls


wyattjoh May 6, 2026
50cf7ea

feat(deploy): resolve production state from API


wyattjoh May 6, 2026
5c766e6

fix(deploy): route test failures through api path


wyattjoh May 6, 2026
e830ef6

fix(deploy): remove gutter tone plumbing


wyattjoh May 6, 2026
61e1dc3

fix(deploy): require human mode for production setup


wyattjoh May 12, 2026
9c99950

refactor(deploy): route lifecycle test failures through api mock


wyattjoh May 12, 2026
371a082

refactor(deploy): extract mock api into its own module


wyattjoh May 13, 2026
c878c51

refactor(deploy): construct simulated PlapiError via fromBody


wyattjoh May 13, 2026
0b70486

refactor(plapi): drop unused is_secondary from CreateProductionInstan…


wyattjoh May 13, 2026
0fd13de

feat(deploy/mock): inject production_instance_exists and unsupported …


wyattjoh May 13, 2026
3cbc0c5

feat(deploy): recover from production_instance_exists by resuming liv…


wyattjoh May 13, 2026
afe3cda

feat(deploy): friendlier error for unsupported subscription plan feat…


wyattjoh May 13, 2026
9218f4a

refactor(plapi): allow null active_domain and guard in deploy wizard


wyattjoh May 13, 2026
fae8e67

docs(deploy): document live-error recovery paths and add changeset


wyattjoh May 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/deploy-error-recovery.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": minor
---

Surface Clerk API error codes and metadata as structured fields on `PlapiError` / `BapiError` / `FapiError`, and use them to add two recovery paths in `clerk deploy`: resume from server state when a production instance already exists, and present a friendly upgrade hint when the development instance uses features the current subscription plan doesn't allow.

78 changes: 48 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -44,6 +45,23 @@ test("users list exposes common filters and pagination options", () => {
 );
});

test("deploy exposes the expected options", () => {
 const program = createProgram();
 const deploy = program.commands.find((command) => command.name() === "deploy")!;
 const optionNames = deploy.options.map((option) => option.long);

 expect(optionNames).toEqual([
 "--debug",
 "--test-force-production-instance",
 "--test-fail-production-instance-check",
 "--test-fail-domain-lookup",
 "--test-fail-validate-cloning",
 "--test-fail-create-production-instance",
 "--test-fail-dns-verification",
 "--test-fail-oauth-save",
 ]);
});

describe("parseIntegerOption (via users list --limit / --offset)", () => {
 function parseUsersList(args: readonly string[]) {
 return createProgram().parseAsync(["users", "list", ...args], { from: "user" });
Expand DownExpand Up@@ -140,7 +158,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +173,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +189,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +204,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +219,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +234,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +257,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +268,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +304,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +340,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(deploy): recover from production_instance_exists and surface plan-feature errors#289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wyattjoh
wants to merge
25
commits into

from

 Closed


feat(deploy): recover from production_instance_exists and surface plan-feature errors
#289
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
91a6fe0

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
8dfb8b5

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
9ab0662

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
c90bf4f

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
1ae6d36

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
0090584

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
f352c6f

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
4f9ddc2

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
bf05f3e

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
5466ad3

feat(deploy): implement resumable deploy wizard


wyattjoh May 6, 2026
e482fef

fix(deploy): address review feedback on resumable wizard


wyattjoh May 6, 2026
3847ef2

refactor(deploy): isolate lifecycle api calls


wyattjoh May 6, 2026
50cf7ea

feat(deploy): resolve production state from API


wyattjoh May 6, 2026
5c766e6

fix(deploy): route test failures through api path


wyattjoh May 6, 2026
e830ef6

fix(deploy): remove gutter tone plumbing


wyattjoh May 6, 2026
61e1dc3

fix(deploy): require human mode for production setup


wyattjoh May 12, 2026
9c99950

refactor(deploy): route lifecycle test failures through api mock


wyattjoh May 12, 2026
371a082

refactor(deploy): extract mock api into its own module


wyattjoh May 13, 2026
c878c51

refactor(deploy): construct simulated PlapiError via fromBody


wyattjoh May 13, 2026
0b70486

refactor(plapi): drop unused is_secondary from CreateProductionInstan…


wyattjoh May 13, 2026
0fd13de

feat(deploy/mock): inject production_instance_exists and unsupported …


wyattjoh May 13, 2026
3cbc0c5

feat(deploy): recover from production_instance_exists by resuming liv…


wyattjoh May 13, 2026
afe3cda

feat(deploy): friendlier error for unsupported subscription plan feat…


wyattjoh May 13, 2026
9218f4a

refactor(plapi): allow null active_domain and guard in deploy wizard


wyattjoh May 13, 2026
fae8e67

docs(deploy): document live-error recovery paths and add changeset


wyattjoh May 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/deploy-error-recovery.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": minor
---

Surface Clerk API error codes and metadata as structured fields on `PlapiError` / `BapiError` / `FapiError`, and use them to add two recovery paths in `clerk deploy`: resume from server state when a production instance already exists, and present a friendly upgrade hint when the development instance uses features the current subscription plan doesn't allow.

78 changes: 48 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -44,6 +45,23 @@ test("users list exposes common filters and pagination options", () => {
 );
});

test("deploy exposes the expected options", () => {
 const program = createProgram();
 const deploy = program.commands.find((command) => command.name() === "deploy")!;
 const optionNames = deploy.options.map((option) => option.long);

 expect(optionNames).toEqual([
 "--debug",
 "--test-force-production-instance",
 "--test-fail-production-instance-check",
 "--test-fail-domain-lookup",
 "--test-fail-validate-cloning",
 "--test-fail-create-production-instance",
 "--test-fail-dns-verification",
 "--test-fail-oauth-save",
 ]);
});

describe("parseIntegerOption (via users list --limit / --offset)", () => {
 function parseUsersList(args: readonly string[]) {
 return createProgram().parseAsync(["users", "list", ...args], { from: "user" });
Expand DownExpand Up@@ -140,7 +158,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +173,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +189,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +204,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +219,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +234,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +257,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +268,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +304,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +340,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(deploy): recover from production_instance_exists and surface plan-feature errors#289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wyattjoh
wants to merge
25
commits into

from

 Closed


feat(deploy): recover from production_instance_exists and surface plan-feature errors
#289
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
91a6fe0

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
8dfb8b5

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
9ab0662

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
c90bf4f

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
1ae6d36

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
0090584

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
f352c6f

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
4f9ddc2

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
bf05f3e

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
5466ad3

feat(deploy): implement resumable deploy wizard


wyattjoh May 6, 2026
e482fef

fix(deploy): address review feedback on resumable wizard


wyattjoh May 6, 2026
3847ef2

refactor(deploy): isolate lifecycle api calls


wyattjoh May 6, 2026
50cf7ea

feat(deploy): resolve production state from API


wyattjoh May 6, 2026
5c766e6

fix(deploy): route test failures through api path


wyattjoh May 6, 2026
e830ef6

fix(deploy): remove gutter tone plumbing


wyattjoh May 6, 2026
61e1dc3

fix(deploy): require human mode for production setup


wyattjoh May 12, 2026
9c99950

refactor(deploy): route lifecycle test failures through api mock


wyattjoh May 12, 2026
371a082

refactor(deploy): extract mock api into its own module


wyattjoh May 13, 2026
c878c51

refactor(deploy): construct simulated PlapiError via fromBody


wyattjoh May 13, 2026
0b70486

refactor(plapi): drop unused is_secondary from CreateProductionInstan…


wyattjoh May 13, 2026
0fd13de

feat(deploy/mock): inject production_instance_exists and unsupported …


wyattjoh May 13, 2026
3cbc0c5

feat(deploy): recover from production_instance_exists by resuming liv…


wyattjoh May 13, 2026
afe3cda

feat(deploy): friendlier error for unsupported subscription plan feat…


wyattjoh May 13, 2026
9218f4a

refactor(plapi): allow null active_domain and guard in deploy wizard


wyattjoh May 13, 2026
fae8e67

docs(deploy): document live-error recovery paths and add changeset


wyattjoh May 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/deploy-error-recovery.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": minor
---

Surface Clerk API error codes and metadata as structured fields on `PlapiError` / `BapiError` / `FapiError`, and use them to add two recovery paths in `clerk deploy`: resume from server state when a production instance already exists, and present a friendly upgrade hint when the development instance uses features the current subscription plan doesn't allow.

78 changes: 48 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -44,6 +45,23 @@ test("users list exposes common filters and pagination options", () => {
 );
});

test("deploy exposes the expected options", () => {
 const program = createProgram();
 const deploy = program.commands.find((command) => command.name() === "deploy")!;
 const optionNames = deploy.options.map((option) => option.long);

 expect(optionNames).toEqual([
 "--debug",
 "--test-force-production-instance",
 "--test-fail-production-instance-check",
 "--test-fail-domain-lookup",
 "--test-fail-validate-cloning",
 "--test-fail-create-production-instance",
 "--test-fail-dns-verification",
 "--test-fail-oauth-save",
 ]);
});

describe("parseIntegerOption (via users list --limit / --offset)", () => {
 function parseUsersList(args: readonly string[]) {
 return createProgram().parseAsync(["users", "list", ...args], { from: "user" });
Expand DownExpand Up@@ -140,7 +158,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +173,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +189,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +204,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +219,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +234,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +257,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +268,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +304,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +340,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(deploy): recover from production_instance_exists and surface plan-feature errors#289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wyattjoh
wants to merge
25
commits into

from

 Closed


feat(deploy): recover from production_instance_exists and surface plan-feature errors
#289
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
91a6fe0

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
8dfb8b5

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
9ab0662

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
c90bf4f

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
1ae6d36

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
0090584

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
f352c6f

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
4f9ddc2

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
bf05f3e

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
5466ad3

feat(deploy): implement resumable deploy wizard


wyattjoh May 6, 2026
e482fef

fix(deploy): address review feedback on resumable wizard


wyattjoh May 6, 2026
3847ef2

refactor(deploy): isolate lifecycle api calls


wyattjoh May 6, 2026
50cf7ea

feat(deploy): resolve production state from API


wyattjoh May 6, 2026
5c766e6

fix(deploy): route test failures through api path


wyattjoh May 6, 2026
e830ef6

fix(deploy): remove gutter tone plumbing


wyattjoh May 6, 2026
61e1dc3

fix(deploy): require human mode for production setup


wyattjoh May 12, 2026
9c99950

refactor(deploy): route lifecycle test failures through api mock


wyattjoh May 12, 2026
371a082

refactor(deploy): extract mock api into its own module


wyattjoh May 13, 2026
c878c51

refactor(deploy): construct simulated PlapiError via fromBody


wyattjoh May 13, 2026
0b70486

refactor(plapi): drop unused is_secondary from CreateProductionInstan…


wyattjoh May 13, 2026
0fd13de

feat(deploy/mock): inject production_instance_exists and unsupported …


wyattjoh May 13, 2026
3cbc0c5

feat(deploy): recover from production_instance_exists by resuming liv…


wyattjoh May 13, 2026
afe3cda

feat(deploy): friendlier error for unsupported subscription plan feat…


wyattjoh May 13, 2026
9218f4a

refactor(plapi): allow null active_domain and guard in deploy wizard


wyattjoh May 13, 2026
fae8e67

docs(deploy): document live-error recovery paths and add changeset


wyattjoh May 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/deploy-error-recovery.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": minor
---

Surface Clerk API error codes and metadata as structured fields on `PlapiError` / `BapiError` / `FapiError`, and use them to add two recovery paths in `clerk deploy`: resume from server state when a production instance already exists, and present a friendly upgrade hint when the development instance uses features the current subscription plan doesn't allow.

78 changes: 48 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -44,6 +45,23 @@ test("users list exposes common filters and pagination options", () => {
 );
});

test("deploy exposes the expected options", () => {
 const program = createProgram();
 const deploy = program.commands.find((command) => command.name() === "deploy")!;
 const optionNames = deploy.options.map((option) => option.long);

 expect(optionNames).toEqual([
 "--debug",
 "--test-force-production-instance",
 "--test-fail-production-instance-check",
 "--test-fail-domain-lookup",
 "--test-fail-validate-cloning",
 "--test-fail-create-production-instance",
 "--test-fail-dns-verification",
 "--test-fail-oauth-save",
 ]);
});

describe("parseIntegerOption (via users list --limit / --offset)", () => {
 function parseUsersList(args: readonly string[]) {
 return createProgram().parseAsync(["users", "list", ...args], { from: "user" });
Expand DownExpand Up@@ -140,7 +158,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +173,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +189,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +204,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +219,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +234,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +257,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +268,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +304,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +340,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(deploy): recover from production_instance_exists and surface plan-feature errors#289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wyattjoh
wants to merge
25
commits into

from

 Closed


feat(deploy): recover from production_instance_exists and surface plan-feature errors
#289
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
91a6fe0

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
8dfb8b5

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
9ab0662

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
c90bf4f

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
1ae6d36

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
0090584

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
f352c6f

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
4f9ddc2

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
bf05f3e

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
5466ad3

feat(deploy): implement resumable deploy wizard


wyattjoh May 6, 2026
e482fef

fix(deploy): address review feedback on resumable wizard


wyattjoh May 6, 2026
3847ef2

refactor(deploy): isolate lifecycle api calls


wyattjoh May 6, 2026
50cf7ea

feat(deploy): resolve production state from API


wyattjoh May 6, 2026
5c766e6

fix(deploy): route test failures through api path


wyattjoh May 6, 2026
e830ef6

fix(deploy): remove gutter tone plumbing


wyattjoh May 6, 2026
61e1dc3

fix(deploy): require human mode for production setup


wyattjoh May 12, 2026
9c99950

refactor(deploy): route lifecycle test failures through api mock


wyattjoh May 12, 2026
371a082

refactor(deploy): extract mock api into its own module


wyattjoh May 13, 2026
c878c51

refactor(deploy): construct simulated PlapiError via fromBody


wyattjoh May 13, 2026
0b70486

refactor(plapi): drop unused is_secondary from CreateProductionInstan…


wyattjoh May 13, 2026
0fd13de

feat(deploy/mock): inject production_instance_exists and unsupported …


wyattjoh May 13, 2026
3cbc0c5

feat(deploy): recover from production_instance_exists by resuming liv…


wyattjoh May 13, 2026
afe3cda

feat(deploy): friendlier error for unsupported subscription plan feat…


wyattjoh May 13, 2026
9218f4a

refactor(plapi): allow null active_domain and guard in deploy wizard


wyattjoh May 13, 2026
fae8e67

docs(deploy): document live-error recovery paths and add changeset


wyattjoh May 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/deploy-error-recovery.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": minor
---

Surface Clerk API error codes and metadata as structured fields on `PlapiError` / `BapiError` / `FapiError`, and use them to add two recovery paths in `clerk deploy`: resume from server state when a production instance already exists, and present a friendly upgrade hint when the development instance uses features the current subscription plan doesn't allow.

78 changes: 48 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -44,6 +45,23 @@ test("users list exposes common filters and pagination options", () => {
 );
});

test("deploy exposes the expected options", () => {
 const program = createProgram();
 const deploy = program.commands.find((command) => command.name() === "deploy")!;
 const optionNames = deploy.options.map((option) => option.long);

 expect(optionNames).toEqual([
 "--debug",
 "--test-force-production-instance",
 "--test-fail-production-instance-check",
 "--test-fail-domain-lookup",
 "--test-fail-validate-cloning",
 "--test-fail-create-production-instance",
 "--test-fail-dns-verification",
 "--test-fail-oauth-save",
 ]);
});

describe("parseIntegerOption (via users list --limit / --offset)", () => {
 function parseUsersList(args: readonly string[]) {
 return createProgram().parseAsync(["users", "list", ...args], { from: "user" });
Expand DownExpand Up@@ -140,7 +158,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +173,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +189,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +204,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +219,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +234,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +257,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +268,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +304,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +340,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(deploy): recover from production_instance_exists and surface plan-feature errors#289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wyattjoh
wants to merge
25
commits into

from

 Closed


feat(deploy): recover from production_instance_exists and surface plan-feature errors
#289
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
91a6fe0

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
8dfb8b5

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
9ab0662

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
c90bf4f

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
1ae6d36

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
0090584

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
f352c6f

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
4f9ddc2

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
bf05f3e

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
5466ad3

feat(deploy): implement resumable deploy wizard


wyattjoh May 6, 2026
e482fef

fix(deploy): address review feedback on resumable wizard


wyattjoh May 6, 2026
3847ef2

refactor(deploy): isolate lifecycle api calls


wyattjoh May 6, 2026
50cf7ea

feat(deploy): resolve production state from API


wyattjoh May 6, 2026
5c766e6

fix(deploy): route test failures through api path


wyattjoh May 6, 2026
e830ef6

fix(deploy): remove gutter tone plumbing


wyattjoh May 6, 2026
61e1dc3

fix(deploy): require human mode for production setup


wyattjoh May 12, 2026
9c99950

refactor(deploy): route lifecycle test failures through api mock


wyattjoh May 12, 2026
371a082

refactor(deploy): extract mock api into its own module


wyattjoh May 13, 2026
c878c51

refactor(deploy): construct simulated PlapiError via fromBody


wyattjoh May 13, 2026
0b70486

refactor(plapi): drop unused is_secondary from CreateProductionInstan…


wyattjoh May 13, 2026
0fd13de

feat(deploy/mock): inject production_instance_exists and unsupported …


wyattjoh May 13, 2026
3cbc0c5

feat(deploy): recover from production_instance_exists by resuming liv…


wyattjoh May 13, 2026
afe3cda

feat(deploy): friendlier error for unsupported subscription plan feat…


wyattjoh May 13, 2026
9218f4a

refactor(plapi): allow null active_domain and guard in deploy wizard


wyattjoh May 13, 2026
fae8e67

docs(deploy): document live-error recovery paths and add changeset


wyattjoh May 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/deploy-error-recovery.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": minor
---

Surface Clerk API error codes and metadata as structured fields on `PlapiError` / `BapiError` / `FapiError`, and use them to add two recovery paths in `clerk deploy`: resume from server state when a production instance already exists, and present a friendly upgrade hint when the development instance uses features the current subscription plan doesn't allow.

78 changes: 48 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -44,6 +45,23 @@ test("users list exposes common filters and pagination options", () => {
 );
});

test("deploy exposes the expected options", () => {
 const program = createProgram();
 const deploy = program.commands.find((command) => command.name() === "deploy")!;
 const optionNames = deploy.options.map((option) => option.long);

 expect(optionNames).toEqual([
 "--debug",
 "--test-force-production-instance",
 "--test-fail-production-instance-check",
 "--test-fail-domain-lookup",
 "--test-fail-validate-cloning",
 "--test-fail-create-production-instance",
 "--test-fail-dns-verification",
 "--test-fail-oauth-save",
 ]);
});

describe("parseIntegerOption (via users list --limit / --offset)", () => {
 function parseUsersList(args: readonly string[]) {
 return createProgram().parseAsync(["users", "list", ...args], { from: "user" });
Expand DownExpand Up@@ -140,7 +158,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +173,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +189,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +204,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +219,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +234,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +257,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +268,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +304,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +340,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(deploy): recover from production_instance_exists and surface plan-feature errors#289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wyattjoh
wants to merge
25
commits into

from

 Closed


feat(deploy): recover from production_instance_exists and surface plan-feature errors
#289
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


25 commits


Select commit
Hold shift + click to select a range
91a6fe0

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
8dfb8b5

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
9ab0662

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
c90bf4f

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
1ae6d36

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
0090584

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
f352c6f

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
4f9ddc2

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
bf05f3e

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
5466ad3

feat(deploy): implement resumable deploy wizard


wyattjoh May 6, 2026
e482fef

fix(deploy): address review feedback on resumable wizard


wyattjoh May 6, 2026
3847ef2

refactor(deploy): isolate lifecycle api calls


wyattjoh May 6, 2026
50cf7ea

feat(deploy): resolve production state from API


wyattjoh May 6, 2026
5c766e6

fix(deploy): route test failures through api path


wyattjoh May 6, 2026
e830ef6

fix(deploy): remove gutter tone plumbing


wyattjoh May 6, 2026
61e1dc3

fix(deploy): require human mode for production setup


wyattjoh May 12, 2026
9c99950

refactor(deploy): route lifecycle test failures through api mock


wyattjoh May 12, 2026
371a082

refactor(deploy): extract mock api into its own module


wyattjoh May 13, 2026
c878c51

refactor(deploy): construct simulated PlapiError via fromBody


wyattjoh May 13, 2026
0b70486

refactor(plapi): drop unused is_secondary from CreateProductionInstan…


wyattjoh May 13, 2026
0fd13de

feat(deploy/mock): inject production_instance_exists and unsupported …


wyattjoh May 13, 2026
3cbc0c5

feat(deploy): recover from production_instance_exists by resuming liv…


wyattjoh May 13, 2026
afe3cda

feat(deploy): friendlier error for unsupported subscription plan feat…


wyattjoh May 13, 2026
9218f4a

refactor(plapi): allow null active_domain and guard in deploy wizard


wyattjoh May 13, 2026
fae8e67

docs(deploy): document live-error recovery paths and add changeset


wyattjoh May 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/deploy-error-recovery.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": minor
---

Surface Clerk API error codes and metadata as structured fields on `PlapiError` / `BapiError` / `FapiError`, and use them to add two recovery paths in `clerk deploy`: resume from server state when a production instance already exists, and present a friendly upgrade hint when the development instance uses features the current subscription plan doesn't allow.

78 changes: 48 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -44,6 +45,23 @@ test("users list exposes common filters and pagination options", () => {
 );
});

test("deploy exposes the expected options", () => {
 const program = createProgram();
 const deploy = program.commands.find((command) => command.name() === "deploy")!;
 const optionNames = deploy.options.map((option) => option.long);

 expect(optionNames).toEqual([
 "--debug",
 "--test-force-production-instance",
 "--test-fail-production-instance-check",
 "--test-fail-domain-lookup",
 "--test-fail-validate-cloning",
 "--test-fail-create-production-instance",
 "--test-fail-dns-verification",
 "--test-fail-oauth-save",
 ]);
});

describe("parseIntegerOption (via users list --limit / --offset)", () => {
 function parseUsersList(args: readonly string[]) {
 return createProgram().parseAsync(["users", "list", ...args], { from: "user" });
Expand DownExpand Up@@ -140,7 +158,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +173,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +189,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +204,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +219,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +234,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +257,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +268,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +304,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +340,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down
Loading