Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-poets-hammer.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/expo": patch
---

Pass `proxyUrl` and `domain` through Expo's native Clerk singleton.
6 changes: 6 additions & 0 deletions packages/expo/src/provider/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
children,
tokenCache,
publishableKey,
proxyUrl,
domain,
__experimental_passkeys,
experimental,
__experimental_resourceCache,
Expand All@@ -80,6 +82,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
? getClerkInstance({
publishableKey: pk,
tokenCache,
proxyUrl,
domain,
__experimental_passkeys,
__experimental_resourceCache,
})
Expand DownExpand Up@@ -283,6 +287,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
key={pk}
{...rest}
publishableKey={pk}
proxyUrl={proxyUrl}
domain={domain}
sdkMetadata={SDK_METADATA}
Clerk={clerkInstance}
standardBrowser={!isNative()}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
import type { Clerk } from '@clerk/clerk-js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => {
return {
constructorSpy: vi.fn(),
};
});

vi.mock('react-native', () => {
return {
Platform: {
OS: 'ios',
},
NativeModules: {},
TurboModuleRegistry: {
get: vi.fn(),
},
};
});

class MockClerk {
public publishableKey: string;
public proxyUrl: unknown;
public domain: unknown;

constructor(publishableKey: string, options?: { proxyUrl?: unknown; domain?: unknown }) {
this.publishableKey = publishableKey;
this.proxyUrl = options?.proxyUrl;
this.domain = options?.domain;
mocks.constructorSpy(publishableKey, options);
}

addListener = vi.fn();
__internal_onBeforeRequest = vi.fn();
__internal_onAfterResponse = vi.fn();
}

const loadCreateClerkInstance = async () => {
const mod = await import('../createClerkInstance');
return mod.createClerkInstance;
};

describe('createClerkInstance', () => {
beforeEach(() => {
vi.resetModules();
vi.clearAllMocks();
});

test('passes proxyUrl to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: undefined,
});
});

test('passes domain to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: undefined,
domain: 'satellite.example.com',
});
});

test('reuses the singleton when the config is unchanged', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('reuses the singleton when called without options after initialization', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance();

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('recreates the singleton when proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('preserves the existing publishable key when only proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('recreates the singleton when proxyUrl is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});

test('does not carry proxy config across publishable key changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_old',
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: 'satellite.example.com',
});
getClerkInstance({
publishableKey: 'pk_test_new',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_new', {
proxyUrl: undefined,
domain: undefined,
});
});

test('recreates the singleton when domain changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-a.example.com',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-b.example.com',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: 'satellite-b.example.com',
});
});

test('recreates the singleton when domain is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});
getClerkInstance({
domain: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});
});
66 changes: 56 additions & 10 deletions packages/expo/src/provider/singleton/createClerkInstance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,31 +37,77 @@ type FapiResponse = Response & {
payload: { errors?: Array<{ code: string }> } | null;
};

type ClerkRuntimeOptions = Pick<BuildClerkOptions, 'publishableKey' | 'proxyUrl' | 'domain'>;
type ResolvedClerkRuntimeOptions = Omit<ClerkRuntimeOptions, 'publishableKey'> & {
publishableKey: string;
};

function hasOwnOption<Key extends keyof ClerkRuntimeOptions>(
options: ClerkRuntimeOptions | undefined,
key: Key,
): options is ClerkRuntimeOptions & Required<Pick<ClerkRuntimeOptions, Key>> {
return !!options && Object.prototype.hasOwnProperty.call(options, key);
}

let __internal_clerk: HeadlessBrowserClerk | BrowserClerk | undefined;
let __internal_clerkOptions: ClerkRuntimeOptions | undefined;

/**
* Resolves the next native singleton config while preserving existing values for omitted options.
* A publishable key change starts from a clean proxy/domain config unless those values are
* explicitly provided alongside the new key.
*/
function getUpdatedClerkOptions(
currentOptions: ClerkRuntimeOptions | undefined,
nextOptions: ClerkRuntimeOptions | undefined,
): {
hasConfigChanged: boolean;
options: ResolvedClerkRuntimeOptions;
} {
const hasNextProxyUrl = hasOwnOption(nextOptions, 'proxyUrl');
const hasNextDomain = hasOwnOption(nextOptions, 'domain');
const hasKeyChanged =
!!currentOptions &&
typeof nextOptions?.publishableKey !== 'undefined' &&
nextOptions.publishableKey !== currentOptions.publishableKey;
const hasProxyChanged = !!currentOptions && hasNextProxyUrl && nextOptions.proxyUrl !== currentOptions.proxyUrl;
const hasDomainChanged = !!currentOptions && hasNextDomain && nextOptions.domain !== currentOptions.domain;
Comment on lines +73 to +74

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I can't really think of a scenario in which these would change at runtime, but good to support I suppose along with publishableKey as they all determine which instance we're interacting with.


return {
hasConfigChanged: hasKeyChanged || hasProxyChanged || hasDomainChanged,
options: {
publishableKey: nextOptions?.publishableKey ?? currentOptions?.publishableKey ?? '',
proxyUrl: hasKeyChanged
? nextOptions?.proxyUrl
: hasNextProxyUrl
? nextOptions.proxyUrl
: currentOptions?.proxyUrl,
domain: hasKeyChanged ? nextOptions?.domain : hasNextDomain ? nextOptions.domain : currentOptions?.domain,
},
};
}

