Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/platform-api-url-credential-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": patch
---

Warn (in human mode) when `CLERK_PLATFORM_API_URL` routes requests to a host that differs from the active environment's URL, since credentials are keyed by environment name and not by URL. `clerk doctor` now also reports the active environment and its API URL so the mismatch is visible.
34 changes: 33 additions & 1 deletion packages/cli-core/src/cli-program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
getCurrentEnvName,
getAvailableEnvs,
getPlapiBaseUrl,
getPlatformApiUrlOverride,
} from "./lib/environment.ts";
import {
CliError,
Expand All@@ -42,7 +43,7 @@ import {
throwUsageError,
} from "./lib/errors.ts";
import { clerkHelpConfig, formatExamplesBlock, type Example } from "./lib/help.ts";
import { isAgent } from "./mode.ts";
import { isAgent, isHuman } from "./mode.ts";
import { log } from "./lib/log.ts";
import { maybeNotifyUpdate } from "./lib/update-check.ts";
import { CURRENT_VERSION } from "./lib/version.ts";
Expand DownExpand Up@@ -145,6 +146,19 @@ export function createProgram(): Program {
if (activeEnv !== "production") {
process.stderr.write(`[${activeEnv.toUpperCase()}]\n`);
}

// Warn (human mode only) when CLERK_PLATFORM_API_URL routes requests to a
// different host than the active environment's platform URL. Credentials are
// keyed by environment name, so the active env's token will be sent to the
// override host. Agent/scripted mode stays off stderr — stray lines there
// corrupt machine-readable output — but still gets the info via `log.debug`
// so a `--verbose` re-run of a failing script surfaces it.
const override = getPlatformApiUrlOverride();
if (override.overridden) {
const msg = `CLERK_PLATFORM_API_URL is routing requests to ${override.overrideUrl} instead of the "${override.envName}" environment's ${override.profileUrl} — the "${override.envName}" token will be sent to that host.`;
if (isHuman()) log.warn(msg);
else log.debug(`env: ${msg}`);
}
});

// Show update notification after each command, except for commands that
Expand DownExpand Up@@ -225,10 +239,28 @@ async function resolveArgv(
): Promise<{ argv: string[]; from: ParseFrom }> {
const raw = args ?? process.argv;
const effectiveFrom = from ?? (args === undefined ? "node" : "user");
// Honor an explicit `--mode` flag before `expandInputJson`, so a failure it
// throws (invalid JSON, missing file) is formatted in the right mode. The
// preAction hook re-applies and validates `--mode`, but it runs during
// parseAsync — too late for errors raised while resolving argv.
applyForcedModeFromArgv(raw);
const argv = await expandInputJson([...raw]);
return { argv, from: effectiveFrom };
}

/**
* Scan raw argv for an explicit `--mode human|agent` and force it early.
* Ignores an invalid value — the preAction hook reports that as a usage error.
*/
function applyForcedModeFromArgv(argv: string[]): void {
const idx = argv.indexOf("--mode");
if (idx === -1) return;
const value = argv[idx + 1];
if (value === "human" || value === "agent") {
setMode(value);
}
}

/**
* Parse and run a program, handling all typed errors with user-facing messages.
* Used by `cli.ts` for real execution and by integration tests.
Expand Down
5 changes: 4 additions & 1 deletion packages/cli-core/src/commands/doctor/checks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import {
formatChannelLabel,
} from "../../lib/update-check.ts";
import { formatHostStateProbeFailures, getAgentHostStateProbe } from "../../lib/host-execution.ts";
import { getCurrentEnvName, getPlapiBaseUrl } from "../../lib/environment.ts";
import { isAgent } from "../../mode.ts";
import type { CheckResult, DoctorContext, FixAction, KeylessInstanceInfo } from "./types.ts";

Expand DownExpand Up@@ -110,7 +111,9 @@ export async function checkLoggedIn(ctx: DoctorContext): Promise<CheckResult> {
fixable: false,
});
}
return check.pass("Logged in (token found in credential store)");
return check.pass(
`Logged in (token found in credential store) — environment "${getCurrentEnvName()}", API ${getPlapiBaseUrl()}`,
);
}

// No account session doesn't mean the project is broken: an unclaimed
Expand Down
51 changes: 51 additions & 0 deletions packages/cli-core/src/lib/environment.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { test, expect, describe, beforeEach, afterEach } from "bun:test";
import { getPlatformApiUrlOverride } from "./environment.ts";

describe("getPlatformApiUrlOverride", () => {
const original = process.env.CLERK_PLATFORM_API_URL;

beforeEach(() => {
delete process.env.CLERK_PLATFORM_API_URL;
});

afterEach(() => {
if (original === undefined) delete process.env.CLERK_PLATFORM_API_URL;
else process.env.CLERK_PLATFORM_API_URL = original;
});

test("returns overridden=true with URLs when the override differs from the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.staging.example.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("https://api.staging.example.com");
expect(result.profileUrl).toBe("https://api.clerk.com");
expect(result.envName).toBe("production");
});

test("returns overridden=false when no override is set", () => {
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("returns overridden=false when the override equals the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

Comment thread
rafa-thayto marked this conversation as resolved.
test("returns overridden=false when URLs differ only by trailing slash", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com/";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("falls back to raw string comparison when the override is not a valid URL", () => {
process.env.CLERK_PLATFORM_API_URL = "not a url";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("not a url");
expect(result.profileUrl).toBe("https://api.clerk.com");
});
});
58 changes: 58 additions & 0 deletions packages/cli-core/src/lib/environment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,19 @@ const DEFAULT_PROFILES: Record<string, EnvProfileConfig> = {
let currentEnvName: string | undefined;
let profilesSourceLogged = false;

/**
* Test-only fields shallow-merged into every resolved profile. The integration
* harness uses this to align the active profile's `platformApiUrl` with the
* test `CLERK_PLATFORM_API_URL`, so it stops tripping the override warning it
* never means to exercise. Mirrors config.ts's `_setConfigDir`.
*/
let testProfileOverride: Partial<EnvProfileConfig> | undefined;

/** @internal Test-only. Pass `undefined` to restore normal profile resolution. */
export function _setProfileOverrideForTest(override: Partial<EnvProfileConfig> | undefined): void {
testProfileOverride = override;
}

function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
// Try repo root (cwd) first, then fall back to path relative to this source file
const candidates = [
Expand All@@ -62,6 +75,15 @@ function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
}

function getProfiles(): Record<string, EnvProfileConfig> {
const base = resolveProfiles();
if (!testProfileOverride) return base;
const override = testProfileOverride;
return Object.fromEntries(
Object.entries(base).map(([name, profile]) => [name, { ...profile, ...override }]),
);
}

