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/electron-virtual-router-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/electron': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Keep Clerk's navigation inside the renderer. `ClerkProvider` now always supplies `routerPush`/`routerReplace`, so Clerk routes through your application's router when you provide one, and never navigates the window to an internal `/CLERK-ROUTER/VIRTUAL/...` path β€” which no custom protocol handler can serve, and which reloaded the renderer and dropped the user out of sign-in.

Applications that worked around this by passing no-op router functions, or by filtering `CLERK-ROUTER/VIRTUAL` out themselves, can remove those workarounds.
5 changes: 5 additions & 0 deletions .changeset/signin-transport-transfer-next-step.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Route an OAuth transfer to the sign-up continue step when sign-in uses a native OAuth transport. The callback previously navigated with hash-style URLs (`<sign-up-url>#/continue`) that the in-place component router cannot resolve, landing transferred sign-ups on the start card where submitting created a fresh sign-up without the verified external account.
4 changes: 2 additions & 2 deletions integration/templates/electron-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,8 +12,8 @@ function App() {
<ClerkProvider
publishableKey={PUBLISHABLE_KEY}
__internal_clerkUIUrl={CLERK_UI_URL}
routerPush={() => {}}
routerReplace={() => {}}
routerPush={(to: string) => window.history.pushState(null, '', to)}
routerReplace={(to: string) => window.history.replaceState(null, '', to)}
>
<main data-testid='electron-app'>
<Show when='signed-out'>
Expand Down
21 changes: 21 additions & 0 deletions integration/tests/electron/basic.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ type ElectronWindow = Window & {
tokenCache?: Partial<Record<'clearToken' | 'getToken' | 'saveToken', unknown>>;
oauthTransport?: Partial<Record<'getRedirectUrl' | 'open', unknown>>;
};
__hardNavigations?: string[];
};

test.describe('electron basic auth @electron', () => {
Expand DownExpand Up@@ -74,4 +75,24 @@ test.describe('electron basic auth @electron', () => {
test('keeps the signed-out state after relaunch', async ({ electronPage }) => {
await expect(electronPage.locator('.cl-signIn-root')).toBeVisible({ timeout: 30_000 });
});

test('never hard navigates the renderer during sign-in', async ({ electronPage }) => {
const { signIn } = createPageObjects({ page: electronPage, useTestingToken: false });

await electronPage.evaluate(() => {
(window as ElectronWindow).__hardNavigations = [];
addEventListener('clerk:beforeunload', () => {
(window as ElectronWindow).__hardNavigations?.push(location.href);
});
});

await signIn.waitForMounted();
await signIn.setIdentifier(fakeUser.email!);
await signIn.continue();
await signIn.setPassword(fakeUser.password);
await signIn.continue();

await expect(electronPage.locator('[data-testid="user-id"]')).toHaveText(/^user_/, { timeout: 30_000 });
await expect(electronPage.evaluate(() => (window as ElectronWindow).__hardNavigations)).resolves.toEqual([]);
});
});
71 changes: 71 additions & 0 deletions packages/electron/src/react/__tests__/ClerkProvider.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,77 @@ describe('Electron ClerkProvider', () => {
});
});

describe('router handlers', () => {
const renderWithRouter = (props: Record<string, unknown> = {}) => {
renderToStaticMarkup(
<ClerkProvider
publishableKey='pk_test_provider'
{...props}
>
<span>App</span>
</ClerkProvider>,
);

return {
routerPush: capturedProviderProps?.routerPush as (to: string, metadata?: unknown) => void,
routerReplace: capturedProviderProps?.routerReplace as (to: string, metadata?: unknown) => void,
};
};

it('always supplies both handlers so clerk-js never falls back to a window navigation', () => {
const { routerPush, routerReplace } = renderWithRouter();

expect(routerPush).toBeTypeOf('function');
expect(routerReplace).toBeTypeOf('function');
});

it('absorbs virtual router paths instead of forwarding them to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });
routerReplace('/CLERK-ROUTER/VIRTUAL/sign-in#/factor-two', { windowNavigate });

expect(push).not.toHaveBeenCalled();
expect(replace).not.toHaveBeenCalled();
expect(windowNavigate).not.toHaveBeenCalled();
});

it('absorbs virtual router paths even without an application router', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });

expect(windowNavigate).not.toHaveBeenCalled();
});

it('forwards real destinations to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/settings/connections', { windowNavigate });
routerReplace('/dashboard', { windowNavigate });

expect(push).toHaveBeenCalledWith('/settings/connections', { windowNavigate });
expect(replace).toHaveBeenCalledWith('/dashboard', { windowNavigate });
expect(windowNavigate).not.toHaveBeenCalled();
});

it('falls back to the host navigation for real destinations when no application router is provided', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/settings/connections', { windowNavigate });

expect(windowNavigate).toHaveBeenCalledWith('/settings/connections');
});
});

it('defaults allowedRedirectProtocols to the renderer custom scheme', () => {
stubWindowProtocol('clerk:');

Expand Down
29 changes: 29 additions & 0 deletions packages/electron/src/react/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkProviderProps as ReactClerkProviderProps } from '@clerk/react';
import { InternalClerkProvider as ReactClerkProvider } from '@clerk/react/internal';
import { isVirtualRouterPath } from '@clerk/shared/internal/clerk-js/url';
import { ALLOWED_PROTOCOLS } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { loadClerkUIScript } from '@clerk/shared/loadClerkJsScript';
import type { ClerkUIConstructor } from '@clerk/shared/ui';
Expand DownExpand Up@@ -79,6 +80,30 @@ function createOAuthTransport(): ClerkOAuthTransport | undefined {
};
}

type ClerkRouterFn = NonNullable<ReactClerkProviderProps['routerPush']>;

/** Always supplied, so clerk-js never reaches `window.location` and reloads the renderer. */
function createRouterHandlers(
routerPush: ClerkRouterFn | undefined,
routerReplace: ClerkRouterFn | undefined,
): { routerPush: ClerkRouterFn; routerReplace: ClerkRouterFn } {
const wrap =
(delegate: ClerkRouterFn | undefined): ClerkRouterFn =>
(to, metadata) => {
if (isVirtualRouterPath(to)) {
return;
}

if (delegate) {
return delegate(to, metadata);
}

metadata?.windowNavigate(to);
};

return { routerPush: wrap(routerPush), routerReplace: wrap(routerReplace) };
}

/**
* Infer the custom renderer scheme registered with `createClerkBridge({ renderer })`.
* Built-in Clerk protocols and local file renderers are not inferred.
Expand All@@ -98,15 +123,19 @@ export function ClerkProvider({
publishableKey,
passkeys,
allowedRedirectProtocols,
routerPush,
routerReplace,
...props
}: ClerkProviderProps): JSX.Element {
const clerk = createClerkInstance(publishableKey, passkeys);
const oauthTransport = createOAuthTransport();
const clerkUI = loadClerkUI(publishableKey, props);
const routerHandlers = createRouterHandlers(routerPush, routerReplace);

return (
<ReactClerkProvider
{...props}
{...routerHandlers}
Clerk={clerk}
__internal_oauthTransport={oauthTransport}
allowedRedirectProtocols={allowedRedirectProtocols ?? defaultAllowedRedirectProtocols()}
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/internal/clerk-js/url.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,13 @@ export const pathFromFullPath = (fullPath: string) => {
return fullPath.replace(/CLERK-ROUTER\/(.*?)\//, '');
};

export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

/**
* Whether `to` addresses the in-memory component router rather than a real application route.
*/
export const isVirtualRouterPath = (to: string): boolean => to.includes(VIRTUAL_ROUTER_BASE_PATH);

const frontendApiRedirectPathsWithUserInput: string[] = [
'/oauth/authorize', // OAuth2 identify provider flow
];
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,22 +55,72 @@ describe('buildSignInOAuthTransportCallbackParams', () => {
unsafeMetadata: { a: 1 },
} as any;

const origin = window.location.origin;

expect(buildSignInOAuthTransportCallbackParams(ctx)).toEqual({
signUpUrl: '/sign-up',
signInUrl: '/sign-in',
signInForceRedirectUrl: '/after-in',
signUpForceRedirectUrl: '/after-up',
continueSignUpUrl: '/continue',
transferable: true,
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
// Relative to the SignIn start route; the sign-up gate URL stays absolute (combined-aware).
signInProtectCheckUrl: 'protect-check',
signUpProtectCheckUrl: '/sign-up-protect-check',
// Sign-up steps are path routes on the sign-up component; hash-style URLs would lose their
// hash in the virtual router and land a transferred sign-up on the start card.
continueSignUpUrl: `${origin}/sign-up/continue`,
verifyEmailAddressUrl: `${origin}/sign-up/verify-email-address`,
verifyPhoneNumberUrl: `${origin}/sign-up/verify-phone-number`,
signUpProtectCheckUrl: `${origin}/sign-up/protect-check`,
unsafeMetadata: { a: 1 },
});
});

it('targets the virtual sign-up routes for modal transport callbacks', () => {
const ctx = {
signUpUrl: '/CLERK-ROUTER/VIRTUAL/sign-up',
signInUrl: '/CLERK-ROUTER/VIRTUAL/sign-in',
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/protect-check`);
});

it('drops a hash fragment from signUpUrl when building sign-up step URLs', () => {
const ctx = {
signUpUrl: '/sign-up#/continue',
signInUrl: '/sign-in',
} as any;
Comment thread
coderabbitai[bot] marked this conversation as resolved.

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/sign-up/protect-check`);
});

it('targets the embedded create subtree in the combined flow', () => {
const ctx = {
signUpUrl: '/sign-in#/create',
signInUrl: '/sign-in',
isCombinedFlow: true,
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);

expect(params.continueSignUpUrl).toBe('create/continue');
expect(params.verifyEmailAddressUrl).toBe('create/verify-email-address');
expect(params.verifyPhoneNumberUrl).toBe('create/verify-phone-number');
expect(params.signUpProtectCheckUrl).toBe('create/protect-check');
});
Comment thread
coderabbitai[bot] marked this conversation as resolved.
});

