refactor: generalize auto proxy naming

Author: brkalow

packages/backend/src/tokens/__tests__/authenticateContext.test.ts

@@ -258,8 +258,8 @@ describe('AuthenticateContext', () => {
     });
   });
 
-  describe('auto-proxy for .vercel.app', () => {
-    it('auto-derives proxyUrl for .vercel.app hostnames', async () => {
+  describe('auto-proxy for eligible hosts', () => {
+    it('auto-derives proxyUrl for eligible hostnames', async () => {
       const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
       const context = await createAuthenticateContext(clerkRequest, {
         publishableKey: pkTest,
@@ -268,7 +268,7 @@ describe('AuthenticateContext', () => {
       expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
     });
 
-    it('does NOT auto-derive proxyUrl for non-.vercel.app domains', async () => {
+    it('does NOT auto-derive proxyUrl for ineligible domains', async () => {
       const clerkRequest = createClerkRequest(new Request('https://myapp.com/dashboard'));
       const context = await createAuthenticateContext(clerkRequest, {
         publishableKey: pkTest,

packages/backend/src/tokens/authenticateContext.ts

@@ -1,5 +1,5 @@
 import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
-import { isVercelPreviewDeploy } from '@clerk/shared/proxy';
+import { shouldAutoProxy } from '@clerk/shared/proxy';
 import type { Jwt } from '@clerk/shared/types';
 import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';
 
@@ -70,10 +70,10 @@ class AuthenticateContext implements AuthenticateContext {
     private clerkRequest: ClerkRequest,
     options: AuthenticateRequestOptions,
   ) {
-    // Auto-detect proxy for Vercel preview deployments
+    // Auto-detect proxy for supported platform deployments
     if (!options.proxyUrl && !options.domain) {
       const hostname = clerkRequest.clerkUrl.hostname;
-      if (isVercelPreviewDeploy(hostname)) {
+      if (shouldAutoProxy(hostname)) {
         options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}/__clerk` };
       }
     }

packages/clerk-js/src/core/__tests__/clerk.test.ts

@@ -2492,7 +2492,7 @@ describe('Clerk singleton', () => {
       });
     });
 
-    describe('auto-detection for .vercel.app', () => {
+    describe('auto-detection for eligible hosts', () => {
       const originalLocation = window.location;
 
       afterEach(() => {
@@ -2502,7 +2502,7 @@ describe('Clerk singleton', () => {
         });
       });
 
-      test('auto-derives proxyUrl when hostname is .vercel.app', () => {
+      test('auto-derives proxyUrl when hostname is eligible', () => {
         Object.defineProperty(window, 'location', {
           value: {
             ...originalLocation,
@@ -2517,7 +2517,7 @@ describe('Clerk singleton', () => {
         expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
       });
 
-      test('does NOT auto-derive proxyUrl for non-.vercel.app domains', () => {
+      test('does NOT auto-derive proxyUrl for ineligible domains', () => {
         const sut = new Clerk(developmentPublishableKey);
         expect(sut.proxyUrl).toBe('');
       });

packages/clerk-js/src/core/clerk.ts

@@ -38,7 +38,7 @@ 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, isVercelPreviewDeploy, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
+import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL, shouldAutoProxy } from '@clerk/shared/proxy';
 import {
   eventPrebuiltComponentMounted,
   eventPrebuiltComponentOpened,
@@ -355,8 +355,8 @@ export class Clerk implements ClerkInterface {
       if (resolved) {
         return resolved;
       }
-      // Auto-detect for Vercel preview deployments when no explicit proxy or domain is configured
-      if (!this.#domain && isVercelPreviewDeploy(window.location.hostname)) {
+      // Auto-detect when no explicit proxy or domain is configured
+      if (!this.#domain && shouldAutoProxy(window.location.hostname)) {
         return `${window.location.origin}/__clerk`;
       }
     }

packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts

@@ -1191,8 +1191,8 @@ describe('frontendApiProxy multi-domain support', () => {
   });
 });
 
-describe('auto-proxy for .vercel.app', () => {
-  it('auto-intercepts /__clerk/* requests on .vercel.app hostnames', async () => {
+describe('auto-proxy for eligible hosts', () => {
+  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(),

packages/nextjs/src/server/clerkMiddleware.ts

@@ -23,7 +23,7 @@ import {
 import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
 import { parsePublishableKey } from '@clerk/shared/keys';
 import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
-import { isVercelPreviewDeploy } from '@clerk/shared/proxy';
+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';
@@ -583,7 +583,7 @@ const handleControlFlowErrors = (
 };
 
 function getAutoDetectedProxyConfig(requestUrl: URL): FrontendApiProxyOptions | undefined {
-  if (isVercelPreviewDeploy(requestUrl.hostname)) {
+  if (shouldAutoProxy(requestUrl.hostname)) {
     return { enabled: true };
   }
   return undefined;

packages/shared/src/__tests__/proxy.spec.ts

@@ -1,12 +1,6 @@
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 
-import {
-  isHttpOrHttps,
-  isProxyUrlRelative,
-  isValidProxyUrl,
-  isVercelPreviewDeploy,
-  proxyUrlToAbsoluteURL,
-} from '../proxy';
+import { isHttpOrHttps, isProxyUrlRelative, isValidProxyUrl, proxyUrlToAbsoluteURL, shouldAutoProxy } from '../proxy';
 
 describe('isValidProxyUrl(key)', () => {
   it('returns true if the proxyUrl is valid', () => {
@@ -44,25 +38,25 @@ describe('isHttpOrHttps(key)', () => {
   });
 });
 
-describe('isVercelPreviewDeploy(hostname)', () => {
+describe('shouldAutoProxy(hostname)', () => {
   it('returns true for a .vercel.app subdomain', () => {
-    expect(isVercelPreviewDeploy('myapp.vercel.app')).toBe(true);
+    expect(shouldAutoProxy('myapp.vercel.app')).toBe(true);
   });
 
   it('returns true for a git branch preview subdomain', () => {
-    expect(isVercelPreviewDeploy('myapp-git-branch.vercel.app')).toBe(true);
+    expect(shouldAutoProxy('myapp-git-branch.vercel.app')).toBe(true);
   });
 
   it('returns false for the bare vercel.app domain', () => {
-    expect(isVercelPreviewDeploy('vercel.app')).toBe(false);
+    expect(shouldAutoProxy('vercel.app')).toBe(false);
   });
 
   it('returns false for a custom domain', () => {
-    expect(isVercelPreviewDeploy('myapp.com')).toBe(false);
+    expect(shouldAutoProxy('myapp.com')).toBe(false);
   });
 
   it('returns false for a domain that contains vercel.app but is not a subdomain', () => {
-    expect(isVercelPreviewDeploy('vercel.app.evil.com')).toBe(false);
+    expect(shouldAutoProxy('vercel.app.evil.com')).toBe(false);
   });
 });
 

packages/shared/src/proxy.ts

@@ -33,8 +33,10 @@ export function proxyUrlToAbsoluteURL(url: string | undefined): string {
   return isProxyUrlRelative(url) ? new URL(url, window.location.origin).toString() : url;
 }
 
-export function isVercelPreviewDeploy(hostname: string): boolean {
-  return hostname.endsWith('.vercel.app');
+const AUTO_PROXY_HOST_SUFFIXES = ['.vercel.app'];
+
+export function shouldAutoProxy(hostname: string): boolean {
+  return AUTO_PROXY_HOST_SUFFIXES.some(hostSuffix => hostname.endsWith(hostSuffix));
 }
 
 /**