export function createClerkInstance(ClerkClass: typeof Clerk) {
return (options?: BuildClerkOptions): HeadlessBrowserClerk | BrowserClerk => {
const { tokenCache = MemoryTokenCache, __experimental_resourceCache: createResourceCache } = options || {};
const {
publishableKey = '',
tokenCache = MemoryTokenCache,
__experimental_resourceCache: createResourceCache,
} = options || {};
hasConfigChanged,
options: { publishableKey, proxyUrl, domain },
} = getUpdatedClerkOptions(__internal_clerkOptions, options);

if (!__internal_clerk && !publishableKey) {
errorThrower.throwMissingPublishableKeyError();
}

// Support "hot-swapping" the Clerk instance at runtime. See JS-598 for additional details.
const hasKeyChanged = __internal_clerk && !!publishableKey && publishableKey !== __internal_clerk.publishableKey;

if (!__internal_clerk || hasKeyChanged) {
if (hasKeyChanged) {
if (!__internal_clerk || hasConfigChanged) {
if (hasConfigChanged) {
tokenCache.clearToken?.(CLERK_CLIENT_JWT_KEY);
}

const getToken = tokenCache.getToken;
const saveToken = tokenCache.saveToken;
__internal_clerk = new ClerkClass(publishableKey) as unknown as BrowserClerk;
__internal_clerkOptions = { publishableKey, proxyUrl, domain };
__internal_clerk = new ClerkClass(publishableKey, { proxyUrl, domain }) as unknown as BrowserClerk;

if (Platform.OS === 'ios' || Platform.OS === 'android') {
// @ts-expect-error - This is an internal API
Expand Down
3 changes: 3 additions & 0 deletions packages/expo/src/provider/singleton/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type {
CredentialReturn,
DomainOrProxyUrl,
PublicKeyCredentialCreationOptionsWithoutExtensions,
PublicKeyCredentialRequestOptionsWithoutExtensions,
PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand All@@ -16,6 +17,8 @@ export interface IStorage {
export type BuildClerkOptions = {
publishableKey?: string;
tokenCache?: TokenCache;
proxyUrl?: DomainOrProxyUrl['proxyUrl'];
domain?: DomainOrProxyUrl['domain'];
/**
* Note: Passkey support in Expo is currently in a limited rollout phase.
* If you're interested in using this feature, please contact us for early access or additional details.
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-poets-hammer.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/expo": patch
---

Pass `proxyUrl` and `domain` through Expo's native Clerk singleton.
6 changes: 6 additions & 0 deletions packages/expo/src/provider/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
children,
tokenCache,
publishableKey,
proxyUrl,
domain,
__experimental_passkeys,
experimental,
__experimental_resourceCache,
Expand All@@ -80,6 +82,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
? getClerkInstance({
publishableKey: pk,
tokenCache,
proxyUrl,
domain,
__experimental_passkeys,
__experimental_resourceCache,
})
Expand DownExpand Up@@ -283,6 +287,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
key={pk}
{...rest}
publishableKey={pk}
proxyUrl={proxyUrl}
domain={domain}
sdkMetadata={SDK_METADATA}
Clerk={clerkInstance}
standardBrowser={!isNative()}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
import type { Clerk } from '@clerk/clerk-js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => {
return {
constructorSpy: vi.fn(),
};
});

vi.mock('react-native', () => {
return {
Platform: {
OS: 'ios',
},
NativeModules: {},
TurboModuleRegistry: {
get: vi.fn(),
},
};
});

class MockClerk {
public publishableKey: string;
public proxyUrl: unknown;
public domain: unknown;

constructor(publishableKey: string, options?: { proxyUrl?: unknown; domain?: unknown }) {
this.publishableKey = publishableKey;
this.proxyUrl = options?.proxyUrl;
this.domain = options?.domain;
mocks.constructorSpy(publishableKey, options);
}

addListener = vi.fn();
__internal_onBeforeRequest = vi.fn();
__internal_onAfterResponse = vi.fn();
}

const loadCreateClerkInstance = async () => {
const mod = await import('../createClerkInstance');
return mod.createClerkInstance;
};

describe('createClerkInstance', () => {
beforeEach(() => {
vi.resetModules();
vi.clearAllMocks();
});

test('passes proxyUrl to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: undefined,
});
});

test('passes domain to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: undefined,
domain: 'satellite.example.com',
});
});

test('reuses the singleton when the config is unchanged', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('reuses the singleton when called without options after initialization', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance();

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('recreates the singleton when proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('preserves the existing publishable key when only proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('recreates the singleton when proxyUrl is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});

test('does not carry proxy config across publishable key changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_old',
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: 'satellite.example.com',
});
getClerkInstance({
publishableKey: 'pk_test_new',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_new', {
proxyUrl: undefined,
domain: undefined,
});
});

test('recreates the singleton when domain changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-a.example.com',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-b.example.com',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: 'satellite-b.example.com',
});
});

test('recreates the singleton when domain is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});
getClerkInstance({
domain: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});
});
66 changes: 56 additions & 10 deletions packages/expo/src/provider/singleton/createClerkInstance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,31 +37,77 @@ type FapiResponse = Response & {
payload: { errors?: Array<{ code: string }> } | null;
};

type ClerkRuntimeOptions = Pick<BuildClerkOptions, 'publishableKey' | 'proxyUrl' | 'domain'>;
type ResolvedClerkRuntimeOptions = Omit<ClerkRuntimeOptions, 'publishableKey'> & {
publishableKey: string;
};

function hasOwnOption<Key extends keyof ClerkRuntimeOptions>(
options: ClerkRuntimeOptions | undefined,
key: Key,
): options is ClerkRuntimeOptions & Required<Pick<ClerkRuntimeOptions, Key>> {
return !!options && Object.prototype.hasOwnProperty.call(options, key);
}

let __internal_clerk: HeadlessBrowserClerk | BrowserClerk | undefined;
let __internal_clerkOptions: ClerkRuntimeOptions | undefined;

/**
* Resolves the next native singleton config while preserving existing values for omitted options.
* A publishable key change starts from a clean proxy/domain config unless those values are
* explicitly provided alongside the new key.
*/
function getUpdatedClerkOptions(
currentOptions: ClerkRuntimeOptions | undefined,
nextOptions: ClerkRuntimeOptions | undefined,
): {
hasConfigChanged: boolean;
options: ResolvedClerkRuntimeOptions;
} {
const hasNextProxyUrl = hasOwnOption(nextOptions, 'proxyUrl');
const hasNextDomain = hasOwnOption(nextOptions, 'domain');
const hasKeyChanged =
!!currentOptions &&
typeof nextOptions?.publishableKey !== 'undefined' &&
nextOptions.publishableKey !== currentOptions.publishableKey;
const hasProxyChanged = !!currentOptions && hasNextProxyUrl && nextOptions.proxyUrl !== currentOptions.proxyUrl;
const hasDomainChanged = !!currentOptions && hasNextDomain && nextOptions.domain !== currentOptions.domain;
Comment on lines +73 to +74

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I can't really think of a scenario in which these would change at runtime, but good to support I suppose along with publishableKey as they all determine which instance we're interacting with.


return {
hasConfigChanged: hasKeyChanged || hasProxyChanged || hasDomainChanged,
options: {
publishableKey: nextOptions?.publishableKey ?? currentOptions?.publishableKey ?? '',
proxyUrl: hasKeyChanged
? nextOptions?.proxyUrl
: hasNextProxyUrl
? nextOptions.proxyUrl
: currentOptions?.proxyUrl,
domain: hasKeyChanged ? nextOptions?.domain : hasNextDomain ? nextOptions.domain : currentOptions?.domain,
},
};
}

export function createClerkInstance(ClerkClass: typeof Clerk) {
return (options?: BuildClerkOptions): HeadlessBrowserClerk | BrowserClerk => {
const { tokenCache = MemoryTokenCache, __experimental_resourceCache: createResourceCache } = options || {};
const {
publishableKey = '',
tokenCache = MemoryTokenCache,
__experimental_resourceCache: createResourceCache,
} = options || {};
hasConfigChanged,
options: { publishableKey, proxyUrl, domain },
} = getUpdatedClerkOptions(__internal_clerkOptions, options);

if (!__internal_clerk && !publishableKey) {
errorThrower.throwMissingPublishableKeyError();
}

// Support "hot-swapping" the Clerk instance at runtime. See JS-598 for additional details.
const hasKeyChanged = __internal_clerk && !!publishableKey && publishableKey !== __internal_clerk.publishableKey;

if (!__internal_clerk || hasKeyChanged) {
if (hasKeyChanged) {
if (!__internal_clerk || hasConfigChanged) {
if (hasConfigChanged) {
tokenCache.clearToken?.(CLERK_CLIENT_JWT_KEY);
}

const getToken = tokenCache.getToken;
const saveToken = tokenCache.saveToken;
__internal_clerk = new ClerkClass(publishableKey) as unknown as BrowserClerk;
__internal_clerkOptions = { publishableKey, proxyUrl, domain };
__internal_clerk = new ClerkClass(publishableKey, { proxyUrl, domain }) as unknown as BrowserClerk;

if (Platform.OS === 'ios' || Platform.OS === 'android') {
// @ts-expect-error - This is an internal API
Expand Down
3 changes: 3 additions & 0 deletions packages/expo/src/provider/singleton/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type {
CredentialReturn,
DomainOrProxyUrl,
PublicKeyCredentialCreationOptionsWithoutExtensions,
PublicKeyCredentialRequestOptionsWithoutExtensions,
PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand All@@ -16,6 +17,8 @@ export interface IStorage {
export type BuildClerkOptions = {
publishableKey?: string;
tokenCache?: TokenCache;
proxyUrl?: DomainOrProxyUrl['proxyUrl'];
domain?: DomainOrProxyUrl['domain'];
/**
* Note: Passkey support in Expo is currently in a limited rollout phase.
* If you're interested in using this feature, please contact us for early access or additional details.
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-poets-hammer.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/expo": patch
---

Pass `proxyUrl` and `domain` through Expo's native Clerk singleton.
6 changes: 6 additions & 0 deletions packages/expo/src/provider/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
children,
tokenCache,
publishableKey,
proxyUrl,
domain,
__experimental_passkeys,
experimental,
__experimental_resourceCache,
Expand All@@ -80,6 +82,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
? getClerkInstance({
publishableKey: pk,
tokenCache,
proxyUrl,
domain,
__experimental_passkeys,
__experimental_resourceCache,
})
Expand DownExpand Up@@ -283,6 +287,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
key={pk}
{...rest}
publishableKey={pk}
proxyUrl={proxyUrl}
domain={domain}
sdkMetadata={SDK_METADATA}
Clerk={clerkInstance}
standardBrowser={!isNative()}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
import type { Clerk } from '@clerk/clerk-js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => {
return {
constructorSpy: vi.fn(),
};
});

vi.mock('react-native', () => {
return {
Platform: {
OS: 'ios',
},
NativeModules: {},
TurboModuleRegistry: {
get: vi.fn(),
},
};
});

class MockClerk {
public publishableKey: string;
public proxyUrl: unknown;
public domain: unknown;

constructor(publishableKey: string, options?: { proxyUrl?: unknown; domain?: unknown }) {
this.publishableKey = publishableKey;
this.proxyUrl = options?.proxyUrl;
this.domain = options?.domain;
mocks.constructorSpy(publishableKey, options);
}

addListener = vi.fn();
__internal_onBeforeRequest = vi.fn();
__internal_onAfterResponse = vi.fn();
}

const loadCreateClerkInstance = async () => {
const mod = await import('../createClerkInstance');
return mod.createClerkInstance;
};

describe('createClerkInstance', () => {
beforeEach(() => {
vi.resetModules();
vi.clearAllMocks();
});

test('passes proxyUrl to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: undefined,
});
});

test('passes domain to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: undefined,
domain: 'satellite.example.com',
});
});

test('reuses the singleton when the config is unchanged', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('reuses the singleton when called without options after initialization', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance();

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('recreates the singleton when proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('preserves the existing publishable key when only proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('recreates the singleton when proxyUrl is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});

test('does not carry proxy config across publishable key changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_old',
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: 'satellite.example.com',
});
getClerkInstance({
publishableKey: 'pk_test_new',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_new', {
proxyUrl: undefined,
domain: undefined,
});
});

test('recreates the singleton when domain changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-a.example.com',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-b.example.com',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: 'satellite-b.example.com',
});
});

test('recreates the singleton when domain is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});
getClerkInstance({
domain: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});
});
66 changes: 56 additions & 10 deletions packages/expo/src/provider/singleton/createClerkInstance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,31 +37,77 @@ type FapiResponse = Response & {
payload: { errors?: Array<{ code: string }> } | null;
};

type ClerkRuntimeOptions = Pick<BuildClerkOptions, 'publishableKey' | 'proxyUrl' | 'domain'>;
type ResolvedClerkRuntimeOptions = Omit<ClerkRuntimeOptions, 'publishableKey'> & {
publishableKey: string;
};

function hasOwnOption<Key extends keyof ClerkRuntimeOptions>(
options: ClerkRuntimeOptions | undefined,
key: Key,
): options is ClerkRuntimeOptions & Required<Pick<ClerkRuntimeOptions, Key>> {
return !!options && Object.prototype.hasOwnProperty.call(options, key);
}

let __internal_clerk: HeadlessBrowserClerk | BrowserClerk | undefined;
let __internal_clerkOptions: ClerkRuntimeOptions | undefined;

/**
* Resolves the next native singleton config while preserving existing values for omitted options.
* A publishable key change starts from a clean proxy/domain config unless those values are
* explicitly provided alongside the new key.
*/
function getUpdatedClerkOptions(
currentOptions: ClerkRuntimeOptions | undefined,
nextOptions: ClerkRuntimeOptions | undefined,
): {
hasConfigChanged: boolean;
options: ResolvedClerkRuntimeOptions;
} {
const hasNextProxyUrl = hasOwnOption(nextOptions, 'proxyUrl');
const hasNextDomain = hasOwnOption(nextOptions, 'domain');
const hasKeyChanged =
!!currentOptions &&
typeof nextOptions?.publishableKey !== 'undefined' &&
nextOptions.publishableKey !== currentOptions.publishableKey;
const hasProxyChanged = !!currentOptions && hasNextProxyUrl && nextOptions.proxyUrl !== currentOptions.proxyUrl;
const hasDomainChanged = !!currentOptions && hasNextDomain && nextOptions.domain !== currentOptions.domain;
Comment on lines +73 to +74

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I can't really think of a scenario in which these would change at runtime, but good to support I suppose along with publishableKey as they all determine which instance we're interacting with.


return {
hasConfigChanged: hasKeyChanged || hasProxyChanged || hasDomainChanged,
options: {
publishableKey: nextOptions?.publishableKey ?? currentOptions?.publishableKey ?? '',
proxyUrl: hasKeyChanged
? nextOptions?.proxyUrl
: hasNextProxyUrl
? nextOptions.proxyUrl
: currentOptions?.proxyUrl,
domain: hasKeyChanged ? nextOptions?.domain : hasNextDomain ? nextOptions.domain : currentOptions?.domain,
},
};
}

export function createClerkInstance(ClerkClass: typeof Clerk) {
return (options?: BuildClerkOptions): HeadlessBrowserClerk | BrowserClerk => {
const { tokenCache = MemoryTokenCache, __experimental_resourceCache: createResourceCache } = options || {};
const {
publishableKey = '',
tokenCache = MemoryTokenCache,
__experimental_resourceCache: createResourceCache,
} = options || {};
hasConfigChanged,
options: { publishableKey, proxyUrl, domain },
} = getUpdatedClerkOptions(__internal_clerkOptions, options);

if (!__internal_clerk && !publishableKey) {
errorThrower.throwMissingPublishableKeyError();
}

// Support "hot-swapping" the Clerk instance at runtime. See JS-598 for additional details.
const hasKeyChanged = __internal_clerk && !!publishableKey && publishableKey !== __internal_clerk.publishableKey;

if (!__internal_clerk || hasKeyChanged) {
if (hasKeyChanged) {
if (!__internal_clerk || hasConfigChanged) {
if (hasConfigChanged) {
tokenCache.clearToken?.(CLERK_CLIENT_JWT_KEY);
}

const getToken = tokenCache.getToken;
const saveToken = tokenCache.saveToken;
__internal_clerk = new ClerkClass(publishableKey) as unknown as BrowserClerk;
__internal_clerkOptions = { publishableKey, proxyUrl, domain };
__internal_clerk = new ClerkClass(publishableKey, { proxyUrl, domain }) as unknown as BrowserClerk;

if (Platform.OS === 'ios' || Platform.OS === 'android') {
// @ts-expect-error - This is an internal API
Expand Down
3 changes: 3 additions & 0 deletions packages/expo/src/provider/singleton/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type {
CredentialReturn,
DomainOrProxyUrl,
PublicKeyCredentialCreationOptionsWithoutExtensions,
PublicKeyCredentialRequestOptionsWithoutExtensions,
PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand All@@ -16,6 +17,8 @@ export interface IStorage {
export type BuildClerkOptions = {
publishableKey?: string;
tokenCache?: TokenCache;
proxyUrl?: DomainOrProxyUrl['proxyUrl'];
domain?: DomainOrProxyUrl['domain'];
/**
* Note: Passkey support in Expo is currently in a limited rollout phase.
* If you're interested in using this feature, please contact us for early access or additional details.
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-poets-hammer.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/expo": patch
---

Pass `proxyUrl` and `domain` through Expo's native Clerk singleton.
6 changes: 6 additions & 0 deletions packages/expo/src/provider/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
children,
tokenCache,
publishableKey,
proxyUrl,
domain,
__experimental_passkeys,
experimental,
__experimental_resourceCache,
Expand All@@ -80,6 +82,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
? getClerkInstance({
publishableKey: pk,
tokenCache,
proxyUrl,
domain,
__experimental_passkeys,
__experimental_resourceCache,
})
Expand DownExpand Up@@ -283,6 +287,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
key={pk}
{...rest}
publishableKey={pk}
proxyUrl={proxyUrl}
domain={domain}
sdkMetadata={SDK_METADATA}
Clerk={clerkInstance}
standardBrowser={!isNative()}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
import type { Clerk } from '@clerk/clerk-js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => {
return {
constructorSpy: vi.fn(),
};
});

vi.mock('react-native', () => {
return {
Platform: {
OS: 'ios',
},
NativeModules: {},
TurboModuleRegistry: {
get: vi.fn(),
},
};
});

class MockClerk {
public publishableKey: string;
public proxyUrl: unknown;
public domain: unknown;

constructor(publishableKey: string, options?: { proxyUrl?: unknown; domain?: unknown }) {
this.publishableKey = publishableKey;
this.proxyUrl = options?.proxyUrl;
this.domain = options?.domain;
mocks.constructorSpy(publishableKey, options);
}

addListener = vi.fn();
__internal_onBeforeRequest = vi.fn();
__internal_onAfterResponse = vi.fn();
}

const loadCreateClerkInstance = async () => {
const mod = await import('../createClerkInstance');
return mod.createClerkInstance;
};

describe('createClerkInstance', () => {
beforeEach(() => {
vi.resetModules();
vi.clearAllMocks();
});

test('passes proxyUrl to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: undefined,
});
});

test('passes domain to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: undefined,
domain: 'satellite.example.com',
});
});

test('reuses the singleton when the config is unchanged', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('reuses the singleton when called without options after initialization', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance();

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('recreates the singleton when proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('preserves the existing publishable key when only proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('recreates the singleton when proxyUrl is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});

test('does not carry proxy config across publishable key changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_old',
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: 'satellite.example.com',
});
getClerkInstance({
publishableKey: 'pk_test_new',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_new', {
proxyUrl: undefined,
domain: undefined,
});
});

test('recreates the singleton when domain changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-a.example.com',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-b.example.com',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: 'satellite-b.example.com',
});
});

test('recreates the singleton when domain is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});
getClerkInstance({
domain: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});
});
66 changes: 56 additions & 10 deletions packages/expo/src/provider/singleton/createClerkInstance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,31 +37,77 @@ type FapiResponse = Response & {
payload: { errors?: Array<{ code: string }> } | null;
};

type ClerkRuntimeOptions = Pick<BuildClerkOptions, 'publishableKey' | 'proxyUrl' | 'domain'>;
type ResolvedClerkRuntimeOptions = Omit<ClerkRuntimeOptions, 'publishableKey'> & {
publishableKey: string;
};

function hasOwnOption<Key extends keyof ClerkRuntimeOptions>(
options: ClerkRuntimeOptions | undefined,
key: Key,
): options is ClerkRuntimeOptions & Required<Pick<ClerkRuntimeOptions, Key>> {
return !!options && Object.prototype.hasOwnProperty.call(options, key);
}

let __internal_clerk: HeadlessBrowserClerk | BrowserClerk | undefined;
let __internal_clerkOptions: ClerkRuntimeOptions | undefined;

/**
* Resolves the next native singleton config while preserving existing values for omitted options.
* A publishable key change starts from a clean proxy/domain config unless those values are
* explicitly provided alongside the new key.
*/
function getUpdatedClerkOptions(
currentOptions: ClerkRuntimeOptions | undefined,
nextOptions: ClerkRuntimeOptions | undefined,
): {
hasConfigChanged: boolean;
options: ResolvedClerkRuntimeOptions;
} {
const hasNextProxyUrl = hasOwnOption(nextOptions, 'proxyUrl');
const hasNextDomain = hasOwnOption(nextOptions, 'domain');
const hasKeyChanged =
!!currentOptions &&
typeof nextOptions?.publishableKey !== 'undefined' &&
nextOptions.publishableKey !== currentOptions.publishableKey;
const hasProxyChanged = !!currentOptions && hasNextProxyUrl && nextOptions.proxyUrl !== currentOptions.proxyUrl;
const hasDomainChanged = !!currentOptions && hasNextDomain && nextOptions.domain !== currentOptions.domain;
Comment on lines +73 to +74

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I can't really think of a scenario in which these would change at runtime, but good to support I suppose along with publishableKey as they all determine which instance we're interacting with.


return {
hasConfigChanged: hasKeyChanged || hasProxyChanged || hasDomainChanged,
options: {
publishableKey: nextOptions?.publishableKey ?? currentOptions?.publishableKey ?? '',
proxyUrl: hasKeyChanged
? nextOptions?.proxyUrl
: hasNextProxyUrl
? nextOptions.proxyUrl
: currentOptions?.proxyUrl,
domain: hasKeyChanged ? nextOptions?.domain : hasNextDomain ? nextOptions.domain : currentOptions?.domain,
},
};
}

export function createClerkInstance(ClerkClass: typeof Clerk) {
return (options?: BuildClerkOptions): HeadlessBrowserClerk | BrowserClerk => {
const { tokenCache = MemoryTokenCache, __experimental_resourceCache: createResourceCache } = options || {};
const {
publishableKey = '',
tokenCache = MemoryTokenCache,
__experimental_resourceCache: createResourceCache,
} = options || {};
hasConfigChanged,
options: { publishableKey, proxyUrl, domain },
} = getUpdatedClerkOptions(__internal_clerkOptions, options);

if (!__internal_clerk && !publishableKey) {
errorThrower.throwMissingPublishableKeyError();
}

// Support "hot-swapping" the Clerk instance at runtime. See JS-598 for additional details.
const hasKeyChanged = __internal_clerk && !!publishableKey && publishableKey !== __internal_clerk.publishableKey;

if (!__internal_clerk || hasKeyChanged) {
if (hasKeyChanged) {
if (!__internal_clerk || hasConfigChanged) {
if (hasConfigChanged) {
tokenCache.clearToken?.(CLERK_CLIENT_JWT_KEY);
}

const getToken = tokenCache.getToken;
const saveToken = tokenCache.saveToken;
__internal_clerk = new ClerkClass(publishableKey) as unknown as BrowserClerk;
__internal_clerkOptions = { publishableKey, proxyUrl, domain };
__internal_clerk = new ClerkClass(publishableKey, { proxyUrl, domain }) as unknown as BrowserClerk;

if (Platform.OS === 'ios' || Platform.OS === 'android') {
// @ts-expect-error - This is an internal API
Expand Down
3 changes: 3 additions & 0 deletions packages/expo/src/provider/singleton/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type {
CredentialReturn,
DomainOrProxyUrl,
PublicKeyCredentialCreationOptionsWithoutExtensions,
PublicKeyCredentialRequestOptionsWithoutExtensions,
PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand All@@ -16,6 +17,8 @@ export interface IStorage {
export type BuildClerkOptions = {
publishableKey?: string;
tokenCache?: TokenCache;
proxyUrl?: DomainOrProxyUrl['proxyUrl'];
domain?: DomainOrProxyUrl['domain'];
/**
* Note: Passkey support in Expo is currently in a limited rollout phase.
* If you're interested in using this feature, please contact us for early access or additional details.
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-poets-hammer.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/expo": patch
---

Pass `proxyUrl` and `domain` through Expo's native Clerk singleton.
6 changes: 6 additions & 0 deletions packages/expo/src/provider/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
children,
tokenCache,
publishableKey,
proxyUrl,
domain,
__experimental_passkeys,
experimental,
__experimental_resourceCache,
Expand All@@ -80,6 +82,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
? getClerkInstance({
publishableKey: pk,
tokenCache,
proxyUrl,
domain,
__experimental_passkeys,
__experimental_resourceCache,
})
Expand DownExpand Up@@ -283,6 +287,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
key={pk}
{...rest}
publishableKey={pk}
proxyUrl={proxyUrl}
domain={domain}
sdkMetadata={SDK_METADATA}
Clerk={clerkInstance}
standardBrowser={!isNative()}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
import type { Clerk } from '@clerk/clerk-js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => {
return {
constructorSpy: vi.fn(),
};
});

vi.mock('react-native', () => {
return {
Platform: {
OS: 'ios',
},
NativeModules: {},
TurboModuleRegistry: {
get: vi.fn(),
},
};
});

class MockClerk {
public publishableKey: string;
public proxyUrl: unknown;
public domain: unknown;

constructor(publishableKey: string, options?: { proxyUrl?: unknown; domain?: unknown }) {
this.publishableKey = publishableKey;
this.proxyUrl = options?.proxyUrl;
this.domain = options?.domain;
mocks.constructorSpy(publishableKey, options);
}

addListener = vi.fn();
__internal_onBeforeRequest = vi.fn();
__internal_onAfterResponse = vi.fn();
}

const loadCreateClerkInstance = async () => {
const mod = await import('../createClerkInstance');
return mod.createClerkInstance;
};

describe('createClerkInstance', () => {
beforeEach(() => {
vi.resetModules();
vi.clearAllMocks();
});

test('passes proxyUrl to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: undefined,
});
});

test('passes domain to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: undefined,
domain: 'satellite.example.com',
});
});

test('reuses the singleton when the config is unchanged', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('reuses the singleton when called without options after initialization', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance();

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('recreates the singleton when proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('preserves the existing publishable key when only proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('recreates the singleton when proxyUrl is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});

test('does not carry proxy config across publishable key changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_old',
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: 'satellite.example.com',
});
getClerkInstance({
publishableKey: 'pk_test_new',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_new', {
proxyUrl: undefined,
domain: undefined,
});
});

test('recreates the singleton when domain changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-a.example.com',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-b.example.com',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: 'satellite-b.example.com',
});
});

test('recreates the singleton when domain is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});
getClerkInstance({
domain: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});
});
66 changes: 56 additions & 10 deletions packages/expo/src/provider/singleton/createClerkInstance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,31 +37,77 @@ type FapiResponse = Response & {
payload: { errors?: Array<{ code: string }> } | null;
};

type ClerkRuntimeOptions = Pick<BuildClerkOptions, 'publishableKey' | 'proxyUrl' | 'domain'>;
type ResolvedClerkRuntimeOptions = Omit<ClerkRuntimeOptions, 'publishableKey'> & {
publishableKey: string;
};

function hasOwnOption<Key extends keyof ClerkRuntimeOptions>(
options: ClerkRuntimeOptions | undefined,
key: Key,
): options is ClerkRuntimeOptions & Required<Pick<ClerkRuntimeOptions, Key>> {
return !!options && Object.prototype.hasOwnProperty.call(options, key);
}

let __internal_clerk: HeadlessBrowserClerk | BrowserClerk | undefined;
let __internal_clerkOptions: ClerkRuntimeOptions | undefined;

/**
* Resolves the next native singleton config while preserving existing values for omitted options.
* A publishable key change starts from a clean proxy/domain config unless those values are
* explicitly provided alongside the new key.
*/
function getUpdatedClerkOptions(
currentOptions: ClerkRuntimeOptions | undefined,
nextOptions: ClerkRuntimeOptions | undefined,
): {
hasConfigChanged: boolean;
options: ResolvedClerkRuntimeOptions;
} {
const hasNextProxyUrl = hasOwnOption(nextOptions, 'proxyUrl');
const hasNextDomain = hasOwnOption(nextOptions, 'domain');
const hasKeyChanged =
!!currentOptions &&
typeof nextOptions?.publishableKey !== 'undefined' &&
nextOptions.publishableKey !== currentOptions.publishableKey;
const hasProxyChanged = !!currentOptions && hasNextProxyUrl && nextOptions.proxyUrl !== currentOptions.proxyUrl;
const hasDomainChanged = !!currentOptions && hasNextDomain && nextOptions.domain !== currentOptions.domain;
Comment on lines +73 to +74

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I can't really think of a scenario in which these would change at runtime, but good to support I suppose along with publishableKey as they all determine which instance we're interacting with.


return {
hasConfigChanged: hasKeyChanged || hasProxyChanged || hasDomainChanged,
options: {
publishableKey: nextOptions?.publishableKey ?? currentOptions?.publishableKey ?? '',
proxyUrl: hasKeyChanged
? nextOptions?.proxyUrl
: hasNextProxyUrl
? nextOptions.proxyUrl
: currentOptions?.proxyUrl,
domain: hasKeyChanged ? nextOptions?.domain : hasNextDomain ? nextOptions.domain : currentOptions?.domain,
},
};
}

export function createClerkInstance(ClerkClass: typeof Clerk) {
return (options?: BuildClerkOptions): HeadlessBrowserClerk | BrowserClerk => {
const { tokenCache = MemoryTokenCache, __experimental_resourceCache: createResourceCache } = options || {};
const {
publishableKey = '',
tokenCache = MemoryTokenCache,
__experimental_resourceCache: createResourceCache,
} = options || {};
hasConfigChanged,
options: { publishableKey, proxyUrl, domain },
} = getUpdatedClerkOptions(__internal_clerkOptions, options);

if (!__internal_clerk && !publishableKey) {
errorThrower.throwMissingPublishableKeyError();
}

// Support "hot-swapping" the Clerk instance at runtime. See JS-598 for additional details.
const hasKeyChanged = __internal_clerk && !!publishableKey && publishableKey !== __internal_clerk.publishableKey;

if (!__internal_clerk || hasKeyChanged) {
if (hasKeyChanged) {
if (!__internal_clerk || hasConfigChanged) {
if (hasConfigChanged) {
tokenCache.clearToken?.(CLERK_CLIENT_JWT_KEY);
}

const getToken = tokenCache.getToken;
const saveToken = tokenCache.saveToken;
__internal_clerk = new ClerkClass(publishableKey) as unknown as BrowserClerk;
__internal_clerkOptions = { publishableKey, proxyUrl, domain };
__internal_clerk = new ClerkClass(publishableKey, { proxyUrl, domain }) as unknown as BrowserClerk;

if (Platform.OS === 'ios' || Platform.OS === 'android') {
// @ts-expect-error - This is an internal API
Expand Down
3 changes: 3 additions & 0 deletions packages/expo/src/provider/singleton/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type {
CredentialReturn,
DomainOrProxyUrl,
PublicKeyCredentialCreationOptionsWithoutExtensions,
PublicKeyCredentialRequestOptionsWithoutExtensions,
PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand All@@ -16,6 +17,8 @@ export interface IStorage {
export type BuildClerkOptions = {
publishableKey?: string;
tokenCache?: TokenCache;
proxyUrl?: DomainOrProxyUrl['proxyUrl'];
domain?: DomainOrProxyUrl['domain'];
/**
* Note: Passkey support in Expo is currently in a limited rollout phase.
* If you're interested in using this feature, please contact us for early access or additional details.
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-poets-hammer.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/expo": patch
---

Pass `proxyUrl` and `domain` through Expo's native Clerk singleton.
6 changes: 6 additions & 0 deletions packages/expo/src/provider/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
children,
tokenCache,
publishableKey,
proxyUrl,
domain,
__experimental_passkeys,
experimental,
__experimental_resourceCache,
Expand All@@ -80,6 +82,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
? getClerkInstance({
publishableKey: pk,
tokenCache,
proxyUrl,
domain,
__experimental_passkeys,
__experimental_resourceCache,
})
Expand DownExpand Up@@ -283,6 +287,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
key={pk}
{...rest}
publishableKey={pk}
proxyUrl={proxyUrl}
domain={domain}
sdkMetadata={SDK_METADATA}
Clerk={clerkInstance}
standardBrowser={!isNative()}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
import type { Clerk } from '@clerk/clerk-js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => {
return {
constructorSpy: vi.fn(),
};
});

vi.mock('react-native', () => {
return {
Platform: {
OS: 'ios',
},
NativeModules: {},
TurboModuleRegistry: {
get: vi.fn(),
},
};
});

class MockClerk {
public publishableKey: string;
public proxyUrl: unknown;
public domain: unknown;

constructor(publishableKey: string, options?: { proxyUrl?: unknown; domain?: unknown }) {
this.publishableKey = publishableKey;
this.proxyUrl = options?.proxyUrl;
this.domain = options?.domain;
mocks.constructorSpy(publishableKey, options);
}

addListener = vi.fn();
__internal_onBeforeRequest = vi.fn();
__internal_onAfterResponse = vi.fn();
}

const loadCreateClerkInstance = async () => {
const mod = await import('../createClerkInstance');
return mod.createClerkInstance;
};

describe('createClerkInstance', () => {
beforeEach(() => {
vi.resetModules();
vi.clearAllMocks();
});

test('passes proxyUrl to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: undefined,
});
});

test('passes domain to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: undefined,
domain: 'satellite.example.com',
});
});

test('reuses the singleton when the config is unchanged', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('reuses the singleton when called without options after initialization', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance();

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('recreates the singleton when proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('preserves the existing publishable key when only proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('recreates the singleton when proxyUrl is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});

test('does not carry proxy config across publishable key changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_old',
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: 'satellite.example.com',
});
getClerkInstance({
publishableKey: 'pk_test_new',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_new', {
proxyUrl: undefined,
domain: undefined,
});
});

test('recreates the singleton when domain changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-a.example.com',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-b.example.com',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: 'satellite-b.example.com',
});
});

test('recreates the singleton when domain is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});
getClerkInstance({
domain: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});
});
66 changes: 56 additions & 10 deletions packages/expo/src/provider/singleton/createClerkInstance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,31 +37,77 @@ type FapiResponse = Response & {
payload: { errors?: Array<{ code: string }> } | null;
};

type ClerkRuntimeOptions = Pick<BuildClerkOptions, 'publishableKey' | 'proxyUrl' | 'domain'>;
type ResolvedClerkRuntimeOptions = Omit<ClerkRuntimeOptions, 'publishableKey'> & {
publishableKey: string;
};

function hasOwnOption<Key extends keyof ClerkRuntimeOptions>(
options: ClerkRuntimeOptions | undefined,
key: Key,
): options is ClerkRuntimeOptions & Required<Pick<ClerkRuntimeOptions, Key>> {
return !!options && Object.prototype.hasOwnProperty.call(options, key);
}

let __internal_clerk: HeadlessBrowserClerk | BrowserClerk | undefined;
let __internal_clerkOptions: ClerkRuntimeOptions | undefined;

/**
* Resolves the next native singleton config while preserving existing values for omitted options.
* A publishable key change starts from a clean proxy/domain config unless those values are
* explicitly provided alongside the new key.
*/
function getUpdatedClerkOptions(
currentOptions: ClerkRuntimeOptions | undefined,
nextOptions: ClerkRuntimeOptions | undefined,
): {
hasConfigChanged: boolean;
options: ResolvedClerkRuntimeOptions;
} {
const hasNextProxyUrl = hasOwnOption(nextOptions, 'proxyUrl');
const hasNextDomain = hasOwnOption(nextOptions, 'domain');
const hasKeyChanged =
!!currentOptions &&
typeof nextOptions?.publishableKey !== 'undefined' &&
nextOptions.publishableKey !== currentOptions.publishableKey;
const hasProxyChanged = !!currentOptions && hasNextProxyUrl && nextOptions.proxyUrl !== currentOptions.proxyUrl;
const hasDomainChanged = !!currentOptions && hasNextDomain && nextOptions.domain !== currentOptions.domain;
Comment on lines +73 to +74

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I can't really think of a scenario in which these would change at runtime, but good to support I suppose along with publishableKey as they all determine which instance we're interacting with.


return {
hasConfigChanged: hasKeyChanged || hasProxyChanged || hasDomainChanged,
options: {
publishableKey: nextOptions?.publishableKey ?? currentOptions?.publishableKey ?? '',
proxyUrl: hasKeyChanged
? nextOptions?.proxyUrl
: hasNextProxyUrl
? nextOptions.proxyUrl
: currentOptions?.proxyUrl,
domain: hasKeyChanged ? nextOptions?.domain : hasNextDomain ? nextOptions.domain : currentOptions?.domain,
},
};
}

export function createClerkInstance(ClerkClass: typeof Clerk) {
return (options?: BuildClerkOptions): HeadlessBrowserClerk | BrowserClerk => {
const { tokenCache = MemoryTokenCache, __experimental_resourceCache: createResourceCache } = options || {};
const {
publishableKey = '',
tokenCache = MemoryTokenCache,
__experimental_resourceCache: createResourceCache,
} = options || {};
hasConfigChanged,
options: { publishableKey, proxyUrl, domain },
} = getUpdatedClerkOptions(__internal_clerkOptions, options);

if (!__internal_clerk && !publishableKey) {
errorThrower.throwMissingPublishableKeyError();
}

// Support "hot-swapping" the Clerk instance at runtime. See JS-598 for additional details.
const hasKeyChanged = __internal_clerk && !!publishableKey && publishableKey !== __internal_clerk.publishableKey;

if (!__internal_clerk || hasKeyChanged) {
if (hasKeyChanged) {
if (!__internal_clerk || hasConfigChanged) {
if (hasConfigChanged) {
tokenCache.clearToken?.(CLERK_CLIENT_JWT_KEY);
}

const getToken = tokenCache.getToken;
const saveToken = tokenCache.saveToken;
__internal_clerk = new ClerkClass(publishableKey) as unknown as BrowserClerk;
__internal_clerkOptions = { publishableKey, proxyUrl, domain };
__internal_clerk = new ClerkClass(publishableKey, { proxyUrl, domain }) as unknown as BrowserClerk;

if (Platform.OS === 'ios' || Platform.OS === 'android') {
// @ts-expect-error - This is an internal API
Expand Down
3 changes: 3 additions & 0 deletions packages/expo/src/provider/singleton/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type {
CredentialReturn,
DomainOrProxyUrl,
PublicKeyCredentialCreationOptionsWithoutExtensions,
PublicKeyCredentialRequestOptionsWithoutExtensions,
PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand All@@ -16,6 +17,8 @@ export interface IStorage {
export type BuildClerkOptions = {
publishableKey?: string;
tokenCache?: TokenCache;
proxyUrl?: DomainOrProxyUrl['proxyUrl'];
domain?: DomainOrProxyUrl['domain'];
/**
* Note: Passkey support in Expo is currently in a limited rollout phase.
* If you're interested in using this feature, please contact us for early access or additional details.
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-poets-hammer.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/expo": patch
---

Pass `proxyUrl` and `domain` through Expo's native Clerk singleton.
6 changes: 6 additions & 0 deletions packages/expo/src/provider/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
children,
tokenCache,
publishableKey,
proxyUrl,
domain,
__experimental_passkeys,
experimental,
__experimental_resourceCache,
Expand All@@ -80,6 +82,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
? getClerkInstance({
publishableKey: pk,
tokenCache,
proxyUrl,
domain,
__experimental_passkeys,
__experimental_resourceCache,
})
Expand DownExpand Up@@ -283,6 +287,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
key={pk}
{...rest}
publishableKey={pk}
proxyUrl={proxyUrl}
domain={domain}
sdkMetadata={SDK_METADATA}
Clerk={clerkInstance}
standardBrowser={!isNative()}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
import type { Clerk } from '@clerk/clerk-js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => {
return {
constructorSpy: vi.fn(),
};
});

vi.mock('react-native', () => {
return {
Platform: {
OS: 'ios',
},
NativeModules: {},
TurboModuleRegistry: {
get: vi.fn(),
},
};
});

class MockClerk {
public publishableKey: string;
public proxyUrl: unknown;
public domain: unknown;

constructor(publishableKey: string, options?: { proxyUrl?: unknown; domain?: unknown }) {
this.publishableKey = publishableKey;
this.proxyUrl = options?.proxyUrl;
this.domain = options?.domain;
mocks.constructorSpy(publishableKey, options);
}

addListener = vi.fn();
__internal_onBeforeRequest = vi.fn();
__internal_onAfterResponse = vi.fn();
}

const loadCreateClerkInstance = async () => {
const mod = await import('../createClerkInstance');
return mod.createClerkInstance;
};

describe('createClerkInstance', () => {
beforeEach(() => {
vi.resetModules();
vi.clearAllMocks();
});

test('passes proxyUrl to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: undefined,
});
});

test('passes domain to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: undefined,
domain: 'satellite.example.com',
});
});

test('reuses the singleton when the config is unchanged', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('reuses the singleton when called without options after initialization', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance();

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('recreates the singleton when proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('preserves the existing publishable key when only proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('recreates the singleton when proxyUrl is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});

test('does not carry proxy config across publishable key changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_old',
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: 'satellite.example.com',
});
getClerkInstance({
publishableKey: 'pk_test_new',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_new', {
proxyUrl: undefined,
domain: undefined,
});
});

test('recreates the singleton when domain changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-a.example.com',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-b.example.com',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: 'satellite-b.example.com',
});
});

test('recreates the singleton when domain is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});
getClerkInstance({
domain: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});
});
66 changes: 56 additions & 10 deletions packages/expo/src/provider/singleton/createClerkInstance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,31 +37,77 @@ type FapiResponse = Response & {
payload: { errors?: Array<{ code: string }> } | null;
};

type ClerkRuntimeOptions = Pick<BuildClerkOptions, 'publishableKey' | 'proxyUrl' | 'domain'>;
type ResolvedClerkRuntimeOptions = Omit<ClerkRuntimeOptions, 'publishableKey'> & {
publishableKey: string;
};

function hasOwnOption<Key extends keyof ClerkRuntimeOptions>(
options: ClerkRuntimeOptions | undefined,
key: Key,
): options is ClerkRuntimeOptions & Required<Pick<ClerkRuntimeOptions, Key>> {
return !!options && Object.prototype.hasOwnProperty.call(options, key);
}

let __internal_clerk: HeadlessBrowserClerk | BrowserClerk | undefined;
let __internal_clerkOptions: ClerkRuntimeOptions | undefined;

/**
* Resolves the next native singleton config while preserving existing values for omitted options.
* A publishable key change starts from a clean proxy/domain config unless those values are
* explicitly provided alongside the new key.
*/
function getUpdatedClerkOptions(
currentOptions: ClerkRuntimeOptions | undefined,
nextOptions: ClerkRuntimeOptions | undefined,
): {
hasConfigChanged: boolean;
options: ResolvedClerkRuntimeOptions;
} {
const hasNextProxyUrl = hasOwnOption(nextOptions, 'proxyUrl');
const hasNextDomain = hasOwnOption(nextOptions, 'domain');
const hasKeyChanged =
!!currentOptions &&
typeof nextOptions?.publishableKey !== 'undefined' &&
nextOptions.publishableKey !== currentOptions.publishableKey;
const hasProxyChanged = !!currentOptions && hasNextProxyUrl && nextOptions.proxyUrl !== currentOptions.proxyUrl;
const hasDomainChanged = !!currentOptions && hasNextDomain && nextOptions.domain !== currentOptions.domain;
Comment on lines +73 to +74

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I can't really think of a scenario in which these would change at runtime, but good to support I suppose along with publishableKey as they all determine which instance we're interacting with.


return {
hasConfigChanged: hasKeyChanged || hasProxyChanged || hasDomainChanged,
options: {
publishableKey: nextOptions?.publishableKey ?? currentOptions?.publishableKey ?? '',
proxyUrl: hasKeyChanged
? nextOptions?.proxyUrl
: hasNextProxyUrl
? nextOptions.proxyUrl
: currentOptions?.proxyUrl,
domain: hasKeyChanged ? nextOptions?.domain : hasNextDomain ? nextOptions.domain : currentOptions?.domain,
},
};
}

export function createClerkInstance(ClerkClass: typeof Clerk) {
return (options?: BuildClerkOptions): HeadlessBrowserClerk | BrowserClerk => {
const { tokenCache = MemoryTokenCache, __experimental_resourceCache: createResourceCache } = options || {};
const {
publishableKey = '',
tokenCache = MemoryTokenCache,
__experimental_resourceCache: createResourceCache,
} = options || {};
hasConfigChanged,
options: { publishableKey, proxyUrl, domain },
} = getUpdatedClerkOptions(__internal_clerkOptions, options);

if (!__internal_clerk && !publishableKey) {
errorThrower.throwMissingPublishableKeyError();
}

// Support "hot-swapping" the Clerk instance at runtime. See JS-598 for additional details.
const hasKeyChanged = __internal_clerk && !!publishableKey && publishableKey !== __internal_clerk.publishableKey;

if (!__internal_clerk || hasKeyChanged) {
if (hasKeyChanged) {
if (!__internal_clerk || hasConfigChanged) {
if (hasConfigChanged) {
tokenCache.clearToken?.(CLERK_CLIENT_JWT_KEY);
}

const getToken = tokenCache.getToken;
const saveToken = tokenCache.saveToken;
__internal_clerk = new ClerkClass(publishableKey) as unknown as BrowserClerk;
__internal_clerkOptions = { publishableKey, proxyUrl, domain };
__internal_clerk = new ClerkClass(publishableKey, { proxyUrl, domain }) as unknown as BrowserClerk;

if (Platform.OS === 'ios' || Platform.OS === 'android') {
// @ts-expect-error - This is an internal API
Expand Down
3 changes: 3 additions & 0 deletions packages/expo/src/provider/singleton/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type {
CredentialReturn,
DomainOrProxyUrl,
PublicKeyCredentialCreationOptionsWithoutExtensions,
PublicKeyCredentialRequestOptionsWithoutExtensions,
PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand All@@ -16,6 +17,8 @@ export interface IStorage {
export type BuildClerkOptions = {
publishableKey?: string;
tokenCache?: TokenCache;
proxyUrl?: DomainOrProxyUrl['proxyUrl'];
domain?: DomainOrProxyUrl['domain'];
/**
* Note: Passkey support in Expo is currently in a limited rollout phase.
* If you're interested in using this feature, please contact us for early access or additional details.
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-poets-hammer.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/expo": patch
---

Pass `proxyUrl` and `domain` through Expo's native Clerk singleton.
6 changes: 6 additions & 0 deletions packages/expo/src/provider/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
children,
tokenCache,
publishableKey,
proxyUrl,
domain,
__experimental_passkeys,
experimental,
__experimental_resourceCache,
Expand All@@ -80,6 +82,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
? getClerkInstance({
publishableKey: pk,
tokenCache,
proxyUrl,
domain,
__experimental_passkeys,
__experimental_resourceCache,
})
Expand DownExpand Up@@ -283,6 +287,8 @@ export function ClerkProvider<TUi extends Ui = Ui>(props: ClerkProviderProps<TUi
key={pk}
{...rest}
publishableKey={pk}
proxyUrl={proxyUrl}
domain={domain}
sdkMetadata={SDK_METADATA}
Clerk={clerkInstance}
standardBrowser={!isNative()}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
import type { Clerk } from '@clerk/clerk-js';
import { beforeEach, describe, expect, test, vi } from 'vitest';

const mocks = vi.hoisted(() => {
return {
constructorSpy: vi.fn(),
};
});

vi.mock('react-native', () => {
return {
Platform: {
OS: 'ios',
},
NativeModules: {},
TurboModuleRegistry: {
get: vi.fn(),
},
};
});

class MockClerk {
public publishableKey: string;
public proxyUrl: unknown;
public domain: unknown;

constructor(publishableKey: string, options?: { proxyUrl?: unknown; domain?: unknown }) {
this.publishableKey = publishableKey;
this.proxyUrl = options?.proxyUrl;
this.domain = options?.domain;
mocks.constructorSpy(publishableKey, options);
}

addListener = vi.fn();
__internal_onBeforeRequest = vi.fn();
__internal_onAfterResponse = vi.fn();
}

const loadCreateClerkInstance = async () => {
const mod = await import('../createClerkInstance');
return mod.createClerkInstance;
};

describe('createClerkInstance', () => {
beforeEach(() => {
vi.resetModules();
vi.clearAllMocks();
});

test('passes proxyUrl to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: undefined,
});
});

test('passes domain to the native Clerk constructor', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});

expect(mocks.constructorSpy).toHaveBeenCalledWith('pk_test_123', {
proxyUrl: undefined,
domain: 'satellite.example.com',
});
});

test('reuses the singleton when the config is unchanged', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('reuses the singleton when called without options after initialization', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
const second = getClerkInstance();

expect(first).toBe(second);
expect(mocks.constructorSpy).toHaveBeenCalledTimes(1);
});

test('recreates the singleton when proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('preserves the existing publishable key when only proxyUrl changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy-a.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: 'https://proxy-b.example.com/api/__clerk',
domain: undefined,
});
});

test('recreates the singleton when proxyUrl is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
proxyUrl: 'https://proxy.example.com/api/__clerk',
});
getClerkInstance({
proxyUrl: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});

test('does not carry proxy config across publishable key changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_old',
proxyUrl: 'https://proxy.example.com/api/__clerk',
domain: 'satellite.example.com',
});
getClerkInstance({
publishableKey: 'pk_test_new',
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_new', {
proxyUrl: undefined,
domain: undefined,
});
});

test('recreates the singleton when domain changes', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

const first = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-a.example.com',
});
const second = getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite-b.example.com',
});

expect(first).not.toBe(second);
expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: 'satellite-b.example.com',
});
});

test('recreates the singleton when domain is explicitly removed', async () => {
const createClerkInstance = await loadCreateClerkInstance();
const getClerkInstance = createClerkInstance(MockClerk as unknown as typeof Clerk);

getClerkInstance({
publishableKey: 'pk_test_123',
domain: 'satellite.example.com',
});
getClerkInstance({
domain: undefined,
});

expect(mocks.constructorSpy).toHaveBeenNthCalledWith(2, 'pk_test_123', {
proxyUrl: undefined,
domain: undefined,
});
});
});
66 changes: 56 additions & 10 deletions packages/expo/src/provider/singleton/createClerkInstance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,31 +37,77 @@ type FapiResponse = Response & {
payload: { errors?: Array<{ code: string }> } | null;
};

type ClerkRuntimeOptions = Pick<BuildClerkOptions, 'publishableKey' | 'proxyUrl' | 'domain'>;
type ResolvedClerkRuntimeOptions = Omit<ClerkRuntimeOptions, 'publishableKey'> & {
publishableKey: string;
};

function hasOwnOption<Key extends keyof ClerkRuntimeOptions>(
options: ClerkRuntimeOptions | undefined,
key: Key,
): options is ClerkRuntimeOptions & Required<Pick<ClerkRuntimeOptions, Key>> {
return !!options && Object.prototype.hasOwnProperty.call(options, key);
}

let __internal_clerk: HeadlessBrowserClerk | BrowserClerk | undefined;
let __internal_clerkOptions: ClerkRuntimeOptions | undefined;

/**
* Resolves the next native singleton config while preserving existing values for omitted options.
* A publishable key change starts from a clean proxy/domain config unless those values are
* explicitly provided alongside the new key.
*/
function getUpdatedClerkOptions(
currentOptions: ClerkRuntimeOptions | undefined,
nextOptions: ClerkRuntimeOptions | undefined,
): {
hasConfigChanged: boolean;
options: ResolvedClerkRuntimeOptions;
} {
const hasNextProxyUrl = hasOwnOption(nextOptions, 'proxyUrl');
const hasNextDomain = hasOwnOption(nextOptions, 'domain');
const hasKeyChanged =
!!currentOptions &&
typeof nextOptions?.publishableKey !== 'undefined' &&
nextOptions.publishableKey !== currentOptions.publishableKey;
const hasProxyChanged = !!currentOptions && hasNextProxyUrl && nextOptions.proxyUrl !== currentOptions.proxyUrl;
const hasDomainChanged = !!currentOptions && hasNextDomain && nextOptions.domain !== currentOptions.domain;
Comment on lines +73 to +74

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I can't really think of a scenario in which these would change at runtime, but good to support I suppose along with publishableKey as they all determine which instance we're interacting with.


return {
hasConfigChanged: hasKeyChanged || hasProxyChanged || hasDomainChanged,
options: {
publishableKey: nextOptions?.publishableKey ?? currentOptions?.publishableKey ?? '',
proxyUrl: hasKeyChanged
? nextOptions?.proxyUrl
: hasNextProxyUrl
? nextOptions.proxyUrl
: currentOptions?.proxyUrl,
domain: hasKeyChanged ? nextOptions?.domain : hasNextDomain ? nextOptions.domain : currentOptions?.domain,
},
};
}

export function createClerkInstance(ClerkClass: typeof Clerk) {
return (options?: BuildClerkOptions): HeadlessBrowserClerk | BrowserClerk => {
const { tokenCache = MemoryTokenCache, __experimental_resourceCache: createResourceCache } = options || {};
const {
publishableKey = '',
tokenCache = MemoryTokenCache,
__experimental_resourceCache: createResourceCache,
} = options || {};
hasConfigChanged,
options: { publishableKey, proxyUrl, domain },
} = getUpdatedClerkOptions(__internal_clerkOptions, options);

if (!__internal_clerk && !publishableKey) {
errorThrower.throwMissingPublishableKeyError();
}

// Support "hot-swapping" the Clerk instance at runtime. See JS-598 for additional details.
const hasKeyChanged = __internal_clerk && !!publishableKey && publishableKey !== __internal_clerk.publishableKey;

if (!__internal_clerk || hasKeyChanged) {
if (hasKeyChanged) {
if (!__internal_clerk || hasConfigChanged) {
if (hasConfigChanged) {
tokenCache.clearToken?.(CLERK_CLIENT_JWT_KEY);
}

const getToken = tokenCache.getToken;
const saveToken = tokenCache.saveToken;
__internal_clerk = new ClerkClass(publishableKey) as unknown as BrowserClerk;
__internal_clerkOptions = { publishableKey, proxyUrl, domain };
__internal_clerk = new ClerkClass(publishableKey, { proxyUrl, domain }) as unknown as BrowserClerk;

if (Platform.OS === 'ios' || Platform.OS === 'android') {
// @ts-expect-error - This is an internal API
Expand Down
3 changes: 3 additions & 0 deletions packages/expo/src/provider/singleton/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type {
CredentialReturn,
DomainOrProxyUrl,
PublicKeyCredentialCreationOptionsWithoutExtensions,
PublicKeyCredentialRequestOptionsWithoutExtensions,
PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand All@@ -16,6 +17,8 @@ export interface IStorage {
export type BuildClerkOptions = {
publishableKey?: string;
tokenCache?: TokenCache;
proxyUrl?: DomainOrProxyUrl['proxyUrl'];
domain?: DomainOrProxyUrl['domain'];
/**
* Note: Passkey support in Expo is currently in a limited rollout phase.
* If you're interested in using this feature, please contact us for early access or additional details.
Expand Down
Loading