describe('buildSignUpOAuthCallbackParams', () => {
Expand Down
16 changes: 16 additions & 0 deletions packages/ui/src/components/SignIn/buildOAuthCallbackParams.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { buildURL, trimTrailingSlash } from '@clerk/shared/internal/clerk-js/url';
import type { HandleOAuthCallbackParams } from '@clerk/shared/types';

import type { SignInContextType } from '../../contexts/components/SignIn';
Expand All@@ -23,12 +24,27 @@ export function buildSignInOAuthCallbackParams(ctx: SignInContextType): HandleOA
}

export function buildSignInOAuthTransportCallbackParams(ctx: SignInContextType): HandleOAuthCallbackParams {
// Path form, not `#/step`: the in-place component router matches on pathname only and would drop the hash.
const signUpStepUrl = (step: string): string => {
if (ctx.isCombinedFlow) {
return `create/${step}`;
}
const url = buildURL({ base: ctx.signUpUrl }, { stringify: false });
url.pathname = `${trimTrailingSlash(url.pathname)}/${step}`;
url.hash = '';
return url.href;
};

return {
...buildSignInOAuthCallbackParams(ctx),
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
signInProtectCheckUrl: 'protect-check',
continueSignUpUrl: signUpStepUrl('continue'),
verifyEmailAddressUrl: signUpStepUrl('verify-email-address'),
verifyPhoneNumberUrl: signUpStepUrl('verify-phone-number'),
signUpProtectCheckUrl: signUpStepUrl('protect-check'),
};
}

Expand Down
4 changes: 3 additions & 1 deletion packages/ui/src/router/VirtualRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import { VIRTUAL_ROUTER_BASE_PATH } from '@clerk/shared/internal/clerk-js/url';
import { useClerk } from '@clerk/shared/react';
import React, { useEffect } from 'react';

import { useClerkModalStateParams } from '../hooks';
import { BaseRouter } from './BaseRouter';
export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

export { VIRTUAL_ROUTER_BASE_PATH };

interface VirtualRouterProps {
startPath: string;
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/electron-virtual-router-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/electron': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Keep Clerk's navigation inside the renderer. `ClerkProvider` now always supplies `routerPush`/`routerReplace`, so Clerk routes through your application's router when you provide one, and never navigates the window to an internal `/CLERK-ROUTER/VIRTUAL/...` path β€” which no custom protocol handler can serve, and which reloaded the renderer and dropped the user out of sign-in.

Applications that worked around this by passing no-op router functions, or by filtering `CLERK-ROUTER/VIRTUAL` out themselves, can remove those workarounds.
5 changes: 5 additions & 0 deletions .changeset/signin-transport-transfer-next-step.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Route an OAuth transfer to the sign-up continue step when sign-in uses a native OAuth transport. The callback previously navigated with hash-style URLs (`<sign-up-url>#/continue`) that the in-place component router cannot resolve, landing transferred sign-ups on the start card where submitting created a fresh sign-up without the verified external account.
4 changes: 2 additions & 2 deletions integration/templates/electron-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,8 +12,8 @@ function App() {
<ClerkProvider
publishableKey={PUBLISHABLE_KEY}
__internal_clerkUIUrl={CLERK_UI_URL}
routerPush={() => {}}
routerReplace={() => {}}
routerPush={(to: string) => window.history.pushState(null, '', to)}
routerReplace={(to: string) => window.history.replaceState(null, '', to)}
>
<main data-testid='electron-app'>
<Show when='signed-out'>
Expand Down
21 changes: 21 additions & 0 deletions integration/tests/electron/basic.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ type ElectronWindow = Window & {
tokenCache?: Partial<Record<'clearToken' | 'getToken' | 'saveToken', unknown>>;
oauthTransport?: Partial<Record<'getRedirectUrl' | 'open', unknown>>;
};
__hardNavigations?: string[];
};

test.describe('electron basic auth @electron', () => {
Expand DownExpand Up@@ -74,4 +75,24 @@ test.describe('electron basic auth @electron', () => {
test('keeps the signed-out state after relaunch', async ({ electronPage }) => {
await expect(electronPage.locator('.cl-signIn-root')).toBeVisible({ timeout: 30_000 });
});

test('never hard navigates the renderer during sign-in', async ({ electronPage }) => {
const { signIn } = createPageObjects({ page: electronPage, useTestingToken: false });

await electronPage.evaluate(() => {
(window as ElectronWindow).__hardNavigations = [];
addEventListener('clerk:beforeunload', () => {
(window as ElectronWindow).__hardNavigations?.push(location.href);
});
});

await signIn.waitForMounted();
await signIn.setIdentifier(fakeUser.email!);
await signIn.continue();
await signIn.setPassword(fakeUser.password);
await signIn.continue();

await expect(electronPage.locator('[data-testid="user-id"]')).toHaveText(/^user_/, { timeout: 30_000 });
await expect(electronPage.evaluate(() => (window as ElectronWindow).__hardNavigations)).resolves.toEqual([]);
});
});
71 changes: 71 additions & 0 deletions packages/electron/src/react/__tests__/ClerkProvider.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,77 @@ describe('Electron ClerkProvider', () => {
});
});

describe('router handlers', () => {
const renderWithRouter = (props: Record<string, unknown> = {}) => {
renderToStaticMarkup(
<ClerkProvider
publishableKey='pk_test_provider'
{...props}
>
<span>App</span>
</ClerkProvider>,
);

return {
routerPush: capturedProviderProps?.routerPush as (to: string, metadata?: unknown) => void,
routerReplace: capturedProviderProps?.routerReplace as (to: string, metadata?: unknown) => void,
};
};

it('always supplies both handlers so clerk-js never falls back to a window navigation', () => {
const { routerPush, routerReplace } = renderWithRouter();

expect(routerPush).toBeTypeOf('function');
expect(routerReplace).toBeTypeOf('function');
});

it('absorbs virtual router paths instead of forwarding them to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });
routerReplace('/CLERK-ROUTER/VIRTUAL/sign-in#/factor-two', { windowNavigate });

expect(push).not.toHaveBeenCalled();
expect(replace).not.toHaveBeenCalled();
expect(windowNavigate).not.toHaveBeenCalled();
});

it('absorbs virtual router paths even without an application router', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });

expect(windowNavigate).not.toHaveBeenCalled();
});

it('forwards real destinations to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/settings/connections', { windowNavigate });
routerReplace('/dashboard', { windowNavigate });

expect(push).toHaveBeenCalledWith('/settings/connections', { windowNavigate });
expect(replace).toHaveBeenCalledWith('/dashboard', { windowNavigate });
expect(windowNavigate).not.toHaveBeenCalled();
});

it('falls back to the host navigation for real destinations when no application router is provided', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/settings/connections', { windowNavigate });

expect(windowNavigate).toHaveBeenCalledWith('/settings/connections');
});
});

it('defaults allowedRedirectProtocols to the renderer custom scheme', () => {
stubWindowProtocol('clerk:');

Expand Down
29 changes: 29 additions & 0 deletions packages/electron/src/react/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkProviderProps as ReactClerkProviderProps } from '@clerk/react';
import { InternalClerkProvider as ReactClerkProvider } from '@clerk/react/internal';
import { isVirtualRouterPath } from '@clerk/shared/internal/clerk-js/url';
import { ALLOWED_PROTOCOLS } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { loadClerkUIScript } from '@clerk/shared/loadClerkJsScript';
import type { ClerkUIConstructor } from '@clerk/shared/ui';
Expand DownExpand Up@@ -79,6 +80,30 @@ function createOAuthTransport(): ClerkOAuthTransport | undefined {
};
}

type ClerkRouterFn = NonNullable<ReactClerkProviderProps['routerPush']>;

/** Always supplied, so clerk-js never reaches `window.location` and reloads the renderer. */
function createRouterHandlers(
routerPush: ClerkRouterFn | undefined,
routerReplace: ClerkRouterFn | undefined,
): { routerPush: ClerkRouterFn; routerReplace: ClerkRouterFn } {
const wrap =
(delegate: ClerkRouterFn | undefined): ClerkRouterFn =>
(to, metadata) => {
if (isVirtualRouterPath(to)) {
return;
}

if (delegate) {
return delegate(to, metadata);
}

metadata?.windowNavigate(to);
};

return { routerPush: wrap(routerPush), routerReplace: wrap(routerReplace) };
}

/**
* Infer the custom renderer scheme registered with `createClerkBridge({ renderer })`.
* Built-in Clerk protocols and local file renderers are not inferred.
Expand All@@ -98,15 +123,19 @@ export function ClerkProvider({
publishableKey,
passkeys,
allowedRedirectProtocols,
routerPush,
routerReplace,
...props
}: ClerkProviderProps): JSX.Element {
const clerk = createClerkInstance(publishableKey, passkeys);
const oauthTransport = createOAuthTransport();
const clerkUI = loadClerkUI(publishableKey, props);
const routerHandlers = createRouterHandlers(routerPush, routerReplace);

return (
<ReactClerkProvider
{...props}
{...routerHandlers}
Clerk={clerk}
__internal_oauthTransport={oauthTransport}
allowedRedirectProtocols={allowedRedirectProtocols ?? defaultAllowedRedirectProtocols()}
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/internal/clerk-js/url.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,13 @@ export const pathFromFullPath = (fullPath: string) => {
return fullPath.replace(/CLERK-ROUTER\/(.*?)\//, '');
};

export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

/**
* Whether `to` addresses the in-memory component router rather than a real application route.
*/
export const isVirtualRouterPath = (to: string): boolean => to.includes(VIRTUAL_ROUTER_BASE_PATH);

const frontendApiRedirectPathsWithUserInput: string[] = [
'/oauth/authorize', // OAuth2 identify provider flow
];
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,22 +55,72 @@ describe('buildSignInOAuthTransportCallbackParams', () => {
unsafeMetadata: { a: 1 },
} as any;

const origin = window.location.origin;

expect(buildSignInOAuthTransportCallbackParams(ctx)).toEqual({
signUpUrl: '/sign-up',
signInUrl: '/sign-in',
signInForceRedirectUrl: '/after-in',
signUpForceRedirectUrl: '/after-up',
continueSignUpUrl: '/continue',
transferable: true,
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
// Relative to the SignIn start route; the sign-up gate URL stays absolute (combined-aware).
signInProtectCheckUrl: 'protect-check',
signUpProtectCheckUrl: '/sign-up-protect-check',
// Sign-up steps are path routes on the sign-up component; hash-style URLs would lose their
// hash in the virtual router and land a transferred sign-up on the start card.
continueSignUpUrl: `${origin}/sign-up/continue`,
verifyEmailAddressUrl: `${origin}/sign-up/verify-email-address`,
verifyPhoneNumberUrl: `${origin}/sign-up/verify-phone-number`,
signUpProtectCheckUrl: `${origin}/sign-up/protect-check`,
unsafeMetadata: { a: 1 },
});
});

it('targets the virtual sign-up routes for modal transport callbacks', () => {
const ctx = {
signUpUrl: '/CLERK-ROUTER/VIRTUAL/sign-up',
signInUrl: '/CLERK-ROUTER/VIRTUAL/sign-in',
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/protect-check`);
});

it('drops a hash fragment from signUpUrl when building sign-up step URLs', () => {
const ctx = {
signUpUrl: '/sign-up#/continue',
signInUrl: '/sign-in',
} as any;
Comment thread
coderabbitai[bot] marked this conversation as resolved.

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/sign-up/protect-check`);
});

it('targets the embedded create subtree in the combined flow', () => {
const ctx = {
signUpUrl: '/sign-in#/create',
signInUrl: '/sign-in',
isCombinedFlow: true,
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);

expect(params.continueSignUpUrl).toBe('create/continue');
expect(params.verifyEmailAddressUrl).toBe('create/verify-email-address');
expect(params.verifyPhoneNumberUrl).toBe('create/verify-phone-number');
expect(params.signUpProtectCheckUrl).toBe('create/protect-check');
});
Comment thread
coderabbitai[bot] marked this conversation as resolved.
});

