Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
70420c0
feat(shared,backend,clerk-js,nextjs): Auto-proxy for .vercel.app subd…
brkalow Mar 11, 2026
dbc580e
refactor: generalize auto proxy naming
brkalow Mar 13, 2026
2d729d2
chore(repo): add changeset for auto proxy updates
brkalow Mar 13, 2026
72d6bdc
feat(shared,nextjs): support vercel production static auto proxy
brkalow Mar 20, 2026
f8906d3
fix(shared): make proxy helpers server safe
brkalow Mar 20, 2026
217a991
fix(nextjs): use nextUrl for auto proxy detection
brkalow Mar 20, 2026
db5ee3f
fix(shared,nextjs): proxy initial script tags
brkalow Mar 20, 2026
c99aba2
fix(backend): prevent Content-Encoding mismatch in proxy responses
brkalow Mar 20, 2026
aea3966
fix: add Vercel env vars to turbo.json and harden proxy header stripping
brkalow Mar 24, 2026
675270a
refactor(backend): convert RESPONSE_HEADERS_TO_STRIP to a Set
brkalow Mar 31, 2026
24d68e3
merge: resolve conflicts with main
Railly Apr 10, 2026
bdc8436
chore: add changeset for auto-proxy feature
Railly Apr 10, 2026
9a2f6b7
fix(shared): guard shouldAutoProxy against undefined hostname
Railly Apr 10, 2026
b89156d
chore: remove duplicate changeset
Railly Apr 10, 2026
0b6db2b
fix: only auto-proxy for production instances on .vercel.app
Railly Apr 14, 2026
96842db
refactor: export AUTO_PROXY_PATH and replace hardcoded /__clerk
Railly Apr 14, 2026
635c9b7
refactor(nextjs): inline auto-proxy detection in middleware for reada…
Railly Apr 14, 2026
0859708
test(clerk-js): add dev instance guard test, use production key for a…
Railly Apr 14, 2026
67475c6
fix(nextjs): add production-only guard to middleware auto-proxy detec…
Railly Apr 16, 2026
b3e8273
fix(nextjs): hoist requestUrl declaration to fix ReferenceError with …
Railly Apr 16, 2026
66a8ad1
test(backend): fix auto-proxy tests to use pkLive, add dev key negati…
Railly Apr 17, 2026
cba7dfd
fix(backend): document X-Forwarded-Host trust assumption in auto-proxy
Railly Apr 17, 2026
c9c28b0
fix(shared): wrap normalizeHostname URL parsing in try-catch
Railly Apr 17, 2026
2371ab2
refactor: use isProductionFromPublishableKey instead of raw pk_live_ …
Railly Apr 17, 2026
a492681
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 17, 2026
670d2af
fix(nextjs): use production key in middleware auto-proxy tests, resto…
Railly Apr 17, 2026
0024932
style: restore keyless-provider.tsx formatting from main
Railly Apr 17, 2026
174ed67
style: restore UserSettings.ts formatting from main
Railly Apr 20, 2026
a4091ad
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 20, 2026
06bce1d
style: restore merge artifact formatting from main
Railly Apr 20, 2026
4d7c662
chore: remove stale test-signin-provider file
Railly Apr 20, 2026
e0a275d
docs(shared): add comment explaining build-time/runtime dual executio…
Railly Apr 22, 2026
43be86f
refactor(backend): use getAutoProxyUrlFromEnvironment instead of head…
Railly Apr 22, 2026
d7feb1c
fix(backend): remove unused AUTO_PROXY_PATH import
Railly Apr 27, 2026
d0450ed
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/auto-proxy-vercel-subdomains.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/backend': patch
'@clerk/clerk-js': patch
'@clerk/nextjs': patch
---

Auto-proxy FAPI requests for `.vercel.app` subdomains. When deployed to a `.vercel.app` domain without explicit proxy or domain configuration, the SDK automatically routes Frontend API requests through `/__clerk` on the app's own origin. This enables Clerk production mode on Vercel deployments without manual proxy setup.
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,71 @@ describe('AuthenticateContext', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const originalEnv = process.env;

beforeEach(() => {
process.env = {
...originalEnv,
VERCEL_TARGET_ENV: 'production',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp-abc123.vercel.app',
};
});

afterEach(() => {
process.env = originalEnv;
});

it('auto-derives proxyUrl when Vercel env vars indicate production vercel.app', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

it('does NOT auto-derive proxyUrl for development keys', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkTest,
});

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

it('does NOT auto-derive proxyUrl when Vercel env vars are absent', async () => {
delete process.env.VERCEL_TARGET_ENV;
delete process.env.VERCEL_PROJECT_PRODUCTION_URL;
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, {
publishableKey: pkLive,
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});

expect(context.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

it('explicit domain skips auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
domain: 'clerk.myapp.com',
});

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

// Added these tests to verify that the generated sha-1 is the same as the one used in cookie assignment
// Tests copied from packages/shared/src/__tests__/keys.test.ts
describe('getCookieSuffix(publishableKey, subtle)', () => {
Expand Down
13 changes: 13 additions & 0 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
import { getAutoProxyUrlFromEnvironment } from '@clerk/shared/proxy';
import type { Jwt } from '@clerk/shared/types';
import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';

Expand DownExpand Up@@ -70,6 +71,18 @@ class AuthenticateContext implements AuthenticateContext {
private clerkRequest: ClerkRequest,
options: AuthenticateRequestOptions,
) {
// Auto-detect proxy for supported platform deployments using environment
// variables (e.g. VERCEL_TARGET_ENV, VERCEL_PROJECT_PRODUCTION_URL) instead
// of request headers, which avoids X-Forwarded-Host spoofing concerns.
const autoProxyPath = getAutoProxyUrlFromEnvironment({
publishableKey: options.publishableKey ?? '',
hasProxyUrl: !!options.proxyUrl,
hasDomain: !!options.domain,
});
if (autoProxyPath) {
options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}${autoProxyPath}` };
}

if (options.acceptsToken === TokenType.M2MToken || options.acceptsToken === TokenType.ApiKey) {
// For non-session tokens, we only want to set the header values.
this.initHeaderValues();
Expand Down
80 changes: 80 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

NIT: A possible extra test here is to check that it doesn't break when window is not defined (for native envs).

The if (inBrowser()) { already takes care of it, but tests are always nice.

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.

Addressed in 0859708, also updated existing tests to use production key since auto-proxy is now production-only

Original file line numberDiff line numberDiff line change
Expand Up@@ -2516,6 +2516,86 @@ describe('Clerk singleton', () => {
});
});
});

describe('auto-detection for eligible hosts', () => {
const originalLocation = window.location;

afterEach(() => {
Object.defineProperty(window, 'location', {
value: originalLocation,
writable: true,
});
});

test('auto-derives proxyUrl for production instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

test('does NOT auto-derive proxyUrl for development instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(developmentPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('does NOT auto-derive proxyUrl for ineligible domains', () => {
const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('explicit proxyUrl takes precedence over auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});
expect(sut.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

test('explicit domain skips auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
domain: 'clerk.myapp.com',
});
expect(sut.proxyUrl).toBe('');
});
});
});

describe('buildUrlWithAuth', () => {
Expand Down
17 changes: 15 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,13 @@ import { windowNavigate } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { parsePublishableKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { CLERK_NETLIFY_CACHE_BUST_PARAM } from '@clerk/shared/netlifyCacheHandler';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import {
AUTO_PROXY_PATH,
isHttpOrHttps,
isValidProxyUrl,
proxyUrlToAbsoluteURL,
shouldAutoProxy,
} from '@clerk/shared/proxy';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
Expand DownExpand Up@@ -361,7 +367,14 @@ export class Clerk implements ClerkInterface {
if (!isValidProxyUrl(_unfilteredProxy)) {
errorThrower.throwInvalidProxyUrl({ url: _unfilteredProxy });
}
return proxyUrlToAbsoluteURL(_unfilteredProxy);
const resolved = proxyUrlToAbsoluteURL(_unfilteredProxy);
if (resolved) {
return resolved;
}
// Auto-detect when no explicit proxy or domain is configured (production only)
if (!this.#domain && this.#instanceType === 'production' && shouldAutoProxy(window.location.hostname)) {
return `${window.location.origin}${AUTO_PROXY_PATH}`;
}
}

if (typeof this.#proxyUrl === 'function') {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,4 +86,24 @@ describe('DynamicClerkScripts', () => {
expect(html).not.toContain('nonce="test');
expect(html).not.toContain('nonce="csp');
});

it('renders initial script tags with relative proxied asset URLs', async () => {
mockHeaders.mockResolvedValue(
new Map([
['X-Nonce', null],
['Content-Security-Policy', ''],
]),
);

const html = await render(
DynamicClerkScripts({
...defaultProps,
proxyUrl: '/__clerk',
}),
);

expect(html).toContain('src="/__clerk/npm/@clerk/clerk-js@');
expect(html).toContain('href="/__clerk/npm/@clerk/ui@');
expect(html).toContain('data-clerk-proxy-url="/__clerk"');
});
});
34 changes: 34 additions & 0 deletions packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1326,6 +1326,40 @@ describe('frontendApiProxy multi-domain support', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const productionPublishableKey = 'pk_live_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA';

it('auto-intercepts /__clerk/* requests on eligible hostnames', async () => {
const req = new NextRequest(new URL('/__clerk/v1/client', 'https://myapp-abc123.vercel.app').toString(), {
method: 'GET',
headers: new Headers(),
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

// Proxy should intercept the request — authenticateRequest should NOT be called
expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});

it('uses request.nextUrl for auto-detection', async () => {
const req = new NextRequest('http://127.0.0.1:3000/__clerk/v1/client', {
method: 'GET',
headers: new Headers(),
});

Object.defineProperty(req, 'nextUrl', {
value: new URL('https://myapp-abc123.vercel.app/__clerk/v1/client'),
configurable: true,
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});
});

describe('contentSecurityPolicy option', () => {
it('forwards CSP headers as request headers when strict mode is enabled', async () => {
const resp = await clerkMiddleware({
Expand Down
17 changes: 13 additions & 4 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,10 @@ import {
TokenType,
} from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import { parsePublishableKey } from '@clerk/shared/keys';
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 { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -35,7 +36,7 @@ import type { Logger, LoggerNoCommit } from '../utils/debugLogger';
import { withLogger } from '../utils/debugLogger';
import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { errorThrower } from './errorThrower';
import { getHeader } from './headers-utils';
Expand DownExpand Up@@ -161,12 +162,20 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
);

// Handle Frontend API proxy requests early, before authentication
const frontendApiProxyConfig = resolvedParams.frontendApiProxy;
const requestUrl = new URL(request.nextUrl.href);
let frontendApiProxyConfig = resolvedParams.frontendApiProxy;

// 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 (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
}
if (frontendApiProxyConfig) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxyConfig;

// Resolve enabled - either boolean or function
const requestUrl = new URL(request.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(request, { proxyPath })) {
Expand Down
Loading
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
Show all changes
35 commits
Select commit Hold shift + click to select a range
70420c0
feat(shared,backend,clerk-js,nextjs): Auto-proxy for .vercel.app subd…
brkalow Mar 11, 2026
dbc580e
refactor: generalize auto proxy naming
brkalow Mar 13, 2026
2d729d2
chore(repo): add changeset for auto proxy updates
brkalow Mar 13, 2026
72d6bdc
feat(shared,nextjs): support vercel production static auto proxy
brkalow Mar 20, 2026
f8906d3
fix(shared): make proxy helpers server safe
brkalow Mar 20, 2026
217a991
fix(nextjs): use nextUrl for auto proxy detection
brkalow Mar 20, 2026
db5ee3f
fix(shared,nextjs): proxy initial script tags
brkalow Mar 20, 2026
c99aba2
fix(backend): prevent Content-Encoding mismatch in proxy responses
brkalow Mar 20, 2026
aea3966
fix: add Vercel env vars to turbo.json and harden proxy header stripping
brkalow Mar 24, 2026
675270a
refactor(backend): convert RESPONSE_HEADERS_TO_STRIP to a Set
brkalow Mar 31, 2026
24d68e3
merge: resolve conflicts with main
Railly Apr 10, 2026
bdc8436
chore: add changeset for auto-proxy feature
Railly Apr 10, 2026
9a2f6b7
fix(shared): guard shouldAutoProxy against undefined hostname
Railly Apr 10, 2026
b89156d
chore: remove duplicate changeset
Railly Apr 10, 2026
0b6db2b
fix: only auto-proxy for production instances on .vercel.app
Railly Apr 14, 2026
96842db
refactor: export AUTO_PROXY_PATH and replace hardcoded /__clerk
Railly Apr 14, 2026
635c9b7
refactor(nextjs): inline auto-proxy detection in middleware for reada…
Railly Apr 14, 2026
0859708
test(clerk-js): add dev instance guard test, use production key for a…
Railly Apr 14, 2026
67475c6
fix(nextjs): add production-only guard to middleware auto-proxy detec…
Railly Apr 16, 2026
b3e8273
fix(nextjs): hoist requestUrl declaration to fix ReferenceError with …
Railly Apr 16, 2026
66a8ad1
test(backend): fix auto-proxy tests to use pkLive, add dev key negati…
Railly Apr 17, 2026
cba7dfd
fix(backend): document X-Forwarded-Host trust assumption in auto-proxy
Railly Apr 17, 2026
c9c28b0
fix(shared): wrap normalizeHostname URL parsing in try-catch
Railly Apr 17, 2026
2371ab2
refactor: use isProductionFromPublishableKey instead of raw pk_live_ …
Railly Apr 17, 2026
a492681
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 17, 2026
670d2af
fix(nextjs): use production key in middleware auto-proxy tests, resto…
Railly Apr 17, 2026
0024932
style: restore keyless-provider.tsx formatting from main
Railly Apr 17, 2026
174ed67
style: restore UserSettings.ts formatting from main
Railly Apr 20, 2026
a4091ad
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 20, 2026
06bce1d
style: restore merge artifact formatting from main
Railly Apr 20, 2026
4d7c662
chore: remove stale test-signin-provider file
Railly Apr 20, 2026
e0a275d
docs(shared): add comment explaining build-time/runtime dual executio…
Railly Apr 22, 2026
43be86f
refactor(backend): use getAutoProxyUrlFromEnvironment instead of head…
Railly Apr 22, 2026
d7feb1c
fix(backend): remove unused AUTO_PROXY_PATH import
Railly Apr 27, 2026
d0450ed
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/auto-proxy-vercel-subdomains.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/backend': patch
'@clerk/clerk-js': patch
'@clerk/nextjs': patch
---

Auto-proxy FAPI requests for `.vercel.app` subdomains. When deployed to a `.vercel.app` domain without explicit proxy or domain configuration, the SDK automatically routes Frontend API requests through `/__clerk` on the app's own origin. This enables Clerk production mode on Vercel deployments without manual proxy setup.
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,71 @@ describe('AuthenticateContext', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const originalEnv = process.env;

beforeEach(() => {
process.env = {
...originalEnv,
VERCEL_TARGET_ENV: 'production',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp-abc123.vercel.app',
};
});

afterEach(() => {
process.env = originalEnv;
});

it('auto-derives proxyUrl when Vercel env vars indicate production vercel.app', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

it('does NOT auto-derive proxyUrl for development keys', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkTest,
});

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

it('does NOT auto-derive proxyUrl when Vercel env vars are absent', async () => {
delete process.env.VERCEL_TARGET_ENV;
delete process.env.VERCEL_PROJECT_PRODUCTION_URL;
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, {
publishableKey: pkLive,
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});

expect(context.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

it('explicit domain skips auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
domain: 'clerk.myapp.com',
});

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

// Added these tests to verify that the generated sha-1 is the same as the one used in cookie assignment
// Tests copied from packages/shared/src/__tests__/keys.test.ts
describe('getCookieSuffix(publishableKey, subtle)', () => {
Expand Down
13 changes: 13 additions & 0 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
import { getAutoProxyUrlFromEnvironment } from '@clerk/shared/proxy';
import type { Jwt } from '@clerk/shared/types';
import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';

Expand DownExpand Up@@ -70,6 +71,18 @@ class AuthenticateContext implements AuthenticateContext {
private clerkRequest: ClerkRequest,
options: AuthenticateRequestOptions,
) {
// Auto-detect proxy for supported platform deployments using environment
// variables (e.g. VERCEL_TARGET_ENV, VERCEL_PROJECT_PRODUCTION_URL) instead
// of request headers, which avoids X-Forwarded-Host spoofing concerns.
const autoProxyPath = getAutoProxyUrlFromEnvironment({
publishableKey: options.publishableKey ?? '',
hasProxyUrl: !!options.proxyUrl,
hasDomain: !!options.domain,
});
if (autoProxyPath) {
options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}${autoProxyPath}` };
}

if (options.acceptsToken === TokenType.M2MToken || options.acceptsToken === TokenType.ApiKey) {
// For non-session tokens, we only want to set the header values.
this.initHeaderValues();
Expand Down
80 changes: 80 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

NIT: A possible extra test here is to check that it doesn't break when window is not defined (for native envs).

The if (inBrowser()) { already takes care of it, but tests are always nice.

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.

Addressed in 0859708, also updated existing tests to use production key since auto-proxy is now production-only

Original file line numberDiff line numberDiff line change
Expand Up@@ -2516,6 +2516,86 @@ describe('Clerk singleton', () => {
});
});
});

describe('auto-detection for eligible hosts', () => {
const originalLocation = window.location;

afterEach(() => {
Object.defineProperty(window, 'location', {
value: originalLocation,
writable: true,
});
});

test('auto-derives proxyUrl for production instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

test('does NOT auto-derive proxyUrl for development instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(developmentPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('does NOT auto-derive proxyUrl for ineligible domains', () => {
const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('explicit proxyUrl takes precedence over auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});
expect(sut.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

test('explicit domain skips auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
domain: 'clerk.myapp.com',
});
expect(sut.proxyUrl).toBe('');
});
});
});

