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
9 changes: 9 additions & 0 deletions .changeset/native-oauth-modal-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Fix native OAuth transport flows (e.g. `@clerk/electron`) breaking out of modal components and failing with "Redirect url mismatch" errors.

Intermediate OAuth callback steps (sign-in to sign-up transfer, continue, MFA factors, password reset) now navigate inside the component's own router instead of navigating the app window to an internal Clerk route. Transport flows also always send the registered transport callback URL as the completion redirect, so production instances no longer reject sign-in or sign-up requests when a page-derived URL was picked up as the completion redirect.
120 changes: 120 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1730,6 +1730,126 @@ describe('Clerk singleton', () => {
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigate for intermediate callback navigations instead of window-level navigation', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.handleRedirectCallback({
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('passes raw component-relative paths to __internal_navigate on development instances', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(developmentPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.__internal_handleResourceCallback(sut.client.signIn, {
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2389,10 +2389,14 @@ export class Clerk implements ClerkInterface {
const signIn = 'identifier' in (signInOrUp || {}) ? (signInOrUp as SignInResource) : _signIn;
const signUp = 'missingFields' in (signInOrUp || {}) ? (signInOrUp as SignUpResource) : _signUp;

// The component router expects raw component-relative paths; buildUrlWithAuth would absolutize
// them on development instances and push the navigation back out to the window.
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function'
? customNavigate(this.buildUrlWithAuth(to))
: this.navigate(this.buildUrlWithAuth(to));
: params.__internal_navigate && typeof params.__internal_navigate === 'function'
? params.__internal_navigate(to)
: this.navigate(this.buildUrlWithAuth(to));

return this._handleRedirectCallback(params, {
signUp,
Expand DownExpand Up@@ -2741,8 +2745,9 @@ export class Clerk implements ClerkInterface {
}
const { signIn, signUp } = this.client;

const resolvedNavigate = customNavigate ?? params.__internal_navigate;
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function' ? customNavigate(to) : this.navigate(to);
resolvedNavigate && typeof resolvedNavigate === 'function' ? resolvedNavigate(to) : this.navigate(to);

return this._handleRedirectCallback(params, {
signUp,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ describe('_authenticateWithTransport', () => {
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: '/done' }),
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: 'myapp://sso-callback' }),
expect.any(Function),
);
expect(transport.open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
Expand All@@ -43,6 +43,39 @@ describe('_authenticateWithTransport', () => {
expect(resource.create).not.toHaveBeenCalled();
});

it('replaces a page-derived redirectUrlComplete with the transport URL', async () => {
const clerk = makeClerk();
const transport = {
getRedirectUrl: vi.fn().mockResolvedValue('myapp://app/'),
open: vi.fn().mockResolvedValue({ callbackUrl: 'myapp://app/?rotating_token_nonce=abc' }),
};
const resource = {
reload: vi.fn().mockResolvedValue(undefined),
create: vi.fn().mockResolvedValue(undefined),
} as any;
const authenticateMethod = vi.fn(async (_params, navigate) => {
navigate(new URL('https://provider.example/auth'));
});

await _authenticateWithTransport({
clerk: clerk as any,
transport,
resource,
authenticateMethod,
params: {
strategy: 'oauth_google',
redirectUrl: 'some-ui-callback',
redirectUrlComplete: 'myapp://app/CLERK-ROUTER/VIRTUAL/sign-up#/settings/connections',
} as any,
callbackParams: {},
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://app/', redirectUrlComplete: 'myapp://app/' }),
expect.any(Function),
);
});

it('reloads without a nonce when the callback URL has no nonce', async () => {
const clerk = makeClerk();
const transport = {
Expand Down
4 changes: 3 additions & 1 deletion packages/clerk-js/src/utils/authenticateWithTransport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,9 @@ export async function _authenticateWithTransport(opts: {
const redirectUrl = String(await opts.transport.getRedirectUrl());

let verificationUrl: URL | string | undefined;
await opts.authenticateMethod({ ...opts.params, redirectUrl }, url => {
// Production FAPI validates both URLs against the redirect allowlist and only the transport
// callback is guaranteed registered; the app's destination is navigated client-side instead.
await opts.authenticateMethod({ ...opts.params, redirectUrl, redirectUrlComplete: redirectUrl }, url => {
verificationUrl = url;
});

Expand Down
8 changes: 8 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1325,6 +1325,14 @@ export type HandleOAuthCallbackParams = TransferableOption &
redirectUrl: string;
decorateUrl: (url: string) => string;
}) => Promise<unknown>;
/**
* Internal navigation hook used by Clerk UI to keep intermediate OAuth callback navigations
* (continue, factor steps, sign-in/sign-up switches) inside the component's own router when the
* callback completes in-process (transport flows). Not set by the web redirect/popup paths.
*
* @internal
*/
__internal_navigate?: (to: string) => Promise<unknown>;
};

export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignIn/SignInSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export const SignInSocialButtons = React.memo((props: SignInSocialButtonsProps)
__internal_callbackParams: {
...buildSignInOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ describe('SignInSocialButtons', () => {
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
}),
);
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignUp/SignUpSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ export const SignUpSocialButtons = React.memo((props: SignUpSocialButtonsProps)
__internal_callbackParams: {
...buildSignUpOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ describe('SignUpSocialButtons', () => {
verifyPhoneNumberUrl: 'verify-phone-number',
unsafeMetadata: { source: 'test' },
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
});
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/native-oauth-modal-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Fix native OAuth transport flows (e.g. `@clerk/electron`) breaking out of modal components and failing with "Redirect url mismatch" errors.

Intermediate OAuth callback steps (sign-in to sign-up transfer, continue, MFA factors, password reset) now navigate inside the component's own router instead of navigating the app window to an internal Clerk route. Transport flows also always send the registered transport callback URL as the completion redirect, so production instances no longer reject sign-in or sign-up requests when a page-derived URL was picked up as the completion redirect.
120 changes: 120 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1730,6 +1730,126 @@ describe('Clerk singleton', () => {
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigate for intermediate callback navigations instead of window-level navigation', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.handleRedirectCallback({
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('passes raw component-relative paths to __internal_navigate on development instances', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(developmentPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.__internal_handleResourceCallback(sut.client.signIn, {
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2389,10 +2389,14 @@ export class Clerk implements ClerkInterface {
const signIn = 'identifier' in (signInOrUp || {}) ? (signInOrUp as SignInResource) : _signIn;
const signUp = 'missingFields' in (signInOrUp || {}) ? (signInOrUp as SignUpResource) : _signUp;

// The component router expects raw component-relative paths; buildUrlWithAuth would absolutize
// them on development instances and push the navigation back out to the window.
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function'
? customNavigate(this.buildUrlWithAuth(to))
: this.navigate(this.buildUrlWithAuth(to));
: params.__internal_navigate && typeof params.__internal_navigate === 'function'
? params.__internal_navigate(to)
: this.navigate(this.buildUrlWithAuth(to));

return this._handleRedirectCallback(params, {
signUp,
Expand DownExpand Up@@ -2741,8 +2745,9 @@ export class Clerk implements ClerkInterface {
}
const { signIn, signUp } = this.client;

const resolvedNavigate = customNavigate ?? params.__internal_navigate;
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function' ? customNavigate(to) : this.navigate(to);
resolvedNavigate && typeof resolvedNavigate === 'function' ? resolvedNavigate(to) : this.navigate(to);

return this._handleRedirectCallback(params, {
signUp,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ describe('_authenticateWithTransport', () => {
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: '/done' }),
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: 'myapp://sso-callback' }),
expect.any(Function),
);
expect(transport.open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
Expand All@@ -43,6 +43,39 @@ describe('_authenticateWithTransport', () => {
expect(resource.create).not.toHaveBeenCalled();
});

it('replaces a page-derived redirectUrlComplete with the transport URL', async () => {
const clerk = makeClerk();
const transport = {
getRedirectUrl: vi.fn().mockResolvedValue('myapp://app/'),
open: vi.fn().mockResolvedValue({ callbackUrl: 'myapp://app/?rotating_token_nonce=abc' }),
};
const resource = {
reload: vi.fn().mockResolvedValue(undefined),
create: vi.fn().mockResolvedValue(undefined),
} as any;
const authenticateMethod = vi.fn(async (_params, navigate) => {
navigate(new URL('https://provider.example/auth'));
});

await _authenticateWithTransport({
clerk: clerk as any,
transport,
resource,
authenticateMethod,
params: {
strategy: 'oauth_google',
redirectUrl: 'some-ui-callback',
redirectUrlComplete: 'myapp://app/CLERK-ROUTER/VIRTUAL/sign-up#/settings/connections',
} as any,
callbackParams: {},
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://app/', redirectUrlComplete: 'myapp://app/' }),
expect.any(Function),
);
});

it('reloads without a nonce when the callback URL has no nonce', async () => {
const clerk = makeClerk();
const transport = {
Expand Down
4 changes: 3 additions & 1 deletion packages/clerk-js/src/utils/authenticateWithTransport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,9 @@ export async function _authenticateWithTransport(opts: {
const redirectUrl = String(await opts.transport.getRedirectUrl());

let verificationUrl: URL | string | undefined;
await opts.authenticateMethod({ ...opts.params, redirectUrl }, url => {
// Production FAPI validates both URLs against the redirect allowlist and only the transport
// callback is guaranteed registered; the app's destination is navigated client-side instead.
await opts.authenticateMethod({ ...opts.params, redirectUrl, redirectUrlComplete: redirectUrl }, url => {
verificationUrl = url;
});

Expand Down
8 changes: 8 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1325,6 +1325,14 @@ export type HandleOAuthCallbackParams = TransferableOption &
redirectUrl: string;
decorateUrl: (url: string) => string;
}) => Promise<unknown>;
/**
* Internal navigation hook used by Clerk UI to keep intermediate OAuth callback navigations
* (continue, factor steps, sign-in/sign-up switches) inside the component's own router when the
* callback completes in-process (transport flows). Not set by the web redirect/popup paths.
*
* @internal
*/
__internal_navigate?: (to: string) => Promise<unknown>;
};

export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignIn/SignInSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export const SignInSocialButtons = React.memo((props: SignInSocialButtonsProps)
__internal_callbackParams: {
...buildSignInOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ describe('SignInSocialButtons', () => {
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
}),
);
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignUp/SignUpSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ export const SignUpSocialButtons = React.memo((props: SignUpSocialButtonsProps)
__internal_callbackParams: {
...buildSignUpOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ describe('SignUpSocialButtons', () => {
verifyPhoneNumberUrl: 'verify-phone-number',
unsafeMetadata: { source: 'test' },
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
});
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/native-oauth-modal-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Fix native OAuth transport flows (e.g. `@clerk/electron`) breaking out of modal components and failing with "Redirect url mismatch" errors.

Intermediate OAuth callback steps (sign-in to sign-up transfer, continue, MFA factors, password reset) now navigate inside the component's own router instead of navigating the app window to an internal Clerk route. Transport flows also always send the registered transport callback URL as the completion redirect, so production instances no longer reject sign-in or sign-up requests when a page-derived URL was picked up as the completion redirect.
120 changes: 120 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1730,6 +1730,126 @@ describe('Clerk singleton', () => {
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigate for intermediate callback navigations instead of window-level navigation', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.handleRedirectCallback({
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('passes raw component-relative paths to __internal_navigate on development instances', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(developmentPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.__internal_handleResourceCallback(sut.client.signIn, {
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2389,10 +2389,14 @@ export class Clerk implements ClerkInterface {
const signIn = 'identifier' in (signInOrUp || {}) ? (signInOrUp as SignInResource) : _signIn;
const signUp = 'missingFields' in (signInOrUp || {}) ? (signInOrUp as SignUpResource) : _signUp;

// The component router expects raw component-relative paths; buildUrlWithAuth would absolutize
// them on development instances and push the navigation back out to the window.
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function'
? customNavigate(this.buildUrlWithAuth(to))
: this.navigate(this.buildUrlWithAuth(to));
: params.__internal_navigate && typeof params.__internal_navigate === 'function'
? params.__internal_navigate(to)
: this.navigate(this.buildUrlWithAuth(to));

return this._handleRedirectCallback(params, {
signUp,
Expand DownExpand Up@@ -2741,8 +2745,9 @@ export class Clerk implements ClerkInterface {
}
const { signIn, signUp } = this.client;

const resolvedNavigate = customNavigate ?? params.__internal_navigate;
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function' ? customNavigate(to) : this.navigate(to);
resolvedNavigate && typeof resolvedNavigate === 'function' ? resolvedNavigate(to) : this.navigate(to);

return this._handleRedirectCallback(params, {
signUp,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ describe('_authenticateWithTransport', () => {
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: '/done' }),
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: 'myapp://sso-callback' }),
expect.any(Function),
);
expect(transport.open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
Expand All@@ -43,6 +43,39 @@ describe('_authenticateWithTransport', () => {
expect(resource.create).not.toHaveBeenCalled();
});

it('replaces a page-derived redirectUrlComplete with the transport URL', async () => {
const clerk = makeClerk();
const transport = {
getRedirectUrl: vi.fn().mockResolvedValue('myapp://app/'),
open: vi.fn().mockResolvedValue({ callbackUrl: 'myapp://app/?rotating_token_nonce=abc' }),
};
const resource = {
reload: vi.fn().mockResolvedValue(undefined),
create: vi.fn().mockResolvedValue(undefined),
} as any;
const authenticateMethod = vi.fn(async (_params, navigate) => {
navigate(new URL('https://provider.example/auth'));
});

await _authenticateWithTransport({
clerk: clerk as any,
transport,
resource,
authenticateMethod,
params: {
strategy: 'oauth_google',
redirectUrl: 'some-ui-callback',
redirectUrlComplete: 'myapp://app/CLERK-ROUTER/VIRTUAL/sign-up#/settings/connections',
} as any,
callbackParams: {},
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://app/', redirectUrlComplete: 'myapp://app/' }),
expect.any(Function),
);
});

it('reloads without a nonce when the callback URL has no nonce', async () => {
const clerk = makeClerk();
const transport = {
Expand Down
4 changes: 3 additions & 1 deletion packages/clerk-js/src/utils/authenticateWithTransport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,9 @@ export async function _authenticateWithTransport(opts: {
const redirectUrl = String(await opts.transport.getRedirectUrl());

let verificationUrl: URL | string | undefined;
await opts.authenticateMethod({ ...opts.params, redirectUrl }, url => {
// Production FAPI validates both URLs against the redirect allowlist and only the transport
// callback is guaranteed registered; the app's destination is navigated client-side instead.
await opts.authenticateMethod({ ...opts.params, redirectUrl, redirectUrlComplete: redirectUrl }, url => {
verificationUrl = url;
});

Expand Down
8 changes: 8 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1325,6 +1325,14 @@ export type HandleOAuthCallbackParams = TransferableOption &
redirectUrl: string;
decorateUrl: (url: string) => string;
}) => Promise<unknown>;
/**
* Internal navigation hook used by Clerk UI to keep intermediate OAuth callback navigations
* (continue, factor steps, sign-in/sign-up switches) inside the component's own router when the
* callback completes in-process (transport flows). Not set by the web redirect/popup paths.
*
* @internal
*/
__internal_navigate?: (to: string) => Promise<unknown>;
};

export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignIn/SignInSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export const SignInSocialButtons = React.memo((props: SignInSocialButtonsProps)
__internal_callbackParams: {
...buildSignInOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ describe('SignInSocialButtons', () => {
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
}),
);
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignUp/SignUpSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ export const SignUpSocialButtons = React.memo((props: SignUpSocialButtonsProps)
__internal_callbackParams: {
...buildSignUpOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ describe('SignUpSocialButtons', () => {
verifyPhoneNumberUrl: 'verify-phone-number',
unsafeMetadata: { source: 'test' },
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
});
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/native-oauth-modal-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Fix native OAuth transport flows (e.g. `@clerk/electron`) breaking out of modal components and failing with "Redirect url mismatch" errors.

Intermediate OAuth callback steps (sign-in to sign-up transfer, continue, MFA factors, password reset) now navigate inside the component's own router instead of navigating the app window to an internal Clerk route. Transport flows also always send the registered transport callback URL as the completion redirect, so production instances no longer reject sign-in or sign-up requests when a page-derived URL was picked up as the completion redirect.
120 changes: 120 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1730,6 +1730,126 @@ describe('Clerk singleton', () => {
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigate for intermediate callback navigations instead of window-level navigation', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.handleRedirectCallback({
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('passes raw component-relative paths to __internal_navigate on development instances', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(developmentPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.__internal_handleResourceCallback(sut.client.signIn, {
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2389,10 +2389,14 @@ export class Clerk implements ClerkInterface {
const signIn = 'identifier' in (signInOrUp || {}) ? (signInOrUp as SignInResource) : _signIn;
const signUp = 'missingFields' in (signInOrUp || {}) ? (signInOrUp as SignUpResource) : _signUp;

// The component router expects raw component-relative paths; buildUrlWithAuth would absolutize
// them on development instances and push the navigation back out to the window.
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function'
? customNavigate(this.buildUrlWithAuth(to))
: this.navigate(this.buildUrlWithAuth(to));
: params.__internal_navigate && typeof params.__internal_navigate === 'function'
? params.__internal_navigate(to)
: this.navigate(this.buildUrlWithAuth(to));

return this._handleRedirectCallback(params, {
signUp,
Expand DownExpand Up@@ -2741,8 +2745,9 @@ export class Clerk implements ClerkInterface {
}
const { signIn, signUp } = this.client;

const resolvedNavigate = customNavigate ?? params.__internal_navigate;
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function' ? customNavigate(to) : this.navigate(to);
resolvedNavigate && typeof resolvedNavigate === 'function' ? resolvedNavigate(to) : this.navigate(to);

return this._handleRedirectCallback(params, {
signUp,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ describe('_authenticateWithTransport', () => {
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: '/done' }),
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: 'myapp://sso-callback' }),
expect.any(Function),
);
expect(transport.open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
Expand All@@ -43,6 +43,39 @@ describe('_authenticateWithTransport', () => {
expect(resource.create).not.toHaveBeenCalled();
});

it('replaces a page-derived redirectUrlComplete with the transport URL', async () => {
const clerk = makeClerk();
const transport = {
getRedirectUrl: vi.fn().mockResolvedValue('myapp://app/'),
open: vi.fn().mockResolvedValue({ callbackUrl: 'myapp://app/?rotating_token_nonce=abc' }),
};
const resource = {
reload: vi.fn().mockResolvedValue(undefined),
create: vi.fn().mockResolvedValue(undefined),
} as any;
const authenticateMethod = vi.fn(async (_params, navigate) => {
navigate(new URL('https://provider.example/auth'));
});

await _authenticateWithTransport({
clerk: clerk as any,
transport,
resource,
authenticateMethod,
params: {
strategy: 'oauth_google',
redirectUrl: 'some-ui-callback',
redirectUrlComplete: 'myapp://app/CLERK-ROUTER/VIRTUAL/sign-up#/settings/connections',
} as any,
callbackParams: {},
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://app/', redirectUrlComplete: 'myapp://app/' }),
expect.any(Function),
);
});

it('reloads without a nonce when the callback URL has no nonce', async () => {
const clerk = makeClerk();
const transport = {
Expand Down
4 changes: 3 additions & 1 deletion packages/clerk-js/src/utils/authenticateWithTransport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,9 @@ export async function _authenticateWithTransport(opts: {
const redirectUrl = String(await opts.transport.getRedirectUrl());

let verificationUrl: URL | string | undefined;
await opts.authenticateMethod({ ...opts.params, redirectUrl }, url => {
// Production FAPI validates both URLs against the redirect allowlist and only the transport
// callback is guaranteed registered; the app's destination is navigated client-side instead.
await opts.authenticateMethod({ ...opts.params, redirectUrl, redirectUrlComplete: redirectUrl }, url => {
verificationUrl = url;
});

Expand Down
8 changes: 8 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1325,6 +1325,14 @@ export type HandleOAuthCallbackParams = TransferableOption &
redirectUrl: string;
decorateUrl: (url: string) => string;
}) => Promise<unknown>;
/**
* Internal navigation hook used by Clerk UI to keep intermediate OAuth callback navigations
* (continue, factor steps, sign-in/sign-up switches) inside the component's own router when the
* callback completes in-process (transport flows). Not set by the web redirect/popup paths.
*
* @internal
*/
__internal_navigate?: (to: string) => Promise<unknown>;
};

export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignIn/SignInSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export const SignInSocialButtons = React.memo((props: SignInSocialButtonsProps)
__internal_callbackParams: {
...buildSignInOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ describe('SignInSocialButtons', () => {
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
}),
);
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignUp/SignUpSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ export const SignUpSocialButtons = React.memo((props: SignUpSocialButtonsProps)
__internal_callbackParams: {
...buildSignUpOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ describe('SignUpSocialButtons', () => {
verifyPhoneNumberUrl: 'verify-phone-number',
unsafeMetadata: { source: 'test' },
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
});
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/native-oauth-modal-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Fix native OAuth transport flows (e.g. `@clerk/electron`) breaking out of modal components and failing with "Redirect url mismatch" errors.

Intermediate OAuth callback steps (sign-in to sign-up transfer, continue, MFA factors, password reset) now navigate inside the component's own router instead of navigating the app window to an internal Clerk route. Transport flows also always send the registered transport callback URL as the completion redirect, so production instances no longer reject sign-in or sign-up requests when a page-derived URL was picked up as the completion redirect.
120 changes: 120 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1730,6 +1730,126 @@ describe('Clerk singleton', () => {
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigate for intermediate callback navigations instead of window-level navigation', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.handleRedirectCallback({
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('passes raw component-relative paths to __internal_navigate on development instances', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(developmentPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.__internal_handleResourceCallback(sut.client.signIn, {
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2389,10 +2389,14 @@ export class Clerk implements ClerkInterface {
const signIn = 'identifier' in (signInOrUp || {}) ? (signInOrUp as SignInResource) : _signIn;
const signUp = 'missingFields' in (signInOrUp || {}) ? (signInOrUp as SignUpResource) : _signUp;

// The component router expects raw component-relative paths; buildUrlWithAuth would absolutize
// them on development instances and push the navigation back out to the window.
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function'
? customNavigate(this.buildUrlWithAuth(to))
: this.navigate(this.buildUrlWithAuth(to));
: params.__internal_navigate && typeof params.__internal_navigate === 'function'
? params.__internal_navigate(to)
: this.navigate(this.buildUrlWithAuth(to));

return this._handleRedirectCallback(params, {
signUp,
Expand DownExpand Up@@ -2741,8 +2745,9 @@ export class Clerk implements ClerkInterface {
}
const { signIn, signUp } = this.client;

const resolvedNavigate = customNavigate ?? params.__internal_navigate;
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function' ? customNavigate(to) : this.navigate(to);
resolvedNavigate && typeof resolvedNavigate === 'function' ? resolvedNavigate(to) : this.navigate(to);

return this._handleRedirectCallback(params, {
signUp,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ describe('_authenticateWithTransport', () => {
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: '/done' }),
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: 'myapp://sso-callback' }),
expect.any(Function),
);
expect(transport.open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
Expand All@@ -43,6 +43,39 @@ describe('_authenticateWithTransport', () => {
expect(resource.create).not.toHaveBeenCalled();
});

it('replaces a page-derived redirectUrlComplete with the transport URL', async () => {
const clerk = makeClerk();
const transport = {
getRedirectUrl: vi.fn().mockResolvedValue('myapp://app/'),
open: vi.fn().mockResolvedValue({ callbackUrl: 'myapp://app/?rotating_token_nonce=abc' }),
};
const resource = {
reload: vi.fn().mockResolvedValue(undefined),
create: vi.fn().mockResolvedValue(undefined),
} as any;
const authenticateMethod = vi.fn(async (_params, navigate) => {
navigate(new URL('https://provider.example/auth'));
});

await _authenticateWithTransport({
clerk: clerk as any,
transport,
resource,
authenticateMethod,
params: {
strategy: 'oauth_google',
redirectUrl: 'some-ui-callback',
redirectUrlComplete: 'myapp://app/CLERK-ROUTER/VIRTUAL/sign-up#/settings/connections',
} as any,
callbackParams: {},
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://app/', redirectUrlComplete: 'myapp://app/' }),
expect.any(Function),
);
});

it('reloads without a nonce when the callback URL has no nonce', async () => {
const clerk = makeClerk();
const transport = {
Expand Down
4 changes: 3 additions & 1 deletion packages/clerk-js/src/utils/authenticateWithTransport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,9 @@ export async function _authenticateWithTransport(opts: {
const redirectUrl = String(await opts.transport.getRedirectUrl());

let verificationUrl: URL | string | undefined;
await opts.authenticateMethod({ ...opts.params, redirectUrl }, url => {
// Production FAPI validates both URLs against the redirect allowlist and only the transport
// callback is guaranteed registered; the app's destination is navigated client-side instead.
await opts.authenticateMethod({ ...opts.params, redirectUrl, redirectUrlComplete: redirectUrl }, url => {
verificationUrl = url;
});

Expand Down
8 changes: 8 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1325,6 +1325,14 @@ export type HandleOAuthCallbackParams = TransferableOption &
redirectUrl: string;
decorateUrl: (url: string) => string;
}) => Promise<unknown>;
/**
* Internal navigation hook used by Clerk UI to keep intermediate OAuth callback navigations
* (continue, factor steps, sign-in/sign-up switches) inside the component's own router when the
* callback completes in-process (transport flows). Not set by the web redirect/popup paths.
*
* @internal
*/
__internal_navigate?: (to: string) => Promise<unknown>;
};

export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignIn/SignInSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export const SignInSocialButtons = React.memo((props: SignInSocialButtonsProps)
__internal_callbackParams: {
...buildSignInOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ describe('SignInSocialButtons', () => {
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
}),
);
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignUp/SignUpSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ export const SignUpSocialButtons = React.memo((props: SignUpSocialButtonsProps)
__internal_callbackParams: {
...buildSignUpOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ describe('SignUpSocialButtons', () => {
verifyPhoneNumberUrl: 'verify-phone-number',
unsafeMetadata: { source: 'test' },
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
});
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/native-oauth-modal-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Fix native OAuth transport flows (e.g. `@clerk/electron`) breaking out of modal components and failing with "Redirect url mismatch" errors.

Intermediate OAuth callback steps (sign-in to sign-up transfer, continue, MFA factors, password reset) now navigate inside the component's own router instead of navigating the app window to an internal Clerk route. Transport flows also always send the registered transport callback URL as the completion redirect, so production instances no longer reject sign-in or sign-up requests when a page-derived URL was picked up as the completion redirect.
120 changes: 120 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1730,6 +1730,126 @@ describe('Clerk singleton', () => {
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigate for intermediate callback navigations instead of window-level navigation', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.handleRedirectCallback({
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('passes raw component-relative paths to __internal_navigate on development instances', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(developmentPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.__internal_handleResourceCallback(sut.client.signIn, {
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2389,10 +2389,14 @@ export class Clerk implements ClerkInterface {
const signIn = 'identifier' in (signInOrUp || {}) ? (signInOrUp as SignInResource) : _signIn;
const signUp = 'missingFields' in (signInOrUp || {}) ? (signInOrUp as SignUpResource) : _signUp;

// The component router expects raw component-relative paths; buildUrlWithAuth would absolutize
// them on development instances and push the navigation back out to the window.
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function'
? customNavigate(this.buildUrlWithAuth(to))
: this.navigate(this.buildUrlWithAuth(to));
: params.__internal_navigate && typeof params.__internal_navigate === 'function'
? params.__internal_navigate(to)
: this.navigate(this.buildUrlWithAuth(to));

return this._handleRedirectCallback(params, {
signUp,
Expand DownExpand Up@@ -2741,8 +2745,9 @@ export class Clerk implements ClerkInterface {
}
const { signIn, signUp } = this.client;

const resolvedNavigate = customNavigate ?? params.__internal_navigate;
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function' ? customNavigate(to) : this.navigate(to);
resolvedNavigate && typeof resolvedNavigate === 'function' ? resolvedNavigate(to) : this.navigate(to);

return this._handleRedirectCallback(params, {
signUp,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ describe('_authenticateWithTransport', () => {
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: '/done' }),
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: 'myapp://sso-callback' }),
expect.any(Function),
);
expect(transport.open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
Expand All@@ -43,6 +43,39 @@ describe('_authenticateWithTransport', () => {
expect(resource.create).not.toHaveBeenCalled();
});

it('replaces a page-derived redirectUrlComplete with the transport URL', async () => {
const clerk = makeClerk();
const transport = {
getRedirectUrl: vi.fn().mockResolvedValue('myapp://app/'),
open: vi.fn().mockResolvedValue({ callbackUrl: 'myapp://app/?rotating_token_nonce=abc' }),
};
const resource = {
reload: vi.fn().mockResolvedValue(undefined),
create: vi.fn().mockResolvedValue(undefined),
} as any;
const authenticateMethod = vi.fn(async (_params, navigate) => {
navigate(new URL('https://provider.example/auth'));
});

await _authenticateWithTransport({
clerk: clerk as any,
transport,
resource,
authenticateMethod,
params: {
strategy: 'oauth_google',
redirectUrl: 'some-ui-callback',
redirectUrlComplete: 'myapp://app/CLERK-ROUTER/VIRTUAL/sign-up#/settings/connections',
} as any,
callbackParams: {},
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://app/', redirectUrlComplete: 'myapp://app/' }),
expect.any(Function),
);
});

it('reloads without a nonce when the callback URL has no nonce', async () => {
const clerk = makeClerk();
const transport = {
Expand Down
4 changes: 3 additions & 1 deletion packages/clerk-js/src/utils/authenticateWithTransport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,9 @@ export async function _authenticateWithTransport(opts: {
const redirectUrl = String(await opts.transport.getRedirectUrl());

let verificationUrl: URL | string | undefined;
await opts.authenticateMethod({ ...opts.params, redirectUrl }, url => {
// Production FAPI validates both URLs against the redirect allowlist and only the transport
// callback is guaranteed registered; the app's destination is navigated client-side instead.
await opts.authenticateMethod({ ...opts.params, redirectUrl, redirectUrlComplete: redirectUrl }, url => {
verificationUrl = url;
});

Expand Down
8 changes: 8 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1325,6 +1325,14 @@ export type HandleOAuthCallbackParams = TransferableOption &
redirectUrl: string;
decorateUrl: (url: string) => string;
}) => Promise<unknown>;
/**
* Internal navigation hook used by Clerk UI to keep intermediate OAuth callback navigations
* (continue, factor steps, sign-in/sign-up switches) inside the component's own router when the
* callback completes in-process (transport flows). Not set by the web redirect/popup paths.
*
* @internal
*/
__internal_navigate?: (to: string) => Promise<unknown>;
};

export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignIn/SignInSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export const SignInSocialButtons = React.memo((props: SignInSocialButtonsProps)
__internal_callbackParams: {
...buildSignInOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ describe('SignInSocialButtons', () => {
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
}),
);
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignUp/SignUpSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ export const SignUpSocialButtons = React.memo((props: SignUpSocialButtonsProps)
__internal_callbackParams: {
...buildSignUpOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ describe('SignUpSocialButtons', () => {
verifyPhoneNumberUrl: 'verify-phone-number',
unsafeMetadata: { source: 'test' },
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
});
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/native-oauth-modal-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Fix native OAuth transport flows (e.g. `@clerk/electron`) breaking out of modal components and failing with "Redirect url mismatch" errors.

Intermediate OAuth callback steps (sign-in to sign-up transfer, continue, MFA factors, password reset) now navigate inside the component's own router instead of navigating the app window to an internal Clerk route. Transport flows also always send the registered transport callback URL as the completion redirect, so production instances no longer reject sign-in or sign-up requests when a page-derived URL was picked up as the completion redirect.
120 changes: 120 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1730,6 +1730,126 @@ describe('Clerk singleton', () => {
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigate for intermediate callback navigations instead of window-level navigation', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.handleRedirectCallback({
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('passes raw component-relative paths to __internal_navigate on development instances', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(developmentPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.__internal_handleResourceCallback(sut.client.signIn, {
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2389,10 +2389,14 @@ export class Clerk implements ClerkInterface {
const signIn = 'identifier' in (signInOrUp || {}) ? (signInOrUp as SignInResource) : _signIn;
const signUp = 'missingFields' in (signInOrUp || {}) ? (signInOrUp as SignUpResource) : _signUp;

// The component router expects raw component-relative paths; buildUrlWithAuth would absolutize
// them on development instances and push the navigation back out to the window.
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function'
? customNavigate(this.buildUrlWithAuth(to))
: this.navigate(this.buildUrlWithAuth(to));
: params.__internal_navigate && typeof params.__internal_navigate === 'function'
? params.__internal_navigate(to)
: this.navigate(this.buildUrlWithAuth(to));

return this._handleRedirectCallback(params, {
signUp,
Expand DownExpand Up@@ -2741,8 +2745,9 @@ export class Clerk implements ClerkInterface {
}
const { signIn, signUp } = this.client;

const resolvedNavigate = customNavigate ?? params.__internal_navigate;
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function' ? customNavigate(to) : this.navigate(to);
resolvedNavigate && typeof resolvedNavigate === 'function' ? resolvedNavigate(to) : this.navigate(to);

return this._handleRedirectCallback(params, {
signUp,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ describe('_authenticateWithTransport', () => {
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: '/done' }),
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: 'myapp://sso-callback' }),
expect.any(Function),
);
expect(transport.open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
Expand All@@ -43,6 +43,39 @@ describe('_authenticateWithTransport', () => {
expect(resource.create).not.toHaveBeenCalled();
});

it('replaces a page-derived redirectUrlComplete with the transport URL', async () => {
const clerk = makeClerk();
const transport = {
getRedirectUrl: vi.fn().mockResolvedValue('myapp://app/'),
open: vi.fn().mockResolvedValue({ callbackUrl: 'myapp://app/?rotating_token_nonce=abc' }),
};
const resource = {
reload: vi.fn().mockResolvedValue(undefined),
create: vi.fn().mockResolvedValue(undefined),
} as any;
const authenticateMethod = vi.fn(async (_params, navigate) => {
navigate(new URL('https://provider.example/auth'));
});

await _authenticateWithTransport({
clerk: clerk as any,
transport,
resource,
authenticateMethod,
params: {
strategy: 'oauth_google',
redirectUrl: 'some-ui-callback',
redirectUrlComplete: 'myapp://app/CLERK-ROUTER/VIRTUAL/sign-up#/settings/connections',
} as any,
callbackParams: {},
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://app/', redirectUrlComplete: 'myapp://app/' }),
expect.any(Function),
);
});

it('reloads without a nonce when the callback URL has no nonce', async () => {
const clerk = makeClerk();
const transport = {
Expand Down
4 changes: 3 additions & 1 deletion packages/clerk-js/src/utils/authenticateWithTransport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,9 @@ export async function _authenticateWithTransport(opts: {
const redirectUrl = String(await opts.transport.getRedirectUrl());

let verificationUrl: URL | string | undefined;
await opts.authenticateMethod({ ...opts.params, redirectUrl }, url => {
// Production FAPI validates both URLs against the redirect allowlist and only the transport
// callback is guaranteed registered; the app's destination is navigated client-side instead.
await opts.authenticateMethod({ ...opts.params, redirectUrl, redirectUrlComplete: redirectUrl }, url => {
verificationUrl = url;
});

Expand Down
8 changes: 8 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1325,6 +1325,14 @@ export type HandleOAuthCallbackParams = TransferableOption &
redirectUrl: string;
decorateUrl: (url: string) => string;
}) => Promise<unknown>;
/**
* Internal navigation hook used by Clerk UI to keep intermediate OAuth callback navigations
* (continue, factor steps, sign-in/sign-up switches) inside the component's own router when the
* callback completes in-process (transport flows). Not set by the web redirect/popup paths.
*
* @internal
*/
__internal_navigate?: (to: string) => Promise<unknown>;
};

export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignIn/SignInSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export const SignInSocialButtons = React.memo((props: SignInSocialButtonsProps)
__internal_callbackParams: {
...buildSignInOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ describe('SignInSocialButtons', () => {
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
}),
);
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignUp/SignUpSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ export const SignUpSocialButtons = React.memo((props: SignUpSocialButtonsProps)
__internal_callbackParams: {
...buildSignUpOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ describe('SignUpSocialButtons', () => {
verifyPhoneNumberUrl: 'verify-phone-number',
unsafeMetadata: { source: 'test' },
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
});
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/native-oauth-modal-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Fix native OAuth transport flows (e.g. `@clerk/electron`) breaking out of modal components and failing with "Redirect url mismatch" errors.

Intermediate OAuth callback steps (sign-in to sign-up transfer, continue, MFA factors, password reset) now navigate inside the component's own router instead of navigating the app window to an internal Clerk route. Transport flows also always send the registered transport callback URL as the completion redirect, so production instances no longer reject sign-in or sign-up requests when a page-derived URL was picked up as the completion redirect.
120 changes: 120 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1730,6 +1730,126 @@ describe('Clerk singleton', () => {
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigate for intermediate callback navigations instead of window-level navigation', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.handleRedirectCallback({
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('passes raw component-relative paths to __internal_navigate on development instances', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'needs_identifier',
first_factor_verification: {
status: 'transferable',
strategy: 'oauth_google',
external_verification_redirect_url: '',
error: {
code: 'external_account_not_found',
long_message: 'The External Account was not found.',
message: 'Invalid external account',
},
},
second_factor_verification: null,
identifier: '',
user_data: null,
created_session_id: null,
created_user_id: null,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigate = vi.fn().mockResolvedValue(undefined);
const mockSignUpCreate = vi
.fn()
.mockReturnValue(Promise.resolve({ status: 'missing_requirements', missingFields: ['phone_number'] }));

const sut = new Clerk(developmentPublishableKey);
await sut.load(mockedLoadOptions);
if (!sut.client) {
fail('we should always have a client');
}
sut.client.signUp.create = mockSignUpCreate;

await sut.__internal_handleResourceCallback(sut.client.signIn, {
continueSignUpUrl: 'continue',
__internal_navigate: internalNavigate,
});

await waitFor(() => {
expect(internalNavigate).toHaveBeenCalledWith('continue');
});
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2389,10 +2389,14 @@ export class Clerk implements ClerkInterface {
const signIn = 'identifier' in (signInOrUp || {}) ? (signInOrUp as SignInResource) : _signIn;
const signUp = 'missingFields' in (signInOrUp || {}) ? (signInOrUp as SignUpResource) : _signUp;

// The component router expects raw component-relative paths; buildUrlWithAuth would absolutize
// them on development instances and push the navigation back out to the window.
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function'
? customNavigate(this.buildUrlWithAuth(to))
: this.navigate(this.buildUrlWithAuth(to));
: params.__internal_navigate && typeof params.__internal_navigate === 'function'
? params.__internal_navigate(to)
: this.navigate(this.buildUrlWithAuth(to));

return this._handleRedirectCallback(params, {
signUp,
Expand DownExpand Up@@ -2741,8 +2745,9 @@ export class Clerk implements ClerkInterface {
}
const { signIn, signUp } = this.client;

const resolvedNavigate = customNavigate ?? params.__internal_navigate;
const navigate = (to: string) =>
customNavigate && typeof customNavigate === 'function' ? customNavigate(to) : this.navigate(to);
resolvedNavigate && typeof resolvedNavigate === 'function' ? resolvedNavigate(to) : this.navigate(to);

return this._handleRedirectCallback(params, {
signUp,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ describe('_authenticateWithTransport', () => {
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: '/done' }),
expect.objectContaining({ redirectUrl: 'myapp://sso-callback', redirectUrlComplete: 'myapp://sso-callback' }),
expect.any(Function),
);
expect(transport.open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
Expand All@@ -43,6 +43,39 @@ describe('_authenticateWithTransport', () => {
expect(resource.create).not.toHaveBeenCalled();
});

it('replaces a page-derived redirectUrlComplete with the transport URL', async () => {
const clerk = makeClerk();
const transport = {
getRedirectUrl: vi.fn().mockResolvedValue('myapp://app/'),
open: vi.fn().mockResolvedValue({ callbackUrl: 'myapp://app/?rotating_token_nonce=abc' }),
};
const resource = {
reload: vi.fn().mockResolvedValue(undefined),
create: vi.fn().mockResolvedValue(undefined),
} as any;
const authenticateMethod = vi.fn(async (_params, navigate) => {
navigate(new URL('https://provider.example/auth'));
});

await _authenticateWithTransport({
clerk: clerk as any,
transport,
resource,
authenticateMethod,
params: {
strategy: 'oauth_google',
redirectUrl: 'some-ui-callback',
redirectUrlComplete: 'myapp://app/CLERK-ROUTER/VIRTUAL/sign-up#/settings/connections',
} as any,
callbackParams: {},
});

expect(authenticateMethod).toHaveBeenCalledWith(
expect.objectContaining({ redirectUrl: 'myapp://app/', redirectUrlComplete: 'myapp://app/' }),
expect.any(Function),
);
});

it('reloads without a nonce when the callback URL has no nonce', async () => {
const clerk = makeClerk();
const transport = {
Expand Down
4 changes: 3 additions & 1 deletion packages/clerk-js/src/utils/authenticateWithTransport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,9 @@ export async function _authenticateWithTransport(opts: {
const redirectUrl = String(await opts.transport.getRedirectUrl());

let verificationUrl: URL | string | undefined;
await opts.authenticateMethod({ ...opts.params, redirectUrl }, url => {
// Production FAPI validates both URLs against the redirect allowlist and only the transport
// callback is guaranteed registered; the app's destination is navigated client-side instead.
await opts.authenticateMethod({ ...opts.params, redirectUrl, redirectUrlComplete: redirectUrl }, url => {
verificationUrl = url;
});

Expand Down
8 changes: 8 additions & 0 deletions packages/shared/src/types/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1325,6 +1325,14 @@ export type HandleOAuthCallbackParams = TransferableOption &
redirectUrl: string;
decorateUrl: (url: string) => string;
}) => Promise<unknown>;
/**
* Internal navigation hook used by Clerk UI to keep intermediate OAuth callback navigations
* (continue, factor steps, sign-in/sign-up switches) inside the component's own router when the
* callback completes in-process (transport flows). Not set by the web redirect/popup paths.
*
* @internal
*/
__internal_navigate?: (to: string) => Promise<unknown>;
};

export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignIn/SignInSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export const SignInSocialButtons = React.memo((props: SignInSocialButtonsProps)
__internal_callbackParams: {
...buildSignInOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ describe('SignInSocialButtons', () => {
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
}),
);
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/components/SignUp/SignUpSocialButtons.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ export const SignUpSocialButtons = React.memo((props: SignUpSocialButtonsProps)
__internal_callbackParams: {
...buildSignUpOAuthTransportCallbackParams(ctx),
__internal_navigateOnSetActive: ctx.navigateOnSetActive,
__internal_navigate: navigate,
},
})
.catch(err => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ describe('SignUpSocialButtons', () => {
verifyPhoneNumberUrl: 'verify-phone-number',
unsafeMetadata: { source: 'test' },
__internal_navigateOnSetActive: expect.any(Function),
__internal_navigate: expect.any(Function),
}),
});
});
Expand Down
Loading