describe('buildSignUpOAuthCallbackParams', () => {
Expand Down
16 changes: 16 additions & 0 deletions packages/ui/src/components/SignIn/buildOAuthCallbackParams.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { buildURL, trimTrailingSlash } from '@clerk/shared/internal/clerk-js/url';
import type { HandleOAuthCallbackParams } from '@clerk/shared/types';

import type { SignInContextType } from '../../contexts/components/SignIn';
Expand All@@ -23,12 +24,27 @@ export function buildSignInOAuthCallbackParams(ctx: SignInContextType): HandleOA
}

export function buildSignInOAuthTransportCallbackParams(ctx: SignInContextType): HandleOAuthCallbackParams {
// Path form, not `#/step`: the in-place component router matches on pathname only and would drop the hash.
const signUpStepUrl = (step: string): string => {
if (ctx.isCombinedFlow) {
return `create/${step}`;
}
const url = buildURL({ base: ctx.signUpUrl }, { stringify: false });
url.pathname = `${trimTrailingSlash(url.pathname)}/${step}`;
url.hash = '';
return url.href;
};

return {
...buildSignInOAuthCallbackParams(ctx),
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
signInProtectCheckUrl: 'protect-check',
continueSignUpUrl: signUpStepUrl('continue'),
verifyEmailAddressUrl: signUpStepUrl('verify-email-address'),
verifyPhoneNumberUrl: signUpStepUrl('verify-phone-number'),
signUpProtectCheckUrl: signUpStepUrl('protect-check'),
};
}

Expand Down
4 changes: 3 additions & 1 deletion packages/ui/src/router/VirtualRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import { VIRTUAL_ROUTER_BASE_PATH } from '@clerk/shared/internal/clerk-js/url';
import { useClerk } from '@clerk/shared/react';
import React, { useEffect } from 'react';

import { useClerkModalStateParams } from '../hooks';
import { BaseRouter } from './BaseRouter';
export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

export { VIRTUAL_ROUTER_BASE_PATH };

interface VirtualRouterProps {
startPath: string;
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/electron-virtual-router-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/electron': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Keep Clerk's navigation inside the renderer. `ClerkProvider` now always supplies `routerPush`/`routerReplace`, so Clerk routes through your application's router when you provide one, and never navigates the window to an internal `/CLERK-ROUTER/VIRTUAL/...` path β€” which no custom protocol handler can serve, and which reloaded the renderer and dropped the user out of sign-in.

Applications that worked around this by passing no-op router functions, or by filtering `CLERK-ROUTER/VIRTUAL` out themselves, can remove those workarounds.
5 changes: 5 additions & 0 deletions .changeset/signin-transport-transfer-next-step.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Route an OAuth transfer to the sign-up continue step when sign-in uses a native OAuth transport. The callback previously navigated with hash-style URLs (`<sign-up-url>#/continue`) that the in-place component router cannot resolve, landing transferred sign-ups on the start card where submitting created a fresh sign-up without the verified external account.
4 changes: 2 additions & 2 deletions integration/templates/electron-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,8 +12,8 @@ function App() {
<ClerkProvider
publishableKey={PUBLISHABLE_KEY}
__internal_clerkUIUrl={CLERK_UI_URL}
routerPush={() => {}}
routerReplace={() => {}}
routerPush={(to: string) => window.history.pushState(null, '', to)}
routerReplace={(to: string) => window.history.replaceState(null, '', to)}
>
<main data-testid='electron-app'>
<Show when='signed-out'>
Expand Down
21 changes: 21 additions & 0 deletions integration/tests/electron/basic.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ type ElectronWindow = Window & {
tokenCache?: Partial<Record<'clearToken' | 'getToken' | 'saveToken', unknown>>;
oauthTransport?: Partial<Record<'getRedirectUrl' | 'open', unknown>>;
};
__hardNavigations?: string[];
};

test.describe('electron basic auth @electron', () => {
Expand DownExpand Up@@ -74,4 +75,24 @@ test.describe('electron basic auth @electron', () => {
test('keeps the signed-out state after relaunch', async ({ electronPage }) => {
await expect(electronPage.locator('.cl-signIn-root')).toBeVisible({ timeout: 30_000 });
});

test('never hard navigates the renderer during sign-in', async ({ electronPage }) => {
const { signIn } = createPageObjects({ page: electronPage, useTestingToken: false });

await electronPage.evaluate(() => {
(window as ElectronWindow).__hardNavigations = [];
addEventListener('clerk:beforeunload', () => {
(window as ElectronWindow).__hardNavigations?.push(location.href);
});
});

await signIn.waitForMounted();
await signIn.setIdentifier(fakeUser.email!);
await signIn.continue();
await signIn.setPassword(fakeUser.password);
await signIn.continue();

await expect(electronPage.locator('[data-testid="user-id"]')).toHaveText(/^user_/, { timeout: 30_000 });
await expect(electronPage.evaluate(() => (window as ElectronWindow).__hardNavigations)).resolves.toEqual([]);
});
});
71 changes: 71 additions & 0 deletions packages/electron/src/react/__tests__/ClerkProvider.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,77 @@ describe('Electron ClerkProvider', () => {
});
});

describe('router handlers', () => {
const renderWithRouter = (props: Record<string, unknown> = {}) => {
renderToStaticMarkup(
<ClerkProvider
publishableKey='pk_test_provider'
{...props}
>
<span>App</span>
</ClerkProvider>,
);

return {
routerPush: capturedProviderProps?.routerPush as (to: string, metadata?: unknown) => void,
routerReplace: capturedProviderProps?.routerReplace as (to: string, metadata?: unknown) => void,
};
};

it('always supplies both handlers so clerk-js never falls back to a window navigation', () => {
const { routerPush, routerReplace } = renderWithRouter();

expect(routerPush).toBeTypeOf('function');
expect(routerReplace).toBeTypeOf('function');
});

it('absorbs virtual router paths instead of forwarding them to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });
routerReplace('/CLERK-ROUTER/VIRTUAL/sign-in#/factor-two', { windowNavigate });

expect(push).not.toHaveBeenCalled();
expect(replace).not.toHaveBeenCalled();
expect(windowNavigate).not.toHaveBeenCalled();
});

it('absorbs virtual router paths even without an application router', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });

expect(windowNavigate).not.toHaveBeenCalled();
});

it('forwards real destinations to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/settings/connections', { windowNavigate });
routerReplace('/dashboard', { windowNavigate });

expect(push).toHaveBeenCalledWith('/settings/connections', { windowNavigate });
expect(replace).toHaveBeenCalledWith('/dashboard', { windowNavigate });
expect(windowNavigate).not.toHaveBeenCalled();
});

it('falls back to the host navigation for real destinations when no application router is provided', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/settings/connections', { windowNavigate });

expect(windowNavigate).toHaveBeenCalledWith('/settings/connections');
});
});

it('defaults allowedRedirectProtocols to the renderer custom scheme', () => {
stubWindowProtocol('clerk:');

Expand Down
29 changes: 29 additions & 0 deletions packages/electron/src/react/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkProviderProps as ReactClerkProviderProps } from '@clerk/react';
import { InternalClerkProvider as ReactClerkProvider } from '@clerk/react/internal';
import { isVirtualRouterPath } from '@clerk/shared/internal/clerk-js/url';
import { ALLOWED_PROTOCOLS } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { loadClerkUIScript } from '@clerk/shared/loadClerkJsScript';
import type { ClerkUIConstructor } from '@clerk/shared/ui';
Expand DownExpand Up@@ -79,6 +80,30 @@ function createOAuthTransport(): ClerkOAuthTransport | undefined {
};
}

type ClerkRouterFn = NonNullable<ReactClerkProviderProps['routerPush']>;

/** Always supplied, so clerk-js never reaches `window.location` and reloads the renderer. */
function createRouterHandlers(
routerPush: ClerkRouterFn | undefined,
routerReplace: ClerkRouterFn | undefined,
): { routerPush: ClerkRouterFn; routerReplace: ClerkRouterFn } {
const wrap =
(delegate: ClerkRouterFn | undefined): ClerkRouterFn =>
(to, metadata) => {
if (isVirtualRouterPath(to)) {
return;
}

if (delegate) {
return delegate(to, metadata);
}

metadata?.windowNavigate(to);
};

return { routerPush: wrap(routerPush), routerReplace: wrap(routerReplace) };
}

/**
* Infer the custom renderer scheme registered with `createClerkBridge({ renderer })`.
* Built-in Clerk protocols and local file renderers are not inferred.
Expand All@@ -98,15 +123,19 @@ export function ClerkProvider({
publishableKey,
passkeys,
allowedRedirectProtocols,
routerPush,
routerReplace,
...props
}: ClerkProviderProps): JSX.Element {
const clerk = createClerkInstance(publishableKey, passkeys);
const oauthTransport = createOAuthTransport();
const clerkUI = loadClerkUI(publishableKey, props);
const routerHandlers = createRouterHandlers(routerPush, routerReplace);

return (
<ReactClerkProvider
{...props}
{...routerHandlers}
Clerk={clerk}
__internal_oauthTransport={oauthTransport}
allowedRedirectProtocols={allowedRedirectProtocols ?? defaultAllowedRedirectProtocols()}
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/internal/clerk-js/url.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,13 @@ export const pathFromFullPath = (fullPath: string) => {
return fullPath.replace(/CLERK-ROUTER\/(.*?)\//, '');
};

export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

/**
* Whether `to` addresses the in-memory component router rather than a real application route.
*/
export const isVirtualRouterPath = (to: string): boolean => to.includes(VIRTUAL_ROUTER_BASE_PATH);

const frontendApiRedirectPathsWithUserInput: string[] = [
'/oauth/authorize', // OAuth2 identify provider flow
];
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,22 +55,72 @@ describe('buildSignInOAuthTransportCallbackParams', () => {
unsafeMetadata: { a: 1 },
} as any;

const origin = window.location.origin;

expect(buildSignInOAuthTransportCallbackParams(ctx)).toEqual({
signUpUrl: '/sign-up',
signInUrl: '/sign-in',
signInForceRedirectUrl: '/after-in',
signUpForceRedirectUrl: '/after-up',
continueSignUpUrl: '/continue',
transferable: true,
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
// Relative to the SignIn start route; the sign-up gate URL stays absolute (combined-aware).
signInProtectCheckUrl: 'protect-check',
signUpProtectCheckUrl: '/sign-up-protect-check',
// Sign-up steps are path routes on the sign-up component; hash-style URLs would lose their
// hash in the virtual router and land a transferred sign-up on the start card.
continueSignUpUrl: `${origin}/sign-up/continue`,
verifyEmailAddressUrl: `${origin}/sign-up/verify-email-address`,
verifyPhoneNumberUrl: `${origin}/sign-up/verify-phone-number`,
signUpProtectCheckUrl: `${origin}/sign-up/protect-check`,
unsafeMetadata: { a: 1 },
});
});

it('targets the virtual sign-up routes for modal transport callbacks', () => {
const ctx = {
signUpUrl: '/CLERK-ROUTER/VIRTUAL/sign-up',
signInUrl: '/CLERK-ROUTER/VIRTUAL/sign-in',
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/protect-check`);
});

it('drops a hash fragment from signUpUrl when building sign-up step URLs', () => {
const ctx = {
signUpUrl: '/sign-up#/continue',
signInUrl: '/sign-in',
} as any;
Comment thread
coderabbitai[bot] marked this conversation as resolved.

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/sign-up/protect-check`);
});

it('targets the embedded create subtree in the combined flow', () => {
const ctx = {
signUpUrl: '/sign-in#/create',
signInUrl: '/sign-in',
isCombinedFlow: true,
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);

expect(params.continueSignUpUrl).toBe('create/continue');
expect(params.verifyEmailAddressUrl).toBe('create/verify-email-address');
expect(params.verifyPhoneNumberUrl).toBe('create/verify-phone-number');
expect(params.signUpProtectCheckUrl).toBe('create/protect-check');
});
Comment thread
coderabbitai[bot] marked this conversation as resolved.
});

