Merged
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
7 changes: 7 additions & 0 deletions .changeset/disable-vercel-auto-proxy.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/shared': patch
---

Add `CLERK_DISABLE_AUTO_PROXY=true` to opt out of automatic Frontend API proxying on Vercel production deployments.
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,16 @@ describe('AuthenticateContext', () => {
expect(context.proxyUrl).toBeUndefined();
});

it('does NOT auto-derive proxyUrl when auto-proxy is disabled', async () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBeUndefined();
});

it('explicit proxyUrl takes precedence over auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@cler
import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shared/keys';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { shouldAutoProxy } from '@clerk/shared/proxy';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand DownExpand Up@@ -168,7 +168,12 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl

// Auto-detect when no explicit proxy or domain is configured
const hasExplicitProxyOrDomain = resolvedParams.proxyUrl || PROXY_URL || resolvedParams.domain || DOMAIN;
if (!frontendApiProxyConfig && !hasExplicitProxyOrDomain && isProductionFromPublishableKey(publishableKey)) {
if (
!frontendApiProxyConfig &&
!hasExplicitProxyOrDomain &&
!isAutoProxyDisabledFromEnvironment() &&
isProductionFromPublishableKey(publishableKey)
) {
Comment on lines +171 to +176

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== clerkMiddleware excerpt =="
sed -n '130,220p' packages/nextjs/src/server/clerkMiddleware.ts
echoecho"== search for auto proxy / disable auto proxy / middleware tests =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|proxy handler|auto proxy|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey|vercel" packages/nextjs -g '*.{ts,tsx,test.ts,test.tsx,spec.ts,spec.tsx}'echoecho"== list test files near nextjs server middleware =="
fd -a "clerkMiddleware" packages/nextjs
fd -a "middleware" packages/nextjs/src packages/nextjs/test packages/nextjs/__tests__ 2>/dev/null ||true

Repository: clerk/javascript

Length of output: 9457


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== repo files of interest =="
git ls-files 'packages/nextjs/**/*'| rg 'clerkMiddleware|middleware|proxy|vercel|test|spec'echoecho"== text search for disable auto proxy across repo =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|auto proxy|proxy handler|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey".echoecho"== if tests exist, print filenames =="
rg -l "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|isProductionFromPublishableKey" packages/nextjs

Repository: clerk/javascript

Length of output: 4975


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== candidate test files =="
fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'echoecho"== read smallest likely test files =="forfin$(fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'| head -n 10);doecho"---- $f ----"
wc -l "$f"
sed -n '1,260p'"$f"done

Repository: clerk/javascript

Length of output: 547


🏁 Script executed:

#!/bin/bashset -euo pipefail
TEST=packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
echo"== file size =="
wc -l "$TEST"echoecho"== outline =="
ast-grep outline "$TEST" --view expanded | sed -n '1,260p'echoecho"== relevant ranges around vercel/proxy tests =="
sed -n '1160,1395p'"$TEST"echoecho"== search for CLERK_DISABLE_AUTO_PROXY in clerkMiddleware.test.ts =="
rg -n "CLERK_DISABLE_AUTO_PROXY|shouldAutoProxy|proxy handler|frontendApiProxy|vercel""$TEST"

Repository: clerk/javascript

Length of output: 11562


Add coverage for the auto-proxy opt-out branch.clerkMiddleware makes this decision independently, so add a middleware test with CLERK_DISABLE_AUTO_PROXY=true, a live key, and an eligible Vercel hostname, and assert the proxy handler is skipped.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/server/clerkMiddleware.ts` around lines 171 - 176, Add
middleware test coverage for the auto-proxy opt-out branch in clerkMiddleware:
set CLERK_DISABLE_AUTO_PROXY=true, use a live publishable key and eligible
Vercel hostname, then assert the proxy handler is not invoked. Keep the test
focused on the condition guarded by isAutoProxyDisabledFromEnvironment and
preserve existing proxy behavior for other configurations.

Source: Coding guidelines

if (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,17 @@ describe('mergeNextClerkPropsWithEnv', () => {
expect(result.proxyUrl).toBe('');
});

it('does not auto-derive proxyUrl when auto-proxy is disabled', () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
process.env.VERCEL_PROJECT_PRODUCTION_URL = 'myapp.vercel.app';

const result = mergeNextClerkPropsWithEnv({});

expect(result.proxyUrl).toBe('');
});
Comment on lines +52 to +61

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Keep environment-sensitive tests deterministic.

Both suites can inherit CLERK_DISABLE_AUTO_PROXY=true from the test runner, causing auto-proxy-enabled cases to fail. Clear or explicitly disable the variable in shared setup, and set it to true only in opt-out cases.

  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61: isolate the flag before tests expecting /__clerk.
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313: isolate the flag before tests expecting automatic proxy derivation.
🧰 Tools
🪛 Betterleaks (1.6.1)

[high] 54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

📍 Affects 2 files
  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61 (this comment)
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts`
around lines 52 - 61, Make the environment-sensitive tests deterministic by
clearing or explicitly disabling CLERK_DISABLE_AUTO_PROXY in shared setup for
auto-proxy-enabled cases, while setting it to true only in opt-out cases. Apply
this in packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts
at lines 52-61 and
packages/backend/src/tokens/__tests__/authenticateContext.test.ts at lines
305-313, preserving the existing expectations for /__clerk and automatic proxy
derivation.


it('does not override an explicit proxyUrl', () => {
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
Expand Down
13 changes: 13 additions & 0 deletions packages/shared/src/__tests__/proxy.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,19 @@ describe('getAutoProxyUrlFromEnvironment(options)', () => {
).toBe('');
});

it('returns empty string when auto-proxy is disabled', () => {
expect(
getAutoProxyUrlFromEnvironment({
publishableKey: 'pk_live_Zm9vLmNsZXJrLmNvbSQ=',
environment: {
CLERK_DISABLE_AUTO_PROXY: 'true',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp.vercel.app',
VERCEL_TARGET_ENV: 'production',
},
}),
).toBe('');
});

it('returns empty string for ineligible or non-production Vercel environments', () => {
expect(
getAutoProxyUrlFromEnvironment({
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/proxy.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { isProductionFromPublishableKey } from './keys';
import { isTruthy } from './underscore';

/**
*
Expand DownExpand Up@@ -55,6 +56,10 @@ function getDefaultEnvironment(): NodeJS.ProcessEnv {
return typeof process !== 'undefined' && process.env ? process.env : {};
}

export function isAutoProxyDisabledFromEnvironment(environment = getDefaultEnvironment()): boolean {
return isTruthy(environment.CLERK_DISABLE_AUTO_PROXY);
}

function normalizeHostname(hostnameOrUrl: string): string {
if (hostnameOrUrl.startsWith('http://') || hostnameOrUrl.startsWith('https://')) {
try {
Expand DownExpand Up@@ -90,6 +95,10 @@ export function getAutoProxyUrlFromEnvironment({
return '';
}

if (isAutoProxyDisabledFromEnvironment(environment)) {
return '';
}

if (environment.VERCEL_TARGET_ENV !== 'production') {
return '';
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
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
7 changes: 7 additions & 0 deletions .changeset/disable-vercel-auto-proxy.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/shared': patch
---

Add `CLERK_DISABLE_AUTO_PROXY=true` to opt out of automatic Frontend API proxying on Vercel production deployments.
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,16 @@ describe('AuthenticateContext', () => {
expect(context.proxyUrl).toBeUndefined();
});

it('does NOT auto-derive proxyUrl when auto-proxy is disabled', async () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBeUndefined();
});

it('explicit proxyUrl takes precedence over auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@cler
import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shared/keys';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { shouldAutoProxy } from '@clerk/shared/proxy';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand DownExpand Up@@ -168,7 +168,12 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl

// Auto-detect when no explicit proxy or domain is configured
const hasExplicitProxyOrDomain = resolvedParams.proxyUrl || PROXY_URL || resolvedParams.domain || DOMAIN;
if (!frontendApiProxyConfig && !hasExplicitProxyOrDomain && isProductionFromPublishableKey(publishableKey)) {
if (
!frontendApiProxyConfig &&
!hasExplicitProxyOrDomain &&
!isAutoProxyDisabledFromEnvironment() &&
isProductionFromPublishableKey(publishableKey)
) {
Comment on lines +171 to +176

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== clerkMiddleware excerpt =="
sed -n '130,220p' packages/nextjs/src/server/clerkMiddleware.ts
echoecho"== search for auto proxy / disable auto proxy / middleware tests =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|proxy handler|auto proxy|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey|vercel" packages/nextjs -g '*.{ts,tsx,test.ts,test.tsx,spec.ts,spec.tsx}'echoecho"== list test files near nextjs server middleware =="
fd -a "clerkMiddleware" packages/nextjs
fd -a "middleware" packages/nextjs/src packages/nextjs/test packages/nextjs/__tests__ 2>/dev/null ||true

Repository: clerk/javascript

Length of output: 9457


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== repo files of interest =="
git ls-files 'packages/nextjs/**/*'| rg 'clerkMiddleware|middleware|proxy|vercel|test|spec'echoecho"== text search for disable auto proxy across repo =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|auto proxy|proxy handler|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey".echoecho"== if tests exist, print filenames =="
rg -l "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|isProductionFromPublishableKey" packages/nextjs

Repository: clerk/javascript

Length of output: 4975


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== candidate test files =="
fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'echoecho"== read smallest likely test files =="forfin$(fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'| head -n 10);doecho"---- $f ----"
wc -l "$f"
sed -n '1,260p'"$f"done

Repository: clerk/javascript

Length of output: 547


🏁 Script executed:

#!/bin/bashset -euo pipefail
TEST=packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
echo"== file size =="
wc -l "$TEST"echoecho"== outline =="
ast-grep outline "$TEST" --view expanded | sed -n '1,260p'echoecho"== relevant ranges around vercel/proxy tests =="
sed -n '1160,1395p'"$TEST"echoecho"== search for CLERK_DISABLE_AUTO_PROXY in clerkMiddleware.test.ts =="
rg -n "CLERK_DISABLE_AUTO_PROXY|shouldAutoProxy|proxy handler|frontendApiProxy|vercel""$TEST"

Repository: clerk/javascript

Length of output: 11562


Add coverage for the auto-proxy opt-out branch.clerkMiddleware makes this decision independently, so add a middleware test with CLERK_DISABLE_AUTO_PROXY=true, a live key, and an eligible Vercel hostname, and assert the proxy handler is skipped.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/server/clerkMiddleware.ts` around lines 171 - 176, Add
middleware test coverage for the auto-proxy opt-out branch in clerkMiddleware:
set CLERK_DISABLE_AUTO_PROXY=true, use a live publishable key and eligible
Vercel hostname, then assert the proxy handler is not invoked. Keep the test
focused on the condition guarded by isAutoProxyDisabledFromEnvironment and
preserve existing proxy behavior for other configurations.

Source: Coding guidelines

if (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,17 @@ describe('mergeNextClerkPropsWithEnv', () => {
expect(result.proxyUrl).toBe('');
});

it('does not auto-derive proxyUrl when auto-proxy is disabled', () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
process.env.VERCEL_PROJECT_PRODUCTION_URL = 'myapp.vercel.app';

const result = mergeNextClerkPropsWithEnv({});

expect(result.proxyUrl).toBe('');
});
Comment on lines +52 to +61

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Keep environment-sensitive tests deterministic.

Both suites can inherit CLERK_DISABLE_AUTO_PROXY=true from the test runner, causing auto-proxy-enabled cases to fail. Clear or explicitly disable the variable in shared setup, and set it to true only in opt-out cases.

  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61: isolate the flag before tests expecting /__clerk.
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313: isolate the flag before tests expecting automatic proxy derivation.
🧰 Tools
🪛 Betterleaks (1.6.1)

[high] 54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

📍 Affects 2 files
  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61 (this comment)
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts`
around lines 52 - 61, Make the environment-sensitive tests deterministic by
clearing or explicitly disabling CLERK_DISABLE_AUTO_PROXY in shared setup for
auto-proxy-enabled cases, while setting it to true only in opt-out cases. Apply
this in packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts
at lines 52-61 and
packages/backend/src/tokens/__tests__/authenticateContext.test.ts at lines
305-313, preserving the existing expectations for /__clerk and automatic proxy
derivation.


it('does not override an explicit proxyUrl', () => {
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
Expand Down
13 changes: 13 additions & 0 deletions packages/shared/src/__tests__/proxy.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,19 @@ describe('getAutoProxyUrlFromEnvironment(options)', () => {
).toBe('');
});

it('returns empty string when auto-proxy is disabled', () => {
expect(
getAutoProxyUrlFromEnvironment({
publishableKey: 'pk_live_Zm9vLmNsZXJrLmNvbSQ=',
environment: {
CLERK_DISABLE_AUTO_PROXY: 'true',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp.vercel.app',
VERCEL_TARGET_ENV: 'production',
},
}),
).toBe('');
});

it('returns empty string for ineligible or non-production Vercel environments', () => {
expect(
getAutoProxyUrlFromEnvironment({
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/proxy.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { isProductionFromPublishableKey } from './keys';
import { isTruthy } from './underscore';

/**
*
Expand DownExpand Up@@ -55,6 +56,10 @@ function getDefaultEnvironment(): NodeJS.ProcessEnv {
return typeof process !== 'undefined' && process.env ? process.env : {};
}

export function isAutoProxyDisabledFromEnvironment(environment = getDefaultEnvironment()): boolean {
return isTruthy(environment.CLERK_DISABLE_AUTO_PROXY);
}

function normalizeHostname(hostnameOrUrl: string): string {
if (hostnameOrUrl.startsWith('http://') || hostnameOrUrl.startsWith('https://')) {
try {
Expand DownExpand Up@@ -90,6 +95,10 @@ export function getAutoProxyUrlFromEnvironment({
return '';
}

if (isAutoProxyDisabledFromEnvironment(environment)) {
return '';
}

if (environment.VERCEL_TARGET_ENV !== 'production') {
return '';
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
7 changes: 7 additions & 0 deletions .changeset/disable-vercel-auto-proxy.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/shared': patch
---

Add `CLERK_DISABLE_AUTO_PROXY=true` to opt out of automatic Frontend API proxying on Vercel production deployments.
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,16 @@ describe('AuthenticateContext', () => {
expect(context.proxyUrl).toBeUndefined();
});

it('does NOT auto-derive proxyUrl when auto-proxy is disabled', async () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBeUndefined();
});

it('explicit proxyUrl takes precedence over auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@cler
import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shared/keys';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { shouldAutoProxy } from '@clerk/shared/proxy';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand DownExpand Up@@ -168,7 +168,12 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl

// Auto-detect when no explicit proxy or domain is configured
const hasExplicitProxyOrDomain = resolvedParams.proxyUrl || PROXY_URL || resolvedParams.domain || DOMAIN;
if (!frontendApiProxyConfig && !hasExplicitProxyOrDomain && isProductionFromPublishableKey(publishableKey)) {
if (
!frontendApiProxyConfig &&
!hasExplicitProxyOrDomain &&
!isAutoProxyDisabledFromEnvironment() &&
isProductionFromPublishableKey(publishableKey)
) {
Comment on lines +171 to +176

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== clerkMiddleware excerpt =="
sed -n '130,220p' packages/nextjs/src/server/clerkMiddleware.ts
echoecho"== search for auto proxy / disable auto proxy / middleware tests =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|proxy handler|auto proxy|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey|vercel" packages/nextjs -g '*.{ts,tsx,test.ts,test.tsx,spec.ts,spec.tsx}'echoecho"== list test files near nextjs server middleware =="
fd -a "clerkMiddleware" packages/nextjs
fd -a "middleware" packages/nextjs/src packages/nextjs/test packages/nextjs/__tests__ 2>/dev/null ||true

Repository: clerk/javascript

Length of output: 9457


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== repo files of interest =="
git ls-files 'packages/nextjs/**/*'| rg 'clerkMiddleware|middleware|proxy|vercel|test|spec'echoecho"== text search for disable auto proxy across repo =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|auto proxy|proxy handler|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey".echoecho"== if tests exist, print filenames =="
rg -l "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|isProductionFromPublishableKey" packages/nextjs

Repository: clerk/javascript

Length of output: 4975


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== candidate test files =="
fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'echoecho"== read smallest likely test files =="forfin$(fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'| head -n 10);doecho"---- $f ----"
wc -l "$f"
sed -n '1,260p'"$f"done

Repository: clerk/javascript

Length of output: 547


🏁 Script executed:

#!/bin/bashset -euo pipefail
TEST=packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
echo"== file size =="
wc -l "$TEST"echoecho"== outline =="
ast-grep outline "$TEST" --view expanded | sed -n '1,260p'echoecho"== relevant ranges around vercel/proxy tests =="
sed -n '1160,1395p'"$TEST"echoecho"== search for CLERK_DISABLE_AUTO_PROXY in clerkMiddleware.test.ts =="
rg -n "CLERK_DISABLE_AUTO_PROXY|shouldAutoProxy|proxy handler|frontendApiProxy|vercel""$TEST"

Repository: clerk/javascript

Length of output: 11562


Add coverage for the auto-proxy opt-out branch.clerkMiddleware makes this decision independently, so add a middleware test with CLERK_DISABLE_AUTO_PROXY=true, a live key, and an eligible Vercel hostname, and assert the proxy handler is skipped.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/server/clerkMiddleware.ts` around lines 171 - 176, Add
middleware test coverage for the auto-proxy opt-out branch in clerkMiddleware:
set CLERK_DISABLE_AUTO_PROXY=true, use a live publishable key and eligible
Vercel hostname, then assert the proxy handler is not invoked. Keep the test
focused on the condition guarded by isAutoProxyDisabledFromEnvironment and
preserve existing proxy behavior for other configurations.

Source: Coding guidelines

if (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,17 @@ describe('mergeNextClerkPropsWithEnv', () => {
expect(result.proxyUrl).toBe('');
});

it('does not auto-derive proxyUrl when auto-proxy is disabled', () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
process.env.VERCEL_PROJECT_PRODUCTION_URL = 'myapp.vercel.app';

const result = mergeNextClerkPropsWithEnv({});

expect(result.proxyUrl).toBe('');
});
Comment on lines +52 to +61

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Keep environment-sensitive tests deterministic.

Both suites can inherit CLERK_DISABLE_AUTO_PROXY=true from the test runner, causing auto-proxy-enabled cases to fail. Clear or explicitly disable the variable in shared setup, and set it to true only in opt-out cases.

  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61: isolate the flag before tests expecting /__clerk.
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313: isolate the flag before tests expecting automatic proxy derivation.
🧰 Tools
🪛 Betterleaks (1.6.1)

[high] 54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

📍 Affects 2 files
  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61 (this comment)
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts`
around lines 52 - 61, Make the environment-sensitive tests deterministic by
clearing or explicitly disabling CLERK_DISABLE_AUTO_PROXY in shared setup for
auto-proxy-enabled cases, while setting it to true only in opt-out cases. Apply
this in packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts
at lines 52-61 and
packages/backend/src/tokens/__tests__/authenticateContext.test.ts at lines
305-313, preserving the existing expectations for /__clerk and automatic proxy
derivation.


it('does not override an explicit proxyUrl', () => {
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
Expand Down
13 changes: 13 additions & 0 deletions packages/shared/src/__tests__/proxy.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,19 @@ describe('getAutoProxyUrlFromEnvironment(options)', () => {
).toBe('');
});

it('returns empty string when auto-proxy is disabled', () => {
expect(
getAutoProxyUrlFromEnvironment({
publishableKey: 'pk_live_Zm9vLmNsZXJrLmNvbSQ=',
environment: {
CLERK_DISABLE_AUTO_PROXY: 'true',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp.vercel.app',
VERCEL_TARGET_ENV: 'production',
},
}),
).toBe('');
});

it('returns empty string for ineligible or non-production Vercel environments', () => {
expect(
getAutoProxyUrlFromEnvironment({
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/proxy.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { isProductionFromPublishableKey } from './keys';
import { isTruthy } from './underscore';

/**
*
Expand DownExpand Up@@ -55,6 +56,10 @@ function getDefaultEnvironment(): NodeJS.ProcessEnv {
return typeof process !== 'undefined' && process.env ? process.env : {};
}

export function isAutoProxyDisabledFromEnvironment(environment = getDefaultEnvironment()): boolean {
return isTruthy(environment.CLERK_DISABLE_AUTO_PROXY);
}

function normalizeHostname(hostnameOrUrl: string): string {
if (hostnameOrUrl.startsWith('http://') || hostnameOrUrl.startsWith('https://')) {
try {
Expand DownExpand Up@@ -90,6 +95,10 @@ export function getAutoProxyUrlFromEnvironment({
return '';
}

if (isAutoProxyDisabledFromEnvironment(environment)) {
return '';
}

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

Add `CLERK_DISABLE_AUTO_PROXY=true` to opt out of automatic Frontend API proxying on Vercel production deployments.
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,16 @@ describe('AuthenticateContext', () => {
expect(context.proxyUrl).toBeUndefined();
});

it('does NOT auto-derive proxyUrl when auto-proxy is disabled', async () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBeUndefined();
});

it('explicit proxyUrl takes precedence over auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@cler
import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shared/keys';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { shouldAutoProxy } from '@clerk/shared/proxy';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand DownExpand Up@@ -168,7 +168,12 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl

// Auto-detect when no explicit proxy or domain is configured
const hasExplicitProxyOrDomain = resolvedParams.proxyUrl || PROXY_URL || resolvedParams.domain || DOMAIN;
if (!frontendApiProxyConfig && !hasExplicitProxyOrDomain && isProductionFromPublishableKey(publishableKey)) {
if (
!frontendApiProxyConfig &&
!hasExplicitProxyOrDomain &&
!isAutoProxyDisabledFromEnvironment() &&
isProductionFromPublishableKey(publishableKey)
) {
Comment on lines +171 to +176

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== clerkMiddleware excerpt =="
sed -n '130,220p' packages/nextjs/src/server/clerkMiddleware.ts
echoecho"== search for auto proxy / disable auto proxy / middleware tests =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|proxy handler|auto proxy|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey|vercel" packages/nextjs -g '*.{ts,tsx,test.ts,test.tsx,spec.ts,spec.tsx}'echoecho"== list test files near nextjs server middleware =="
fd -a "clerkMiddleware" packages/nextjs
fd -a "middleware" packages/nextjs/src packages/nextjs/test packages/nextjs/__tests__ 2>/dev/null ||true

Repository: clerk/javascript

Length of output: 9457


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== repo files of interest =="
git ls-files 'packages/nextjs/**/*'| rg 'clerkMiddleware|middleware|proxy|vercel|test|spec'echoecho"== text search for disable auto proxy across repo =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|auto proxy|proxy handler|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey".echoecho"== if tests exist, print filenames =="
rg -l "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|isProductionFromPublishableKey" packages/nextjs

Repository: clerk/javascript

Length of output: 4975


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== candidate test files =="
fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'echoecho"== read smallest likely test files =="forfin$(fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'| head -n 10);doecho"---- $f ----"
wc -l "$f"
sed -n '1,260p'"$f"done

Repository: clerk/javascript

Length of output: 547


🏁 Script executed:

#!/bin/bashset -euo pipefail
TEST=packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
echo"== file size =="
wc -l "$TEST"echoecho"== outline =="
ast-grep outline "$TEST" --view expanded | sed -n '1,260p'echoecho"== relevant ranges around vercel/proxy tests =="
sed -n '1160,1395p'"$TEST"echoecho"== search for CLERK_DISABLE_AUTO_PROXY in clerkMiddleware.test.ts =="
rg -n "CLERK_DISABLE_AUTO_PROXY|shouldAutoProxy|proxy handler|frontendApiProxy|vercel""$TEST"

Repository: clerk/javascript

Length of output: 11562


Add coverage for the auto-proxy opt-out branch.clerkMiddleware makes this decision independently, so add a middleware test with CLERK_DISABLE_AUTO_PROXY=true, a live key, and an eligible Vercel hostname, and assert the proxy handler is skipped.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/server/clerkMiddleware.ts` around lines 171 - 176, Add
middleware test coverage for the auto-proxy opt-out branch in clerkMiddleware:
set CLERK_DISABLE_AUTO_PROXY=true, use a live publishable key and eligible
Vercel hostname, then assert the proxy handler is not invoked. Keep the test
focused on the condition guarded by isAutoProxyDisabledFromEnvironment and
preserve existing proxy behavior for other configurations.

Source: Coding guidelines

if (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,17 @@ describe('mergeNextClerkPropsWithEnv', () => {
expect(result.proxyUrl).toBe('');
});

it('does not auto-derive proxyUrl when auto-proxy is disabled', () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
process.env.VERCEL_PROJECT_PRODUCTION_URL = 'myapp.vercel.app';

const result = mergeNextClerkPropsWithEnv({});

expect(result.proxyUrl).toBe('');
});
Comment on lines +52 to +61

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Keep environment-sensitive tests deterministic.

Both suites can inherit CLERK_DISABLE_AUTO_PROXY=true from the test runner, causing auto-proxy-enabled cases to fail. Clear or explicitly disable the variable in shared setup, and set it to true only in opt-out cases.

  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61: isolate the flag before tests expecting /__clerk.
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313: isolate the flag before tests expecting automatic proxy derivation.
🧰 Tools
🪛 Betterleaks (1.6.1)

[high] 54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

📍 Affects 2 files
  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61 (this comment)
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts`
around lines 52 - 61, Make the environment-sensitive tests deterministic by
clearing or explicitly disabling CLERK_DISABLE_AUTO_PROXY in shared setup for
auto-proxy-enabled cases, while setting it to true only in opt-out cases. Apply
this in packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts
at lines 52-61 and
packages/backend/src/tokens/__tests__/authenticateContext.test.ts at lines
305-313, preserving the existing expectations for /__clerk and automatic proxy
derivation.


it('does not override an explicit proxyUrl', () => {
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
Expand Down
13 changes: 13 additions & 0 deletions packages/shared/src/__tests__/proxy.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,19 @@ describe('getAutoProxyUrlFromEnvironment(options)', () => {
).toBe('');
});

it('returns empty string when auto-proxy is disabled', () => {
expect(
getAutoProxyUrlFromEnvironment({
publishableKey: 'pk_live_Zm9vLmNsZXJrLmNvbSQ=',
environment: {
CLERK_DISABLE_AUTO_PROXY: 'true',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp.vercel.app',
VERCEL_TARGET_ENV: 'production',
},
}),
).toBe('');
});

it('returns empty string for ineligible or non-production Vercel environments', () => {
expect(
getAutoProxyUrlFromEnvironment({
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/proxy.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { isProductionFromPublishableKey } from './keys';
import { isTruthy } from './underscore';

/**
*
Expand DownExpand Up@@ -55,6 +56,10 @@ function getDefaultEnvironment(): NodeJS.ProcessEnv {
return typeof process !== 'undefined' && process.env ? process.env : {};
}

export function isAutoProxyDisabledFromEnvironment(environment = getDefaultEnvironment()): boolean {
return isTruthy(environment.CLERK_DISABLE_AUTO_PROXY);
}

function normalizeHostname(hostnameOrUrl: string): string {
if (hostnameOrUrl.startsWith('http://') || hostnameOrUrl.startsWith('https://')) {
try {
Expand DownExpand Up@@ -90,6 +95,10 @@ export function getAutoProxyUrlFromEnvironment({
return '';
}

if (isAutoProxyDisabledFromEnvironment(environment)) {
return '';
}

if (environment.VERCEL_TARGET_ENV !== 'production') {
return '';
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
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
7 changes: 7 additions & 0 deletions .changeset/disable-vercel-auto-proxy.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/shared': patch
---

Add `CLERK_DISABLE_AUTO_PROXY=true` to opt out of automatic Frontend API proxying on Vercel production deployments.
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,16 @@ describe('AuthenticateContext', () => {
expect(context.proxyUrl).toBeUndefined();
});

it('does NOT auto-derive proxyUrl when auto-proxy is disabled', async () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBeUndefined();
});

it('explicit proxyUrl takes precedence over auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@cler
import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shared/keys';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { shouldAutoProxy } from '@clerk/shared/proxy';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand DownExpand Up@@ -168,7 +168,12 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl

// Auto-detect when no explicit proxy or domain is configured
const hasExplicitProxyOrDomain = resolvedParams.proxyUrl || PROXY_URL || resolvedParams.domain || DOMAIN;
if (!frontendApiProxyConfig && !hasExplicitProxyOrDomain && isProductionFromPublishableKey(publishableKey)) {
if (
!frontendApiProxyConfig &&
!hasExplicitProxyOrDomain &&
!isAutoProxyDisabledFromEnvironment() &&
isProductionFromPublishableKey(publishableKey)
) {
Comment on lines +171 to +176

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== clerkMiddleware excerpt =="
sed -n '130,220p' packages/nextjs/src/server/clerkMiddleware.ts
echoecho"== search for auto proxy / disable auto proxy / middleware tests =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|proxy handler|auto proxy|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey|vercel" packages/nextjs -g '*.{ts,tsx,test.ts,test.tsx,spec.ts,spec.tsx}'echoecho"== list test files near nextjs server middleware =="
fd -a "clerkMiddleware" packages/nextjs
fd -a "middleware" packages/nextjs/src packages/nextjs/test packages/nextjs/__tests__ 2>/dev/null ||true

Repository: clerk/javascript

Length of output: 9457


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== repo files of interest =="
git ls-files 'packages/nextjs/**/*'| rg 'clerkMiddleware|middleware|proxy|vercel|test|spec'echoecho"== text search for disable auto proxy across repo =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|auto proxy|proxy handler|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey".echoecho"== if tests exist, print filenames =="
rg -l "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|isProductionFromPublishableKey" packages/nextjs

Repository: clerk/javascript

Length of output: 4975


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== candidate test files =="
fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'echoecho"== read smallest likely test files =="forfin$(fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'| head -n 10);doecho"---- $f ----"
wc -l "$f"
sed -n '1,260p'"$f"done

Repository: clerk/javascript

Length of output: 547


🏁 Script executed:

#!/bin/bashset -euo pipefail
TEST=packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
echo"== file size =="
wc -l "$TEST"echoecho"== outline =="
ast-grep outline "$TEST" --view expanded | sed -n '1,260p'echoecho"== relevant ranges around vercel/proxy tests =="
sed -n '1160,1395p'"$TEST"echoecho"== search for CLERK_DISABLE_AUTO_PROXY in clerkMiddleware.test.ts =="
rg -n "CLERK_DISABLE_AUTO_PROXY|shouldAutoProxy|proxy handler|frontendApiProxy|vercel""$TEST"

Repository: clerk/javascript

Length of output: 11562


Add coverage for the auto-proxy opt-out branch.clerkMiddleware makes this decision independently, so add a middleware test with CLERK_DISABLE_AUTO_PROXY=true, a live key, and an eligible Vercel hostname, and assert the proxy handler is skipped.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/server/clerkMiddleware.ts` around lines 171 - 176, Add
middleware test coverage for the auto-proxy opt-out branch in clerkMiddleware:
set CLERK_DISABLE_AUTO_PROXY=true, use a live publishable key and eligible
Vercel hostname, then assert the proxy handler is not invoked. Keep the test
focused on the condition guarded by isAutoProxyDisabledFromEnvironment and
preserve existing proxy behavior for other configurations.

Source: Coding guidelines

if (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,17 @@ describe('mergeNextClerkPropsWithEnv', () => {
expect(result.proxyUrl).toBe('');
});

it('does not auto-derive proxyUrl when auto-proxy is disabled', () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
process.env.VERCEL_PROJECT_PRODUCTION_URL = 'myapp.vercel.app';

const result = mergeNextClerkPropsWithEnv({});

expect(result.proxyUrl).toBe('');
});
Comment on lines +52 to +61

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Keep environment-sensitive tests deterministic.

Both suites can inherit CLERK_DISABLE_AUTO_PROXY=true from the test runner, causing auto-proxy-enabled cases to fail. Clear or explicitly disable the variable in shared setup, and set it to true only in opt-out cases.

  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61: isolate the flag before tests expecting /__clerk.
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313: isolate the flag before tests expecting automatic proxy derivation.
🧰 Tools
🪛 Betterleaks (1.6.1)

[high] 54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

📍 Affects 2 files
  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61 (this comment)
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts`
around lines 52 - 61, Make the environment-sensitive tests deterministic by
clearing or explicitly disabling CLERK_DISABLE_AUTO_PROXY in shared setup for
auto-proxy-enabled cases, while setting it to true only in opt-out cases. Apply
this in packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts
at lines 52-61 and
packages/backend/src/tokens/__tests__/authenticateContext.test.ts at lines
305-313, preserving the existing expectations for /__clerk and automatic proxy
derivation.


it('does not override an explicit proxyUrl', () => {
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
Expand Down
13 changes: 13 additions & 0 deletions packages/shared/src/__tests__/proxy.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,19 @@ describe('getAutoProxyUrlFromEnvironment(options)', () => {
).toBe('');
});

it('returns empty string when auto-proxy is disabled', () => {
expect(
getAutoProxyUrlFromEnvironment({
publishableKey: 'pk_live_Zm9vLmNsZXJrLmNvbSQ=',
environment: {
CLERK_DISABLE_AUTO_PROXY: 'true',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp.vercel.app',
VERCEL_TARGET_ENV: 'production',
},
}),
).toBe('');
});

it('returns empty string for ineligible or non-production Vercel environments', () => {
expect(
getAutoProxyUrlFromEnvironment({
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/proxy.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { isProductionFromPublishableKey } from './keys';
import { isTruthy } from './underscore';

/**
*
Expand DownExpand Up@@ -55,6 +56,10 @@ function getDefaultEnvironment(): NodeJS.ProcessEnv {
return typeof process !== 'undefined' && process.env ? process.env : {};
}

export function isAutoProxyDisabledFromEnvironment(environment = getDefaultEnvironment()): boolean {
return isTruthy(environment.CLERK_DISABLE_AUTO_PROXY);
}

function normalizeHostname(hostnameOrUrl: string): string {
if (hostnameOrUrl.startsWith('http://') || hostnameOrUrl.startsWith('https://')) {
try {
Expand DownExpand Up@@ -90,6 +95,10 @@ export function getAutoProxyUrlFromEnvironment({
return '';
}

if (isAutoProxyDisabledFromEnvironment(environment)) {
return '';
}

if (environment.VERCEL_TARGET_ENV !== 'production') {
return '';
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
7 changes: 7 additions & 0 deletions .changeset/disable-vercel-auto-proxy.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/shared': patch
---

Add `CLERK_DISABLE_AUTO_PROXY=true` to opt out of automatic Frontend API proxying on Vercel production deployments.
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,16 @@ describe('AuthenticateContext', () => {
expect(context.proxyUrl).toBeUndefined();
});

it('does NOT auto-derive proxyUrl when auto-proxy is disabled', async () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBeUndefined();
});

it('explicit proxyUrl takes precedence over auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@cler
import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shared/keys';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { shouldAutoProxy } from '@clerk/shared/proxy';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand DownExpand Up@@ -168,7 +168,12 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl

// Auto-detect when no explicit proxy or domain is configured
const hasExplicitProxyOrDomain = resolvedParams.proxyUrl || PROXY_URL || resolvedParams.domain || DOMAIN;
if (!frontendApiProxyConfig && !hasExplicitProxyOrDomain && isProductionFromPublishableKey(publishableKey)) {
if (
!frontendApiProxyConfig &&
!hasExplicitProxyOrDomain &&
!isAutoProxyDisabledFromEnvironment() &&
isProductionFromPublishableKey(publishableKey)
) {
Comment on lines +171 to +176

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== clerkMiddleware excerpt =="
sed -n '130,220p' packages/nextjs/src/server/clerkMiddleware.ts
echoecho"== search for auto proxy / disable auto proxy / middleware tests =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|proxy handler|auto proxy|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey|vercel" packages/nextjs -g '*.{ts,tsx,test.ts,test.tsx,spec.ts,spec.tsx}'echoecho"== list test files near nextjs server middleware =="
fd -a "clerkMiddleware" packages/nextjs
fd -a "middleware" packages/nextjs/src packages/nextjs/test packages/nextjs/__tests__ 2>/dev/null ||true

Repository: clerk/javascript

Length of output: 9457


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== repo files of interest =="
git ls-files 'packages/nextjs/**/*'| rg 'clerkMiddleware|middleware|proxy|vercel|test|spec'echoecho"== text search for disable auto proxy across repo =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|auto proxy|proxy handler|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey".echoecho"== if tests exist, print filenames =="
rg -l "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|isProductionFromPublishableKey" packages/nextjs

Repository: clerk/javascript

Length of output: 4975


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== candidate test files =="
fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'echoecho"== read smallest likely test files =="forfin$(fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'| head -n 10);doecho"---- $f ----"
wc -l "$f"
sed -n '1,260p'"$f"done

Repository: clerk/javascript

Length of output: 547


🏁 Script executed:

#!/bin/bashset -euo pipefail
TEST=packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
echo"== file size =="
wc -l "$TEST"echoecho"== outline =="
ast-grep outline "$TEST" --view expanded | sed -n '1,260p'echoecho"== relevant ranges around vercel/proxy tests =="
sed -n '1160,1395p'"$TEST"echoecho"== search for CLERK_DISABLE_AUTO_PROXY in clerkMiddleware.test.ts =="
rg -n "CLERK_DISABLE_AUTO_PROXY|shouldAutoProxy|proxy handler|frontendApiProxy|vercel""$TEST"

Repository: clerk/javascript

Length of output: 11562


Add coverage for the auto-proxy opt-out branch.clerkMiddleware makes this decision independently, so add a middleware test with CLERK_DISABLE_AUTO_PROXY=true, a live key, and an eligible Vercel hostname, and assert the proxy handler is skipped.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/server/clerkMiddleware.ts` around lines 171 - 176, Add
middleware test coverage for the auto-proxy opt-out branch in clerkMiddleware:
set CLERK_DISABLE_AUTO_PROXY=true, use a live publishable key and eligible
Vercel hostname, then assert the proxy handler is not invoked. Keep the test
focused on the condition guarded by isAutoProxyDisabledFromEnvironment and
preserve existing proxy behavior for other configurations.

Source: Coding guidelines

if (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,17 @@ describe('mergeNextClerkPropsWithEnv', () => {
expect(result.proxyUrl).toBe('');
});

it('does not auto-derive proxyUrl when auto-proxy is disabled', () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
process.env.VERCEL_PROJECT_PRODUCTION_URL = 'myapp.vercel.app';

const result = mergeNextClerkPropsWithEnv({});

expect(result.proxyUrl).toBe('');
});
Comment on lines +52 to +61

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Keep environment-sensitive tests deterministic.

Both suites can inherit CLERK_DISABLE_AUTO_PROXY=true from the test runner, causing auto-proxy-enabled cases to fail. Clear or explicitly disable the variable in shared setup, and set it to true only in opt-out cases.

  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61: isolate the flag before tests expecting /__clerk.
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313: isolate the flag before tests expecting automatic proxy derivation.
🧰 Tools
🪛 Betterleaks (1.6.1)

[high] 54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

📍 Affects 2 files
  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61 (this comment)
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts`
around lines 52 - 61, Make the environment-sensitive tests deterministic by
clearing or explicitly disabling CLERK_DISABLE_AUTO_PROXY in shared setup for
auto-proxy-enabled cases, while setting it to true only in opt-out cases. Apply
this in packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts
at lines 52-61 and
packages/backend/src/tokens/__tests__/authenticateContext.test.ts at lines
305-313, preserving the existing expectations for /__clerk and automatic proxy
derivation.


it('does not override an explicit proxyUrl', () => {
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
Expand Down
13 changes: 13 additions & 0 deletions packages/shared/src/__tests__/proxy.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,19 @@ describe('getAutoProxyUrlFromEnvironment(options)', () => {
).toBe('');
});

it('returns empty string when auto-proxy is disabled', () => {
expect(
getAutoProxyUrlFromEnvironment({
publishableKey: 'pk_live_Zm9vLmNsZXJrLmNvbSQ=',
environment: {
CLERK_DISABLE_AUTO_PROXY: 'true',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp.vercel.app',
VERCEL_TARGET_ENV: 'production',
},
}),
).toBe('');
});

it('returns empty string for ineligible or non-production Vercel environments', () => {
expect(
getAutoProxyUrlFromEnvironment({
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/proxy.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { isProductionFromPublishableKey } from './keys';
import { isTruthy } from './underscore';

/**
*
Expand DownExpand Up@@ -55,6 +56,10 @@ function getDefaultEnvironment(): NodeJS.ProcessEnv {
return typeof process !== 'undefined' && process.env ? process.env : {};
}

export function isAutoProxyDisabledFromEnvironment(environment = getDefaultEnvironment()): boolean {
return isTruthy(environment.CLERK_DISABLE_AUTO_PROXY);
}

function normalizeHostname(hostnameOrUrl: string): string {
if (hostnameOrUrl.startsWith('http://') || hostnameOrUrl.startsWith('https://')) {
try {
Expand DownExpand Up@@ -90,6 +95,10 @@ export function getAutoProxyUrlFromEnvironment({
return '';
}

if (isAutoProxyDisabledFromEnvironment(environment)) {
return '';
}

if (environment.VERCEL_TARGET_ENV !== 'production') {
return '';
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
7 changes: 7 additions & 0 deletions .changeset/disable-vercel-auto-proxy.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/shared': patch
---

Add `CLERK_DISABLE_AUTO_PROXY=true` to opt out of automatic Frontend API proxying on Vercel production deployments.
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,16 @@ describe('AuthenticateContext', () => {
expect(context.proxyUrl).toBeUndefined();
});

it('does NOT auto-derive proxyUrl when auto-proxy is disabled', async () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBeUndefined();
});

it('explicit proxyUrl takes precedence over auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@cler
import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shared/keys';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { shouldAutoProxy } from '@clerk/shared/proxy';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand DownExpand Up@@ -168,7 +168,12 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl

// Auto-detect when no explicit proxy or domain is configured
const hasExplicitProxyOrDomain = resolvedParams.proxyUrl || PROXY_URL || resolvedParams.domain || DOMAIN;
if (!frontendApiProxyConfig && !hasExplicitProxyOrDomain && isProductionFromPublishableKey(publishableKey)) {
if (
!frontendApiProxyConfig &&
!hasExplicitProxyOrDomain &&
!isAutoProxyDisabledFromEnvironment() &&
isProductionFromPublishableKey(publishableKey)
) {
Comment on lines +171 to +176

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== clerkMiddleware excerpt =="
sed -n '130,220p' packages/nextjs/src/server/clerkMiddleware.ts
echoecho"== search for auto proxy / disable auto proxy / middleware tests =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|proxy handler|auto proxy|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey|vercel" packages/nextjs -g '*.{ts,tsx,test.ts,test.tsx,spec.ts,spec.tsx}'echoecho"== list test files near nextjs server middleware =="
fd -a "clerkMiddleware" packages/nextjs
fd -a "middleware" packages/nextjs/src packages/nextjs/test packages/nextjs/__tests__ 2>/dev/null ||true

Repository: clerk/javascript

Length of output: 9457


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== repo files of interest =="
git ls-files 'packages/nextjs/**/*'| rg 'clerkMiddleware|middleware|proxy|vercel|test|spec'echoecho"== text search for disable auto proxy across repo =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|auto proxy|proxy handler|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey".echoecho"== if tests exist, print filenames =="
rg -l "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|isProductionFromPublishableKey" packages/nextjs

Repository: clerk/javascript

Length of output: 4975


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== candidate test files =="
fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'echoecho"== read smallest likely test files =="forfin$(fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'| head -n 10);doecho"---- $f ----"
wc -l "$f"
sed -n '1,260p'"$f"done

Repository: clerk/javascript

Length of output: 547


🏁 Script executed:

#!/bin/bashset -euo pipefail
TEST=packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
echo"== file size =="
wc -l "$TEST"echoecho"== outline =="
ast-grep outline "$TEST" --view expanded | sed -n '1,260p'echoecho"== relevant ranges around vercel/proxy tests =="
sed -n '1160,1395p'"$TEST"echoecho"== search for CLERK_DISABLE_AUTO_PROXY in clerkMiddleware.test.ts =="
rg -n "CLERK_DISABLE_AUTO_PROXY|shouldAutoProxy|proxy handler|frontendApiProxy|vercel""$TEST"

Repository: clerk/javascript

Length of output: 11562


Add coverage for the auto-proxy opt-out branch.clerkMiddleware makes this decision independently, so add a middleware test with CLERK_DISABLE_AUTO_PROXY=true, a live key, and an eligible Vercel hostname, and assert the proxy handler is skipped.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/server/clerkMiddleware.ts` around lines 171 - 176, Add
middleware test coverage for the auto-proxy opt-out branch in clerkMiddleware:
set CLERK_DISABLE_AUTO_PROXY=true, use a live publishable key and eligible
Vercel hostname, then assert the proxy handler is not invoked. Keep the test
focused on the condition guarded by isAutoProxyDisabledFromEnvironment and
preserve existing proxy behavior for other configurations.

Source: Coding guidelines

if (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,17 @@ describe('mergeNextClerkPropsWithEnv', () => {
expect(result.proxyUrl).toBe('');
});

it('does not auto-derive proxyUrl when auto-proxy is disabled', () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
process.env.VERCEL_PROJECT_PRODUCTION_URL = 'myapp.vercel.app';

const result = mergeNextClerkPropsWithEnv({});

expect(result.proxyUrl).toBe('');
});
Comment on lines +52 to +61

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Keep environment-sensitive tests deterministic.

Both suites can inherit CLERK_DISABLE_AUTO_PROXY=true from the test runner, causing auto-proxy-enabled cases to fail. Clear or explicitly disable the variable in shared setup, and set it to true only in opt-out cases.

  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61: isolate the flag before tests expecting /__clerk.
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313: isolate the flag before tests expecting automatic proxy derivation.
🧰 Tools
🪛 Betterleaks (1.6.1)

[high] 54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

📍 Affects 2 files
  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61 (this comment)
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts`
around lines 52 - 61, Make the environment-sensitive tests deterministic by
clearing or explicitly disabling CLERK_DISABLE_AUTO_PROXY in shared setup for
auto-proxy-enabled cases, while setting it to true only in opt-out cases. Apply
this in packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts
at lines 52-61 and
packages/backend/src/tokens/__tests__/authenticateContext.test.ts at lines
305-313, preserving the existing expectations for /__clerk and automatic proxy
derivation.


it('does not override an explicit proxyUrl', () => {
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
Expand Down
13 changes: 13 additions & 0 deletions packages/shared/src/__tests__/proxy.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,19 @@ describe('getAutoProxyUrlFromEnvironment(options)', () => {
).toBe('');
});

it('returns empty string when auto-proxy is disabled', () => {
expect(
getAutoProxyUrlFromEnvironment({
publishableKey: 'pk_live_Zm9vLmNsZXJrLmNvbSQ=',
environment: {
CLERK_DISABLE_AUTO_PROXY: 'true',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp.vercel.app',
VERCEL_TARGET_ENV: 'production',
},
}),
).toBe('');
});

it('returns empty string for ineligible or non-production Vercel environments', () => {
expect(
getAutoProxyUrlFromEnvironment({
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/proxy.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { isProductionFromPublishableKey } from './keys';
import { isTruthy } from './underscore';

/**
*
Expand DownExpand Up@@ -55,6 +56,10 @@ function getDefaultEnvironment(): NodeJS.ProcessEnv {
return typeof process !== 'undefined' && process.env ? process.env : {};
}

export function isAutoProxyDisabledFromEnvironment(environment = getDefaultEnvironment()): boolean {
return isTruthy(environment.CLERK_DISABLE_AUTO_PROXY);
}

function normalizeHostname(hostnameOrUrl: string): string {
if (hostnameOrUrl.startsWith('http://') || hostnameOrUrl.startsWith('https://')) {
try {
Expand DownExpand Up@@ -90,6 +95,10 @@ export function getAutoProxyUrlFromEnvironment({
return '';
}

if (isAutoProxyDisabledFromEnvironment(environment)) {
return '';
}

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

Add `CLERK_DISABLE_AUTO_PROXY=true` to opt out of automatic Frontend API proxying on Vercel production deployments.
Original file line numberDiff line numberDiff line change
Expand Up@@ -302,6 +302,16 @@ describe('AuthenticateContext', () => {
expect(context.proxyUrl).toBeUndefined();
});

it('does NOT auto-derive proxyUrl when auto-proxy is disabled', async () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBeUndefined();
});

it('explicit proxyUrl takes precedence over auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
Expand Down
9 changes: 7 additions & 2 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@cler
import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shared/keys';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { shouldAutoProxy } from '@clerk/shared/proxy';
import { isAutoProxyDisabledFromEnvironment, shouldAutoProxy } from '@clerk/shared/proxy';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand DownExpand Up@@ -168,7 +168,12 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl

// Auto-detect when no explicit proxy or domain is configured
const hasExplicitProxyOrDomain = resolvedParams.proxyUrl || PROXY_URL || resolvedParams.domain || DOMAIN;
if (!frontendApiProxyConfig && !hasExplicitProxyOrDomain && isProductionFromPublishableKey(publishableKey)) {
if (
!frontendApiProxyConfig &&
!hasExplicitProxyOrDomain &&
!isAutoProxyDisabledFromEnvironment() &&
isProductionFromPublishableKey(publishableKey)
) {
Comment on lines +171 to +176

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== clerkMiddleware excerpt =="
sed -n '130,220p' packages/nextjs/src/server/clerkMiddleware.ts
echoecho"== search for auto proxy / disable auto proxy / middleware tests =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|proxy handler|auto proxy|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey|vercel" packages/nextjs -g '*.{ts,tsx,test.ts,test.tsx,spec.ts,spec.tsx}'echoecho"== list test files near nextjs server middleware =="
fd -a "clerkMiddleware" packages/nextjs
fd -a "middleware" packages/nextjs/src packages/nextjs/test packages/nextjs/__tests__ 2>/dev/null ||true

Repository: clerk/javascript

Length of output: 9457


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== repo files of interest =="
git ls-files 'packages/nextjs/**/*'| rg 'clerkMiddleware|middleware|proxy|vercel|test|spec'echoecho"== text search for disable auto proxy across repo =="
rg -n "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|auto proxy|proxy handler|frontendApiProxyConfig|hasExplicitProxyOrDomain|isProductionFromPublishableKey".echoecho"== if tests exist, print filenames =="
rg -l "CLERK_DISABLE_AUTO_PROXY|isAutoProxyDisabledFromEnvironment|isProductionFromPublishableKey" packages/nextjs

Repository: clerk/javascript

Length of output: 4975


🏁 Script executed:

#!/bin/bashset -euo pipefail
echo"== candidate test files =="
fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'echoecho"== read smallest likely test files =="forfin$(fd -a -e ts -e tsx -e test.ts -e spec.ts packages/nextjs | rg 'clerkMiddleware|middleware|proxy|vercel'| head -n 10);doecho"---- $f ----"
wc -l "$f"
sed -n '1,260p'"$f"done

Repository: clerk/javascript

Length of output: 547


🏁 Script executed:

#!/bin/bashset -euo pipefail
TEST=packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
echo"== file size =="
wc -l "$TEST"echoecho"== outline =="
ast-grep outline "$TEST" --view expanded | sed -n '1,260p'echoecho"== relevant ranges around vercel/proxy tests =="
sed -n '1160,1395p'"$TEST"echoecho"== search for CLERK_DISABLE_AUTO_PROXY in clerkMiddleware.test.ts =="
rg -n "CLERK_DISABLE_AUTO_PROXY|shouldAutoProxy|proxy handler|frontendApiProxy|vercel""$TEST"

Repository: clerk/javascript

Length of output: 11562


Add coverage for the auto-proxy opt-out branch.clerkMiddleware makes this decision independently, so add a middleware test with CLERK_DISABLE_AUTO_PROXY=true, a live key, and an eligible Vercel hostname, and assert the proxy handler is skipped.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/server/clerkMiddleware.ts` around lines 171 - 176, Add
middleware test coverage for the auto-proxy opt-out branch in clerkMiddleware:
set CLERK_DISABLE_AUTO_PROXY=true, use a live publishable key and eligible
Vercel hostname, then assert the proxy handler is not invoked. Keep the test
focused on the condition guarded by isAutoProxyDisabledFromEnvironment and
preserve existing proxy behavior for other configurations.

Source: Coding guidelines

if (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,17 @@ describe('mergeNextClerkPropsWithEnv', () => {
expect(result.proxyUrl).toBe('');
});

it('does not auto-derive proxyUrl when auto-proxy is disabled', () => {
process.env.CLERK_DISABLE_AUTO_PROXY = 'true';
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
process.env.VERCEL_PROJECT_PRODUCTION_URL = 'myapp.vercel.app';

const result = mergeNextClerkPropsWithEnv({});

expect(result.proxyUrl).toBe('');
});
Comment on lines +52 to +61

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

Keep environment-sensitive tests deterministic.

Both suites can inherit CLERK_DISABLE_AUTO_PROXY=true from the test runner, causing auto-proxy-enabled cases to fail. Clear or explicitly disable the variable in shared setup, and set it to true only in opt-out cases.

  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61: isolate the flag before tests expecting /__clerk.
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313: isolate the flag before tests expecting automatic proxy derivation.
🧰 Tools
🪛 Betterleaks (1.6.1)

[high] 54-54: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

📍 Affects 2 files
  • packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts#L52-L61 (this comment)
  • packages/backend/src/tokens/__tests__/authenticateContext.test.ts#L305-L313
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts`
around lines 52 - 61, Make the environment-sensitive tests deterministic by
clearing or explicitly disabling CLERK_DISABLE_AUTO_PROXY in shared setup for
auto-proxy-enabled cases, while setting it to true only in opt-out cases. Apply
this in packages/nextjs/src/utils/__tests__/mergeNextClerkPropsWithEnv.test.ts
at lines 52-61 and
packages/backend/src/tokens/__tests__/authenticateContext.test.ts at lines
305-313, preserving the existing expectations for /__clerk and automatic proxy
derivation.


it('does not override an explicit proxyUrl', () => {
process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY = 'pk_live_Zm9vLmNsZXJrLmNvbSQ=';
process.env.VERCEL_TARGET_ENV = 'production';
Expand Down
13 changes: 13 additions & 0 deletions packages/shared/src/__tests__/proxy.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,19 @@ describe('getAutoProxyUrlFromEnvironment(options)', () => {
).toBe('');
});

it('returns empty string when auto-proxy is disabled', () => {
expect(
getAutoProxyUrlFromEnvironment({
publishableKey: 'pk_live_Zm9vLmNsZXJrLmNvbSQ=',
environment: {
CLERK_DISABLE_AUTO_PROXY: 'true',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp.vercel.app',
VERCEL_TARGET_ENV: 'production',
},
}),
).toBe('');
});

it('returns empty string for ineligible or non-production Vercel environments', () => {
expect(
getAutoProxyUrlFromEnvironment({
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/proxy.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { isProductionFromPublishableKey } from './keys';
import { isTruthy } from './underscore';

/**
*
Expand DownExpand Up@@ -55,6 +56,10 @@ function getDefaultEnvironment(): NodeJS.ProcessEnv {
return typeof process !== 'undefined' && process.env ? process.env : {};
}

export function isAutoProxyDisabledFromEnvironment(environment = getDefaultEnvironment()): boolean {
return isTruthy(environment.CLERK_DISABLE_AUTO_PROXY);
}

function normalizeHostname(hostnameOrUrl: string): string {
if (hostnameOrUrl.startsWith('http://') || hostnameOrUrl.startsWith('https://')) {
try {
Expand DownExpand Up@@ -90,6 +95,10 @@ export function getAutoProxyUrlFromEnvironment({
return '';
}

if (isAutoProxyDisabledFromEnvironment(environment)) {
return '';
}

if (environment.VERCEL_TARGET_ENV !== 'production') {
return '';
}
Expand Down
Loading