describe('buildUrlWithAuth', () => {
Expand Down
17 changes: 15 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,13 @@ import { windowNavigate } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { parsePublishableKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { CLERK_NETLIFY_CACHE_BUST_PARAM } from '@clerk/shared/netlifyCacheHandler';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import {
AUTO_PROXY_PATH,
isHttpOrHttps,
isValidProxyUrl,
proxyUrlToAbsoluteURL,
shouldAutoProxy,
} from '@clerk/shared/proxy';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
Expand DownExpand Up@@ -361,7 +367,14 @@ export class Clerk implements ClerkInterface {
if (!isValidProxyUrl(_unfilteredProxy)) {
errorThrower.throwInvalidProxyUrl({ url: _unfilteredProxy });
}
return proxyUrlToAbsoluteURL(_unfilteredProxy);
const resolved = proxyUrlToAbsoluteURL(_unfilteredProxy);
if (resolved) {
return resolved;
}
// Auto-detect when no explicit proxy or domain is configured (production only)
if (!this.#domain && this.#instanceType === 'production' && shouldAutoProxy(window.location.hostname)) {
return `${window.location.origin}${AUTO_PROXY_PATH}`;
}
}

if (typeof this.#proxyUrl === 'function') {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,4 +86,24 @@ describe('DynamicClerkScripts', () => {
expect(html).not.toContain('nonce="test');
expect(html).not.toContain('nonce="csp');
});

it('renders initial script tags with relative proxied asset URLs', async () => {
mockHeaders.mockResolvedValue(
new Map([
['X-Nonce', null],
['Content-Security-Policy', ''],
]),
);

const html = await render(
DynamicClerkScripts({
...defaultProps,
proxyUrl: '/__clerk',
}),
);

expect(html).toContain('src="/__clerk/npm/@clerk/clerk-js@');
expect(html).toContain('href="/__clerk/npm/@clerk/ui@');
expect(html).toContain('data-clerk-proxy-url="/__clerk"');
});
});
34 changes: 34 additions & 0 deletions packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1326,6 +1326,40 @@ describe('frontendApiProxy multi-domain support', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const productionPublishableKey = 'pk_live_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA';

it('auto-intercepts /__clerk/* requests on eligible hostnames', async () => {
const req = new NextRequest(new URL('/__clerk/v1/client', 'https://myapp-abc123.vercel.app').toString(), {
method: 'GET',
headers: new Headers(),
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

// Proxy should intercept the request — authenticateRequest should NOT be called
expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});

it('uses request.nextUrl for auto-detection', async () => {
const req = new NextRequest('http://127.0.0.1:3000/__clerk/v1/client', {
method: 'GET',
headers: new Headers(),
});

Object.defineProperty(req, 'nextUrl', {
value: new URL('https://myapp-abc123.vercel.app/__clerk/v1/client'),
configurable: true,
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});
});

describe('contentSecurityPolicy option', () => {
it('forwards CSP headers as request headers when strict mode is enabled', async () => {
const resp = await clerkMiddleware({
Expand Down
17 changes: 13 additions & 4 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,10 @@ import {
TokenType,
} from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import { parsePublishableKey } from '@clerk/shared/keys';
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 { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -35,7 +36,7 @@ import type { Logger, LoggerNoCommit } from '../utils/debugLogger';
import { withLogger } from '../utils/debugLogger';
import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { errorThrower } from './errorThrower';
import { getHeader } from './headers-utils';
Expand DownExpand Up@@ -161,12 +162,20 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
);

// Handle Frontend API proxy requests early, before authentication
const frontendApiProxyConfig = resolvedParams.frontendApiProxy;
const requestUrl = new URL(request.nextUrl.href);
let frontendApiProxyConfig = resolvedParams.frontendApiProxy;

// 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 (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
}
if (frontendApiProxyConfig) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxyConfig;

// Resolve enabled - either boolean or function
const requestUrl = new URL(request.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(request, { proxyPath })) {
Expand Down
Loading
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
Show all changes
35 commits
Select commit Hold shift + click to select a range
70420c0
feat(shared,backend,clerk-js,nextjs): Auto-proxy for .vercel.app subd…
brkalow Mar 11, 2026
dbc580e
refactor: generalize auto proxy naming
brkalow Mar 13, 2026
2d729d2
chore(repo): add changeset for auto proxy updates
brkalow Mar 13, 2026
72d6bdc
feat(shared,nextjs): support vercel production static auto proxy
brkalow Mar 20, 2026
f8906d3
fix(shared): make proxy helpers server safe
brkalow Mar 20, 2026
217a991
fix(nextjs): use nextUrl for auto proxy detection
brkalow Mar 20, 2026
db5ee3f
fix(shared,nextjs): proxy initial script tags
brkalow Mar 20, 2026
c99aba2
fix(backend): prevent Content-Encoding mismatch in proxy responses
brkalow Mar 20, 2026
aea3966
fix: add Vercel env vars to turbo.json and harden proxy header stripping
brkalow Mar 24, 2026
675270a
refactor(backend): convert RESPONSE_HEADERS_TO_STRIP to a Set
brkalow Mar 31, 2026
24d68e3
merge: resolve conflicts with main
Railly Apr 10, 2026
bdc8436
chore: add changeset for auto-proxy feature
Railly Apr 10, 2026
9a2f6b7
fix(shared): guard shouldAutoProxy against undefined hostname
Railly Apr 10, 2026
b89156d
chore: remove duplicate changeset
Railly Apr 10, 2026
0b6db2b
fix: only auto-proxy for production instances on .vercel.app
Railly Apr 14, 2026
96842db
refactor: export AUTO_PROXY_PATH and replace hardcoded /__clerk
Railly Apr 14, 2026
635c9b7
refactor(nextjs): inline auto-proxy detection in middleware for reada…
Railly Apr 14, 2026
0859708
test(clerk-js): add dev instance guard test, use production key for a…
Railly Apr 14, 2026
67475c6
fix(nextjs): add production-only guard to middleware auto-proxy detec…
Railly Apr 16, 2026
b3e8273
fix(nextjs): hoist requestUrl declaration to fix ReferenceError with …
Railly Apr 16, 2026
66a8ad1
test(backend): fix auto-proxy tests to use pkLive, add dev key negati…
Railly Apr 17, 2026
cba7dfd
fix(backend): document X-Forwarded-Host trust assumption in auto-proxy
Railly Apr 17, 2026
c9c28b0
fix(shared): wrap normalizeHostname URL parsing in try-catch
Railly Apr 17, 2026
2371ab2
refactor: use isProductionFromPublishableKey instead of raw pk_live_ …
Railly Apr 17, 2026
a492681
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 17, 2026
670d2af
fix(nextjs): use production key in middleware auto-proxy tests, resto…
Railly Apr 17, 2026
0024932
style: restore keyless-provider.tsx formatting from main
Railly Apr 17, 2026
174ed67
style: restore UserSettings.ts formatting from main
Railly Apr 20, 2026
a4091ad
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 20, 2026
06bce1d
style: restore merge artifact formatting from main
Railly Apr 20, 2026
4d7c662
chore: remove stale test-signin-provider file
Railly Apr 20, 2026
e0a275d
docs(shared): add comment explaining build-time/runtime dual executio…
Railly Apr 22, 2026
43be86f
refactor(backend): use getAutoProxyUrlFromEnvironment instead of head…
Railly Apr 22, 2026
d7feb1c
fix(backend): remove unused AUTO_PROXY_PATH import
Railly Apr 27, 2026
d0450ed
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/auto-proxy-vercel-subdomains.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/backend': patch
'@clerk/clerk-js': patch
'@clerk/nextjs': patch
---

Auto-proxy FAPI requests for `.vercel.app` subdomains. When deployed to a `.vercel.app` domain without explicit proxy or domain configuration, the SDK automatically routes Frontend API requests through `/__clerk` on the app's own origin. This enables Clerk production mode on Vercel deployments without manual proxy setup.
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,71 @@ describe('AuthenticateContext', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const originalEnv = process.env;

beforeEach(() => {
process.env = {
...originalEnv,
VERCEL_TARGET_ENV: 'production',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp-abc123.vercel.app',
};
});

afterEach(() => {
process.env = originalEnv;
});

it('auto-derives proxyUrl when Vercel env vars indicate production vercel.app', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

it('does NOT auto-derive proxyUrl for development keys', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkTest,
});

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

it('does NOT auto-derive proxyUrl when Vercel env vars are absent', async () => {
delete process.env.VERCEL_TARGET_ENV;
delete process.env.VERCEL_PROJECT_PRODUCTION_URL;
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, {
publishableKey: pkLive,
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});

expect(context.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

it('explicit domain skips auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
domain: 'clerk.myapp.com',
});

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

// Added these tests to verify that the generated sha-1 is the same as the one used in cookie assignment
// Tests copied from packages/shared/src/__tests__/keys.test.ts
describe('getCookieSuffix(publishableKey, subtle)', () => {
Expand Down
13 changes: 13 additions & 0 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
import { getAutoProxyUrlFromEnvironment } from '@clerk/shared/proxy';
import type { Jwt } from '@clerk/shared/types';
import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';

Expand DownExpand Up@@ -70,6 +71,18 @@ class AuthenticateContext implements AuthenticateContext {
private clerkRequest: ClerkRequest,
options: AuthenticateRequestOptions,
) {
// Auto-detect proxy for supported platform deployments using environment
// variables (e.g. VERCEL_TARGET_ENV, VERCEL_PROJECT_PRODUCTION_URL) instead
// of request headers, which avoids X-Forwarded-Host spoofing concerns.
const autoProxyPath = getAutoProxyUrlFromEnvironment({
publishableKey: options.publishableKey ?? '',
hasProxyUrl: !!options.proxyUrl,
hasDomain: !!options.domain,
});
if (autoProxyPath) {
options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}${autoProxyPath}` };
}

if (options.acceptsToken === TokenType.M2MToken || options.acceptsToken === TokenType.ApiKey) {
// For non-session tokens, we only want to set the header values.
this.initHeaderValues();
Expand Down
80 changes: 80 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

NIT: A possible extra test here is to check that it doesn't break when window is not defined (for native envs).

The if (inBrowser()) { already takes care of it, but tests are always nice.

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.

Addressed in 0859708, also updated existing tests to use production key since auto-proxy is now production-only

Original file line numberDiff line numberDiff line change
Expand Up@@ -2516,6 +2516,86 @@ describe('Clerk singleton', () => {
});
});
});

describe('auto-detection for eligible hosts', () => {
const originalLocation = window.location;

afterEach(() => {
Object.defineProperty(window, 'location', {
value: originalLocation,
writable: true,
});
});

test('auto-derives proxyUrl for production instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

test('does NOT auto-derive proxyUrl for development instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(developmentPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('does NOT auto-derive proxyUrl for ineligible domains', () => {
const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('explicit proxyUrl takes precedence over auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});
expect(sut.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

test('explicit domain skips auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
domain: 'clerk.myapp.com',
});
expect(sut.proxyUrl).toBe('');
});
});
});

describe('buildUrlWithAuth', () => {
Expand Down
17 changes: 15 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,13 @@ import { windowNavigate } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { parsePublishableKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { CLERK_NETLIFY_CACHE_BUST_PARAM } from '@clerk/shared/netlifyCacheHandler';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import {
AUTO_PROXY_PATH,
isHttpOrHttps,
isValidProxyUrl,
proxyUrlToAbsoluteURL,
shouldAutoProxy,
} from '@clerk/shared/proxy';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
Expand DownExpand Up@@ -361,7 +367,14 @@ export class Clerk implements ClerkInterface {
if (!isValidProxyUrl(_unfilteredProxy)) {
errorThrower.throwInvalidProxyUrl({ url: _unfilteredProxy });
}
return proxyUrlToAbsoluteURL(_unfilteredProxy);
const resolved = proxyUrlToAbsoluteURL(_unfilteredProxy);
if (resolved) {
return resolved;
}
// Auto-detect when no explicit proxy or domain is configured (production only)
if (!this.#domain && this.#instanceType === 'production' && shouldAutoProxy(window.location.hostname)) {
return `${window.location.origin}${AUTO_PROXY_PATH}`;
}
}

if (typeof this.#proxyUrl === 'function') {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,4 +86,24 @@ describe('DynamicClerkScripts', () => {
expect(html).not.toContain('nonce="test');
expect(html).not.toContain('nonce="csp');
});

it('renders initial script tags with relative proxied asset URLs', async () => {
mockHeaders.mockResolvedValue(
new Map([
['X-Nonce', null],
['Content-Security-Policy', ''],
]),
);

const html = await render(
DynamicClerkScripts({
...defaultProps,
proxyUrl: '/__clerk',
}),
);

expect(html).toContain('src="/__clerk/npm/@clerk/clerk-js@');
expect(html).toContain('href="/__clerk/npm/@clerk/ui@');
expect(html).toContain('data-clerk-proxy-url="/__clerk"');
});
});
34 changes: 34 additions & 0 deletions packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1326,6 +1326,40 @@ describe('frontendApiProxy multi-domain support', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const productionPublishableKey = 'pk_live_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA';

it('auto-intercepts /__clerk/* requests on eligible hostnames', async () => {
const req = new NextRequest(new URL('/__clerk/v1/client', 'https://myapp-abc123.vercel.app').toString(), {
method: 'GET',
headers: new Headers(),
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

// Proxy should intercept the request — authenticateRequest should NOT be called
expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});

it('uses request.nextUrl for auto-detection', async () => {
const req = new NextRequest('http://127.0.0.1:3000/__clerk/v1/client', {
method: 'GET',
headers: new Headers(),
});

Object.defineProperty(req, 'nextUrl', {
value: new URL('https://myapp-abc123.vercel.app/__clerk/v1/client'),
configurable: true,
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});
});

describe('contentSecurityPolicy option', () => {
it('forwards CSP headers as request headers when strict mode is enabled', async () => {
const resp = await clerkMiddleware({
Expand Down
17 changes: 13 additions & 4 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,10 @@ import {
TokenType,
} from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import { parsePublishableKey } from '@clerk/shared/keys';
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 { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -35,7 +36,7 @@ import type { Logger, LoggerNoCommit } from '../utils/debugLogger';
import { withLogger } from '../utils/debugLogger';
import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { errorThrower } from './errorThrower';
import { getHeader } from './headers-utils';
Expand DownExpand Up@@ -161,12 +162,20 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
);

// Handle Frontend API proxy requests early, before authentication
const frontendApiProxyConfig = resolvedParams.frontendApiProxy;
const requestUrl = new URL(request.nextUrl.href);
let frontendApiProxyConfig = resolvedParams.frontendApiProxy;

// 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 (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
}
if (frontendApiProxyConfig) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxyConfig;

// Resolve enabled - either boolean or function
const requestUrl = new URL(request.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(request, { proxyPath })) {
Expand Down
Loading
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
Show all changes
35 commits
Select commit Hold shift + click to select a range
70420c0
feat(shared,backend,clerk-js,nextjs): Auto-proxy for .vercel.app subd…
brkalow Mar 11, 2026
dbc580e
refactor: generalize auto proxy naming
brkalow Mar 13, 2026
2d729d2
chore(repo): add changeset for auto proxy updates
brkalow Mar 13, 2026
72d6bdc
feat(shared,nextjs): support vercel production static auto proxy
brkalow Mar 20, 2026
f8906d3
fix(shared): make proxy helpers server safe
brkalow Mar 20, 2026
217a991
fix(nextjs): use nextUrl for auto proxy detection
brkalow Mar 20, 2026
db5ee3f
fix(shared,nextjs): proxy initial script tags
brkalow Mar 20, 2026
c99aba2
fix(backend): prevent Content-Encoding mismatch in proxy responses
brkalow Mar 20, 2026
aea3966
fix: add Vercel env vars to turbo.json and harden proxy header stripping
brkalow Mar 24, 2026
675270a
refactor(backend): convert RESPONSE_HEADERS_TO_STRIP to a Set
brkalow Mar 31, 2026
24d68e3
merge: resolve conflicts with main
Railly Apr 10, 2026
bdc8436
chore: add changeset for auto-proxy feature
Railly Apr 10, 2026
9a2f6b7
fix(shared): guard shouldAutoProxy against undefined hostname
Railly Apr 10, 2026
b89156d
chore: remove duplicate changeset
Railly Apr 10, 2026
0b6db2b
fix: only auto-proxy for production instances on .vercel.app
Railly Apr 14, 2026
96842db
refactor: export AUTO_PROXY_PATH and replace hardcoded /__clerk
Railly Apr 14, 2026
635c9b7
refactor(nextjs): inline auto-proxy detection in middleware for reada…
Railly Apr 14, 2026
0859708
test(clerk-js): add dev instance guard test, use production key for a…
Railly Apr 14, 2026
67475c6
fix(nextjs): add production-only guard to middleware auto-proxy detec…
Railly Apr 16, 2026
b3e8273
fix(nextjs): hoist requestUrl declaration to fix ReferenceError with …
Railly Apr 16, 2026
66a8ad1
test(backend): fix auto-proxy tests to use pkLive, add dev key negati…
Railly Apr 17, 2026
cba7dfd
fix(backend): document X-Forwarded-Host trust assumption in auto-proxy
Railly Apr 17, 2026
c9c28b0
fix(shared): wrap normalizeHostname URL parsing in try-catch
Railly Apr 17, 2026
2371ab2
refactor: use isProductionFromPublishableKey instead of raw pk_live_ …
Railly Apr 17, 2026
a492681
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 17, 2026
670d2af
fix(nextjs): use production key in middleware auto-proxy tests, resto…
Railly Apr 17, 2026
0024932
style: restore keyless-provider.tsx formatting from main
Railly Apr 17, 2026
174ed67
style: restore UserSettings.ts formatting from main
Railly Apr 20, 2026
a4091ad
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 20, 2026
06bce1d
style: restore merge artifact formatting from main
Railly Apr 20, 2026
4d7c662
chore: remove stale test-signin-provider file
Railly Apr 20, 2026
e0a275d
docs(shared): add comment explaining build-time/runtime dual executio…
Railly Apr 22, 2026
43be86f
refactor(backend): use getAutoProxyUrlFromEnvironment instead of head…
Railly Apr 22, 2026
d7feb1c
fix(backend): remove unused AUTO_PROXY_PATH import
Railly Apr 27, 2026
d0450ed
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/auto-proxy-vercel-subdomains.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/backend': patch
'@clerk/clerk-js': patch
'@clerk/nextjs': patch
---

Auto-proxy FAPI requests for `.vercel.app` subdomains. When deployed to a `.vercel.app` domain without explicit proxy or domain configuration, the SDK automatically routes Frontend API requests through `/__clerk` on the app's own origin. This enables Clerk production mode on Vercel deployments without manual proxy setup.
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,71 @@ describe('AuthenticateContext', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const originalEnv = process.env;

beforeEach(() => {
process.env = {
...originalEnv,
VERCEL_TARGET_ENV: 'production',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp-abc123.vercel.app',
};
});

afterEach(() => {
process.env = originalEnv;
});

it('auto-derives proxyUrl when Vercel env vars indicate production vercel.app', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

it('does NOT auto-derive proxyUrl for development keys', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkTest,
});

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

it('does NOT auto-derive proxyUrl when Vercel env vars are absent', async () => {
delete process.env.VERCEL_TARGET_ENV;
delete process.env.VERCEL_PROJECT_PRODUCTION_URL;
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, {
publishableKey: pkLive,
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});

expect(context.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

it('explicit domain skips auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
domain: 'clerk.myapp.com',
});

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

// Added these tests to verify that the generated sha-1 is the same as the one used in cookie assignment
// Tests copied from packages/shared/src/__tests__/keys.test.ts
describe('getCookieSuffix(publishableKey, subtle)', () => {
Expand Down
13 changes: 13 additions & 0 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
import { getAutoProxyUrlFromEnvironment } from '@clerk/shared/proxy';
import type { Jwt } from '@clerk/shared/types';
import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';

Expand DownExpand Up@@ -70,6 +71,18 @@ class AuthenticateContext implements AuthenticateContext {
private clerkRequest: ClerkRequest,
options: AuthenticateRequestOptions,
) {
// Auto-detect proxy for supported platform deployments using environment
// variables (e.g. VERCEL_TARGET_ENV, VERCEL_PROJECT_PRODUCTION_URL) instead
// of request headers, which avoids X-Forwarded-Host spoofing concerns.
const autoProxyPath = getAutoProxyUrlFromEnvironment({
publishableKey: options.publishableKey ?? '',
hasProxyUrl: !!options.proxyUrl,
hasDomain: !!options.domain,
});
if (autoProxyPath) {
options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}${autoProxyPath}` };
}

if (options.acceptsToken === TokenType.M2MToken || options.acceptsToken === TokenType.ApiKey) {
// For non-session tokens, we only want to set the header values.
this.initHeaderValues();
Expand Down
80 changes: 80 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

NIT: A possible extra test here is to check that it doesn't break when window is not defined (for native envs).

The if (inBrowser()) { already takes care of it, but tests are always nice.

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.

Addressed in 0859708, also updated existing tests to use production key since auto-proxy is now production-only

Original file line numberDiff line numberDiff line change
Expand Up@@ -2516,6 +2516,86 @@ describe('Clerk singleton', () => {
});
});
});

describe('auto-detection for eligible hosts', () => {
const originalLocation = window.location;

afterEach(() => {
Object.defineProperty(window, 'location', {
value: originalLocation,
writable: true,
});
});

test('auto-derives proxyUrl for production instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

test('does NOT auto-derive proxyUrl for development instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(developmentPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('does NOT auto-derive proxyUrl for ineligible domains', () => {
const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('explicit proxyUrl takes precedence over auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});
expect(sut.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

test('explicit domain skips auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
domain: 'clerk.myapp.com',
});
expect(sut.proxyUrl).toBe('');
});
});
});

describe('buildUrlWithAuth', () => {
Expand Down
17 changes: 15 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,13 @@ import { windowNavigate } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { parsePublishableKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { CLERK_NETLIFY_CACHE_BUST_PARAM } from '@clerk/shared/netlifyCacheHandler';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import {
AUTO_PROXY_PATH,
isHttpOrHttps,
isValidProxyUrl,
proxyUrlToAbsoluteURL,
shouldAutoProxy,
} from '@clerk/shared/proxy';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
Expand DownExpand Up@@ -361,7 +367,14 @@ export class Clerk implements ClerkInterface {
if (!isValidProxyUrl(_unfilteredProxy)) {
errorThrower.throwInvalidProxyUrl({ url: _unfilteredProxy });
}
return proxyUrlToAbsoluteURL(_unfilteredProxy);
const resolved = proxyUrlToAbsoluteURL(_unfilteredProxy);
if (resolved) {
return resolved;
}
// Auto-detect when no explicit proxy or domain is configured (production only)
if (!this.#domain && this.#instanceType === 'production' && shouldAutoProxy(window.location.hostname)) {
return `${window.location.origin}${AUTO_PROXY_PATH}`;
}
}

if (typeof this.#proxyUrl === 'function') {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,4 +86,24 @@ describe('DynamicClerkScripts', () => {
expect(html).not.toContain('nonce="test');
expect(html).not.toContain('nonce="csp');
});

it('renders initial script tags with relative proxied asset URLs', async () => {
mockHeaders.mockResolvedValue(
new Map([
['X-Nonce', null],
['Content-Security-Policy', ''],
]),
);

const html = await render(
DynamicClerkScripts({
...defaultProps,
proxyUrl: '/__clerk',
}),
);

expect(html).toContain('src="/__clerk/npm/@clerk/clerk-js@');
expect(html).toContain('href="/__clerk/npm/@clerk/ui@');
expect(html).toContain('data-clerk-proxy-url="/__clerk"');
});
});
34 changes: 34 additions & 0 deletions packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1326,6 +1326,40 @@ describe('frontendApiProxy multi-domain support', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const productionPublishableKey = 'pk_live_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA';

it('auto-intercepts /__clerk/* requests on eligible hostnames', async () => {
const req = new NextRequest(new URL('/__clerk/v1/client', 'https://myapp-abc123.vercel.app').toString(), {
method: 'GET',
headers: new Headers(),
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

// Proxy should intercept the request — authenticateRequest should NOT be called
expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});

it('uses request.nextUrl for auto-detection', async () => {
const req = new NextRequest('http://127.0.0.1:3000/__clerk/v1/client', {
method: 'GET',
headers: new Headers(),
});

Object.defineProperty(req, 'nextUrl', {
value: new URL('https://myapp-abc123.vercel.app/__clerk/v1/client'),
configurable: true,
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});
});

describe('contentSecurityPolicy option', () => {
it('forwards CSP headers as request headers when strict mode is enabled', async () => {
const resp = await clerkMiddleware({
Expand Down
17 changes: 13 additions & 4 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,10 @@ import {
TokenType,
} from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import { parsePublishableKey } from '@clerk/shared/keys';
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 { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -35,7 +36,7 @@ import type { Logger, LoggerNoCommit } from '../utils/debugLogger';
import { withLogger } from '../utils/debugLogger';
import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { errorThrower } from './errorThrower';
import { getHeader } from './headers-utils';
Expand DownExpand Up@@ -161,12 +162,20 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
);

// Handle Frontend API proxy requests early, before authentication
const frontendApiProxyConfig = resolvedParams.frontendApiProxy;
const requestUrl = new URL(request.nextUrl.href);
let frontendApiProxyConfig = resolvedParams.frontendApiProxy;

// 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 (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
}
if (frontendApiProxyConfig) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxyConfig;

// Resolve enabled - either boolean or function
const requestUrl = new URL(request.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(request, { proxyPath })) {
Expand Down
Loading
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
Show all changes
35 commits
Select commit Hold shift + click to select a range
70420c0
feat(shared,backend,clerk-js,nextjs): Auto-proxy for .vercel.app subd…
brkalow Mar 11, 2026
dbc580e
refactor: generalize auto proxy naming
brkalow Mar 13, 2026
2d729d2
chore(repo): add changeset for auto proxy updates
brkalow Mar 13, 2026
72d6bdc
feat(shared,nextjs): support vercel production static auto proxy
brkalow Mar 20, 2026
f8906d3
fix(shared): make proxy helpers server safe
brkalow Mar 20, 2026
217a991
fix(nextjs): use nextUrl for auto proxy detection
brkalow Mar 20, 2026
db5ee3f
fix(shared,nextjs): proxy initial script tags
brkalow Mar 20, 2026
c99aba2
fix(backend): prevent Content-Encoding mismatch in proxy responses
brkalow Mar 20, 2026
aea3966
fix: add Vercel env vars to turbo.json and harden proxy header stripping
brkalow Mar 24, 2026
675270a
refactor(backend): convert RESPONSE_HEADERS_TO_STRIP to a Set
brkalow Mar 31, 2026
24d68e3
merge: resolve conflicts with main
Railly Apr 10, 2026
bdc8436
chore: add changeset for auto-proxy feature
Railly Apr 10, 2026
9a2f6b7
fix(shared): guard shouldAutoProxy against undefined hostname
Railly Apr 10, 2026
b89156d
chore: remove duplicate changeset
Railly Apr 10, 2026
0b6db2b
fix: only auto-proxy for production instances on .vercel.app
Railly Apr 14, 2026
96842db
refactor: export AUTO_PROXY_PATH and replace hardcoded /__clerk
Railly Apr 14, 2026
635c9b7
refactor(nextjs): inline auto-proxy detection in middleware for reada…
Railly Apr 14, 2026
0859708
test(clerk-js): add dev instance guard test, use production key for a…
Railly Apr 14, 2026
67475c6
fix(nextjs): add production-only guard to middleware auto-proxy detec…
Railly Apr 16, 2026
b3e8273
fix(nextjs): hoist requestUrl declaration to fix ReferenceError with …
Railly Apr 16, 2026
66a8ad1
test(backend): fix auto-proxy tests to use pkLive, add dev key negati…
Railly Apr 17, 2026
cba7dfd
fix(backend): document X-Forwarded-Host trust assumption in auto-proxy
Railly Apr 17, 2026
c9c28b0
fix(shared): wrap normalizeHostname URL parsing in try-catch
Railly Apr 17, 2026
2371ab2
refactor: use isProductionFromPublishableKey instead of raw pk_live_ …
Railly Apr 17, 2026
a492681
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 17, 2026
670d2af
fix(nextjs): use production key in middleware auto-proxy tests, resto…
Railly Apr 17, 2026
0024932
style: restore keyless-provider.tsx formatting from main
Railly Apr 17, 2026
174ed67
style: restore UserSettings.ts formatting from main
Railly Apr 20, 2026
a4091ad
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 20, 2026
06bce1d
style: restore merge artifact formatting from main
Railly Apr 20, 2026
4d7c662
chore: remove stale test-signin-provider file
Railly Apr 20, 2026
e0a275d
docs(shared): add comment explaining build-time/runtime dual executio…
Railly Apr 22, 2026
43be86f
refactor(backend): use getAutoProxyUrlFromEnvironment instead of head…
Railly Apr 22, 2026
d7feb1c
fix(backend): remove unused AUTO_PROXY_PATH import
Railly Apr 27, 2026
d0450ed
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/auto-proxy-vercel-subdomains.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/backend': patch
'@clerk/clerk-js': patch
'@clerk/nextjs': patch
---

Auto-proxy FAPI requests for `.vercel.app` subdomains. When deployed to a `.vercel.app` domain without explicit proxy or domain configuration, the SDK automatically routes Frontend API requests through `/__clerk` on the app's own origin. This enables Clerk production mode on Vercel deployments without manual proxy setup.
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,71 @@ describe('AuthenticateContext', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const originalEnv = process.env;

beforeEach(() => {
process.env = {
...originalEnv,
VERCEL_TARGET_ENV: 'production',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp-abc123.vercel.app',
};
});

afterEach(() => {
process.env = originalEnv;
});

it('auto-derives proxyUrl when Vercel env vars indicate production vercel.app', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

it('does NOT auto-derive proxyUrl for development keys', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkTest,
});

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

it('does NOT auto-derive proxyUrl when Vercel env vars are absent', async () => {
delete process.env.VERCEL_TARGET_ENV;
delete process.env.VERCEL_PROJECT_PRODUCTION_URL;
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, {
publishableKey: pkLive,
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});

expect(context.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

it('explicit domain skips auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
domain: 'clerk.myapp.com',
});

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

// Added these tests to verify that the generated sha-1 is the same as the one used in cookie assignment
// Tests copied from packages/shared/src/__tests__/keys.test.ts
describe('getCookieSuffix(publishableKey, subtle)', () => {
Expand Down
13 changes: 13 additions & 0 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
import { getAutoProxyUrlFromEnvironment } from '@clerk/shared/proxy';
import type { Jwt } from '@clerk/shared/types';
import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';

Expand DownExpand Up@@ -70,6 +71,18 @@ class AuthenticateContext implements AuthenticateContext {
private clerkRequest: ClerkRequest,
options: AuthenticateRequestOptions,
) {
// Auto-detect proxy for supported platform deployments using environment
// variables (e.g. VERCEL_TARGET_ENV, VERCEL_PROJECT_PRODUCTION_URL) instead
// of request headers, which avoids X-Forwarded-Host spoofing concerns.
const autoProxyPath = getAutoProxyUrlFromEnvironment({
publishableKey: options.publishableKey ?? '',
hasProxyUrl: !!options.proxyUrl,
hasDomain: !!options.domain,
});
if (autoProxyPath) {
options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}${autoProxyPath}` };
}

if (options.acceptsToken === TokenType.M2MToken || options.acceptsToken === TokenType.ApiKey) {
// For non-session tokens, we only want to set the header values.
this.initHeaderValues();
Expand Down
80 changes: 80 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

NIT: A possible extra test here is to check that it doesn't break when window is not defined (for native envs).

The if (inBrowser()) { already takes care of it, but tests are always nice.

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.

Addressed in 0859708, also updated existing tests to use production key since auto-proxy is now production-only

Original file line numberDiff line numberDiff line change
Expand Up@@ -2516,6 +2516,86 @@ describe('Clerk singleton', () => {
});
});
});

describe('auto-detection for eligible hosts', () => {
const originalLocation = window.location;

afterEach(() => {
Object.defineProperty(window, 'location', {
value: originalLocation,
writable: true,
});
});

test('auto-derives proxyUrl for production instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

test('does NOT auto-derive proxyUrl for development instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(developmentPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('does NOT auto-derive proxyUrl for ineligible domains', () => {
const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('explicit proxyUrl takes precedence over auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});
expect(sut.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

test('explicit domain skips auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
domain: 'clerk.myapp.com',
});
expect(sut.proxyUrl).toBe('');
});
});
});

describe('buildUrlWithAuth', () => {
Expand Down
17 changes: 15 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,13 @@ import { windowNavigate } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { parsePublishableKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { CLERK_NETLIFY_CACHE_BUST_PARAM } from '@clerk/shared/netlifyCacheHandler';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import {
AUTO_PROXY_PATH,
isHttpOrHttps,
isValidProxyUrl,
proxyUrlToAbsoluteURL,
shouldAutoProxy,
} from '@clerk/shared/proxy';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
Expand DownExpand Up@@ -361,7 +367,14 @@ export class Clerk implements ClerkInterface {
if (!isValidProxyUrl(_unfilteredProxy)) {
errorThrower.throwInvalidProxyUrl({ url: _unfilteredProxy });
}
return proxyUrlToAbsoluteURL(_unfilteredProxy);
const resolved = proxyUrlToAbsoluteURL(_unfilteredProxy);
if (resolved) {
return resolved;
}
// Auto-detect when no explicit proxy or domain is configured (production only)
if (!this.#domain && this.#instanceType === 'production' && shouldAutoProxy(window.location.hostname)) {
return `${window.location.origin}${AUTO_PROXY_PATH}`;
}
}

if (typeof this.#proxyUrl === 'function') {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,4 +86,24 @@ describe('DynamicClerkScripts', () => {
expect(html).not.toContain('nonce="test');
expect(html).not.toContain('nonce="csp');
});

it('renders initial script tags with relative proxied asset URLs', async () => {
mockHeaders.mockResolvedValue(
new Map([
['X-Nonce', null],
['Content-Security-Policy', ''],
]),
);

const html = await render(
DynamicClerkScripts({
...defaultProps,
proxyUrl: '/__clerk',
}),
);

expect(html).toContain('src="/__clerk/npm/@clerk/clerk-js@');
expect(html).toContain('href="/__clerk/npm/@clerk/ui@');
expect(html).toContain('data-clerk-proxy-url="/__clerk"');
});
});
34 changes: 34 additions & 0 deletions packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1326,6 +1326,40 @@ describe('frontendApiProxy multi-domain support', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const productionPublishableKey = 'pk_live_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA';

it('auto-intercepts /__clerk/* requests on eligible hostnames', async () => {
const req = new NextRequest(new URL('/__clerk/v1/client', 'https://myapp-abc123.vercel.app').toString(), {
method: 'GET',
headers: new Headers(),
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

// Proxy should intercept the request — authenticateRequest should NOT be called
expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});

it('uses request.nextUrl for auto-detection', async () => {
const req = new NextRequest('http://127.0.0.1:3000/__clerk/v1/client', {
method: 'GET',
headers: new Headers(),
});

Object.defineProperty(req, 'nextUrl', {
value: new URL('https://myapp-abc123.vercel.app/__clerk/v1/client'),
configurable: true,
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});
});

describe('contentSecurityPolicy option', () => {
it('forwards CSP headers as request headers when strict mode is enabled', async () => {
const resp = await clerkMiddleware({
Expand Down
17 changes: 13 additions & 4 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,10 @@ import {
TokenType,
} from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import { parsePublishableKey } from '@clerk/shared/keys';
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 { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -35,7 +36,7 @@ import type { Logger, LoggerNoCommit } from '../utils/debugLogger';
import { withLogger } from '../utils/debugLogger';
import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { errorThrower } from './errorThrower';
import { getHeader } from './headers-utils';
Expand DownExpand Up@@ -161,12 +162,20 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
);

// Handle Frontend API proxy requests early, before authentication
const frontendApiProxyConfig = resolvedParams.frontendApiProxy;
const requestUrl = new URL(request.nextUrl.href);
let frontendApiProxyConfig = resolvedParams.frontendApiProxy;

// 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 (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
}
if (frontendApiProxyConfig) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxyConfig;

// Resolve enabled - either boolean or function
const requestUrl = new URL(request.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(request, { proxyPath })) {
Expand Down
Loading
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
Show all changes
35 commits
Select commit Hold shift + click to select a range
70420c0
feat(shared,backend,clerk-js,nextjs): Auto-proxy for .vercel.app subd…
brkalow Mar 11, 2026
dbc580e
refactor: generalize auto proxy naming
brkalow Mar 13, 2026
2d729d2
chore(repo): add changeset for auto proxy updates
brkalow Mar 13, 2026
72d6bdc
feat(shared,nextjs): support vercel production static auto proxy
brkalow Mar 20, 2026
f8906d3
fix(shared): make proxy helpers server safe
brkalow Mar 20, 2026
217a991
fix(nextjs): use nextUrl for auto proxy detection
brkalow Mar 20, 2026
db5ee3f
fix(shared,nextjs): proxy initial script tags
brkalow Mar 20, 2026
c99aba2
fix(backend): prevent Content-Encoding mismatch in proxy responses
brkalow Mar 20, 2026
aea3966
fix: add Vercel env vars to turbo.json and harden proxy header stripping
brkalow Mar 24, 2026
675270a
refactor(backend): convert RESPONSE_HEADERS_TO_STRIP to a Set
brkalow Mar 31, 2026
24d68e3
merge: resolve conflicts with main
Railly Apr 10, 2026
bdc8436
chore: add changeset for auto-proxy feature
Railly Apr 10, 2026
9a2f6b7
fix(shared): guard shouldAutoProxy against undefined hostname
Railly Apr 10, 2026
b89156d
chore: remove duplicate changeset
Railly Apr 10, 2026
0b6db2b
fix: only auto-proxy for production instances on .vercel.app
Railly Apr 14, 2026
96842db
refactor: export AUTO_PROXY_PATH and replace hardcoded /__clerk
Railly Apr 14, 2026
635c9b7
refactor(nextjs): inline auto-proxy detection in middleware for reada…
Railly Apr 14, 2026
0859708
test(clerk-js): add dev instance guard test, use production key for a…
Railly Apr 14, 2026
67475c6
fix(nextjs): add production-only guard to middleware auto-proxy detec…
Railly Apr 16, 2026
b3e8273
fix(nextjs): hoist requestUrl declaration to fix ReferenceError with …
Railly Apr 16, 2026
66a8ad1
test(backend): fix auto-proxy tests to use pkLive, add dev key negati…
Railly Apr 17, 2026
cba7dfd
fix(backend): document X-Forwarded-Host trust assumption in auto-proxy
Railly Apr 17, 2026
c9c28b0
fix(shared): wrap normalizeHostname URL parsing in try-catch
Railly Apr 17, 2026
2371ab2
refactor: use isProductionFromPublishableKey instead of raw pk_live_ …
Railly Apr 17, 2026
a492681
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 17, 2026
670d2af
fix(nextjs): use production key in middleware auto-proxy tests, resto…
Railly Apr 17, 2026
0024932
style: restore keyless-provider.tsx formatting from main
Railly Apr 17, 2026
174ed67
style: restore UserSettings.ts formatting from main
Railly Apr 20, 2026
a4091ad
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 20, 2026
06bce1d
style: restore merge artifact formatting from main
Railly Apr 20, 2026
4d7c662
chore: remove stale test-signin-provider file
Railly Apr 20, 2026
e0a275d
docs(shared): add comment explaining build-time/runtime dual executio…
Railly Apr 22, 2026
43be86f
refactor(backend): use getAutoProxyUrlFromEnvironment instead of head…
Railly Apr 22, 2026
d7feb1c
fix(backend): remove unused AUTO_PROXY_PATH import
Railly Apr 27, 2026
d0450ed
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/auto-proxy-vercel-subdomains.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/backend': patch
'@clerk/clerk-js': patch
'@clerk/nextjs': patch
---

Auto-proxy FAPI requests for `.vercel.app` subdomains. When deployed to a `.vercel.app` domain without explicit proxy or domain configuration, the SDK automatically routes Frontend API requests through `/__clerk` on the app's own origin. This enables Clerk production mode on Vercel deployments without manual proxy setup.
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,71 @@ describe('AuthenticateContext', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const originalEnv = process.env;

beforeEach(() => {
process.env = {
...originalEnv,
VERCEL_TARGET_ENV: 'production',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp-abc123.vercel.app',
};
});

afterEach(() => {
process.env = originalEnv;
});

it('auto-derives proxyUrl when Vercel env vars indicate production vercel.app', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

it('does NOT auto-derive proxyUrl for development keys', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkTest,
});

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

it('does NOT auto-derive proxyUrl when Vercel env vars are absent', async () => {
delete process.env.VERCEL_TARGET_ENV;
delete process.env.VERCEL_PROJECT_PRODUCTION_URL;
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, {
publishableKey: pkLive,
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});

expect(context.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

it('explicit domain skips auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
domain: 'clerk.myapp.com',
});

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

// Added these tests to verify that the generated sha-1 is the same as the one used in cookie assignment
// Tests copied from packages/shared/src/__tests__/keys.test.ts
describe('getCookieSuffix(publishableKey, subtle)', () => {
Expand Down
13 changes: 13 additions & 0 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
import { getAutoProxyUrlFromEnvironment } from '@clerk/shared/proxy';
import type { Jwt } from '@clerk/shared/types';
import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';

Expand DownExpand Up@@ -70,6 +71,18 @@ class AuthenticateContext implements AuthenticateContext {
private clerkRequest: ClerkRequest,
options: AuthenticateRequestOptions,
) {
// Auto-detect proxy for supported platform deployments using environment
// variables (e.g. VERCEL_TARGET_ENV, VERCEL_PROJECT_PRODUCTION_URL) instead
// of request headers, which avoids X-Forwarded-Host spoofing concerns.
const autoProxyPath = getAutoProxyUrlFromEnvironment({
publishableKey: options.publishableKey ?? '',
hasProxyUrl: !!options.proxyUrl,
hasDomain: !!options.domain,
});
if (autoProxyPath) {
options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}${autoProxyPath}` };
}

if (options.acceptsToken === TokenType.M2MToken || options.acceptsToken === TokenType.ApiKey) {
// For non-session tokens, we only want to set the header values.
this.initHeaderValues();
Expand Down
80 changes: 80 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

NIT: A possible extra test here is to check that it doesn't break when window is not defined (for native envs).

The if (inBrowser()) { already takes care of it, but tests are always nice.

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.

Addressed in 0859708, also updated existing tests to use production key since auto-proxy is now production-only

Original file line numberDiff line numberDiff line change
Expand Up@@ -2516,6 +2516,86 @@ describe('Clerk singleton', () => {
});
});
});

describe('auto-detection for eligible hosts', () => {
const originalLocation = window.location;

afterEach(() => {
Object.defineProperty(window, 'location', {
value: originalLocation,
writable: true,
});
});

test('auto-derives proxyUrl for production instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

test('does NOT auto-derive proxyUrl for development instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(developmentPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('does NOT auto-derive proxyUrl for ineligible domains', () => {
const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('explicit proxyUrl takes precedence over auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});
expect(sut.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

test('explicit domain skips auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
domain: 'clerk.myapp.com',
});
expect(sut.proxyUrl).toBe('');
});
});
});

describe('buildUrlWithAuth', () => {
Expand Down
17 changes: 15 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,13 @@ import { windowNavigate } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { parsePublishableKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { CLERK_NETLIFY_CACHE_BUST_PARAM } from '@clerk/shared/netlifyCacheHandler';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import {
AUTO_PROXY_PATH,
isHttpOrHttps,
isValidProxyUrl,
proxyUrlToAbsoluteURL,
shouldAutoProxy,
} from '@clerk/shared/proxy';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
Expand DownExpand Up@@ -361,7 +367,14 @@ export class Clerk implements ClerkInterface {
if (!isValidProxyUrl(_unfilteredProxy)) {
errorThrower.throwInvalidProxyUrl({ url: _unfilteredProxy });
}
return proxyUrlToAbsoluteURL(_unfilteredProxy);
const resolved = proxyUrlToAbsoluteURL(_unfilteredProxy);
if (resolved) {
return resolved;
}
// Auto-detect when no explicit proxy or domain is configured (production only)
if (!this.#domain && this.#instanceType === 'production' && shouldAutoProxy(window.location.hostname)) {
return `${window.location.origin}${AUTO_PROXY_PATH}`;
}
}

if (typeof this.#proxyUrl === 'function') {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,4 +86,24 @@ describe('DynamicClerkScripts', () => {
expect(html).not.toContain('nonce="test');
expect(html).not.toContain('nonce="csp');
});

it('renders initial script tags with relative proxied asset URLs', async () => {
mockHeaders.mockResolvedValue(
new Map([
['X-Nonce', null],
['Content-Security-Policy', ''],
]),
);

const html = await render(
DynamicClerkScripts({
...defaultProps,
proxyUrl: '/__clerk',
}),
);

expect(html).toContain('src="/__clerk/npm/@clerk/clerk-js@');
expect(html).toContain('href="/__clerk/npm/@clerk/ui@');
expect(html).toContain('data-clerk-proxy-url="/__clerk"');
});
});
34 changes: 34 additions & 0 deletions packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1326,6 +1326,40 @@ describe('frontendApiProxy multi-domain support', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const productionPublishableKey = 'pk_live_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA';

it('auto-intercepts /__clerk/* requests on eligible hostnames', async () => {
const req = new NextRequest(new URL('/__clerk/v1/client', 'https://myapp-abc123.vercel.app').toString(), {
method: 'GET',
headers: new Headers(),
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

// Proxy should intercept the request — authenticateRequest should NOT be called
expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});

it('uses request.nextUrl for auto-detection', async () => {
const req = new NextRequest('http://127.0.0.1:3000/__clerk/v1/client', {
method: 'GET',
headers: new Headers(),
});

Object.defineProperty(req, 'nextUrl', {
value: new URL('https://myapp-abc123.vercel.app/__clerk/v1/client'),
configurable: true,
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});
});

describe('contentSecurityPolicy option', () => {
it('forwards CSP headers as request headers when strict mode is enabled', async () => {
const resp = await clerkMiddleware({
Expand Down
17 changes: 13 additions & 4 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,10 @@ import {
TokenType,
} from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import { parsePublishableKey } from '@clerk/shared/keys';
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 { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -35,7 +36,7 @@ import type { Logger, LoggerNoCommit } from '../utils/debugLogger';
import { withLogger } from '../utils/debugLogger';
import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { errorThrower } from './errorThrower';
import { getHeader } from './headers-utils';
Expand DownExpand Up@@ -161,12 +162,20 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
);

// Handle Frontend API proxy requests early, before authentication
const frontendApiProxyConfig = resolvedParams.frontendApiProxy;
const requestUrl = new URL(request.nextUrl.href);
let frontendApiProxyConfig = resolvedParams.frontendApiProxy;

// 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 (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
}
if (frontendApiProxyConfig) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxyConfig;

// Resolve enabled - either boolean or function
const requestUrl = new URL(request.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(request, { proxyPath })) {
Expand Down
Loading
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
Show all changes
35 commits
Select commit Hold shift + click to select a range
70420c0
feat(shared,backend,clerk-js,nextjs): Auto-proxy for .vercel.app subd…
brkalow Mar 11, 2026
dbc580e
refactor: generalize auto proxy naming
brkalow Mar 13, 2026
2d729d2
chore(repo): add changeset for auto proxy updates
brkalow Mar 13, 2026
72d6bdc
feat(shared,nextjs): support vercel production static auto proxy
brkalow Mar 20, 2026
f8906d3
fix(shared): make proxy helpers server safe
brkalow Mar 20, 2026
217a991
fix(nextjs): use nextUrl for auto proxy detection
brkalow Mar 20, 2026
db5ee3f
fix(shared,nextjs): proxy initial script tags
brkalow Mar 20, 2026
c99aba2
fix(backend): prevent Content-Encoding mismatch in proxy responses
brkalow Mar 20, 2026
aea3966
fix: add Vercel env vars to turbo.json and harden proxy header stripping
brkalow Mar 24, 2026
675270a
refactor(backend): convert RESPONSE_HEADERS_TO_STRIP to a Set
brkalow Mar 31, 2026
24d68e3
merge: resolve conflicts with main
Railly Apr 10, 2026
bdc8436
chore: add changeset for auto-proxy feature
Railly Apr 10, 2026
9a2f6b7
fix(shared): guard shouldAutoProxy against undefined hostname
Railly Apr 10, 2026
b89156d
chore: remove duplicate changeset
Railly Apr 10, 2026
0b6db2b
fix: only auto-proxy for production instances on .vercel.app
Railly Apr 14, 2026
96842db
refactor: export AUTO_PROXY_PATH and replace hardcoded /__clerk
Railly Apr 14, 2026
635c9b7
refactor(nextjs): inline auto-proxy detection in middleware for reada…
Railly Apr 14, 2026
0859708
test(clerk-js): add dev instance guard test, use production key for a…
Railly Apr 14, 2026
67475c6
fix(nextjs): add production-only guard to middleware auto-proxy detec…
Railly Apr 16, 2026
b3e8273
fix(nextjs): hoist requestUrl declaration to fix ReferenceError with …
Railly Apr 16, 2026
66a8ad1
test(backend): fix auto-proxy tests to use pkLive, add dev key negati…
Railly Apr 17, 2026
cba7dfd
fix(backend): document X-Forwarded-Host trust assumption in auto-proxy
Railly Apr 17, 2026
c9c28b0
fix(shared): wrap normalizeHostname URL parsing in try-catch
Railly Apr 17, 2026
2371ab2
refactor: use isProductionFromPublishableKey instead of raw pk_live_ …
Railly Apr 17, 2026
a492681
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 17, 2026
670d2af
fix(nextjs): use production key in middleware auto-proxy tests, resto…
Railly Apr 17, 2026
0024932
style: restore keyless-provider.tsx formatting from main
Railly Apr 17, 2026
174ed67
style: restore UserSettings.ts formatting from main
Railly Apr 20, 2026
a4091ad
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 20, 2026
06bce1d
style: restore merge artifact formatting from main
Railly Apr 20, 2026
4d7c662
chore: remove stale test-signin-provider file
Railly Apr 20, 2026
e0a275d
docs(shared): add comment explaining build-time/runtime dual executio…
Railly Apr 22, 2026
43be86f
refactor(backend): use getAutoProxyUrlFromEnvironment instead of head…
Railly Apr 22, 2026
d7feb1c
fix(backend): remove unused AUTO_PROXY_PATH import
Railly Apr 27, 2026
d0450ed
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/auto-proxy-vercel-subdomains.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/backend': patch
'@clerk/clerk-js': patch
'@clerk/nextjs': patch
---

Auto-proxy FAPI requests for `.vercel.app` subdomains. When deployed to a `.vercel.app` domain without explicit proxy or domain configuration, the SDK automatically routes Frontend API requests through `/__clerk` on the app's own origin. This enables Clerk production mode on Vercel deployments without manual proxy setup.
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,71 @@ describe('AuthenticateContext', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const originalEnv = process.env;

beforeEach(() => {
process.env = {
...originalEnv,
VERCEL_TARGET_ENV: 'production',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp-abc123.vercel.app',
};
});

afterEach(() => {
process.env = originalEnv;
});

it('auto-derives proxyUrl when Vercel env vars indicate production vercel.app', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

it('does NOT auto-derive proxyUrl for development keys', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkTest,
});

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

it('does NOT auto-derive proxyUrl when Vercel env vars are absent', async () => {
delete process.env.VERCEL_TARGET_ENV;
delete process.env.VERCEL_PROJECT_PRODUCTION_URL;
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, {
publishableKey: pkLive,
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});

expect(context.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

it('explicit domain skips auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
domain: 'clerk.myapp.com',
});

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

// Added these tests to verify that the generated sha-1 is the same as the one used in cookie assignment
// Tests copied from packages/shared/src/__tests__/keys.test.ts
describe('getCookieSuffix(publishableKey, subtle)', () => {
Expand Down
13 changes: 13 additions & 0 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
import { getAutoProxyUrlFromEnvironment } from '@clerk/shared/proxy';
import type { Jwt } from '@clerk/shared/types';
import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';

Expand DownExpand Up@@ -70,6 +71,18 @@ class AuthenticateContext implements AuthenticateContext {
private clerkRequest: ClerkRequest,
options: AuthenticateRequestOptions,
) {
// Auto-detect proxy for supported platform deployments using environment
// variables (e.g. VERCEL_TARGET_ENV, VERCEL_PROJECT_PRODUCTION_URL) instead
// of request headers, which avoids X-Forwarded-Host spoofing concerns.
const autoProxyPath = getAutoProxyUrlFromEnvironment({
publishableKey: options.publishableKey ?? '',
hasProxyUrl: !!options.proxyUrl,
hasDomain: !!options.domain,
});
if (autoProxyPath) {
options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}${autoProxyPath}` };
}

if (options.acceptsToken === TokenType.M2MToken || options.acceptsToken === TokenType.ApiKey) {
// For non-session tokens, we only want to set the header values.
this.initHeaderValues();
Expand Down
80 changes: 80 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

NIT: A possible extra test here is to check that it doesn't break when window is not defined (for native envs).

The if (inBrowser()) { already takes care of it, but tests are always nice.

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.

Addressed in 0859708, also updated existing tests to use production key since auto-proxy is now production-only

Original file line numberDiff line numberDiff line change
Expand Up@@ -2516,6 +2516,86 @@ describe('Clerk singleton', () => {
});
});
});

describe('auto-detection for eligible hosts', () => {
const originalLocation = window.location;

afterEach(() => {
Object.defineProperty(window, 'location', {
value: originalLocation,
writable: true,
});
});

test('auto-derives proxyUrl for production instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

test('does NOT auto-derive proxyUrl for development instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(developmentPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('does NOT auto-derive proxyUrl for ineligible domains', () => {
const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('explicit proxyUrl takes precedence over auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});
expect(sut.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

test('explicit domain skips auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
domain: 'clerk.myapp.com',
});
expect(sut.proxyUrl).toBe('');
});
});
});

describe('buildUrlWithAuth', () => {
Expand Down
17 changes: 15 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,13 @@ import { windowNavigate } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { parsePublishableKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { CLERK_NETLIFY_CACHE_BUST_PARAM } from '@clerk/shared/netlifyCacheHandler';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import {
AUTO_PROXY_PATH,
isHttpOrHttps,
isValidProxyUrl,
proxyUrlToAbsoluteURL,
shouldAutoProxy,
} from '@clerk/shared/proxy';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
Expand DownExpand Up@@ -361,7 +367,14 @@ export class Clerk implements ClerkInterface {
if (!isValidProxyUrl(_unfilteredProxy)) {
errorThrower.throwInvalidProxyUrl({ url: _unfilteredProxy });
}
return proxyUrlToAbsoluteURL(_unfilteredProxy);
const resolved = proxyUrlToAbsoluteURL(_unfilteredProxy);
if (resolved) {
return resolved;
}
// Auto-detect when no explicit proxy or domain is configured (production only)
if (!this.#domain && this.#instanceType === 'production' && shouldAutoProxy(window.location.hostname)) {
return `${window.location.origin}${AUTO_PROXY_PATH}`;
}
}

if (typeof this.#proxyUrl === 'function') {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,4 +86,24 @@ describe('DynamicClerkScripts', () => {
expect(html).not.toContain('nonce="test');
expect(html).not.toContain('nonce="csp');
});

it('renders initial script tags with relative proxied asset URLs', async () => {
mockHeaders.mockResolvedValue(
new Map([
['X-Nonce', null],
['Content-Security-Policy', ''],
]),
);

const html = await render(
DynamicClerkScripts({
...defaultProps,
proxyUrl: '/__clerk',
}),
);

expect(html).toContain('src="/__clerk/npm/@clerk/clerk-js@');
expect(html).toContain('href="/__clerk/npm/@clerk/ui@');
expect(html).toContain('data-clerk-proxy-url="/__clerk"');
});
});
34 changes: 34 additions & 0 deletions packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1326,6 +1326,40 @@ describe('frontendApiProxy multi-domain support', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const productionPublishableKey = 'pk_live_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA';

it('auto-intercepts /__clerk/* requests on eligible hostnames', async () => {
const req = new NextRequest(new URL('/__clerk/v1/client', 'https://myapp-abc123.vercel.app').toString(), {
method: 'GET',
headers: new Headers(),
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

// Proxy should intercept the request — authenticateRequest should NOT be called
expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});

it('uses request.nextUrl for auto-detection', async () => {
const req = new NextRequest('http://127.0.0.1:3000/__clerk/v1/client', {
method: 'GET',
headers: new Headers(),
});

Object.defineProperty(req, 'nextUrl', {
value: new URL('https://myapp-abc123.vercel.app/__clerk/v1/client'),
configurable: true,
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});
});

describe('contentSecurityPolicy option', () => {
it('forwards CSP headers as request headers when strict mode is enabled', async () => {
const resp = await clerkMiddleware({
Expand Down
17 changes: 13 additions & 4 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,10 @@ import {
TokenType,
} from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import { parsePublishableKey } from '@clerk/shared/keys';
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 { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -35,7 +36,7 @@ import type { Logger, LoggerNoCommit } from '../utils/debugLogger';
import { withLogger } from '../utils/debugLogger';
import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { errorThrower } from './errorThrower';
import { getHeader } from './headers-utils';
Expand DownExpand Up@@ -161,12 +162,20 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
);

// Handle Frontend API proxy requests early, before authentication
const frontendApiProxyConfig = resolvedParams.frontendApiProxy;
const requestUrl = new URL(request.nextUrl.href);
let frontendApiProxyConfig = resolvedParams.frontendApiProxy;

// 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 (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
}
if (frontendApiProxyConfig) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxyConfig;

// Resolve enabled - either boolean or function
const requestUrl = new URL(request.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(request, { proxyPath })) {
Expand Down
Loading
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
Show all changes
35 commits
Select commit Hold shift + click to select a range
70420c0
feat(shared,backend,clerk-js,nextjs): Auto-proxy for .vercel.app subd…
brkalow Mar 11, 2026
dbc580e
refactor: generalize auto proxy naming
brkalow Mar 13, 2026
2d729d2
chore(repo): add changeset for auto proxy updates
brkalow Mar 13, 2026
72d6bdc
feat(shared,nextjs): support vercel production static auto proxy
brkalow Mar 20, 2026
f8906d3
fix(shared): make proxy helpers server safe
brkalow Mar 20, 2026
217a991
fix(nextjs): use nextUrl for auto proxy detection
brkalow Mar 20, 2026
db5ee3f
fix(shared,nextjs): proxy initial script tags
brkalow Mar 20, 2026
c99aba2
fix(backend): prevent Content-Encoding mismatch in proxy responses
brkalow Mar 20, 2026
aea3966
fix: add Vercel env vars to turbo.json and harden proxy header stripping
brkalow Mar 24, 2026
675270a
refactor(backend): convert RESPONSE_HEADERS_TO_STRIP to a Set
brkalow Mar 31, 2026
24d68e3
merge: resolve conflicts with main
Railly Apr 10, 2026
bdc8436
chore: add changeset for auto-proxy feature
Railly Apr 10, 2026
9a2f6b7
fix(shared): guard shouldAutoProxy against undefined hostname
Railly Apr 10, 2026
b89156d
chore: remove duplicate changeset
Railly Apr 10, 2026
0b6db2b
fix: only auto-proxy for production instances on .vercel.app
Railly Apr 14, 2026
96842db
refactor: export AUTO_PROXY_PATH and replace hardcoded /__clerk
Railly Apr 14, 2026
635c9b7
refactor(nextjs): inline auto-proxy detection in middleware for reada…
Railly Apr 14, 2026
0859708
test(clerk-js): add dev instance guard test, use production key for a…
Railly Apr 14, 2026
67475c6
fix(nextjs): add production-only guard to middleware auto-proxy detec…
Railly Apr 16, 2026
b3e8273
fix(nextjs): hoist requestUrl declaration to fix ReferenceError with …
Railly Apr 16, 2026
66a8ad1
test(backend): fix auto-proxy tests to use pkLive, add dev key negati…
Railly Apr 17, 2026
cba7dfd
fix(backend): document X-Forwarded-Host trust assumption in auto-proxy
Railly Apr 17, 2026
c9c28b0
fix(shared): wrap normalizeHostname URL parsing in try-catch
Railly Apr 17, 2026
2371ab2
refactor: use isProductionFromPublishableKey instead of raw pk_live_ …
Railly Apr 17, 2026
a492681
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 17, 2026
670d2af
fix(nextjs): use production key in middleware auto-proxy tests, resto…
Railly Apr 17, 2026
0024932
style: restore keyless-provider.tsx formatting from main
Railly Apr 17, 2026
174ed67
style: restore UserSettings.ts formatting from main
Railly Apr 20, 2026
a4091ad
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 20, 2026
06bce1d
style: restore merge artifact formatting from main
Railly Apr 20, 2026
4d7c662
chore: remove stale test-signin-provider file
Railly Apr 20, 2026
e0a275d
docs(shared): add comment explaining build-time/runtime dual executio…
Railly Apr 22, 2026
43be86f
refactor(backend): use getAutoProxyUrlFromEnvironment instead of head…
Railly Apr 22, 2026
d7feb1c
fix(backend): remove unused AUTO_PROXY_PATH import
Railly Apr 27, 2026
d0450ed
Merge remote-tracking branch 'origin/main' into brkalow/auto-proxy-ve…
Railly Apr 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/auto-proxy-vercel-subdomains.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/backend': patch
'@clerk/clerk-js': patch
'@clerk/nextjs': patch
---

Auto-proxy FAPI requests for `.vercel.app` subdomains. When deployed to a `.vercel.app` domain without explicit proxy or domain configuration, the SDK automatically routes Frontend API requests through `/__clerk` on the app's own origin. This enables Clerk production mode on Vercel deployments without manual proxy setup.
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,71 @@ describe('AuthenticateContext', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const originalEnv = process.env;

beforeEach(() => {
process.env = {
...originalEnv,
VERCEL_TARGET_ENV: 'production',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp-abc123.vercel.app',
};
});

afterEach(() => {
process.env = originalEnv;
});

it('auto-derives proxyUrl when Vercel env vars indicate production vercel.app', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

it('does NOT auto-derive proxyUrl for development keys', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkTest,
});

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

it('does NOT auto-derive proxyUrl when Vercel env vars are absent', async () => {
delete process.env.VERCEL_TARGET_ENV;
delete process.env.VERCEL_PROJECT_PRODUCTION_URL;
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, {
publishableKey: pkLive,
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});

expect(context.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

it('explicit domain skips auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
domain: 'clerk.myapp.com',
});

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

// Added these tests to verify that the generated sha-1 is the same as the one used in cookie assignment
// Tests copied from packages/shared/src/__tests__/keys.test.ts
describe('getCookieSuffix(publishableKey, subtle)', () => {
Expand Down
13 changes: 13 additions & 0 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
import { getAutoProxyUrlFromEnvironment } from '@clerk/shared/proxy';
import type { Jwt } from '@clerk/shared/types';
import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';

Expand DownExpand Up@@ -70,6 +71,18 @@ class AuthenticateContext implements AuthenticateContext {
private clerkRequest: ClerkRequest,
options: AuthenticateRequestOptions,
) {
// Auto-detect proxy for supported platform deployments using environment
// variables (e.g. VERCEL_TARGET_ENV, VERCEL_PROJECT_PRODUCTION_URL) instead
// of request headers, which avoids X-Forwarded-Host spoofing concerns.
const autoProxyPath = getAutoProxyUrlFromEnvironment({
publishableKey: options.publishableKey ?? '',
hasProxyUrl: !!options.proxyUrl,
hasDomain: !!options.domain,
});
if (autoProxyPath) {
options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}${autoProxyPath}` };
}

if (options.acceptsToken === TokenType.M2MToken || options.acceptsToken === TokenType.ApiKey) {
// For non-session tokens, we only want to set the header values.
this.initHeaderValues();
Expand Down
80 changes: 80 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

NIT: A possible extra test here is to check that it doesn't break when window is not defined (for native envs).

The if (inBrowser()) { already takes care of it, but tests are always nice.

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.

Addressed in 0859708, also updated existing tests to use production key since auto-proxy is now production-only

Original file line numberDiff line numberDiff line change
Expand Up@@ -2516,6 +2516,86 @@ describe('Clerk singleton', () => {
});
});
});

describe('auto-detection for eligible hosts', () => {
const originalLocation = window.location;

afterEach(() => {
Object.defineProperty(window, 'location', {
value: originalLocation,
writable: true,
});
});

test('auto-derives proxyUrl for production instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

test('does NOT auto-derive proxyUrl for development instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(developmentPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('does NOT auto-derive proxyUrl for ineligible domains', () => {
const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('explicit proxyUrl takes precedence over auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});
expect(sut.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

test('explicit domain skips auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
domain: 'clerk.myapp.com',
});
expect(sut.proxyUrl).toBe('');
});
});
});

describe('buildUrlWithAuth', () => {
Expand Down
17 changes: 15 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,13 @@ import { windowNavigate } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { parsePublishableKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { CLERK_NETLIFY_CACHE_BUST_PARAM } from '@clerk/shared/netlifyCacheHandler';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import {
AUTO_PROXY_PATH,
isHttpOrHttps,
isValidProxyUrl,
proxyUrlToAbsoluteURL,
shouldAutoProxy,
} from '@clerk/shared/proxy';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
Expand DownExpand Up@@ -361,7 +367,14 @@ export class Clerk implements ClerkInterface {
if (!isValidProxyUrl(_unfilteredProxy)) {
errorThrower.throwInvalidProxyUrl({ url: _unfilteredProxy });
}
return proxyUrlToAbsoluteURL(_unfilteredProxy);
const resolved = proxyUrlToAbsoluteURL(_unfilteredProxy);
if (resolved) {
return resolved;
}
// Auto-detect when no explicit proxy or domain is configured (production only)
if (!this.#domain && this.#instanceType === 'production' && shouldAutoProxy(window.location.hostname)) {
return `${window.location.origin}${AUTO_PROXY_PATH}`;
}
}

if (typeof this.#proxyUrl === 'function') {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,4 +86,24 @@ describe('DynamicClerkScripts', () => {
expect(html).not.toContain('nonce="test');
expect(html).not.toContain('nonce="csp');
});

it('renders initial script tags with relative proxied asset URLs', async () => {
mockHeaders.mockResolvedValue(
new Map([
['X-Nonce', null],
['Content-Security-Policy', ''],
]),
);

const html = await render(
DynamicClerkScripts({
...defaultProps,
proxyUrl: '/__clerk',
}),
);

expect(html).toContain('src="/__clerk/npm/@clerk/clerk-js@');
expect(html).toContain('href="/__clerk/npm/@clerk/ui@');
expect(html).toContain('data-clerk-proxy-url="/__clerk"');
});
});
34 changes: 34 additions & 0 deletions packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1326,6 +1326,40 @@ describe('frontendApiProxy multi-domain support', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const productionPublishableKey = 'pk_live_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA';

it('auto-intercepts /__clerk/* requests on eligible hostnames', async () => {
const req = new NextRequest(new URL('/__clerk/v1/client', 'https://myapp-abc123.vercel.app').toString(), {
method: 'GET',
headers: new Headers(),
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

// Proxy should intercept the request — authenticateRequest should NOT be called
expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});

it('uses request.nextUrl for auto-detection', async () => {
const req = new NextRequest('http://127.0.0.1:3000/__clerk/v1/client', {
method: 'GET',
headers: new Headers(),
});

Object.defineProperty(req, 'nextUrl', {
value: new URL('https://myapp-abc123.vercel.app/__clerk/v1/client'),
configurable: true,
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});
});

describe('contentSecurityPolicy option', () => {
it('forwards CSP headers as request headers when strict mode is enabled', async () => {
const resp = await clerkMiddleware({
Expand Down
17 changes: 13 additions & 4 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,10 @@ import {
TokenType,
} from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import { parsePublishableKey } from '@clerk/shared/keys';
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 { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All@@ -35,7 +36,7 @@ import type { Logger, LoggerNoCommit } from '../utils/debugLogger';
import { withLogger } from '../utils/debugLogger';
import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { errorThrower } from './errorThrower';
import { getHeader } from './headers-utils';
Expand DownExpand Up@@ -161,12 +162,20 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
);

// Handle Frontend API proxy requests early, before authentication
const frontendApiProxyConfig = resolvedParams.frontendApiProxy;
const requestUrl = new URL(request.nextUrl.href);
let frontendApiProxyConfig = resolvedParams.frontendApiProxy;

// 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 (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
}
if (frontendApiProxyConfig) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxyConfig;

// Resolve enabled - either boolean or function
const requestUrl = new URL(request.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(request, { proxyPath })) {
Expand Down
Loading
Loading