describe('buildSignUpOAuthCallbackParams', () => {
Expand Down
16 changes: 16 additions & 0 deletions packages/ui/src/components/SignIn/buildOAuthCallbackParams.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { buildURL, trimTrailingSlash } from '@clerk/shared/internal/clerk-js/url';
import type { HandleOAuthCallbackParams } from '@clerk/shared/types';

import type { SignInContextType } from '../../contexts/components/SignIn';
Expand All@@ -23,12 +24,27 @@ export function buildSignInOAuthCallbackParams(ctx: SignInContextType): HandleOA
}

export function buildSignInOAuthTransportCallbackParams(ctx: SignInContextType): HandleOAuthCallbackParams {
// Path form, not `#/step`: the in-place component router matches on pathname only and would drop the hash.
const signUpStepUrl = (step: string): string => {
if (ctx.isCombinedFlow) {
return `create/${step}`;
}
const url = buildURL({ base: ctx.signUpUrl }, { stringify: false });
url.pathname = `${trimTrailingSlash(url.pathname)}/${step}`;
url.hash = '';
return url.href;
};

return {
...buildSignInOAuthCallbackParams(ctx),
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
signInProtectCheckUrl: 'protect-check',
continueSignUpUrl: signUpStepUrl('continue'),
verifyEmailAddressUrl: signUpStepUrl('verify-email-address'),
verifyPhoneNumberUrl: signUpStepUrl('verify-phone-number'),
signUpProtectCheckUrl: signUpStepUrl('protect-check'),
};
}

Expand Down
4 changes: 3 additions & 1 deletion packages/ui/src/router/VirtualRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import { VIRTUAL_ROUTER_BASE_PATH } from '@clerk/shared/internal/clerk-js/url';
import { useClerk } from '@clerk/shared/react';
import React, { useEffect } from 'react';

import { useClerkModalStateParams } from '../hooks';
import { BaseRouter } from './BaseRouter';
export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

export { VIRTUAL_ROUTER_BASE_PATH };

interface VirtualRouterProps {
startPath: string;
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/electron-virtual-router-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/electron': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Keep Clerk's navigation inside the renderer. `ClerkProvider` now always supplies `routerPush`/`routerReplace`, so Clerk routes through your application's router when you provide one, and never navigates the window to an internal `/CLERK-ROUTER/VIRTUAL/...` path β€” which no custom protocol handler can serve, and which reloaded the renderer and dropped the user out of sign-in.

Applications that worked around this by passing no-op router functions, or by filtering `CLERK-ROUTER/VIRTUAL` out themselves, can remove those workarounds.
5 changes: 5 additions & 0 deletions .changeset/signin-transport-transfer-next-step.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Route an OAuth transfer to the sign-up continue step when sign-in uses a native OAuth transport. The callback previously navigated with hash-style URLs (`<sign-up-url>#/continue`) that the in-place component router cannot resolve, landing transferred sign-ups on the start card where submitting created a fresh sign-up without the verified external account.
4 changes: 2 additions & 2 deletions integration/templates/electron-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,8 +12,8 @@ function App() {
<ClerkProvider
publishableKey={PUBLISHABLE_KEY}
__internal_clerkUIUrl={CLERK_UI_URL}
routerPush={() => {}}
routerReplace={() => {}}
routerPush={(to: string) => window.history.pushState(null, '', to)}
routerReplace={(to: string) => window.history.replaceState(null, '', to)}
>
<main data-testid='electron-app'>
<Show when='signed-out'>
Expand Down
21 changes: 21 additions & 0 deletions integration/tests/electron/basic.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ type ElectronWindow = Window & {
tokenCache?: Partial<Record<'clearToken' | 'getToken' | 'saveToken', unknown>>;
oauthTransport?: Partial<Record<'getRedirectUrl' | 'open', unknown>>;
};
__hardNavigations?: string[];
};

test.describe('electron basic auth @electron', () => {
Expand DownExpand Up@@ -74,4 +75,24 @@ test.describe('electron basic auth @electron', () => {
test('keeps the signed-out state after relaunch', async ({ electronPage }) => {
await expect(electronPage.locator('.cl-signIn-root')).toBeVisible({ timeout: 30_000 });
});

test('never hard navigates the renderer during sign-in', async ({ electronPage }) => {
const { signIn } = createPageObjects({ page: electronPage, useTestingToken: false });

await electronPage.evaluate(() => {
(window as ElectronWindow).__hardNavigations = [];
addEventListener('clerk:beforeunload', () => {
(window as ElectronWindow).__hardNavigations?.push(location.href);
});
});

await signIn.waitForMounted();
await signIn.setIdentifier(fakeUser.email!);
await signIn.continue();
await signIn.setPassword(fakeUser.password);
await signIn.continue();

await expect(electronPage.locator('[data-testid="user-id"]')).toHaveText(/^user_/, { timeout: 30_000 });
await expect(electronPage.evaluate(() => (window as ElectronWindow).__hardNavigations)).resolves.toEqual([]);
});
});
71 changes: 71 additions & 0 deletions packages/electron/src/react/__tests__/ClerkProvider.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,77 @@ describe('Electron ClerkProvider', () => {
});
});

describe('router handlers', () => {
const renderWithRouter = (props: Record<string, unknown> = {}) => {
renderToStaticMarkup(
<ClerkProvider
publishableKey='pk_test_provider'
{...props}
>
<span>App</span>
</ClerkProvider>,
);

return {
routerPush: capturedProviderProps?.routerPush as (to: string, metadata?: unknown) => void,
routerReplace: capturedProviderProps?.routerReplace as (to: string, metadata?: unknown) => void,
};
};

it('always supplies both handlers so clerk-js never falls back to a window navigation', () => {
const { routerPush, routerReplace } = renderWithRouter();

expect(routerPush).toBeTypeOf('function');
expect(routerReplace).toBeTypeOf('function');
});

it('absorbs virtual router paths instead of forwarding them to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });
routerReplace('/CLERK-ROUTER/VIRTUAL/sign-in#/factor-two', { windowNavigate });

expect(push).not.toHaveBeenCalled();
expect(replace).not.toHaveBeenCalled();
expect(windowNavigate).not.toHaveBeenCalled();
});

it('absorbs virtual router paths even without an application router', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });

expect(windowNavigate).not.toHaveBeenCalled();
});

it('forwards real destinations to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/settings/connections', { windowNavigate });
routerReplace('/dashboard', { windowNavigate });

expect(push).toHaveBeenCalledWith('/settings/connections', { windowNavigate });
expect(replace).toHaveBeenCalledWith('/dashboard', { windowNavigate });
expect(windowNavigate).not.toHaveBeenCalled();
});

it('falls back to the host navigation for real destinations when no application router is provided', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/settings/connections', { windowNavigate });

expect(windowNavigate).toHaveBeenCalledWith('/settings/connections');
});
});

it('defaults allowedRedirectProtocols to the renderer custom scheme', () => {
stubWindowProtocol('clerk:');

Expand Down
29 changes: 29 additions & 0 deletions packages/electron/src/react/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkProviderProps as ReactClerkProviderProps } from '@clerk/react';
import { InternalClerkProvider as ReactClerkProvider } from '@clerk/react/internal';
import { isVirtualRouterPath } from '@clerk/shared/internal/clerk-js/url';
import { ALLOWED_PROTOCOLS } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { loadClerkUIScript } from '@clerk/shared/loadClerkJsScript';
import type { ClerkUIConstructor } from '@clerk/shared/ui';
Expand DownExpand Up@@ -79,6 +80,30 @@ function createOAuthTransport(): ClerkOAuthTransport | undefined {
};
}

type ClerkRouterFn = NonNullable<ReactClerkProviderProps['routerPush']>;

/** Always supplied, so clerk-js never reaches `window.location` and reloads the renderer. */
function createRouterHandlers(
routerPush: ClerkRouterFn | undefined,
routerReplace: ClerkRouterFn | undefined,
): { routerPush: ClerkRouterFn; routerReplace: ClerkRouterFn } {
const wrap =
(delegate: ClerkRouterFn | undefined): ClerkRouterFn =>
(to, metadata) => {
if (isVirtualRouterPath(to)) {
return;
}

if (delegate) {
return delegate(to, metadata);
}

metadata?.windowNavigate(to);
};

return { routerPush: wrap(routerPush), routerReplace: wrap(routerReplace) };
}

/**
* Infer the custom renderer scheme registered with `createClerkBridge({ renderer })`.
* Built-in Clerk protocols and local file renderers are not inferred.
Expand All@@ -98,15 +123,19 @@ export function ClerkProvider({
publishableKey,
passkeys,
allowedRedirectProtocols,
routerPush,
routerReplace,
...props
}: ClerkProviderProps): JSX.Element {
const clerk = createClerkInstance(publishableKey, passkeys);
const oauthTransport = createOAuthTransport();
const clerkUI = loadClerkUI(publishableKey, props);
const routerHandlers = createRouterHandlers(routerPush, routerReplace);

return (
<ReactClerkProvider
{...props}
{...routerHandlers}
Clerk={clerk}
__internal_oauthTransport={oauthTransport}
allowedRedirectProtocols={allowedRedirectProtocols ?? defaultAllowedRedirectProtocols()}
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/internal/clerk-js/url.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,13 @@ export const pathFromFullPath = (fullPath: string) => {
return fullPath.replace(/CLERK-ROUTER\/(.*?)\//, '');
};

export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

/**
* Whether `to` addresses the in-memory component router rather than a real application route.
*/
export const isVirtualRouterPath = (to: string): boolean => to.includes(VIRTUAL_ROUTER_BASE_PATH);

const frontendApiRedirectPathsWithUserInput: string[] = [
'/oauth/authorize', // OAuth2 identify provider flow
];
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,22 +55,72 @@ describe('buildSignInOAuthTransportCallbackParams', () => {
unsafeMetadata: { a: 1 },
} as any;

const origin = window.location.origin;

expect(buildSignInOAuthTransportCallbackParams(ctx)).toEqual({
signUpUrl: '/sign-up',
signInUrl: '/sign-in',
signInForceRedirectUrl: '/after-in',
signUpForceRedirectUrl: '/after-up',
continueSignUpUrl: '/continue',
transferable: true,
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
// Relative to the SignIn start route; the sign-up gate URL stays absolute (combined-aware).
signInProtectCheckUrl: 'protect-check',
signUpProtectCheckUrl: '/sign-up-protect-check',
// Sign-up steps are path routes on the sign-up component; hash-style URLs would lose their
// hash in the virtual router and land a transferred sign-up on the start card.
continueSignUpUrl: `${origin}/sign-up/continue`,
verifyEmailAddressUrl: `${origin}/sign-up/verify-email-address`,
verifyPhoneNumberUrl: `${origin}/sign-up/verify-phone-number`,
signUpProtectCheckUrl: `${origin}/sign-up/protect-check`,
unsafeMetadata: { a: 1 },
});
});

it('targets the virtual sign-up routes for modal transport callbacks', () => {
const ctx = {
signUpUrl: '/CLERK-ROUTER/VIRTUAL/sign-up',
signInUrl: '/CLERK-ROUTER/VIRTUAL/sign-in',
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/protect-check`);
});

it('drops a hash fragment from signUpUrl when building sign-up step URLs', () => {
const ctx = {
signUpUrl: '/sign-up#/continue',
signInUrl: '/sign-in',
} as any;
Comment thread
coderabbitai[bot] marked this conversation as resolved.

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/sign-up/protect-check`);
});

it('targets the embedded create subtree in the combined flow', () => {
const ctx = {
signUpUrl: '/sign-in#/create',
signInUrl: '/sign-in',
isCombinedFlow: true,
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);

expect(params.continueSignUpUrl).toBe('create/continue');
expect(params.verifyEmailAddressUrl).toBe('create/verify-email-address');
expect(params.verifyPhoneNumberUrl).toBe('create/verify-phone-number');
expect(params.signUpProtectCheckUrl).toBe('create/protect-check');
});
Comment thread
coderabbitai[bot] marked this conversation as resolved.
});