function resolveProfiles(): Record<string, EnvProfileConfig> {
if (typeof CLI_ENV_PROFILES !== "undefined" && CLI_ENV_PROFILES) {
if (!profilesSourceLogged) {
profilesSourceLogged = true;
Expand DownExpand Up@@ -141,6 +163,42 @@ export function getPlapiBaseUrl(): string {
return process.env.CLERK_PLATFORM_API_URL ?? getCurrentEnv().platformApiUrl;
}

/**
* Checks whether CLERK_PLATFORM_API_URL is set to a URL that differs from the
* active environment's configured platform URL, along with both URLs so the
* caller can surface a warning.
*
* Comparison normalises both URLs via `new URL().href` so trailing-slash and
* case differences are ignored; falls back to raw string comparison if either
* value is not a valid URL.
*/
export function getPlatformApiUrlOverride():
| {
overridden: false;
}
| {
overridden: true;
overrideUrl: string;
profileUrl: string;
envName: string;
} {
const override = process.env.CLERK_PLATFORM_API_URL;
if (!override) return { overridden: false };

const profileUrl = getCurrentEnv().platformApiUrl;
const normalize = (u: string) => {
try {
return new URL(u).href;
} catch {
return u;
}
};

if (normalize(override) === normalize(profileUrl)) return { overridden: false };

return { overridden: true, overrideUrl: override, profileUrl, envName: getCurrentEnvName() };
}

export function getBapiBaseUrl(): string {
return process.env.CLERK_BACKEND_API_URL ?? getCurrentEnv().backendApiUrl;
}
Expand Down
21 changes: 21 additions & 0 deletions packages/cli-core/src/test/integration/lib/harness.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ export async function setProfile(
return (await getConfigModule()).setProfile(...args);
}

// ── Real environment module ──────────────────────────────────────────────────

type EnvironmentModule = typeof import("../../../lib/environment.ts");

let environmentModulePromise: Promise<EnvironmentModule> | null = null;

function getEnvironmentModule(): Promise<EnvironmentModule> {
environmentModulePromise ??= import("../../../lib/environment.ts");
return environmentModulePromise;
}

// ── Mock data ────────────────────────────────────────────────────────────────

/**
Expand DownExpand Up@@ -539,10 +550,18 @@ export async function setupTest(): Promise<TestHarness> {
const tempDir = await mkdtemp(join(tmpdir(), "clerk-integration-"));
const { _setConfigDir } = await getConfigModule();
_setConfigDir(tempDir);
// `_mode` is module-level state in the mode.ts mock; reset it so a prior
// test that switched to agent mode can't leak `--mode agent` into the next.
_mode = "human";
process.cwd = () => tempDir;
setEnv("CLERK_PLATFORM_API_KEY", "test_platform_key");
setEnv("CLERK_PLATFORM_API_URL", "https://test-api.clerk.com");
setEnv("CLERK_BACKEND_API_URL", "https://test-bapi.clerk.dev");
// Point the active profile's platform URL at the same host as the override
// above, so `getPlatformApiUrlOverride()` sees no mismatch and the CLI's
// credential-mismatch warning never fires as a stray first line of stderr.
const { _setProfileOverrideForTest } = await getEnvironmentModule();
_setProfileOverrideForTest({ platformApiUrl: "https://test-api.clerk.com" });
mockState.storedToken = "mock_token";
mockState.gitNormalizedRemote = "github.com/test/project";
mockState.gitRepoRoot = "/repo";
Expand DownExpand Up@@ -572,11 +591,13 @@ export async function setupTest(): Promise<TestHarness> {
*/
export async function teardownTest(harness: TestHarness): Promise<void> {
const { _setConfigDir } = await getConfigModule();
const { _setProfileOverrideForTest } = await getEnvironmentModule();
currentHarness = null;
setActiveCapture(null);
assertPromptQueuesEmpty();
http.assertRoutesConsumed();
_setConfigDir(undefined);
_setProfileOverrideForTest(undefined);
process.cwd = originalCwd;
for (const [key, original] of envMutations) {
if (original === undefined) {
Expand Down
, '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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/platform-api-url-credential-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": patch
---

Warn (in human mode) when `CLERK_PLATFORM_API_URL` routes requests to a host that differs from the active environment's URL, since credentials are keyed by environment name and not by URL. `clerk doctor` now also reports the active environment and its API URL so the mismatch is visible.
34 changes: 33 additions & 1 deletion packages/cli-core/src/cli-program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
getCurrentEnvName,
getAvailableEnvs,
getPlapiBaseUrl,
getPlatformApiUrlOverride,
} from "./lib/environment.ts";
import {
CliError,
Expand All@@ -42,7 +43,7 @@ import {
throwUsageError,
} from "./lib/errors.ts";
import { clerkHelpConfig, formatExamplesBlock, type Example } from "./lib/help.ts";
import { isAgent } from "./mode.ts";
import { isAgent, isHuman } from "./mode.ts";
import { log } from "./lib/log.ts";
import { maybeNotifyUpdate } from "./lib/update-check.ts";
import { CURRENT_VERSION } from "./lib/version.ts";
Expand DownExpand Up@@ -145,6 +146,19 @@ export function createProgram(): Program {
if (activeEnv !== "production") {
process.stderr.write(`[${activeEnv.toUpperCase()}]\n`);
}

// Warn (human mode only) when CLERK_PLATFORM_API_URL routes requests to a
// different host than the active environment's platform URL. Credentials are
// keyed by environment name, so the active env's token will be sent to the
// override host. Agent/scripted mode stays off stderr — stray lines there
// corrupt machine-readable output — but still gets the info via `log.debug`
// so a `--verbose` re-run of a failing script surfaces it.
const override = getPlatformApiUrlOverride();
if (override.overridden) {
const msg = `CLERK_PLATFORM_API_URL is routing requests to ${override.overrideUrl} instead of the "${override.envName}" environment's ${override.profileUrl} — the "${override.envName}" token will be sent to that host.`;
if (isHuman()) log.warn(msg);
else log.debug(`env: ${msg}`);
}
});

// Show update notification after each command, except for commands that
Expand DownExpand Up@@ -225,10 +239,28 @@ async function resolveArgv(
): Promise<{ argv: string[]; from: ParseFrom }> {
const raw = args ?? process.argv;
const effectiveFrom = from ?? (args === undefined ? "node" : "user");
// Honor an explicit `--mode` flag before `expandInputJson`, so a failure it
// throws (invalid JSON, missing file) is formatted in the right mode. The
// preAction hook re-applies and validates `--mode`, but it runs during
// parseAsync — too late for errors raised while resolving argv.
applyForcedModeFromArgv(raw);
const argv = await expandInputJson([...raw]);
return { argv, from: effectiveFrom };
}

/**
* Scan raw argv for an explicit `--mode human|agent` and force it early.
* Ignores an invalid value — the preAction hook reports that as a usage error.
*/
function applyForcedModeFromArgv(argv: string[]): void {
const idx = argv.indexOf("--mode");
if (idx === -1) return;
const value = argv[idx + 1];
if (value === "human" || value === "agent") {
setMode(value);
}
}

/**
* Parse and run a program, handling all typed errors with user-facing messages.
* Used by `cli.ts` for real execution and by integration tests.
Expand Down
5 changes: 4 additions & 1 deletion packages/cli-core/src/commands/doctor/checks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import {
formatChannelLabel,
} from "../../lib/update-check.ts";
import { formatHostStateProbeFailures, getAgentHostStateProbe } from "../../lib/host-execution.ts";
import { getCurrentEnvName, getPlapiBaseUrl } from "../../lib/environment.ts";
import { isAgent } from "../../mode.ts";
import type { CheckResult, DoctorContext, FixAction, KeylessInstanceInfo } from "./types.ts";

Expand DownExpand Up@@ -110,7 +111,9 @@ export async function checkLoggedIn(ctx: DoctorContext): Promise<CheckResult> {
fixable: false,
});
}
return check.pass("Logged in (token found in credential store)");
return check.pass(
`Logged in (token found in credential store) — environment "${getCurrentEnvName()}", API ${getPlapiBaseUrl()}`,
);
}

// No account session doesn't mean the project is broken: an unclaimed
Expand Down
51 changes: 51 additions & 0 deletions packages/cli-core/src/lib/environment.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { test, expect, describe, beforeEach, afterEach } from "bun:test";
import { getPlatformApiUrlOverride } from "./environment.ts";

describe("getPlatformApiUrlOverride", () => {
const original = process.env.CLERK_PLATFORM_API_URL;

beforeEach(() => {
delete process.env.CLERK_PLATFORM_API_URL;
});

afterEach(() => {
if (original === undefined) delete process.env.CLERK_PLATFORM_API_URL;
else process.env.CLERK_PLATFORM_API_URL = original;
});

test("returns overridden=true with URLs when the override differs from the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.staging.example.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("https://api.staging.example.com");
expect(result.profileUrl).toBe("https://api.clerk.com");
expect(result.envName).toBe("production");
});

test("returns overridden=false when no override is set", () => {
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("returns overridden=false when the override equals the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

Comment thread
rafa-thayto marked this conversation as resolved.
test("returns overridden=false when URLs differ only by trailing slash", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com/";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("falls back to raw string comparison when the override is not a valid URL", () => {
process.env.CLERK_PLATFORM_API_URL = "not a url";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("not a url");
expect(result.profileUrl).toBe("https://api.clerk.com");
});
});
58 changes: 58 additions & 0 deletions packages/cli-core/src/lib/environment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,19 @@ const DEFAULT_PROFILES: Record<string, EnvProfileConfig> = {
let currentEnvName: string | undefined;
let profilesSourceLogged = false;

/**
* Test-only fields shallow-merged into every resolved profile. The integration
* harness uses this to align the active profile's `platformApiUrl` with the
* test `CLERK_PLATFORM_API_URL`, so it stops tripping the override warning it
* never means to exercise. Mirrors config.ts's `_setConfigDir`.
*/
let testProfileOverride: Partial<EnvProfileConfig> | undefined;

/** @internal Test-only. Pass `undefined` to restore normal profile resolution. */
export function _setProfileOverrideForTest(override: Partial<EnvProfileConfig> | undefined): void {
testProfileOverride = override;
}

function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
// Try repo root (cwd) first, then fall back to path relative to this source file
const candidates = [
Expand All@@ -62,6 +75,15 @@ function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
}

function getProfiles(): Record<string, EnvProfileConfig> {
const base = resolveProfiles();
if (!testProfileOverride) return base;
const override = testProfileOverride;
return Object.fromEntries(
Object.entries(base).map(([name, profile]) => [name, { ...profile, ...override }]),
);
}

function resolveProfiles(): Record<string, EnvProfileConfig> {
if (typeof CLI_ENV_PROFILES !== "undefined" && CLI_ENV_PROFILES) {
if (!profilesSourceLogged) {
profilesSourceLogged = true;
Expand DownExpand Up@@ -141,6 +163,42 @@ export function getPlapiBaseUrl(): string {
return process.env.CLERK_PLATFORM_API_URL ?? getCurrentEnv().platformApiUrl;
}

/**
* Checks whether CLERK_PLATFORM_API_URL is set to a URL that differs from the
* active environment's configured platform URL, along with both URLs so the
* caller can surface a warning.
*
* Comparison normalises both URLs via `new URL().href` so trailing-slash and
* case differences are ignored; falls back to raw string comparison if either
* value is not a valid URL.
*/
export function getPlatformApiUrlOverride():
| {
overridden: false;
}
| {
overridden: true;
overrideUrl: string;
profileUrl: string;
envName: string;
} {
const override = process.env.CLERK_PLATFORM_API_URL;
if (!override) return { overridden: false };

const profileUrl = getCurrentEnv().platformApiUrl;
const normalize = (u: string) => {
try {
return new URL(u).href;
} catch {
return u;
}
};

if (normalize(override) === normalize(profileUrl)) return { overridden: false };

return { overridden: true, overrideUrl: override, profileUrl, envName: getCurrentEnvName() };
}

export function getBapiBaseUrl(): string {
return process.env.CLERK_BACKEND_API_URL ?? getCurrentEnv().backendApiUrl;
}
Expand Down
21 changes: 21 additions & 0 deletions packages/cli-core/src/test/integration/lib/harness.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ export async function setProfile(
return (await getConfigModule()).setProfile(...args);
}

// ── Real environment module ──────────────────────────────────────────────────

type EnvironmentModule = typeof import("../../../lib/environment.ts");

let environmentModulePromise: Promise<EnvironmentModule> | null = null;

function getEnvironmentModule(): Promise<EnvironmentModule> {
environmentModulePromise ??= import("../../../lib/environment.ts");
return environmentModulePromise;
}

// ── Mock data ────────────────────────────────────────────────────────────────

/**
Expand DownExpand Up@@ -539,10 +550,18 @@ export async function setupTest(): Promise<TestHarness> {
const tempDir = await mkdtemp(join(tmpdir(), "clerk-integration-"));
const { _setConfigDir } = await getConfigModule();
_setConfigDir(tempDir);
// `_mode` is module-level state in the mode.ts mock; reset it so a prior
// test that switched to agent mode can't leak `--mode agent` into the next.
_mode = "human";
process.cwd = () => tempDir;
setEnv("CLERK_PLATFORM_API_KEY", "test_platform_key");
setEnv("CLERK_PLATFORM_API_URL", "https://test-api.clerk.com");
setEnv("CLERK_BACKEND_API_URL", "https://test-bapi.clerk.dev");
// Point the active profile's platform URL at the same host as the override
// above, so `getPlatformApiUrlOverride()` sees no mismatch and the CLI's
// credential-mismatch warning never fires as a stray first line of stderr.
const { _setProfileOverrideForTest } = await getEnvironmentModule();
_setProfileOverrideForTest({ platformApiUrl: "https://test-api.clerk.com" });
mockState.storedToken = "mock_token";
mockState.gitNormalizedRemote = "github.com/test/project";
mockState.gitRepoRoot = "/repo";
Expand DownExpand Up@@ -572,11 +591,13 @@ export async function setupTest(): Promise<TestHarness> {
*/
export async function teardownTest(harness: TestHarness): Promise<void> {
const { _setConfigDir } = await getConfigModule();
const { _setProfileOverrideForTest } = await getEnvironmentModule();
currentHarness = null;
setActiveCapture(null);
assertPromptQueuesEmpty();
http.assertRoutesConsumed();
_setConfigDir(undefined);
_setProfileOverrideForTest(undefined);
process.cwd = originalCwd;
for (const [key, original] of envMutations) {
if (original === undefined) {
Expand Down
, '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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/platform-api-url-credential-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": patch
---

Warn (in human mode) when `CLERK_PLATFORM_API_URL` routes requests to a host that differs from the active environment's URL, since credentials are keyed by environment name and not by URL. `clerk doctor` now also reports the active environment and its API URL so the mismatch is visible.
34 changes: 33 additions & 1 deletion packages/cli-core/src/cli-program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
getCurrentEnvName,
getAvailableEnvs,
getPlapiBaseUrl,
getPlatformApiUrlOverride,
} from "./lib/environment.ts";
import {
CliError,
Expand All@@ -42,7 +43,7 @@ import {
throwUsageError,
} from "./lib/errors.ts";
import { clerkHelpConfig, formatExamplesBlock, type Example } from "./lib/help.ts";
import { isAgent } from "./mode.ts";
import { isAgent, isHuman } from "./mode.ts";
import { log } from "./lib/log.ts";
import { maybeNotifyUpdate } from "./lib/update-check.ts";
import { CURRENT_VERSION } from "./lib/version.ts";
Expand DownExpand Up@@ -145,6 +146,19 @@ export function createProgram(): Program {
if (activeEnv !== "production") {
process.stderr.write(`[${activeEnv.toUpperCase()}]\n`);
}

// Warn (human mode only) when CLERK_PLATFORM_API_URL routes requests to a
// different host than the active environment's platform URL. Credentials are
// keyed by environment name, so the active env's token will be sent to the
// override host. Agent/scripted mode stays off stderr — stray lines there
// corrupt machine-readable output — but still gets the info via `log.debug`
// so a `--verbose` re-run of a failing script surfaces it.
const override = getPlatformApiUrlOverride();
if (override.overridden) {
const msg = `CLERK_PLATFORM_API_URL is routing requests to ${override.overrideUrl} instead of the "${override.envName}" environment's ${override.profileUrl} — the "${override.envName}" token will be sent to that host.`;
if (isHuman()) log.warn(msg);
else log.debug(`env: ${msg}`);
}
});

// Show update notification after each command, except for commands that
Expand DownExpand Up@@ -225,10 +239,28 @@ async function resolveArgv(
): Promise<{ argv: string[]; from: ParseFrom }> {
const raw = args ?? process.argv;
const effectiveFrom = from ?? (args === undefined ? "node" : "user");
// Honor an explicit `--mode` flag before `expandInputJson`, so a failure it
// throws (invalid JSON, missing file) is formatted in the right mode. The
// preAction hook re-applies and validates `--mode`, but it runs during
// parseAsync — too late for errors raised while resolving argv.
applyForcedModeFromArgv(raw);
const argv = await expandInputJson([...raw]);
return { argv, from: effectiveFrom };
}

/**
* Scan raw argv for an explicit `--mode human|agent` and force it early.
* Ignores an invalid value — the preAction hook reports that as a usage error.
*/
function applyForcedModeFromArgv(argv: string[]): void {
const idx = argv.indexOf("--mode");
if (idx === -1) return;
const value = argv[idx + 1];
if (value === "human" || value === "agent") {
setMode(value);
}
}

/**
* Parse and run a program, handling all typed errors with user-facing messages.
* Used by `cli.ts` for real execution and by integration tests.
Expand Down
5 changes: 4 additions & 1 deletion packages/cli-core/src/commands/doctor/checks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import {
formatChannelLabel,
} from "../../lib/update-check.ts";
import { formatHostStateProbeFailures, getAgentHostStateProbe } from "../../lib/host-execution.ts";
import { getCurrentEnvName, getPlapiBaseUrl } from "../../lib/environment.ts";
import { isAgent } from "../../mode.ts";
import type { CheckResult, DoctorContext, FixAction, KeylessInstanceInfo } from "./types.ts";

Expand DownExpand Up@@ -110,7 +111,9 @@ export async function checkLoggedIn(ctx: DoctorContext): Promise<CheckResult> {
fixable: false,
});
}
return check.pass("Logged in (token found in credential store)");
return check.pass(
`Logged in (token found in credential store) — environment "${getCurrentEnvName()}", API ${getPlapiBaseUrl()}`,
);
}

// No account session doesn't mean the project is broken: an unclaimed
Expand Down
51 changes: 51 additions & 0 deletions packages/cli-core/src/lib/environment.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { test, expect, describe, beforeEach, afterEach } from "bun:test";
import { getPlatformApiUrlOverride } from "./environment.ts";

describe("getPlatformApiUrlOverride", () => {
const original = process.env.CLERK_PLATFORM_API_URL;

beforeEach(() => {
delete process.env.CLERK_PLATFORM_API_URL;
});

afterEach(() => {
if (original === undefined) delete process.env.CLERK_PLATFORM_API_URL;
else process.env.CLERK_PLATFORM_API_URL = original;
});

test("returns overridden=true with URLs when the override differs from the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.staging.example.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("https://api.staging.example.com");
expect(result.profileUrl).toBe("https://api.clerk.com");
expect(result.envName).toBe("production");
});

test("returns overridden=false when no override is set", () => {
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("returns overridden=false when the override equals the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

Comment thread
rafa-thayto marked this conversation as resolved.
test("returns overridden=false when URLs differ only by trailing slash", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com/";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("falls back to raw string comparison when the override is not a valid URL", () => {
process.env.CLERK_PLATFORM_API_URL = "not a url";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("not a url");
expect(result.profileUrl).toBe("https://api.clerk.com");
});
});
58 changes: 58 additions & 0 deletions packages/cli-core/src/lib/environment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,19 @@ const DEFAULT_PROFILES: Record<string, EnvProfileConfig> = {
let currentEnvName: string | undefined;
let profilesSourceLogged = false;

/**
* Test-only fields shallow-merged into every resolved profile. The integration
* harness uses this to align the active profile's `platformApiUrl` with the
* test `CLERK_PLATFORM_API_URL`, so it stops tripping the override warning it
* never means to exercise. Mirrors config.ts's `_setConfigDir`.
*/
let testProfileOverride: Partial<EnvProfileConfig> | undefined;

/** @internal Test-only. Pass `undefined` to restore normal profile resolution. */
export function _setProfileOverrideForTest(override: Partial<EnvProfileConfig> | undefined): void {
testProfileOverride = override;
}

function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
// Try repo root (cwd) first, then fall back to path relative to this source file
const candidates = [
Expand All@@ -62,6 +75,15 @@ function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
}

function getProfiles(): Record<string, EnvProfileConfig> {
const base = resolveProfiles();
if (!testProfileOverride) return base;
const override = testProfileOverride;
return Object.fromEntries(
Object.entries(base).map(([name, profile]) => [name, { ...profile, ...override }]),
);
}

function resolveProfiles(): Record<string, EnvProfileConfig> {
if (typeof CLI_ENV_PROFILES !== "undefined" && CLI_ENV_PROFILES) {
if (!profilesSourceLogged) {
profilesSourceLogged = true;
Expand DownExpand Up@@ -141,6 +163,42 @@ export function getPlapiBaseUrl(): string {
return process.env.CLERK_PLATFORM_API_URL ?? getCurrentEnv().platformApiUrl;
}

/**
* Checks whether CLERK_PLATFORM_API_URL is set to a URL that differs from the
* active environment's configured platform URL, along with both URLs so the
* caller can surface a warning.
*
* Comparison normalises both URLs via `new URL().href` so trailing-slash and
* case differences are ignored; falls back to raw string comparison if either
* value is not a valid URL.
*/
export function getPlatformApiUrlOverride():
| {
overridden: false;
}
| {
overridden: true;
overrideUrl: string;
profileUrl: string;
envName: string;
} {
const override = process.env.CLERK_PLATFORM_API_URL;
if (!override) return { overridden: false };

const profileUrl = getCurrentEnv().platformApiUrl;
const normalize = (u: string) => {
try {
return new URL(u).href;
} catch {
return u;
}
};

if (normalize(override) === normalize(profileUrl)) return { overridden: false };

return { overridden: true, overrideUrl: override, profileUrl, envName: getCurrentEnvName() };
}

export function getBapiBaseUrl(): string {
return process.env.CLERK_BACKEND_API_URL ?? getCurrentEnv().backendApiUrl;
}
Expand Down
21 changes: 21 additions & 0 deletions packages/cli-core/src/test/integration/lib/harness.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ export async function setProfile(
return (await getConfigModule()).setProfile(...args);
}

// ── Real environment module ──────────────────────────────────────────────────

type EnvironmentModule = typeof import("../../../lib/environment.ts");

let environmentModulePromise: Promise<EnvironmentModule> | null = null;

function getEnvironmentModule(): Promise<EnvironmentModule> {
environmentModulePromise ??= import("../../../lib/environment.ts");
return environmentModulePromise;
}

// ── Mock data ────────────────────────────────────────────────────────────────

/**
Expand DownExpand Up@@ -539,10 +550,18 @@ export async function setupTest(): Promise<TestHarness> {
const tempDir = await mkdtemp(join(tmpdir(), "clerk-integration-"));
const { _setConfigDir } = await getConfigModule();
_setConfigDir(tempDir);
// `_mode` is module-level state in the mode.ts mock; reset it so a prior
// test that switched to agent mode can't leak `--mode agent` into the next.
_mode = "human";
process.cwd = () => tempDir;
setEnv("CLERK_PLATFORM_API_KEY", "test_platform_key");
setEnv("CLERK_PLATFORM_API_URL", "https://test-api.clerk.com");
setEnv("CLERK_BACKEND_API_URL", "https://test-bapi.clerk.dev");
// Point the active profile's platform URL at the same host as the override
// above, so `getPlatformApiUrlOverride()` sees no mismatch and the CLI's
// credential-mismatch warning never fires as a stray first line of stderr.
const { _setProfileOverrideForTest } = await getEnvironmentModule();
_setProfileOverrideForTest({ platformApiUrl: "https://test-api.clerk.com" });
mockState.storedToken = "mock_token";
mockState.gitNormalizedRemote = "github.com/test/project";
mockState.gitRepoRoot = "/repo";
Expand DownExpand Up@@ -572,11 +591,13 @@ export async function setupTest(): Promise<TestHarness> {
*/
export async function teardownTest(harness: TestHarness): Promise<void> {
const { _setConfigDir } = await getConfigModule();
const { _setProfileOverrideForTest } = await getEnvironmentModule();
currentHarness = null;
setActiveCapture(null);
assertPromptQueuesEmpty();
http.assertRoutesConsumed();
_setConfigDir(undefined);
_setProfileOverrideForTest(undefined);
process.cwd = originalCwd;
for (const [key, original] of envMutations) {
if (original === undefined) {
Expand Down
, '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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/platform-api-url-credential-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": patch
---

Warn (in human mode) when `CLERK_PLATFORM_API_URL` routes requests to a host that differs from the active environment's URL, since credentials are keyed by environment name and not by URL. `clerk doctor` now also reports the active environment and its API URL so the mismatch is visible.
34 changes: 33 additions & 1 deletion packages/cli-core/src/cli-program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
getCurrentEnvName,
getAvailableEnvs,
getPlapiBaseUrl,
getPlatformApiUrlOverride,
} from "./lib/environment.ts";
import {
CliError,
Expand All@@ -42,7 +43,7 @@ import {
throwUsageError,
} from "./lib/errors.ts";
import { clerkHelpConfig, formatExamplesBlock, type Example } from "./lib/help.ts";
import { isAgent } from "./mode.ts";
import { isAgent, isHuman } from "./mode.ts";
import { log } from "./lib/log.ts";
import { maybeNotifyUpdate } from "./lib/update-check.ts";
import { CURRENT_VERSION } from "./lib/version.ts";
Expand DownExpand Up@@ -145,6 +146,19 @@ export function createProgram(): Program {
if (activeEnv !== "production") {
process.stderr.write(`[${activeEnv.toUpperCase()}]\n`);
}

// Warn (human mode only) when CLERK_PLATFORM_API_URL routes requests to a
// different host than the active environment's platform URL. Credentials are
// keyed by environment name, so the active env's token will be sent to the
// override host. Agent/scripted mode stays off stderr — stray lines there
// corrupt machine-readable output — but still gets the info via `log.debug`
// so a `--verbose` re-run of a failing script surfaces it.
const override = getPlatformApiUrlOverride();
if (override.overridden) {
const msg = `CLERK_PLATFORM_API_URL is routing requests to ${override.overrideUrl} instead of the "${override.envName}" environment's ${override.profileUrl} — the "${override.envName}" token will be sent to that host.`;
if (isHuman()) log.warn(msg);
else log.debug(`env: ${msg}`);
}
});

// Show update notification after each command, except for commands that
Expand DownExpand Up@@ -225,10 +239,28 @@ async function resolveArgv(
): Promise<{ argv: string[]; from: ParseFrom }> {
const raw = args ?? process.argv;
const effectiveFrom = from ?? (args === undefined ? "node" : "user");
// Honor an explicit `--mode` flag before `expandInputJson`, so a failure it
// throws (invalid JSON, missing file) is formatted in the right mode. The
// preAction hook re-applies and validates `--mode`, but it runs during
// parseAsync — too late for errors raised while resolving argv.
applyForcedModeFromArgv(raw);
const argv = await expandInputJson([...raw]);
return { argv, from: effectiveFrom };
}

/**
* Scan raw argv for an explicit `--mode human|agent` and force it early.
* Ignores an invalid value — the preAction hook reports that as a usage error.
*/
function applyForcedModeFromArgv(argv: string[]): void {
const idx = argv.indexOf("--mode");
if (idx === -1) return;
const value = argv[idx + 1];
if (value === "human" || value === "agent") {
setMode(value);
}
}

/**
* Parse and run a program, handling all typed errors with user-facing messages.
* Used by `cli.ts` for real execution and by integration tests.
Expand Down
5 changes: 4 additions & 1 deletion packages/cli-core/src/commands/doctor/checks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import {
formatChannelLabel,
} from "../../lib/update-check.ts";
import { formatHostStateProbeFailures, getAgentHostStateProbe } from "../../lib/host-execution.ts";
import { getCurrentEnvName, getPlapiBaseUrl } from "../../lib/environment.ts";
import { isAgent } from "../../mode.ts";
import type { CheckResult, DoctorContext, FixAction, KeylessInstanceInfo } from "./types.ts";

Expand DownExpand Up@@ -110,7 +111,9 @@ export async function checkLoggedIn(ctx: DoctorContext): Promise<CheckResult> {
fixable: false,
});
}
return check.pass("Logged in (token found in credential store)");
return check.pass(
`Logged in (token found in credential store) — environment "${getCurrentEnvName()}", API ${getPlapiBaseUrl()}`,
);
}

// No account session doesn't mean the project is broken: an unclaimed
Expand Down
51 changes: 51 additions & 0 deletions packages/cli-core/src/lib/environment.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { test, expect, describe, beforeEach, afterEach } from "bun:test";
import { getPlatformApiUrlOverride } from "./environment.ts";

describe("getPlatformApiUrlOverride", () => {
const original = process.env.CLERK_PLATFORM_API_URL;

beforeEach(() => {
delete process.env.CLERK_PLATFORM_API_URL;
});

afterEach(() => {
if (original === undefined) delete process.env.CLERK_PLATFORM_API_URL;
else process.env.CLERK_PLATFORM_API_URL = original;
});

test("returns overridden=true with URLs when the override differs from the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.staging.example.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("https://api.staging.example.com");
expect(result.profileUrl).toBe("https://api.clerk.com");
expect(result.envName).toBe("production");
});

test("returns overridden=false when no override is set", () => {
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("returns overridden=false when the override equals the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

Comment thread
rafa-thayto marked this conversation as resolved.
test("returns overridden=false when URLs differ only by trailing slash", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com/";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("falls back to raw string comparison when the override is not a valid URL", () => {
process.env.CLERK_PLATFORM_API_URL = "not a url";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("not a url");
expect(result.profileUrl).toBe("https://api.clerk.com");
});
});
58 changes: 58 additions & 0 deletions packages/cli-core/src/lib/environment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,19 @@ const DEFAULT_PROFILES: Record<string, EnvProfileConfig> = {
let currentEnvName: string | undefined;
let profilesSourceLogged = false;

/**
* Test-only fields shallow-merged into every resolved profile. The integration
* harness uses this to align the active profile's `platformApiUrl` with the
* test `CLERK_PLATFORM_API_URL`, so it stops tripping the override warning it
* never means to exercise. Mirrors config.ts's `_setConfigDir`.
*/
let testProfileOverride: Partial<EnvProfileConfig> | undefined;

/** @internal Test-only. Pass `undefined` to restore normal profile resolution. */
export function _setProfileOverrideForTest(override: Partial<EnvProfileConfig> | undefined): void {
testProfileOverride = override;
}

function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
// Try repo root (cwd) first, then fall back to path relative to this source file
const candidates = [
Expand All@@ -62,6 +75,15 @@ function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
}

function getProfiles(): Record<string, EnvProfileConfig> {
const base = resolveProfiles();
if (!testProfileOverride) return base;
const override = testProfileOverride;
return Object.fromEntries(
Object.entries(base).map(([name, profile]) => [name, { ...profile, ...override }]),
);
}

function resolveProfiles(): Record<string, EnvProfileConfig> {
if (typeof CLI_ENV_PROFILES !== "undefined" && CLI_ENV_PROFILES) {
if (!profilesSourceLogged) {
profilesSourceLogged = true;
Expand DownExpand Up@@ -141,6 +163,42 @@ export function getPlapiBaseUrl(): string {
return process.env.CLERK_PLATFORM_API_URL ?? getCurrentEnv().platformApiUrl;
}

/**
* Checks whether CLERK_PLATFORM_API_URL is set to a URL that differs from the
* active environment's configured platform URL, along with both URLs so the
* caller can surface a warning.
*
* Comparison normalises both URLs via `new URL().href` so trailing-slash and
* case differences are ignored; falls back to raw string comparison if either
* value is not a valid URL.
*/
export function getPlatformApiUrlOverride():
| {
overridden: false;
}
| {
overridden: true;
overrideUrl: string;
profileUrl: string;
envName: string;
} {
const override = process.env.CLERK_PLATFORM_API_URL;
if (!override) return { overridden: false };

const profileUrl = getCurrentEnv().platformApiUrl;
const normalize = (u: string) => {
try {
return new URL(u).href;
} catch {
return u;
}
};

if (normalize(override) === normalize(profileUrl)) return { overridden: false };

return { overridden: true, overrideUrl: override, profileUrl, envName: getCurrentEnvName() };
}

export function getBapiBaseUrl(): string {
return process.env.CLERK_BACKEND_API_URL ?? getCurrentEnv().backendApiUrl;
}
Expand Down
21 changes: 21 additions & 0 deletions packages/cli-core/src/test/integration/lib/harness.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ export async function setProfile(
return (await getConfigModule()).setProfile(...args);
}

// ── Real environment module ──────────────────────────────────────────────────

type EnvironmentModule = typeof import("../../../lib/environment.ts");

let environmentModulePromise: Promise<EnvironmentModule> | null = null;

function getEnvironmentModule(): Promise<EnvironmentModule> {
environmentModulePromise ??= import("../../../lib/environment.ts");
return environmentModulePromise;
}

// ── Mock data ────────────────────────────────────────────────────────────────

/**
Expand DownExpand Up@@ -539,10 +550,18 @@ export async function setupTest(): Promise<TestHarness> {
const tempDir = await mkdtemp(join(tmpdir(), "clerk-integration-"));
const { _setConfigDir } = await getConfigModule();
_setConfigDir(tempDir);
// `_mode` is module-level state in the mode.ts mock; reset it so a prior
// test that switched to agent mode can't leak `--mode agent` into the next.
_mode = "human";
process.cwd = () => tempDir;
setEnv("CLERK_PLATFORM_API_KEY", "test_platform_key");
setEnv("CLERK_PLATFORM_API_URL", "https://test-api.clerk.com");
setEnv("CLERK_BACKEND_API_URL", "https://test-bapi.clerk.dev");
// Point the active profile's platform URL at the same host as the override
// above, so `getPlatformApiUrlOverride()` sees no mismatch and the CLI's
// credential-mismatch warning never fires as a stray first line of stderr.
const { _setProfileOverrideForTest } = await getEnvironmentModule();
_setProfileOverrideForTest({ platformApiUrl: "https://test-api.clerk.com" });
mockState.storedToken = "mock_token";
mockState.gitNormalizedRemote = "github.com/test/project";
mockState.gitRepoRoot = "/repo";
Expand DownExpand Up@@ -572,11 +591,13 @@ export async function setupTest(): Promise<TestHarness> {
*/
export async function teardownTest(harness: TestHarness): Promise<void> {
const { _setConfigDir } = await getConfigModule();
const { _setProfileOverrideForTest } = await getEnvironmentModule();
currentHarness = null;
setActiveCapture(null);
assertPromptQueuesEmpty();
http.assertRoutesConsumed();
_setConfigDir(undefined);
_setProfileOverrideForTest(undefined);
process.cwd = originalCwd;
for (const [key, original] of envMutations) {
if (original === undefined) {
Expand Down
, '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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/platform-api-url-credential-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": patch
---

Warn (in human mode) when `CLERK_PLATFORM_API_URL` routes requests to a host that differs from the active environment's URL, since credentials are keyed by environment name and not by URL. `clerk doctor` now also reports the active environment and its API URL so the mismatch is visible.
34 changes: 33 additions & 1 deletion packages/cli-core/src/cli-program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
getCurrentEnvName,
getAvailableEnvs,
getPlapiBaseUrl,
getPlatformApiUrlOverride,
} from "./lib/environment.ts";
import {
CliError,
Expand All@@ -42,7 +43,7 @@ import {
throwUsageError,
} from "./lib/errors.ts";
import { clerkHelpConfig, formatExamplesBlock, type Example } from "./lib/help.ts";
import { isAgent } from "./mode.ts";
import { isAgent, isHuman } from "./mode.ts";
import { log } from "./lib/log.ts";
import { maybeNotifyUpdate } from "./lib/update-check.ts";
import { CURRENT_VERSION } from "./lib/version.ts";
Expand DownExpand Up@@ -145,6 +146,19 @@ export function createProgram(): Program {
if (activeEnv !== "production") {
process.stderr.write(`[${activeEnv.toUpperCase()}]\n`);
}

// Warn (human mode only) when CLERK_PLATFORM_API_URL routes requests to a
// different host than the active environment's platform URL. Credentials are
// keyed by environment name, so the active env's token will be sent to the
// override host. Agent/scripted mode stays off stderr — stray lines there
// corrupt machine-readable output — but still gets the info via `log.debug`
// so a `--verbose` re-run of a failing script surfaces it.
const override = getPlatformApiUrlOverride();
if (override.overridden) {
const msg = `CLERK_PLATFORM_API_URL is routing requests to ${override.overrideUrl} instead of the "${override.envName}" environment's ${override.profileUrl} — the "${override.envName}" token will be sent to that host.`;
if (isHuman()) log.warn(msg);
else log.debug(`env: ${msg}`);
}
});

// Show update notification after each command, except for commands that
Expand DownExpand Up@@ -225,10 +239,28 @@ async function resolveArgv(
): Promise<{ argv: string[]; from: ParseFrom }> {
const raw = args ?? process.argv;
const effectiveFrom = from ?? (args === undefined ? "node" : "user");
// Honor an explicit `--mode` flag before `expandInputJson`, so a failure it
// throws (invalid JSON, missing file) is formatted in the right mode. The
// preAction hook re-applies and validates `--mode`, but it runs during
// parseAsync — too late for errors raised while resolving argv.
applyForcedModeFromArgv(raw);
const argv = await expandInputJson([...raw]);
return { argv, from: effectiveFrom };
}

/**
* Scan raw argv for an explicit `--mode human|agent` and force it early.
* Ignores an invalid value — the preAction hook reports that as a usage error.
*/
function applyForcedModeFromArgv(argv: string[]): void {
const idx = argv.indexOf("--mode");
if (idx === -1) return;
const value = argv[idx + 1];
if (value === "human" || value === "agent") {
setMode(value);
}
}

/**
* Parse and run a program, handling all typed errors with user-facing messages.
* Used by `cli.ts` for real execution and by integration tests.
Expand Down
5 changes: 4 additions & 1 deletion packages/cli-core/src/commands/doctor/checks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import {
formatChannelLabel,
} from "../../lib/update-check.ts";
import { formatHostStateProbeFailures, getAgentHostStateProbe } from "../../lib/host-execution.ts";
import { getCurrentEnvName, getPlapiBaseUrl } from "../../lib/environment.ts";
import { isAgent } from "../../mode.ts";
import type { CheckResult, DoctorContext, FixAction, KeylessInstanceInfo } from "./types.ts";

Expand DownExpand Up@@ -110,7 +111,9 @@ export async function checkLoggedIn(ctx: DoctorContext): Promise<CheckResult> {
fixable: false,
});
}
return check.pass("Logged in (token found in credential store)");
return check.pass(
`Logged in (token found in credential store) — environment "${getCurrentEnvName()}", API ${getPlapiBaseUrl()}`,
);
}

// No account session doesn't mean the project is broken: an unclaimed
Expand Down
51 changes: 51 additions & 0 deletions packages/cli-core/src/lib/environment.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { test, expect, describe, beforeEach, afterEach } from "bun:test";
import { getPlatformApiUrlOverride } from "./environment.ts";

describe("getPlatformApiUrlOverride", () => {
const original = process.env.CLERK_PLATFORM_API_URL;

beforeEach(() => {
delete process.env.CLERK_PLATFORM_API_URL;
});

afterEach(() => {
if (original === undefined) delete process.env.CLERK_PLATFORM_API_URL;
else process.env.CLERK_PLATFORM_API_URL = original;
});

test("returns overridden=true with URLs when the override differs from the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.staging.example.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("https://api.staging.example.com");
expect(result.profileUrl).toBe("https://api.clerk.com");
expect(result.envName).toBe("production");
});

test("returns overridden=false when no override is set", () => {
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("returns overridden=false when the override equals the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

Comment thread
rafa-thayto marked this conversation as resolved.
test("returns overridden=false when URLs differ only by trailing slash", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com/";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("falls back to raw string comparison when the override is not a valid URL", () => {
process.env.CLERK_PLATFORM_API_URL = "not a url";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("not a url");
expect(result.profileUrl).toBe("https://api.clerk.com");
});
});
58 changes: 58 additions & 0 deletions packages/cli-core/src/lib/environment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,19 @@ const DEFAULT_PROFILES: Record<string, EnvProfileConfig> = {
let currentEnvName: string | undefined;
let profilesSourceLogged = false;

/**
* Test-only fields shallow-merged into every resolved profile. The integration
* harness uses this to align the active profile's `platformApiUrl` with the
* test `CLERK_PLATFORM_API_URL`, so it stops tripping the override warning it
* never means to exercise. Mirrors config.ts's `_setConfigDir`.
*/
let testProfileOverride: Partial<EnvProfileConfig> | undefined;

/** @internal Test-only. Pass `undefined` to restore normal profile resolution. */
export function _setProfileOverrideForTest(override: Partial<EnvProfileConfig> | undefined): void {
testProfileOverride = override;
}

function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
// Try repo root (cwd) first, then fall back to path relative to this source file
const candidates = [
Expand All@@ -62,6 +75,15 @@ function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
}

function getProfiles(): Record<string, EnvProfileConfig> {
const base = resolveProfiles();
if (!testProfileOverride) return base;
const override = testProfileOverride;
return Object.fromEntries(
Object.entries(base).map(([name, profile]) => [name, { ...profile, ...override }]),
);
}

function resolveProfiles(): Record<string, EnvProfileConfig> {
if (typeof CLI_ENV_PROFILES !== "undefined" && CLI_ENV_PROFILES) {
if (!profilesSourceLogged) {
profilesSourceLogged = true;
Expand DownExpand Up@@ -141,6 +163,42 @@ export function getPlapiBaseUrl(): string {
return process.env.CLERK_PLATFORM_API_URL ?? getCurrentEnv().platformApiUrl;
}

/**
* Checks whether CLERK_PLATFORM_API_URL is set to a URL that differs from the
* active environment's configured platform URL, along with both URLs so the
* caller can surface a warning.
*
* Comparison normalises both URLs via `new URL().href` so trailing-slash and
* case differences are ignored; falls back to raw string comparison if either
* value is not a valid URL.
*/
export function getPlatformApiUrlOverride():
| {
overridden: false;
}
| {
overridden: true;
overrideUrl: string;
profileUrl: string;
envName: string;
} {
const override = process.env.CLERK_PLATFORM_API_URL;
if (!override) return { overridden: false };

const profileUrl = getCurrentEnv().platformApiUrl;
const normalize = (u: string) => {
try {
return new URL(u).href;
} catch {
return u;
}
};

if (normalize(override) === normalize(profileUrl)) return { overridden: false };

return { overridden: true, overrideUrl: override, profileUrl, envName: getCurrentEnvName() };
}

export function getBapiBaseUrl(): string {
return process.env.CLERK_BACKEND_API_URL ?? getCurrentEnv().backendApiUrl;
}
Expand Down
21 changes: 21 additions & 0 deletions packages/cli-core/src/test/integration/lib/harness.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ export async function setProfile(
return (await getConfigModule()).setProfile(...args);
}

// ── Real environment module ──────────────────────────────────────────────────

type EnvironmentModule = typeof import("../../../lib/environment.ts");

let environmentModulePromise: Promise<EnvironmentModule> | null = null;

function getEnvironmentModule(): Promise<EnvironmentModule> {
environmentModulePromise ??= import("../../../lib/environment.ts");
return environmentModulePromise;
}

// ── Mock data ────────────────────────────────────────────────────────────────

/**
Expand DownExpand Up@@ -539,10 +550,18 @@ export async function setupTest(): Promise<TestHarness> {
const tempDir = await mkdtemp(join(tmpdir(), "clerk-integration-"));
const { _setConfigDir } = await getConfigModule();
_setConfigDir(tempDir);
// `_mode` is module-level state in the mode.ts mock; reset it so a prior
// test that switched to agent mode can't leak `--mode agent` into the next.
_mode = "human";
process.cwd = () => tempDir;
setEnv("CLERK_PLATFORM_API_KEY", "test_platform_key");
setEnv("CLERK_PLATFORM_API_URL", "https://test-api.clerk.com");
setEnv("CLERK_BACKEND_API_URL", "https://test-bapi.clerk.dev");
// Point the active profile's platform URL at the same host as the override
// above, so `getPlatformApiUrlOverride()` sees no mismatch and the CLI's
// credential-mismatch warning never fires as a stray first line of stderr.
const { _setProfileOverrideForTest } = await getEnvironmentModule();
_setProfileOverrideForTest({ platformApiUrl: "https://test-api.clerk.com" });
mockState.storedToken = "mock_token";
mockState.gitNormalizedRemote = "github.com/test/project";
mockState.gitRepoRoot = "/repo";
Expand DownExpand Up@@ -572,11 +591,13 @@ export async function setupTest(): Promise<TestHarness> {
*/
export async function teardownTest(harness: TestHarness): Promise<void> {
const { _setConfigDir } = await getConfigModule();
const { _setProfileOverrideForTest } = await getEnvironmentModule();
currentHarness = null;
setActiveCapture(null);
assertPromptQueuesEmpty();
http.assertRoutesConsumed();
_setConfigDir(undefined);
_setProfileOverrideForTest(undefined);
process.cwd = originalCwd;
for (const [key, original] of envMutations) {
if (original === undefined) {
Expand Down
, '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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/platform-api-url-credential-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": patch
---

Warn (in human mode) when `CLERK_PLATFORM_API_URL` routes requests to a host that differs from the active environment's URL, since credentials are keyed by environment name and not by URL. `clerk doctor` now also reports the active environment and its API URL so the mismatch is visible.
34 changes: 33 additions & 1 deletion packages/cli-core/src/cli-program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
getCurrentEnvName,
getAvailableEnvs,
getPlapiBaseUrl,
getPlatformApiUrlOverride,
} from "./lib/environment.ts";
import {
CliError,
Expand All@@ -42,7 +43,7 @@ import {
throwUsageError,
} from "./lib/errors.ts";
import { clerkHelpConfig, formatExamplesBlock, type Example } from "./lib/help.ts";
import { isAgent } from "./mode.ts";
import { isAgent, isHuman } from "./mode.ts";
import { log } from "./lib/log.ts";
import { maybeNotifyUpdate } from "./lib/update-check.ts";
import { CURRENT_VERSION } from "./lib/version.ts";
Expand DownExpand Up@@ -145,6 +146,19 @@ export function createProgram(): Program {
if (activeEnv !== "production") {
process.stderr.write(`[${activeEnv.toUpperCase()}]\n`);
}

// Warn (human mode only) when CLERK_PLATFORM_API_URL routes requests to a
// different host than the active environment's platform URL. Credentials are
// keyed by environment name, so the active env's token will be sent to the
// override host. Agent/scripted mode stays off stderr — stray lines there
// corrupt machine-readable output — but still gets the info via `log.debug`
// so a `--verbose` re-run of a failing script surfaces it.
const override = getPlatformApiUrlOverride();
if (override.overridden) {
const msg = `CLERK_PLATFORM_API_URL is routing requests to ${override.overrideUrl} instead of the "${override.envName}" environment's ${override.profileUrl} — the "${override.envName}" token will be sent to that host.`;
if (isHuman()) log.warn(msg);
else log.debug(`env: ${msg}`);
}
});

// Show update notification after each command, except for commands that
Expand DownExpand Up@@ -225,10 +239,28 @@ async function resolveArgv(
): Promise<{ argv: string[]; from: ParseFrom }> {
const raw = args ?? process.argv;
const effectiveFrom = from ?? (args === undefined ? "node" : "user");
// Honor an explicit `--mode` flag before `expandInputJson`, so a failure it
// throws (invalid JSON, missing file) is formatted in the right mode. The
// preAction hook re-applies and validates `--mode`, but it runs during
// parseAsync — too late for errors raised while resolving argv.
applyForcedModeFromArgv(raw);
const argv = await expandInputJson([...raw]);
return { argv, from: effectiveFrom };
}

/**
* Scan raw argv for an explicit `--mode human|agent` and force it early.
* Ignores an invalid value — the preAction hook reports that as a usage error.
*/
function applyForcedModeFromArgv(argv: string[]): void {
const idx = argv.indexOf("--mode");
if (idx === -1) return;
const value = argv[idx + 1];
if (value === "human" || value === "agent") {
setMode(value);
}
}

/**
* Parse and run a program, handling all typed errors with user-facing messages.
* Used by `cli.ts` for real execution and by integration tests.
Expand Down
5 changes: 4 additions & 1 deletion packages/cli-core/src/commands/doctor/checks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import {
formatChannelLabel,
} from "../../lib/update-check.ts";
import { formatHostStateProbeFailures, getAgentHostStateProbe } from "../../lib/host-execution.ts";
import { getCurrentEnvName, getPlapiBaseUrl } from "../../lib/environment.ts";
import { isAgent } from "../../mode.ts";
import type { CheckResult, DoctorContext, FixAction, KeylessInstanceInfo } from "./types.ts";

Expand DownExpand Up@@ -110,7 +111,9 @@ export async function checkLoggedIn(ctx: DoctorContext): Promise<CheckResult> {
fixable: false,
});
}
return check.pass("Logged in (token found in credential store)");
return check.pass(
`Logged in (token found in credential store) — environment "${getCurrentEnvName()}", API ${getPlapiBaseUrl()}`,
);
}

// No account session doesn't mean the project is broken: an unclaimed
Expand Down
51 changes: 51 additions & 0 deletions packages/cli-core/src/lib/environment.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { test, expect, describe, beforeEach, afterEach } from "bun:test";
import { getPlatformApiUrlOverride } from "./environment.ts";

describe("getPlatformApiUrlOverride", () => {
const original = process.env.CLERK_PLATFORM_API_URL;

beforeEach(() => {
delete process.env.CLERK_PLATFORM_API_URL;
});

afterEach(() => {
if (original === undefined) delete process.env.CLERK_PLATFORM_API_URL;
else process.env.CLERK_PLATFORM_API_URL = original;
});

test("returns overridden=true with URLs when the override differs from the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.staging.example.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("https://api.staging.example.com");
expect(result.profileUrl).toBe("https://api.clerk.com");
expect(result.envName).toBe("production");
});

test("returns overridden=false when no override is set", () => {
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("returns overridden=false when the override equals the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

Comment thread
rafa-thayto marked this conversation as resolved.
test("returns overridden=false when URLs differ only by trailing slash", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com/";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("falls back to raw string comparison when the override is not a valid URL", () => {
process.env.CLERK_PLATFORM_API_URL = "not a url";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("not a url");
expect(result.profileUrl).toBe("https://api.clerk.com");
});
});
58 changes: 58 additions & 0 deletions packages/cli-core/src/lib/environment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,19 @@ const DEFAULT_PROFILES: Record<string, EnvProfileConfig> = {
let currentEnvName: string | undefined;
let profilesSourceLogged = false;

/**
* Test-only fields shallow-merged into every resolved profile. The integration
* harness uses this to align the active profile's `platformApiUrl` with the
* test `CLERK_PLATFORM_API_URL`, so it stops tripping the override warning it
* never means to exercise. Mirrors config.ts's `_setConfigDir`.
*/
let testProfileOverride: Partial<EnvProfileConfig> | undefined;

/** @internal Test-only. Pass `undefined` to restore normal profile resolution. */
export function _setProfileOverrideForTest(override: Partial<EnvProfileConfig> | undefined): void {
testProfileOverride = override;
}

function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
// Try repo root (cwd) first, then fall back to path relative to this source file
const candidates = [
Expand All@@ -62,6 +75,15 @@ function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
}

function getProfiles(): Record<string, EnvProfileConfig> {
const base = resolveProfiles();
if (!testProfileOverride) return base;
const override = testProfileOverride;
return Object.fromEntries(
Object.entries(base).map(([name, profile]) => [name, { ...profile, ...override }]),
);
}

function resolveProfiles(): Record<string, EnvProfileConfig> {
if (typeof CLI_ENV_PROFILES !== "undefined" && CLI_ENV_PROFILES) {
if (!profilesSourceLogged) {
profilesSourceLogged = true;
Expand DownExpand Up@@ -141,6 +163,42 @@ export function getPlapiBaseUrl(): string {
return process.env.CLERK_PLATFORM_API_URL ?? getCurrentEnv().platformApiUrl;
}

/**
* Checks whether CLERK_PLATFORM_API_URL is set to a URL that differs from the
* active environment's configured platform URL, along with both URLs so the
* caller can surface a warning.
*
* Comparison normalises both URLs via `new URL().href` so trailing-slash and
* case differences are ignored; falls back to raw string comparison if either
* value is not a valid URL.
*/
export function getPlatformApiUrlOverride():
| {
overridden: false;
}
| {
overridden: true;
overrideUrl: string;
profileUrl: string;
envName: string;
} {
const override = process.env.CLERK_PLATFORM_API_URL;
if (!override) return { overridden: false };

const profileUrl = getCurrentEnv().platformApiUrl;
const normalize = (u: string) => {
try {
return new URL(u).href;
} catch {
return u;
}
};

if (normalize(override) === normalize(profileUrl)) return { overridden: false };

return { overridden: true, overrideUrl: override, profileUrl, envName: getCurrentEnvName() };
}

export function getBapiBaseUrl(): string {
return process.env.CLERK_BACKEND_API_URL ?? getCurrentEnv().backendApiUrl;
}
Expand Down
21 changes: 21 additions & 0 deletions packages/cli-core/src/test/integration/lib/harness.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ export async function setProfile(
return (await getConfigModule()).setProfile(...args);
}

// ── Real environment module ──────────────────────────────────────────────────

type EnvironmentModule = typeof import("../../../lib/environment.ts");

let environmentModulePromise: Promise<EnvironmentModule> | null = null;

function getEnvironmentModule(): Promise<EnvironmentModule> {
environmentModulePromise ??= import("../../../lib/environment.ts");
return environmentModulePromise;
}

// ── Mock data ────────────────────────────────────────────────────────────────

/**
Expand DownExpand Up@@ -539,10 +550,18 @@ export async function setupTest(): Promise<TestHarness> {
const tempDir = await mkdtemp(join(tmpdir(), "clerk-integration-"));
const { _setConfigDir } = await getConfigModule();
_setConfigDir(tempDir);
// `_mode` is module-level state in the mode.ts mock; reset it so a prior
// test that switched to agent mode can't leak `--mode agent` into the next.
_mode = "human";
process.cwd = () => tempDir;
setEnv("CLERK_PLATFORM_API_KEY", "test_platform_key");
setEnv("CLERK_PLATFORM_API_URL", "https://test-api.clerk.com");
setEnv("CLERK_BACKEND_API_URL", "https://test-bapi.clerk.dev");
// Point the active profile's platform URL at the same host as the override
// above, so `getPlatformApiUrlOverride()` sees no mismatch and the CLI's
// credential-mismatch warning never fires as a stray first line of stderr.
const { _setProfileOverrideForTest } = await getEnvironmentModule();
_setProfileOverrideForTest({ platformApiUrl: "https://test-api.clerk.com" });
mockState.storedToken = "mock_token";
mockState.gitNormalizedRemote = "github.com/test/project";
mockState.gitRepoRoot = "/repo";
Expand DownExpand Up@@ -572,11 +591,13 @@ export async function setupTest(): Promise<TestHarness> {
*/
export async function teardownTest(harness: TestHarness): Promise<void> {
const { _setConfigDir } = await getConfigModule();
const { _setProfileOverrideForTest } = await getEnvironmentModule();
currentHarness = null;
setActiveCapture(null);
assertPromptQueuesEmpty();
http.assertRoutesConsumed();
_setConfigDir(undefined);
_setProfileOverrideForTest(undefined);
process.cwd = originalCwd;
for (const [key, original] of envMutations) {
if (original === undefined) {
Expand Down
, '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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/platform-api-url-credential-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": patch
---

Warn (in human mode) when `CLERK_PLATFORM_API_URL` routes requests to a host that differs from the active environment's URL, since credentials are keyed by environment name and not by URL. `clerk doctor` now also reports the active environment and its API URL so the mismatch is visible.
34 changes: 33 additions & 1 deletion packages/cli-core/src/cli-program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
getCurrentEnvName,
getAvailableEnvs,
getPlapiBaseUrl,
getPlatformApiUrlOverride,
} from "./lib/environment.ts";
import {
CliError,
Expand All@@ -42,7 +43,7 @@ import {
throwUsageError,
} from "./lib/errors.ts";
import { clerkHelpConfig, formatExamplesBlock, type Example } from "./lib/help.ts";
import { isAgent } from "./mode.ts";
import { isAgent, isHuman } from "./mode.ts";
import { log } from "./lib/log.ts";
import { maybeNotifyUpdate } from "./lib/update-check.ts";
import { CURRENT_VERSION } from "./lib/version.ts";
Expand DownExpand Up@@ -145,6 +146,19 @@ export function createProgram(): Program {
if (activeEnv !== "production") {
process.stderr.write(`[${activeEnv.toUpperCase()}]\n`);
}

// Warn (human mode only) when CLERK_PLATFORM_API_URL routes requests to a
// different host than the active environment's platform URL. Credentials are
// keyed by environment name, so the active env's token will be sent to the
// override host. Agent/scripted mode stays off stderr — stray lines there
// corrupt machine-readable output — but still gets the info via `log.debug`
// so a `--verbose` re-run of a failing script surfaces it.
const override = getPlatformApiUrlOverride();
if (override.overridden) {
const msg = `CLERK_PLATFORM_API_URL is routing requests to ${override.overrideUrl} instead of the "${override.envName}" environment's ${override.profileUrl} — the "${override.envName}" token will be sent to that host.`;
if (isHuman()) log.warn(msg);
else log.debug(`env: ${msg}`);
}
});

// Show update notification after each command, except for commands that
Expand DownExpand Up@@ -225,10 +239,28 @@ async function resolveArgv(
): Promise<{ argv: string[]; from: ParseFrom }> {
const raw = args ?? process.argv;
const effectiveFrom = from ?? (args === undefined ? "node" : "user");
// Honor an explicit `--mode` flag before `expandInputJson`, so a failure it
// throws (invalid JSON, missing file) is formatted in the right mode. The
// preAction hook re-applies and validates `--mode`, but it runs during
// parseAsync — too late for errors raised while resolving argv.
applyForcedModeFromArgv(raw);
const argv = await expandInputJson([...raw]);
return { argv, from: effectiveFrom };
}

/**
* Scan raw argv for an explicit `--mode human|agent` and force it early.
* Ignores an invalid value — the preAction hook reports that as a usage error.
*/
function applyForcedModeFromArgv(argv: string[]): void {
const idx = argv.indexOf("--mode");
if (idx === -1) return;
const value = argv[idx + 1];
if (value === "human" || value === "agent") {
setMode(value);
}
}

/**
* Parse and run a program, handling all typed errors with user-facing messages.
* Used by `cli.ts` for real execution and by integration tests.
Expand Down
5 changes: 4 additions & 1 deletion packages/cli-core/src/commands/doctor/checks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import {
formatChannelLabel,
} from "../../lib/update-check.ts";
import { formatHostStateProbeFailures, getAgentHostStateProbe } from "../../lib/host-execution.ts";
import { getCurrentEnvName, getPlapiBaseUrl } from "../../lib/environment.ts";
import { isAgent } from "../../mode.ts";
import type { CheckResult, DoctorContext, FixAction, KeylessInstanceInfo } from "./types.ts";

Expand DownExpand Up@@ -110,7 +111,9 @@ export async function checkLoggedIn(ctx: DoctorContext): Promise<CheckResult> {
fixable: false,
});
}
return check.pass("Logged in (token found in credential store)");
return check.pass(
`Logged in (token found in credential store) — environment "${getCurrentEnvName()}", API ${getPlapiBaseUrl()}`,
);
}

// No account session doesn't mean the project is broken: an unclaimed
Expand Down
51 changes: 51 additions & 0 deletions packages/cli-core/src/lib/environment.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { test, expect, describe, beforeEach, afterEach } from "bun:test";
import { getPlatformApiUrlOverride } from "./environment.ts";

describe("getPlatformApiUrlOverride", () => {
const original = process.env.CLERK_PLATFORM_API_URL;

beforeEach(() => {
delete process.env.CLERK_PLATFORM_API_URL;
});

afterEach(() => {
if (original === undefined) delete process.env.CLERK_PLATFORM_API_URL;
else process.env.CLERK_PLATFORM_API_URL = original;
});

test("returns overridden=true with URLs when the override differs from the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.staging.example.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("https://api.staging.example.com");
expect(result.profileUrl).toBe("https://api.clerk.com");
expect(result.envName).toBe("production");
});

test("returns overridden=false when no override is set", () => {
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("returns overridden=false when the override equals the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

Comment thread
rafa-thayto marked this conversation as resolved.
test("returns overridden=false when URLs differ only by trailing slash", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com/";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("falls back to raw string comparison when the override is not a valid URL", () => {
process.env.CLERK_PLATFORM_API_URL = "not a url";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("not a url");
expect(result.profileUrl).toBe("https://api.clerk.com");
});
});
58 changes: 58 additions & 0 deletions packages/cli-core/src/lib/environment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,19 @@ const DEFAULT_PROFILES: Record<string, EnvProfileConfig> = {
let currentEnvName: string | undefined;
let profilesSourceLogged = false;

/**
* Test-only fields shallow-merged into every resolved profile. The integration
* harness uses this to align the active profile's `platformApiUrl` with the
* test `CLERK_PLATFORM_API_URL`, so it stops tripping the override warning it
* never means to exercise. Mirrors config.ts's `_setConfigDir`.
*/
let testProfileOverride: Partial<EnvProfileConfig> | undefined;

/** @internal Test-only. Pass `undefined` to restore normal profile resolution. */
export function _setProfileOverrideForTest(override: Partial<EnvProfileConfig> | undefined): void {
testProfileOverride = override;
}

function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
// Try repo root (cwd) first, then fall back to path relative to this source file
const candidates = [
Expand All@@ -62,6 +75,15 @@ function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
}

function getProfiles(): Record<string, EnvProfileConfig> {
const base = resolveProfiles();
if (!testProfileOverride) return base;
const override = testProfileOverride;
return Object.fromEntries(
Object.entries(base).map(([name, profile]) => [name, { ...profile, ...override }]),
);
}

function resolveProfiles(): Record<string, EnvProfileConfig> {
if (typeof CLI_ENV_PROFILES !== "undefined" && CLI_ENV_PROFILES) {
if (!profilesSourceLogged) {
profilesSourceLogged = true;
Expand DownExpand Up@@ -141,6 +163,42 @@ export function getPlapiBaseUrl(): string {
return process.env.CLERK_PLATFORM_API_URL ?? getCurrentEnv().platformApiUrl;
}

/**
* Checks whether CLERK_PLATFORM_API_URL is set to a URL that differs from the
* active environment's configured platform URL, along with both URLs so the
* caller can surface a warning.
*
* Comparison normalises both URLs via `new URL().href` so trailing-slash and
* case differences are ignored; falls back to raw string comparison if either
* value is not a valid URL.
*/
export function getPlatformApiUrlOverride():
| {
overridden: false;
}
| {
overridden: true;
overrideUrl: string;
profileUrl: string;
envName: string;
} {
const override = process.env.CLERK_PLATFORM_API_URL;
if (!override) return { overridden: false };

const profileUrl = getCurrentEnv().platformApiUrl;
const normalize = (u: string) => {
try {
return new URL(u).href;
} catch {
return u;
}
};

if (normalize(override) === normalize(profileUrl)) return { overridden: false };

return { overridden: true, overrideUrl: override, profileUrl, envName: getCurrentEnvName() };
}

export function getBapiBaseUrl(): string {
return process.env.CLERK_BACKEND_API_URL ?? getCurrentEnv().backendApiUrl;
}
Expand Down
21 changes: 21 additions & 0 deletions packages/cli-core/src/test/integration/lib/harness.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ export async function setProfile(
return (await getConfigModule()).setProfile(...args);
}

// ── Real environment module ──────────────────────────────────────────────────

type EnvironmentModule = typeof import("../../../lib/environment.ts");

let environmentModulePromise: Promise<EnvironmentModule> | null = null;

function getEnvironmentModule(): Promise<EnvironmentModule> {
environmentModulePromise ??= import("../../../lib/environment.ts");
return environmentModulePromise;
}

// ── Mock data ────────────────────────────────────────────────────────────────

/**
Expand DownExpand Up@@ -539,10 +550,18 @@ export async function setupTest(): Promise<TestHarness> {
const tempDir = await mkdtemp(join(tmpdir(), "clerk-integration-"));
const { _setConfigDir } = await getConfigModule();
_setConfigDir(tempDir);
// `_mode` is module-level state in the mode.ts mock; reset it so a prior
// test that switched to agent mode can't leak `--mode agent` into the next.
_mode = "human";
process.cwd = () => tempDir;
setEnv("CLERK_PLATFORM_API_KEY", "test_platform_key");
setEnv("CLERK_PLATFORM_API_URL", "https://test-api.clerk.com");
setEnv("CLERK_BACKEND_API_URL", "https://test-bapi.clerk.dev");
// Point the active profile's platform URL at the same host as the override
// above, so `getPlatformApiUrlOverride()` sees no mismatch and the CLI's
// credential-mismatch warning never fires as a stray first line of stderr.
const { _setProfileOverrideForTest } = await getEnvironmentModule();
_setProfileOverrideForTest({ platformApiUrl: "https://test-api.clerk.com" });
mockState.storedToken = "mock_token";
mockState.gitNormalizedRemote = "github.com/test/project";
mockState.gitRepoRoot = "/repo";
Expand DownExpand Up@@ -572,11 +591,13 @@ export async function setupTest(): Promise<TestHarness> {
*/
export async function teardownTest(harness: TestHarness): Promise<void> {
const { _setConfigDir } = await getConfigModule();
const { _setProfileOverrideForTest } = await getEnvironmentModule();
currentHarness = null;
setActiveCapture(null);
assertPromptQueuesEmpty();
http.assertRoutesConsumed();
_setConfigDir(undefined);
_setProfileOverrideForTest(undefined);
process.cwd = originalCwd;
for (const [key, original] of envMutations) {
if (original === undefined) {
Expand Down
, '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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/platform-api-url-credential-warning.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"clerk": patch
---

Warn (in human mode) when `CLERK_PLATFORM_API_URL` routes requests to a host that differs from the active environment's URL, since credentials are keyed by environment name and not by URL. `clerk doctor` now also reports the active environment and its API URL so the mismatch is visible.
34 changes: 33 additions & 1 deletion packages/cli-core/src/cli-program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ import {
getCurrentEnvName,
getAvailableEnvs,
getPlapiBaseUrl,
getPlatformApiUrlOverride,
} from "./lib/environment.ts";
import {
CliError,
Expand All@@ -42,7 +43,7 @@ import {
throwUsageError,
} from "./lib/errors.ts";
import { clerkHelpConfig, formatExamplesBlock, type Example } from "./lib/help.ts";
import { isAgent } from "./mode.ts";
import { isAgent, isHuman } from "./mode.ts";
import { log } from "./lib/log.ts";
import { maybeNotifyUpdate } from "./lib/update-check.ts";
import { CURRENT_VERSION } from "./lib/version.ts";
Expand DownExpand Up@@ -145,6 +146,19 @@ export function createProgram(): Program {
if (activeEnv !== "production") {
process.stderr.write(`[${activeEnv.toUpperCase()}]\n`);
}

// Warn (human mode only) when CLERK_PLATFORM_API_URL routes requests to a
// different host than the active environment's platform URL. Credentials are
// keyed by environment name, so the active env's token will be sent to the
// override host. Agent/scripted mode stays off stderr — stray lines there
// corrupt machine-readable output — but still gets the info via `log.debug`
// so a `--verbose` re-run of a failing script surfaces it.
const override = getPlatformApiUrlOverride();
if (override.overridden) {
const msg = `CLERK_PLATFORM_API_URL is routing requests to ${override.overrideUrl} instead of the "${override.envName}" environment's ${override.profileUrl} — the "${override.envName}" token will be sent to that host.`;
if (isHuman()) log.warn(msg);
else log.debug(`env: ${msg}`);
}
});

// Show update notification after each command, except for commands that
Expand DownExpand Up@@ -225,10 +239,28 @@ async function resolveArgv(
): Promise<{ argv: string[]; from: ParseFrom }> {
const raw = args ?? process.argv;
const effectiveFrom = from ?? (args === undefined ? "node" : "user");
// Honor an explicit `--mode` flag before `expandInputJson`, so a failure it
// throws (invalid JSON, missing file) is formatted in the right mode. The
// preAction hook re-applies and validates `--mode`, but it runs during
// parseAsync — too late for errors raised while resolving argv.
applyForcedModeFromArgv(raw);
const argv = await expandInputJson([...raw]);
return { argv, from: effectiveFrom };
}

/**
* Scan raw argv for an explicit `--mode human|agent` and force it early.
* Ignores an invalid value — the preAction hook reports that as a usage error.
*/
function applyForcedModeFromArgv(argv: string[]): void {
const idx = argv.indexOf("--mode");
if (idx === -1) return;
const value = argv[idx + 1];
if (value === "human" || value === "agent") {
setMode(value);
}
}

/**
* Parse and run a program, handling all typed errors with user-facing messages.
* Used by `cli.ts` for real execution and by integration tests.
Expand Down
5 changes: 4 additions & 1 deletion packages/cli-core/src/commands/doctor/checks.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import {
formatChannelLabel,
} from "../../lib/update-check.ts";
import { formatHostStateProbeFailures, getAgentHostStateProbe } from "../../lib/host-execution.ts";
import { getCurrentEnvName, getPlapiBaseUrl } from "../../lib/environment.ts";
import { isAgent } from "../../mode.ts";
import type { CheckResult, DoctorContext, FixAction, KeylessInstanceInfo } from "./types.ts";

Expand DownExpand Up@@ -110,7 +111,9 @@ export async function checkLoggedIn(ctx: DoctorContext): Promise<CheckResult> {
fixable: false,
});
}
return check.pass("Logged in (token found in credential store)");
return check.pass(
`Logged in (token found in credential store) — environment "${getCurrentEnvName()}", API ${getPlapiBaseUrl()}`,
);
}

// No account session doesn't mean the project is broken: an unclaimed
Expand Down
51 changes: 51 additions & 0 deletions packages/cli-core/src/lib/environment.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { test, expect, describe, beforeEach, afterEach } from "bun:test";
import { getPlatformApiUrlOverride } from "./environment.ts";

describe("getPlatformApiUrlOverride", () => {
const original = process.env.CLERK_PLATFORM_API_URL;

beforeEach(() => {
delete process.env.CLERK_PLATFORM_API_URL;
});

afterEach(() => {
if (original === undefined) delete process.env.CLERK_PLATFORM_API_URL;
else process.env.CLERK_PLATFORM_API_URL = original;
});

test("returns overridden=true with URLs when the override differs from the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.staging.example.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("https://api.staging.example.com");
expect(result.profileUrl).toBe("https://api.clerk.com");
expect(result.envName).toBe("production");
});

test("returns overridden=false when no override is set", () => {
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("returns overridden=false when the override equals the active env URL", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

Comment thread
rafa-thayto marked this conversation as resolved.
test("returns overridden=false when URLs differ only by trailing slash", () => {
process.env.CLERK_PLATFORM_API_URL = "https://api.clerk.com/";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(false);
});

test("falls back to raw string comparison when the override is not a valid URL", () => {
process.env.CLERK_PLATFORM_API_URL = "not a url";
const result = getPlatformApiUrlOverride();
expect(result.overridden).toBe(true);
if (!result.overridden) return;
expect(result.overrideUrl).toBe("not a url");
expect(result.profileUrl).toBe("https://api.clerk.com");
});
});
58 changes: 58 additions & 0 deletions packages/cli-core/src/lib/environment.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,19 @@ const DEFAULT_PROFILES: Record<string, EnvProfileConfig> = {
let currentEnvName: string | undefined;
let profilesSourceLogged = false;

/**
* Test-only fields shallow-merged into every resolved profile. The integration
* harness uses this to align the active profile's `platformApiUrl` with the
* test `CLERK_PLATFORM_API_URL`, so it stops tripping the override warning it
* never means to exercise. Mirrors config.ts's `_setConfigDir`.
*/
let testProfileOverride: Partial<EnvProfileConfig> | undefined;

/** @internal Test-only. Pass `undefined` to restore normal profile resolution. */
export function _setProfileOverrideForTest(override: Partial<EnvProfileConfig> | undefined): void {
testProfileOverride = override;
}

function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
// Try repo root (cwd) first, then fall back to path relative to this source file
const candidates = [
Expand All@@ -62,6 +75,15 @@ function loadFileProfiles(): Record<string, EnvProfileConfig> | undefined {
}

function getProfiles(): Record<string, EnvProfileConfig> {
const base = resolveProfiles();
if (!testProfileOverride) return base;
const override = testProfileOverride;
return Object.fromEntries(
Object.entries(base).map(([name, profile]) => [name, { ...profile, ...override }]),
);
}

function resolveProfiles(): Record<string, EnvProfileConfig> {
if (typeof CLI_ENV_PROFILES !== "undefined" && CLI_ENV_PROFILES) {
if (!profilesSourceLogged) {
profilesSourceLogged = true;
Expand DownExpand Up@@ -141,6 +163,42 @@ export function getPlapiBaseUrl(): string {
return process.env.CLERK_PLATFORM_API_URL ?? getCurrentEnv().platformApiUrl;
}

/**
* Checks whether CLERK_PLATFORM_API_URL is set to a URL that differs from the
* active environment's configured platform URL, along with both URLs so the
* caller can surface a warning.
*
* Comparison normalises both URLs via `new URL().href` so trailing-slash and
* case differences are ignored; falls back to raw string comparison if either
* value is not a valid URL.
*/
export function getPlatformApiUrlOverride():
| {
overridden: false;
}
| {
overridden: true;
overrideUrl: string;
profileUrl: string;
envName: string;
} {
const override = process.env.CLERK_PLATFORM_API_URL;
if (!override) return { overridden: false };

const profileUrl = getCurrentEnv().platformApiUrl;
const normalize = (u: string) => {
try {
return new URL(u).href;
} catch {
return u;
}
};

if (normalize(override) === normalize(profileUrl)) return { overridden: false };

return { overridden: true, overrideUrl: override, profileUrl, envName: getCurrentEnvName() };
}

export function getBapiBaseUrl(): string {
return process.env.CLERK_BACKEND_API_URL ?? getCurrentEnv().backendApiUrl;
}
Expand Down
21 changes: 21 additions & 0 deletions packages/cli-core/src/test/integration/lib/harness.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ export async function setProfile(
return (await getConfigModule()).setProfile(...args);
}

// ── Real environment module ──────────────────────────────────────────────────

type EnvironmentModule = typeof import("../../../lib/environment.ts");

let environmentModulePromise: Promise<EnvironmentModule> | null = null;

function getEnvironmentModule(): Promise<EnvironmentModule> {
environmentModulePromise ??= import("../../../lib/environment.ts");
return environmentModulePromise;
}

// ── Mock data ────────────────────────────────────────────────────────────────

/**
Expand DownExpand Up@@ -539,10 +550,18 @@ export async function setupTest(): Promise<TestHarness> {
const tempDir = await mkdtemp(join(tmpdir(), "clerk-integration-"));
const { _setConfigDir } = await getConfigModule();
_setConfigDir(tempDir);
// `_mode` is module-level state in the mode.ts mock; reset it so a prior
// test that switched to agent mode can't leak `--mode agent` into the next.
_mode = "human";
process.cwd = () => tempDir;
setEnv("CLERK_PLATFORM_API_KEY", "test_platform_key");
setEnv("CLERK_PLATFORM_API_URL", "https://test-api.clerk.com");
setEnv("CLERK_BACKEND_API_URL", "https://test-bapi.clerk.dev");
// Point the active profile's platform URL at the same host as the override
// above, so `getPlatformApiUrlOverride()` sees no mismatch and the CLI's
// credential-mismatch warning never fires as a stray first line of stderr.
const { _setProfileOverrideForTest } = await getEnvironmentModule();
_setProfileOverrideForTest({ platformApiUrl: "https://test-api.clerk.com" });
mockState.storedToken = "mock_token";
mockState.gitNormalizedRemote = "github.com/test/project";
mockState.gitRepoRoot = "/repo";
Expand DownExpand Up@@ -572,11 +591,13 @@ export async function setupTest(): Promise<TestHarness> {
*/
export async function teardownTest(harness: TestHarness): Promise<void> {
const { _setConfigDir } = await getConfigModule();
const { _setProfileOverrideForTest } = await getEnvironmentModule();
currentHarness = null;
setActiveCapture(null);
assertPromptQueuesEmpty();
http.assertRoutesConsumed();
_setConfigDir(undefined);
_setProfileOverrideForTest(undefined);
process.cwd = originalCwd;
for (const [key, original] of envMutations) {
if (original === undefined) {
Expand Down