describe('buildSignUpOAuthCallbackParams', () => {
Expand Down
16 changes: 16 additions & 0 deletions packages/ui/src/components/SignIn/buildOAuthCallbackParams.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { buildURL, trimTrailingSlash } from '@clerk/shared/internal/clerk-js/url';
import type { HandleOAuthCallbackParams } from '@clerk/shared/types';

import type { SignInContextType } from '../../contexts/components/SignIn';
Expand All@@ -23,12 +24,27 @@ export function buildSignInOAuthCallbackParams(ctx: SignInContextType): HandleOA
}

export function buildSignInOAuthTransportCallbackParams(ctx: SignInContextType): HandleOAuthCallbackParams {
// Path form, not `#/step`: the in-place component router matches on pathname only and would drop the hash.
const signUpStepUrl = (step: string): string => {
if (ctx.isCombinedFlow) {
return `create/${step}`;
}
const url = buildURL({ base: ctx.signUpUrl }, { stringify: false });
url.pathname = `${trimTrailingSlash(url.pathname)}/${step}`;
url.hash = '';
return url.href;
};

return {
...buildSignInOAuthCallbackParams(ctx),
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
signInProtectCheckUrl: 'protect-check',
continueSignUpUrl: signUpStepUrl('continue'),
verifyEmailAddressUrl: signUpStepUrl('verify-email-address'),
verifyPhoneNumberUrl: signUpStepUrl('verify-phone-number'),
signUpProtectCheckUrl: signUpStepUrl('protect-check'),
};
}

Expand Down
4 changes: 3 additions & 1 deletion packages/ui/src/router/VirtualRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import { VIRTUAL_ROUTER_BASE_PATH } from '@clerk/shared/internal/clerk-js/url';
import { useClerk } from '@clerk/shared/react';
import React, { useEffect } from 'react';

import { useClerkModalStateParams } from '../hooks';
import { BaseRouter } from './BaseRouter';
export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

export { VIRTUAL_ROUTER_BASE_PATH };

interface VirtualRouterProps {
startPath: string;
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/electron-virtual-router-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/electron': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Keep Clerk's navigation inside the renderer. `ClerkProvider` now always supplies `routerPush`/`routerReplace`, so Clerk routes through your application's router when you provide one, and never navigates the window to an internal `/CLERK-ROUTER/VIRTUAL/...` path β€” which no custom protocol handler can serve, and which reloaded the renderer and dropped the user out of sign-in.

Applications that worked around this by passing no-op router functions, or by filtering `CLERK-ROUTER/VIRTUAL` out themselves, can remove those workarounds.
5 changes: 5 additions & 0 deletions .changeset/signin-transport-transfer-next-step.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Route an OAuth transfer to the sign-up continue step when sign-in uses a native OAuth transport. The callback previously navigated with hash-style URLs (`<sign-up-url>#/continue`) that the in-place component router cannot resolve, landing transferred sign-ups on the start card where submitting created a fresh sign-up without the verified external account.
4 changes: 2 additions & 2 deletions integration/templates/electron-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,8 +12,8 @@ function App() {
<ClerkProvider
publishableKey={PUBLISHABLE_KEY}
__internal_clerkUIUrl={CLERK_UI_URL}
routerPush={() => {}}
routerReplace={() => {}}
routerPush={(to: string) => window.history.pushState(null, '', to)}
routerReplace={(to: string) => window.history.replaceState(null, '', to)}
>
<main data-testid='electron-app'>
<Show when='signed-out'>
Expand Down
21 changes: 21 additions & 0 deletions integration/tests/electron/basic.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ type ElectronWindow = Window & {
tokenCache?: Partial<Record<'clearToken' | 'getToken' | 'saveToken', unknown>>;
oauthTransport?: Partial<Record<'getRedirectUrl' | 'open', unknown>>;
};
__hardNavigations?: string[];
};

test.describe('electron basic auth @electron', () => {
Expand DownExpand Up@@ -74,4 +75,24 @@ test.describe('electron basic auth @electron', () => {
test('keeps the signed-out state after relaunch', async ({ electronPage }) => {
await expect(electronPage.locator('.cl-signIn-root')).toBeVisible({ timeout: 30_000 });
});

test('never hard navigates the renderer during sign-in', async ({ electronPage }) => {
const { signIn } = createPageObjects({ page: electronPage, useTestingToken: false });

await electronPage.evaluate(() => {
(window as ElectronWindow).__hardNavigations = [];
addEventListener('clerk:beforeunload', () => {
(window as ElectronWindow).__hardNavigations?.push(location.href);
});
});

await signIn.waitForMounted();
await signIn.setIdentifier(fakeUser.email!);
await signIn.continue();
await signIn.setPassword(fakeUser.password);
await signIn.continue();

await expect(electronPage.locator('[data-testid="user-id"]')).toHaveText(/^user_/, { timeout: 30_000 });
await expect(electronPage.evaluate(() => (window as ElectronWindow).__hardNavigations)).resolves.toEqual([]);
});
});
71 changes: 71 additions & 0 deletions packages/electron/src/react/__tests__/ClerkProvider.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,77 @@ describe('Electron ClerkProvider', () => {
});
});

describe('router handlers', () => {
const renderWithRouter = (props: Record<string, unknown> = {}) => {
renderToStaticMarkup(
<ClerkProvider
publishableKey='pk_test_provider'
{...props}
>
<span>App</span>
</ClerkProvider>,
);

return {
routerPush: capturedProviderProps?.routerPush as (to: string, metadata?: unknown) => void,
routerReplace: capturedProviderProps?.routerReplace as (to: string, metadata?: unknown) => void,
};
};

it('always supplies both handlers so clerk-js never falls back to a window navigation', () => {
const { routerPush, routerReplace } = renderWithRouter();

expect(routerPush).toBeTypeOf('function');
expect(routerReplace).toBeTypeOf('function');
});

it('absorbs virtual router paths instead of forwarding them to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });
routerReplace('/CLERK-ROUTER/VIRTUAL/sign-in#/factor-two', { windowNavigate });

expect(push).not.toHaveBeenCalled();
expect(replace).not.toHaveBeenCalled();
expect(windowNavigate).not.toHaveBeenCalled();
});

it('absorbs virtual router paths even without an application router', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });

expect(windowNavigate).not.toHaveBeenCalled();
});

it('forwards real destinations to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/settings/connections', { windowNavigate });
routerReplace('/dashboard', { windowNavigate });

expect(push).toHaveBeenCalledWith('/settings/connections', { windowNavigate });
expect(replace).toHaveBeenCalledWith('/dashboard', { windowNavigate });
expect(windowNavigate).not.toHaveBeenCalled();
});

it('falls back to the host navigation for real destinations when no application router is provided', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/settings/connections', { windowNavigate });

expect(windowNavigate).toHaveBeenCalledWith('/settings/connections');
});
});

it('defaults allowedRedirectProtocols to the renderer custom scheme', () => {
stubWindowProtocol('clerk:');

Expand Down
29 changes: 29 additions & 0 deletions packages/electron/src/react/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkProviderProps as ReactClerkProviderProps } from '@clerk/react';
import { InternalClerkProvider as ReactClerkProvider } from '@clerk/react/internal';
import { isVirtualRouterPath } from '@clerk/shared/internal/clerk-js/url';
import { ALLOWED_PROTOCOLS } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { loadClerkUIScript } from '@clerk/shared/loadClerkJsScript';
import type { ClerkUIConstructor } from '@clerk/shared/ui';
Expand DownExpand Up@@ -79,6 +80,30 @@ function createOAuthTransport(): ClerkOAuthTransport | undefined {
};
}

type ClerkRouterFn = NonNullable<ReactClerkProviderProps['routerPush']>;

/** Always supplied, so clerk-js never reaches `window.location` and reloads the renderer. */
function createRouterHandlers(
routerPush: ClerkRouterFn | undefined,
routerReplace: ClerkRouterFn | undefined,
): { routerPush: ClerkRouterFn; routerReplace: ClerkRouterFn } {
const wrap =
(delegate: ClerkRouterFn | undefined): ClerkRouterFn =>
(to, metadata) => {
if (isVirtualRouterPath(to)) {
return;
}

if (delegate) {
return delegate(to, metadata);
}

metadata?.windowNavigate(to);
};

return { routerPush: wrap(routerPush), routerReplace: wrap(routerReplace) };
}

/**
* Infer the custom renderer scheme registered with `createClerkBridge({ renderer })`.
* Built-in Clerk protocols and local file renderers are not inferred.
Expand All@@ -98,15 +123,19 @@ export function ClerkProvider({
publishableKey,
passkeys,
allowedRedirectProtocols,
routerPush,
routerReplace,
...props
}: ClerkProviderProps): JSX.Element {
const clerk = createClerkInstance(publishableKey, passkeys);
const oauthTransport = createOAuthTransport();
const clerkUI = loadClerkUI(publishableKey, props);
const routerHandlers = createRouterHandlers(routerPush, routerReplace);

return (
<ReactClerkProvider
{...props}
{...routerHandlers}
Clerk={clerk}
__internal_oauthTransport={oauthTransport}
allowedRedirectProtocols={allowedRedirectProtocols ?? defaultAllowedRedirectProtocols()}
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/internal/clerk-js/url.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,13 @@ export const pathFromFullPath = (fullPath: string) => {
return fullPath.replace(/CLERK-ROUTER\/(.*?)\//, '');
};

export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

/**
* Whether `to` addresses the in-memory component router rather than a real application route.
*/
export const isVirtualRouterPath = (to: string): boolean => to.includes(VIRTUAL_ROUTER_BASE_PATH);

const frontendApiRedirectPathsWithUserInput: string[] = [
'/oauth/authorize', // OAuth2 identify provider flow
];
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,22 +55,72 @@ describe('buildSignInOAuthTransportCallbackParams', () => {
unsafeMetadata: { a: 1 },
} as any;

const origin = window.location.origin;

expect(buildSignInOAuthTransportCallbackParams(ctx)).toEqual({
signUpUrl: '/sign-up',
signInUrl: '/sign-in',
signInForceRedirectUrl: '/after-in',
signUpForceRedirectUrl: '/after-up',
continueSignUpUrl: '/continue',
transferable: true,
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
// Relative to the SignIn start route; the sign-up gate URL stays absolute (combined-aware).
signInProtectCheckUrl: 'protect-check',
signUpProtectCheckUrl: '/sign-up-protect-check',
// Sign-up steps are path routes on the sign-up component; hash-style URLs would lose their
// hash in the virtual router and land a transferred sign-up on the start card.
continueSignUpUrl: `${origin}/sign-up/continue`,
verifyEmailAddressUrl: `${origin}/sign-up/verify-email-address`,
verifyPhoneNumberUrl: `${origin}/sign-up/verify-phone-number`,
signUpProtectCheckUrl: `${origin}/sign-up/protect-check`,
unsafeMetadata: { a: 1 },
});
});

it('targets the virtual sign-up routes for modal transport callbacks', () => {
const ctx = {
signUpUrl: '/CLERK-ROUTER/VIRTUAL/sign-up',
signInUrl: '/CLERK-ROUTER/VIRTUAL/sign-in',
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/protect-check`);
});

it('drops a hash fragment from signUpUrl when building sign-up step URLs', () => {
const ctx = {
signUpUrl: '/sign-up#/continue',
signInUrl: '/sign-in',
} as any;
Comment thread
coderabbitai[bot] marked this conversation as resolved.

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/sign-up/protect-check`);
});

it('targets the embedded create subtree in the combined flow', () => {
const ctx = {
signUpUrl: '/sign-in#/create',
signInUrl: '/sign-in',
isCombinedFlow: true,
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);

expect(params.continueSignUpUrl).toBe('create/continue');
expect(params.verifyEmailAddressUrl).toBe('create/verify-email-address');
expect(params.verifyPhoneNumberUrl).toBe('create/verify-phone-number');
expect(params.signUpProtectCheckUrl).toBe('create/protect-check');
});
Comment thread
coderabbitai[bot] marked this conversation as resolved.
});

describe('buildSignUpOAuthCallbackParams', () => {
Expand Down
16 changes: 16 additions & 0 deletions packages/ui/src/components/SignIn/buildOAuthCallbackParams.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { buildURL, trimTrailingSlash } from '@clerk/shared/internal/clerk-js/url';
import type { HandleOAuthCallbackParams } from '@clerk/shared/types';

import type { SignInContextType } from '../../contexts/components/SignIn';
Expand All@@ -23,12 +24,27 @@ export function buildSignInOAuthCallbackParams(ctx: SignInContextType): HandleOA
}

export function buildSignInOAuthTransportCallbackParams(ctx: SignInContextType): HandleOAuthCallbackParams {
// Path form, not `#/step`: the in-place component router matches on pathname only and would drop the hash.
const signUpStepUrl = (step: string): string => {
if (ctx.isCombinedFlow) {
return `create/${step}`;
}
const url = buildURL({ base: ctx.signUpUrl }, { stringify: false });
url.pathname = `${trimTrailingSlash(url.pathname)}/${step}`;
url.hash = '';
return url.href;
};

return {
...buildSignInOAuthCallbackParams(ctx),
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
signInProtectCheckUrl: 'protect-check',
continueSignUpUrl: signUpStepUrl('continue'),
verifyEmailAddressUrl: signUpStepUrl('verify-email-address'),
verifyPhoneNumberUrl: signUpStepUrl('verify-phone-number'),
signUpProtectCheckUrl: signUpStepUrl('protect-check'),
};
}

Expand Down
4 changes: 3 additions & 1 deletion packages/ui/src/router/VirtualRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import { VIRTUAL_ROUTER_BASE_PATH } from '@clerk/shared/internal/clerk-js/url';
import { useClerk } from '@clerk/shared/react';
import React, { useEffect } from 'react';

import { useClerkModalStateParams } from '../hooks';
import { BaseRouter } from './BaseRouter';
export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

export { VIRTUAL_ROUTER_BASE_PATH };

interface VirtualRouterProps {
startPath: string;
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/electron-virtual-router-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/electron': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Keep Clerk's navigation inside the renderer. `ClerkProvider` now always supplies `routerPush`/`routerReplace`, so Clerk routes through your application's router when you provide one, and never navigates the window to an internal `/CLERK-ROUTER/VIRTUAL/...` path β€” which no custom protocol handler can serve, and which reloaded the renderer and dropped the user out of sign-in.

Applications that worked around this by passing no-op router functions, or by filtering `CLERK-ROUTER/VIRTUAL` out themselves, can remove those workarounds.
5 changes: 5 additions & 0 deletions .changeset/signin-transport-transfer-next-step.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Route an OAuth transfer to the sign-up continue step when sign-in uses a native OAuth transport. The callback previously navigated with hash-style URLs (`<sign-up-url>#/continue`) that the in-place component router cannot resolve, landing transferred sign-ups on the start card where submitting created a fresh sign-up without the verified external account.
4 changes: 2 additions & 2 deletions integration/templates/electron-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,8 +12,8 @@ function App() {
<ClerkProvider
publishableKey={PUBLISHABLE_KEY}
__internal_clerkUIUrl={CLERK_UI_URL}
routerPush={() => {}}
routerReplace={() => {}}
routerPush={(to: string) => window.history.pushState(null, '', to)}
routerReplace={(to: string) => window.history.replaceState(null, '', to)}
>
<main data-testid='electron-app'>
<Show when='signed-out'>
Expand Down
21 changes: 21 additions & 0 deletions integration/tests/electron/basic.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ type ElectronWindow = Window & {
tokenCache?: Partial<Record<'clearToken' | 'getToken' | 'saveToken', unknown>>;
oauthTransport?: Partial<Record<'getRedirectUrl' | 'open', unknown>>;
};
__hardNavigations?: string[];
};

test.describe('electron basic auth @electron', () => {
Expand DownExpand Up@@ -74,4 +75,24 @@ test.describe('electron basic auth @electron', () => {
test('keeps the signed-out state after relaunch', async ({ electronPage }) => {
await expect(electronPage.locator('.cl-signIn-root')).toBeVisible({ timeout: 30_000 });
});

test('never hard navigates the renderer during sign-in', async ({ electronPage }) => {
const { signIn } = createPageObjects({ page: electronPage, useTestingToken: false });

await electronPage.evaluate(() => {
(window as ElectronWindow).__hardNavigations = [];
addEventListener('clerk:beforeunload', () => {
(window as ElectronWindow).__hardNavigations?.push(location.href);
});
});

await signIn.waitForMounted();
await signIn.setIdentifier(fakeUser.email!);
await signIn.continue();
await signIn.setPassword(fakeUser.password);
await signIn.continue();

await expect(electronPage.locator('[data-testid="user-id"]')).toHaveText(/^user_/, { timeout: 30_000 });
await expect(electronPage.evaluate(() => (window as ElectronWindow).__hardNavigations)).resolves.toEqual([]);
});
});
71 changes: 71 additions & 0 deletions packages/electron/src/react/__tests__/ClerkProvider.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,77 @@ describe('Electron ClerkProvider', () => {
});
});

describe('router handlers', () => {
const renderWithRouter = (props: Record<string, unknown> = {}) => {
renderToStaticMarkup(
<ClerkProvider
publishableKey='pk_test_provider'
{...props}
>
<span>App</span>
</ClerkProvider>,
);

return {
routerPush: capturedProviderProps?.routerPush as (to: string, metadata?: unknown) => void,
routerReplace: capturedProviderProps?.routerReplace as (to: string, metadata?: unknown) => void,
};
};

it('always supplies both handlers so clerk-js never falls back to a window navigation', () => {
const { routerPush, routerReplace } = renderWithRouter();

expect(routerPush).toBeTypeOf('function');
expect(routerReplace).toBeTypeOf('function');
});

it('absorbs virtual router paths instead of forwarding them to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });
routerReplace('/CLERK-ROUTER/VIRTUAL/sign-in#/factor-two', { windowNavigate });

expect(push).not.toHaveBeenCalled();
expect(replace).not.toHaveBeenCalled();
expect(windowNavigate).not.toHaveBeenCalled();
});

it('absorbs virtual router paths even without an application router', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });

expect(windowNavigate).not.toHaveBeenCalled();
});

it('forwards real destinations to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/settings/connections', { windowNavigate });
routerReplace('/dashboard', { windowNavigate });

expect(push).toHaveBeenCalledWith('/settings/connections', { windowNavigate });
expect(replace).toHaveBeenCalledWith('/dashboard', { windowNavigate });
expect(windowNavigate).not.toHaveBeenCalled();
});

it('falls back to the host navigation for real destinations when no application router is provided', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/settings/connections', { windowNavigate });

expect(windowNavigate).toHaveBeenCalledWith('/settings/connections');
});
});

it('defaults allowedRedirectProtocols to the renderer custom scheme', () => {
stubWindowProtocol('clerk:');

Expand Down
29 changes: 29 additions & 0 deletions packages/electron/src/react/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkProviderProps as ReactClerkProviderProps } from '@clerk/react';
import { InternalClerkProvider as ReactClerkProvider } from '@clerk/react/internal';
import { isVirtualRouterPath } from '@clerk/shared/internal/clerk-js/url';
import { ALLOWED_PROTOCOLS } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { loadClerkUIScript } from '@clerk/shared/loadClerkJsScript';
import type { ClerkUIConstructor } from '@clerk/shared/ui';
Expand DownExpand Up@@ -79,6 +80,30 @@ function createOAuthTransport(): ClerkOAuthTransport | undefined {
};
}

type ClerkRouterFn = NonNullable<ReactClerkProviderProps['routerPush']>;

/** Always supplied, so clerk-js never reaches `window.location` and reloads the renderer. */
function createRouterHandlers(
routerPush: ClerkRouterFn | undefined,
routerReplace: ClerkRouterFn | undefined,
): { routerPush: ClerkRouterFn; routerReplace: ClerkRouterFn } {
const wrap =
(delegate: ClerkRouterFn | undefined): ClerkRouterFn =>
(to, metadata) => {
if (isVirtualRouterPath(to)) {
return;
}

if (delegate) {
return delegate(to, metadata);
}

metadata?.windowNavigate(to);
};

return { routerPush: wrap(routerPush), routerReplace: wrap(routerReplace) };
}

/**
* Infer the custom renderer scheme registered with `createClerkBridge({ renderer })`.
* Built-in Clerk protocols and local file renderers are not inferred.
Expand All@@ -98,15 +123,19 @@ export function ClerkProvider({
publishableKey,
passkeys,
allowedRedirectProtocols,
routerPush,
routerReplace,
...props
}: ClerkProviderProps): JSX.Element {
const clerk = createClerkInstance(publishableKey, passkeys);
const oauthTransport = createOAuthTransport();
const clerkUI = loadClerkUI(publishableKey, props);
const routerHandlers = createRouterHandlers(routerPush, routerReplace);

return (
<ReactClerkProvider
{...props}
{...routerHandlers}
Clerk={clerk}
__internal_oauthTransport={oauthTransport}
allowedRedirectProtocols={allowedRedirectProtocols ?? defaultAllowedRedirectProtocols()}
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/internal/clerk-js/url.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,13 @@ export const pathFromFullPath = (fullPath: string) => {
return fullPath.replace(/CLERK-ROUTER\/(.*?)\//, '');
};

export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

/**
* Whether `to` addresses the in-memory component router rather than a real application route.
*/
export const isVirtualRouterPath = (to: string): boolean => to.includes(VIRTUAL_ROUTER_BASE_PATH);

const frontendApiRedirectPathsWithUserInput: string[] = [
'/oauth/authorize', // OAuth2 identify provider flow
];
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,22 +55,72 @@ describe('buildSignInOAuthTransportCallbackParams', () => {
unsafeMetadata: { a: 1 },
} as any;

const origin = window.location.origin;

expect(buildSignInOAuthTransportCallbackParams(ctx)).toEqual({
signUpUrl: '/sign-up',
signInUrl: '/sign-in',
signInForceRedirectUrl: '/after-in',
signUpForceRedirectUrl: '/after-up',
continueSignUpUrl: '/continue',
transferable: true,
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
// Relative to the SignIn start route; the sign-up gate URL stays absolute (combined-aware).
signInProtectCheckUrl: 'protect-check',
signUpProtectCheckUrl: '/sign-up-protect-check',
// Sign-up steps are path routes on the sign-up component; hash-style URLs would lose their
// hash in the virtual router and land a transferred sign-up on the start card.
continueSignUpUrl: `${origin}/sign-up/continue`,
verifyEmailAddressUrl: `${origin}/sign-up/verify-email-address`,
verifyPhoneNumberUrl: `${origin}/sign-up/verify-phone-number`,
signUpProtectCheckUrl: `${origin}/sign-up/protect-check`,
unsafeMetadata: { a: 1 },
});
});

it('targets the virtual sign-up routes for modal transport callbacks', () => {
const ctx = {
signUpUrl: '/CLERK-ROUTER/VIRTUAL/sign-up',
signInUrl: '/CLERK-ROUTER/VIRTUAL/sign-in',
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/protect-check`);
});

it('drops a hash fragment from signUpUrl when building sign-up step URLs', () => {
const ctx = {
signUpUrl: '/sign-up#/continue',
signInUrl: '/sign-in',
} as any;
Comment thread
coderabbitai[bot] marked this conversation as resolved.

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/sign-up/protect-check`);
});

it('targets the embedded create subtree in the combined flow', () => {
const ctx = {
signUpUrl: '/sign-in#/create',
signInUrl: '/sign-in',
isCombinedFlow: true,
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);

expect(params.continueSignUpUrl).toBe('create/continue');
expect(params.verifyEmailAddressUrl).toBe('create/verify-email-address');
expect(params.verifyPhoneNumberUrl).toBe('create/verify-phone-number');
expect(params.signUpProtectCheckUrl).toBe('create/protect-check');
});
Comment thread
coderabbitai[bot] marked this conversation as resolved.
});

describe('buildSignUpOAuthCallbackParams', () => {
Expand Down
16 changes: 16 additions & 0 deletions packages/ui/src/components/SignIn/buildOAuthCallbackParams.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { buildURL, trimTrailingSlash } from '@clerk/shared/internal/clerk-js/url';
import type { HandleOAuthCallbackParams } from '@clerk/shared/types';

import type { SignInContextType } from '../../contexts/components/SignIn';
Expand All@@ -23,12 +24,27 @@ export function buildSignInOAuthCallbackParams(ctx: SignInContextType): HandleOA
}

export function buildSignInOAuthTransportCallbackParams(ctx: SignInContextType): HandleOAuthCallbackParams {
// Path form, not `#/step`: the in-place component router matches on pathname only and would drop the hash.
const signUpStepUrl = (step: string): string => {
if (ctx.isCombinedFlow) {
return `create/${step}`;
}
const url = buildURL({ base: ctx.signUpUrl }, { stringify: false });
url.pathname = `${trimTrailingSlash(url.pathname)}/${step}`;
url.hash = '';
return url.href;
};

return {
...buildSignInOAuthCallbackParams(ctx),
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
signInProtectCheckUrl: 'protect-check',
continueSignUpUrl: signUpStepUrl('continue'),
verifyEmailAddressUrl: signUpStepUrl('verify-email-address'),
verifyPhoneNumberUrl: signUpStepUrl('verify-phone-number'),
signUpProtectCheckUrl: signUpStepUrl('protect-check'),
};
}

Expand Down
4 changes: 3 additions & 1 deletion packages/ui/src/router/VirtualRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import { VIRTUAL_ROUTER_BASE_PATH } from '@clerk/shared/internal/clerk-js/url';
import { useClerk } from '@clerk/shared/react';
import React, { useEffect } from 'react';

import { useClerkModalStateParams } from '../hooks';
import { BaseRouter } from './BaseRouter';
export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

export { VIRTUAL_ROUTER_BASE_PATH };

interface VirtualRouterProps {
startPath: string;
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/electron-virtual-router-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/electron': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Keep Clerk's navigation inside the renderer. `ClerkProvider` now always supplies `routerPush`/`routerReplace`, so Clerk routes through your application's router when you provide one, and never navigates the window to an internal `/CLERK-ROUTER/VIRTUAL/...` path β€” which no custom protocol handler can serve, and which reloaded the renderer and dropped the user out of sign-in.

Applications that worked around this by passing no-op router functions, or by filtering `CLERK-ROUTER/VIRTUAL` out themselves, can remove those workarounds.
5 changes: 5 additions & 0 deletions .changeset/signin-transport-transfer-next-step.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Route an OAuth transfer to the sign-up continue step when sign-in uses a native OAuth transport. The callback previously navigated with hash-style URLs (`<sign-up-url>#/continue`) that the in-place component router cannot resolve, landing transferred sign-ups on the start card where submitting created a fresh sign-up without the verified external account.
4 changes: 2 additions & 2 deletions integration/templates/electron-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,8 +12,8 @@ function App() {
<ClerkProvider
publishableKey={PUBLISHABLE_KEY}
__internal_clerkUIUrl={CLERK_UI_URL}
routerPush={() => {}}
routerReplace={() => {}}
routerPush={(to: string) => window.history.pushState(null, '', to)}
routerReplace={(to: string) => window.history.replaceState(null, '', to)}
>
<main data-testid='electron-app'>
<Show when='signed-out'>
Expand Down
21 changes: 21 additions & 0 deletions integration/tests/electron/basic.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ type ElectronWindow = Window & {
tokenCache?: Partial<Record<'clearToken' | 'getToken' | 'saveToken', unknown>>;
oauthTransport?: Partial<Record<'getRedirectUrl' | 'open', unknown>>;
};
__hardNavigations?: string[];
};

test.describe('electron basic auth @electron', () => {
Expand DownExpand Up@@ -74,4 +75,24 @@ test.describe('electron basic auth @electron', () => {
test('keeps the signed-out state after relaunch', async ({ electronPage }) => {
await expect(electronPage.locator('.cl-signIn-root')).toBeVisible({ timeout: 30_000 });
});

test('never hard navigates the renderer during sign-in', async ({ electronPage }) => {
const { signIn } = createPageObjects({ page: electronPage, useTestingToken: false });

await electronPage.evaluate(() => {
(window as ElectronWindow).__hardNavigations = [];
addEventListener('clerk:beforeunload', () => {
(window as ElectronWindow).__hardNavigations?.push(location.href);
});
});

await signIn.waitForMounted();
await signIn.setIdentifier(fakeUser.email!);
await signIn.continue();
await signIn.setPassword(fakeUser.password);
await signIn.continue();

await expect(electronPage.locator('[data-testid="user-id"]')).toHaveText(/^user_/, { timeout: 30_000 });
await expect(electronPage.evaluate(() => (window as ElectronWindow).__hardNavigations)).resolves.toEqual([]);
});
});
71 changes: 71 additions & 0 deletions packages/electron/src/react/__tests__/ClerkProvider.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,77 @@ describe('Electron ClerkProvider', () => {
});
});

describe('router handlers', () => {
const renderWithRouter = (props: Record<string, unknown> = {}) => {
renderToStaticMarkup(
<ClerkProvider
publishableKey='pk_test_provider'
{...props}
>
<span>App</span>
</ClerkProvider>,
);

return {
routerPush: capturedProviderProps?.routerPush as (to: string, metadata?: unknown) => void,
routerReplace: capturedProviderProps?.routerReplace as (to: string, metadata?: unknown) => void,
};
};

it('always supplies both handlers so clerk-js never falls back to a window navigation', () => {
const { routerPush, routerReplace } = renderWithRouter();

expect(routerPush).toBeTypeOf('function');
expect(routerReplace).toBeTypeOf('function');
});

it('absorbs virtual router paths instead of forwarding them to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });
routerReplace('/CLERK-ROUTER/VIRTUAL/sign-in#/factor-two', { windowNavigate });

expect(push).not.toHaveBeenCalled();
expect(replace).not.toHaveBeenCalled();
expect(windowNavigate).not.toHaveBeenCalled();
});

it('absorbs virtual router paths even without an application router', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });

expect(windowNavigate).not.toHaveBeenCalled();
});

it('forwards real destinations to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/settings/connections', { windowNavigate });
routerReplace('/dashboard', { windowNavigate });

expect(push).toHaveBeenCalledWith('/settings/connections', { windowNavigate });
expect(replace).toHaveBeenCalledWith('/dashboard', { windowNavigate });
expect(windowNavigate).not.toHaveBeenCalled();
});

it('falls back to the host navigation for real destinations when no application router is provided', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/settings/connections', { windowNavigate });

expect(windowNavigate).toHaveBeenCalledWith('/settings/connections');
});
});

it('defaults allowedRedirectProtocols to the renderer custom scheme', () => {
stubWindowProtocol('clerk:');

Expand Down
29 changes: 29 additions & 0 deletions packages/electron/src/react/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkProviderProps as ReactClerkProviderProps } from '@clerk/react';
import { InternalClerkProvider as ReactClerkProvider } from '@clerk/react/internal';
import { isVirtualRouterPath } from '@clerk/shared/internal/clerk-js/url';
import { ALLOWED_PROTOCOLS } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { loadClerkUIScript } from '@clerk/shared/loadClerkJsScript';
import type { ClerkUIConstructor } from '@clerk/shared/ui';
Expand DownExpand Up@@ -79,6 +80,30 @@ function createOAuthTransport(): ClerkOAuthTransport | undefined {
};
}

type ClerkRouterFn = NonNullable<ReactClerkProviderProps['routerPush']>;

/** Always supplied, so clerk-js never reaches `window.location` and reloads the renderer. */
function createRouterHandlers(
routerPush: ClerkRouterFn | undefined,
routerReplace: ClerkRouterFn | undefined,
): { routerPush: ClerkRouterFn; routerReplace: ClerkRouterFn } {
const wrap =
(delegate: ClerkRouterFn | undefined): ClerkRouterFn =>
(to, metadata) => {
if (isVirtualRouterPath(to)) {
return;
}

if (delegate) {
return delegate(to, metadata);
}

metadata?.windowNavigate(to);
};

return { routerPush: wrap(routerPush), routerReplace: wrap(routerReplace) };
}

/**
* Infer the custom renderer scheme registered with `createClerkBridge({ renderer })`.
* Built-in Clerk protocols and local file renderers are not inferred.
Expand All@@ -98,15 +123,19 @@ export function ClerkProvider({
publishableKey,
passkeys,
allowedRedirectProtocols,
routerPush,
routerReplace,
...props
}: ClerkProviderProps): JSX.Element {
const clerk = createClerkInstance(publishableKey, passkeys);
const oauthTransport = createOAuthTransport();
const clerkUI = loadClerkUI(publishableKey, props);
const routerHandlers = createRouterHandlers(routerPush, routerReplace);

return (
<ReactClerkProvider
{...props}
{...routerHandlers}
Clerk={clerk}
__internal_oauthTransport={oauthTransport}
allowedRedirectProtocols={allowedRedirectProtocols ?? defaultAllowedRedirectProtocols()}
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/internal/clerk-js/url.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,13 @@ export const pathFromFullPath = (fullPath: string) => {
return fullPath.replace(/CLERK-ROUTER\/(.*?)\//, '');
};

export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

/**
* Whether `to` addresses the in-memory component router rather than a real application route.
*/
export const isVirtualRouterPath = (to: string): boolean => to.includes(VIRTUAL_ROUTER_BASE_PATH);

const frontendApiRedirectPathsWithUserInput: string[] = [
'/oauth/authorize', // OAuth2 identify provider flow
];
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,22 +55,72 @@ describe('buildSignInOAuthTransportCallbackParams', () => {
unsafeMetadata: { a: 1 },
} as any;

const origin = window.location.origin;

expect(buildSignInOAuthTransportCallbackParams(ctx)).toEqual({
signUpUrl: '/sign-up',
signInUrl: '/sign-in',
signInForceRedirectUrl: '/after-in',
signUpForceRedirectUrl: '/after-up',
continueSignUpUrl: '/continue',
transferable: true,
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
// Relative to the SignIn start route; the sign-up gate URL stays absolute (combined-aware).
signInProtectCheckUrl: 'protect-check',
signUpProtectCheckUrl: '/sign-up-protect-check',
// Sign-up steps are path routes on the sign-up component; hash-style URLs would lose their
// hash in the virtual router and land a transferred sign-up on the start card.
continueSignUpUrl: `${origin}/sign-up/continue`,
verifyEmailAddressUrl: `${origin}/sign-up/verify-email-address`,
verifyPhoneNumberUrl: `${origin}/sign-up/verify-phone-number`,
signUpProtectCheckUrl: `${origin}/sign-up/protect-check`,
unsafeMetadata: { a: 1 },
});
});

it('targets the virtual sign-up routes for modal transport callbacks', () => {
const ctx = {
signUpUrl: '/CLERK-ROUTER/VIRTUAL/sign-up',
signInUrl: '/CLERK-ROUTER/VIRTUAL/sign-in',
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/protect-check`);
});

it('drops a hash fragment from signUpUrl when building sign-up step URLs', () => {
const ctx = {
signUpUrl: '/sign-up#/continue',
signInUrl: '/sign-in',
} as any;
Comment thread
coderabbitai[bot] marked this conversation as resolved.

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/sign-up/protect-check`);
});

it('targets the embedded create subtree in the combined flow', () => {
const ctx = {
signUpUrl: '/sign-in#/create',
signInUrl: '/sign-in',
isCombinedFlow: true,
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);

expect(params.continueSignUpUrl).toBe('create/continue');
expect(params.verifyEmailAddressUrl).toBe('create/verify-email-address');
expect(params.verifyPhoneNumberUrl).toBe('create/verify-phone-number');
expect(params.signUpProtectCheckUrl).toBe('create/protect-check');
});
Comment thread
coderabbitai[bot] marked this conversation as resolved.
});

describe('buildSignUpOAuthCallbackParams', () => {
Expand Down
16 changes: 16 additions & 0 deletions packages/ui/src/components/SignIn/buildOAuthCallbackParams.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { buildURL, trimTrailingSlash } from '@clerk/shared/internal/clerk-js/url';
import type { HandleOAuthCallbackParams } from '@clerk/shared/types';

import type { SignInContextType } from '../../contexts/components/SignIn';
Expand All@@ -23,12 +24,27 @@ export function buildSignInOAuthCallbackParams(ctx: SignInContextType): HandleOA
}

export function buildSignInOAuthTransportCallbackParams(ctx: SignInContextType): HandleOAuthCallbackParams {
// Path form, not `#/step`: the in-place component router matches on pathname only and would drop the hash.
const signUpStepUrl = (step: string): string => {
if (ctx.isCombinedFlow) {
return `create/${step}`;
}
const url = buildURL({ base: ctx.signUpUrl }, { stringify: false });
url.pathname = `${trimTrailingSlash(url.pathname)}/${step}`;
url.hash = '';
return url.href;
};

return {
...buildSignInOAuthCallbackParams(ctx),
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
signInProtectCheckUrl: 'protect-check',
continueSignUpUrl: signUpStepUrl('continue'),
verifyEmailAddressUrl: signUpStepUrl('verify-email-address'),
verifyPhoneNumberUrl: signUpStepUrl('verify-phone-number'),
signUpProtectCheckUrl: signUpStepUrl('protect-check'),
};
}

Expand Down
4 changes: 3 additions & 1 deletion packages/ui/src/router/VirtualRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import { VIRTUAL_ROUTER_BASE_PATH } from '@clerk/shared/internal/clerk-js/url';
import { useClerk } from '@clerk/shared/react';
import React, { useEffect } from 'react';

import { useClerkModalStateParams } from '../hooks';
import { BaseRouter } from './BaseRouter';
export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

export { VIRTUAL_ROUTER_BASE_PATH };

interface VirtualRouterProps {
startPath: string;
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/electron-virtual-router-navigation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/electron': patch
'@clerk/shared': patch
'@clerk/ui': patch
---

Keep Clerk's navigation inside the renderer. `ClerkProvider` now always supplies `routerPush`/`routerReplace`, so Clerk routes through your application's router when you provide one, and never navigates the window to an internal `/CLERK-ROUTER/VIRTUAL/...` path β€” which no custom protocol handler can serve, and which reloaded the renderer and dropped the user out of sign-in.

Applications that worked around this by passing no-op router functions, or by filtering `CLERK-ROUTER/VIRTUAL` out themselves, can remove those workarounds.
5 changes: 5 additions & 0 deletions .changeset/signin-transport-transfer-next-step.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Route an OAuth transfer to the sign-up continue step when sign-in uses a native OAuth transport. The callback previously navigated with hash-style URLs (`<sign-up-url>#/continue`) that the in-place component router cannot resolve, landing transferred sign-ups on the start card where submitting created a fresh sign-up without the verified external account.
4 changes: 2 additions & 2 deletions integration/templates/electron-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,8 +12,8 @@ function App() {
<ClerkProvider
publishableKey={PUBLISHABLE_KEY}
__internal_clerkUIUrl={CLERK_UI_URL}
routerPush={() => {}}
routerReplace={() => {}}
routerPush={(to: string) => window.history.pushState(null, '', to)}
routerReplace={(to: string) => window.history.replaceState(null, '', to)}
>
<main data-testid='electron-app'>
<Show when='signed-out'>
Expand Down
21 changes: 21 additions & 0 deletions integration/tests/electron/basic.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ type ElectronWindow = Window & {
tokenCache?: Partial<Record<'clearToken' | 'getToken' | 'saveToken', unknown>>;
oauthTransport?: Partial<Record<'getRedirectUrl' | 'open', unknown>>;
};
__hardNavigations?: string[];
};

test.describe('electron basic auth @electron', () => {
Expand DownExpand Up@@ -74,4 +75,24 @@ test.describe('electron basic auth @electron', () => {
test('keeps the signed-out state after relaunch', async ({ electronPage }) => {
await expect(electronPage.locator('.cl-signIn-root')).toBeVisible({ timeout: 30_000 });
});

test('never hard navigates the renderer during sign-in', async ({ electronPage }) => {
const { signIn } = createPageObjects({ page: electronPage, useTestingToken: false });

await electronPage.evaluate(() => {
(window as ElectronWindow).__hardNavigations = [];
addEventListener('clerk:beforeunload', () => {
(window as ElectronWindow).__hardNavigations?.push(location.href);
});
});

await signIn.waitForMounted();
await signIn.setIdentifier(fakeUser.email!);
await signIn.continue();
await signIn.setPassword(fakeUser.password);
await signIn.continue();

await expect(electronPage.locator('[data-testid="user-id"]')).toHaveText(/^user_/, { timeout: 30_000 });
await expect(electronPage.evaluate(() => (window as ElectronWindow).__hardNavigations)).resolves.toEqual([]);
});
});
71 changes: 71 additions & 0 deletions packages/electron/src/react/__tests__/ClerkProvider.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,77 @@ describe('Electron ClerkProvider', () => {
});
});

describe('router handlers', () => {
const renderWithRouter = (props: Record<string, unknown> = {}) => {
renderToStaticMarkup(
<ClerkProvider
publishableKey='pk_test_provider'
{...props}
>
<span>App</span>
</ClerkProvider>,
);

return {
routerPush: capturedProviderProps?.routerPush as (to: string, metadata?: unknown) => void,
routerReplace: capturedProviderProps?.routerReplace as (to: string, metadata?: unknown) => void,
};
};

it('always supplies both handlers so clerk-js never falls back to a window navigation', () => {
const { routerPush, routerReplace } = renderWithRouter();

expect(routerPush).toBeTypeOf('function');
expect(routerReplace).toBeTypeOf('function');
});

it('absorbs virtual router paths instead of forwarding them to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });
routerReplace('/CLERK-ROUTER/VIRTUAL/sign-in#/factor-two', { windowNavigate });

expect(push).not.toHaveBeenCalled();
expect(replace).not.toHaveBeenCalled();
expect(windowNavigate).not.toHaveBeenCalled();
});

it('absorbs virtual router paths even without an application router', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/CLERK-ROUTER/VIRTUAL/sign-up#/continue', { windowNavigate });

expect(windowNavigate).not.toHaveBeenCalled();
});

it('forwards real destinations to the application router', () => {
const push = vi.fn();
const replace = vi.fn();
const windowNavigate = vi.fn();
const { routerPush, routerReplace } = renderWithRouter({ routerPush: push, routerReplace: replace });

routerPush('/settings/connections', { windowNavigate });
routerReplace('/dashboard', { windowNavigate });

expect(push).toHaveBeenCalledWith('/settings/connections', { windowNavigate });
expect(replace).toHaveBeenCalledWith('/dashboard', { windowNavigate });
expect(windowNavigate).not.toHaveBeenCalled();
});

it('falls back to the host navigation for real destinations when no application router is provided', () => {
const windowNavigate = vi.fn();
const { routerPush } = renderWithRouter();

routerPush('/settings/connections', { windowNavigate });

expect(windowNavigate).toHaveBeenCalledWith('/settings/connections');
});
});

it('defaults allowedRedirectProtocols to the renderer custom scheme', () => {
stubWindowProtocol('clerk:');

Expand Down
29 changes: 29 additions & 0 deletions packages/electron/src/react/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import type { ClerkProviderProps as ReactClerkProviderProps } from '@clerk/react';
import { InternalClerkProvider as ReactClerkProvider } from '@clerk/react/internal';
import { isVirtualRouterPath } from '@clerk/shared/internal/clerk-js/url';
import { ALLOWED_PROTOCOLS } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { loadClerkUIScript } from '@clerk/shared/loadClerkJsScript';
import type { ClerkUIConstructor } from '@clerk/shared/ui';
Expand DownExpand Up@@ -79,6 +80,30 @@ function createOAuthTransport(): ClerkOAuthTransport | undefined {
};
}

type ClerkRouterFn = NonNullable<ReactClerkProviderProps['routerPush']>;

/** Always supplied, so clerk-js never reaches `window.location` and reloads the renderer. */
function createRouterHandlers(
routerPush: ClerkRouterFn | undefined,
routerReplace: ClerkRouterFn | undefined,
): { routerPush: ClerkRouterFn; routerReplace: ClerkRouterFn } {
const wrap =
(delegate: ClerkRouterFn | undefined): ClerkRouterFn =>
(to, metadata) => {
if (isVirtualRouterPath(to)) {
return;
}

if (delegate) {
return delegate(to, metadata);
}

metadata?.windowNavigate(to);
};

return { routerPush: wrap(routerPush), routerReplace: wrap(routerReplace) };
}

/**
* Infer the custom renderer scheme registered with `createClerkBridge({ renderer })`.
* Built-in Clerk protocols and local file renderers are not inferred.
Expand All@@ -98,15 +123,19 @@ export function ClerkProvider({
publishableKey,
passkeys,
allowedRedirectProtocols,
routerPush,
routerReplace,
...props
}: ClerkProviderProps): JSX.Element {
const clerk = createClerkInstance(publishableKey, passkeys);
const oauthTransport = createOAuthTransport();
const clerkUI = loadClerkUI(publishableKey, props);
const routerHandlers = createRouterHandlers(routerPush, routerReplace);

return (
<ReactClerkProvider
{...props}
{...routerHandlers}
Clerk={clerk}
__internal_oauthTransport={oauthTransport}
allowedRedirectProtocols={allowedRedirectProtocols ?? defaultAllowedRedirectProtocols()}
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/internal/clerk-js/url.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,13 @@ export const pathFromFullPath = (fullPath: string) => {
return fullPath.replace(/CLERK-ROUTER\/(.*?)\//, '');
};

export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

/**
* Whether `to` addresses the in-memory component router rather than a real application route.
*/
export const isVirtualRouterPath = (to: string): boolean => to.includes(VIRTUAL_ROUTER_BASE_PATH);

const frontendApiRedirectPathsWithUserInput: string[] = [
'/oauth/authorize', // OAuth2 identify provider flow
];
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,22 +55,72 @@ describe('buildSignInOAuthTransportCallbackParams', () => {
unsafeMetadata: { a: 1 },
} as any;

const origin = window.location.origin;

expect(buildSignInOAuthTransportCallbackParams(ctx)).toEqual({
signUpUrl: '/sign-up',
signInUrl: '/sign-in',
signInForceRedirectUrl: '/after-in',
signUpForceRedirectUrl: '/after-up',
continueSignUpUrl: '/continue',
transferable: true,
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
// Relative to the SignIn start route; the sign-up gate URL stays absolute (combined-aware).
signInProtectCheckUrl: 'protect-check',
signUpProtectCheckUrl: '/sign-up-protect-check',
// Sign-up steps are path routes on the sign-up component; hash-style URLs would lose their
// hash in the virtual router and land a transferred sign-up on the start card.
continueSignUpUrl: `${origin}/sign-up/continue`,
verifyEmailAddressUrl: `${origin}/sign-up/verify-email-address`,
verifyPhoneNumberUrl: `${origin}/sign-up/verify-phone-number`,
signUpProtectCheckUrl: `${origin}/sign-up/protect-check`,
unsafeMetadata: { a: 1 },
});
});

it('targets the virtual sign-up routes for modal transport callbacks', () => {
const ctx = {
signUpUrl: '/CLERK-ROUTER/VIRTUAL/sign-up',
signInUrl: '/CLERK-ROUTER/VIRTUAL/sign-in',
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/CLERK-ROUTER/VIRTUAL/sign-up/protect-check`);
});

it('drops a hash fragment from signUpUrl when building sign-up step URLs', () => {
const ctx = {
signUpUrl: '/sign-up#/continue',
signInUrl: '/sign-in',
} as any;
Comment thread
coderabbitai[bot] marked this conversation as resolved.

const params = buildSignInOAuthTransportCallbackParams(ctx);
const origin = window.location.origin;

expect(params.continueSignUpUrl).toBe(`${origin}/sign-up/continue`);
expect(params.verifyEmailAddressUrl).toBe(`${origin}/sign-up/verify-email-address`);
expect(params.verifyPhoneNumberUrl).toBe(`${origin}/sign-up/verify-phone-number`);
expect(params.signUpProtectCheckUrl).toBe(`${origin}/sign-up/protect-check`);
});

it('targets the embedded create subtree in the combined flow', () => {
const ctx = {
signUpUrl: '/sign-in#/create',
signInUrl: '/sign-in',
isCombinedFlow: true,
} as any;

const params = buildSignInOAuthTransportCallbackParams(ctx);

expect(params.continueSignUpUrl).toBe('create/continue');
expect(params.verifyEmailAddressUrl).toBe('create/verify-email-address');
expect(params.verifyPhoneNumberUrl).toBe('create/verify-phone-number');
expect(params.signUpProtectCheckUrl).toBe('create/protect-check');
});
Comment thread
coderabbitai[bot] marked this conversation as resolved.
});

describe('buildSignUpOAuthCallbackParams', () => {
Expand Down
16 changes: 16 additions & 0 deletions packages/ui/src/components/SignIn/buildOAuthCallbackParams.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { buildURL, trimTrailingSlash } from '@clerk/shared/internal/clerk-js/url';
import type { HandleOAuthCallbackParams } from '@clerk/shared/types';

import type { SignInContextType } from '../../contexts/components/SignIn';
Expand All@@ -23,12 +24,27 @@ export function buildSignInOAuthCallbackParams(ctx: SignInContextType): HandleOA
}

export function buildSignInOAuthTransportCallbackParams(ctx: SignInContextType): HandleOAuthCallbackParams {
// Path form, not `#/step`: the in-place component router matches on pathname only and would drop the hash.
const signUpStepUrl = (step: string): string => {
if (ctx.isCombinedFlow) {
return `create/${step}`;
}
const url = buildURL({ base: ctx.signUpUrl }, { stringify: false });
url.pathname = `${trimTrailingSlash(url.pathname)}/${step}`;
url.hash = '';
return url.href;
};

return {
...buildSignInOAuthCallbackParams(ctx),
firstFactorUrl: 'factor-one',
secondFactorUrl: 'factor-two',
resetPasswordUrl: 'reset-password',
signInProtectCheckUrl: 'protect-check',
continueSignUpUrl: signUpStepUrl('continue'),
verifyEmailAddressUrl: signUpStepUrl('verify-email-address'),
verifyPhoneNumberUrl: signUpStepUrl('verify-phone-number'),
signUpProtectCheckUrl: signUpStepUrl('protect-check'),
};
}

Expand Down
4 changes: 3 additions & 1 deletion packages/ui/src/router/VirtualRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import { VIRTUAL_ROUTER_BASE_PATH } from '@clerk/shared/internal/clerk-js/url';
import { useClerk } from '@clerk/shared/react';
import React, { useEffect } from 'react';

import { useClerkModalStateParams } from '../hooks';
import { BaseRouter } from './BaseRouter';
export const VIRTUAL_ROUTER_BASE_PATH = 'CLERK-ROUTER/VIRTUAL';

export { VIRTUAL_ROUTER_BASE_PATH };

interface VirtualRouterProps {
startPath: string;
Expand Down
Loading