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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-router-sync-popup-oauth.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix BaseRouter state not syncing after popup OAuth by observing `pushState`/`replaceState` changes in addition to `popstate`
1 change: 1 addition & 0 deletions integration/presets/longRunningApps.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ export const createLongRunningApps = () => {
{ id: 'react.vite.withEmailCodes', config: react.vite, env: envs.withEmailCodes },
{ id: 'react.vite.withEmailCodes_persist_client', config: react.vite, env: envs.withEmailCodes_destroy_client },
{ id: 'react.vite.withEmailLinks', config: react.vite, env: envs.withEmailLinks },
{ id: 'react.vite.withLegalConsent', config: react.vite, env: envs.withLegalConsent },
{ id: 'vue.vite', config: vue.vite, env: envs.withCustomRoles },

/**
Expand Down
9 changes: 9 additions & 0 deletions integration/templates/react-vite/src/buttons/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,15 @@ export default function Home() {
Sign in button (force)
</SignInButton>

<SignInButton
mode='modal'
oauthFlow='popup'
forceRedirectUrl='/protected'
signUpForceRedirectUrl='/protected'
>
Sign in button (force, popup)
</SignInButton>

<SignInButton
mode='modal'
fallbackRedirectUrl='/protected'
Expand Down
5 changes: 5 additions & 0 deletions integration/templates/react-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import { createBrowserRouter, Outlet, RouterProvider, useNavigate } from 'react-
import App from './App.tsx';
import Protected from './protected';
import SignIn from './sign-in';
import SignInPopup from './sign-in-popup';
import SignUp from './sign-up';
import UserProfile from './user';
import UserProfileCustom from './custom-user-profile';
Expand DownExpand Up@@ -57,6 +58,10 @@ const router = createBrowserRouter([
path: '/sign-in/*',
element: <SignIn />,
},
{
path: '/sign-in-popup/*',
element: <SignInPopup />,
},
{
path: '/sign-up/*',
element: <SignUp />,
Expand Down
15 changes: 15 additions & 0 deletions integration/templates/react-vite/src/sign-in-popup/index.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
import { SignIn } from '@clerk/clerk-react';

export default function Page() {
return (
<div>
<SignIn
path={'/sign-in-popup'}
signUpUrl={'/sign-up'}
oauthFlow='popup'
fallbackRedirectUrl='/protected'
fallback={<>Loading sign in</>}
/>
</div>
);
}
57 changes: 57 additions & 0 deletions integration/tests/oauth-flows.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,63 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('oauth flo
});
});

testAgainstRunningApps({ withPattern: ['react.vite.withLegalConsent'] })(
'oauth popup with path-based routing @react',
({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

test.beforeAll(async () => {
const client = createClerkClient({
secretKey: instanceKeys.get('oauth-provider').sk,
publishableKey: instanceKeys.get('oauth-provider').pk,
});
const users = createUserService(client);
fakeUser = users.createFakeUser({
withUsername: true,
});
await users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
const u = createTestUtils({ app });
await fakeUser.deleteIfExists();
await u.services.users.deleteIfExists({ email: fakeUser.email });
await app.teardown();
});

test('popup OAuth navigates through sso-callback with path-based routing', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.page.goToRelative('/sign-in-popup');
await u.page.waitForClerkJsLoaded();
await u.po.signIn.waitForMounted();

const popupPromise = context.waitForEvent('page');
await u.page.getByRole('button', { name: 'E2E OAuth Provider' }).click();
const popup = await popupPromise;
const popupUtils = createTestUtils({ app, page: popup, context });
await popupUtils.page.getByText('Sign in to oauth-provider').waitFor();

// Complete OAuth in the popup
await popupUtils.po.signIn.setIdentifier(fakeUser.email);
await popupUtils.po.signIn.continue();
await popupUtils.po.signIn.enterTestOtpCode();

// Because the user is new to the app and legal consent is required,
// the sign-up can't complete in the popup. The popup sends return_url
// back to the parent, which navigates to /sso-callback via pushState.
await u.page.getByRole('heading', { name: 'Legal consent' }).waitFor();
await u.page.getByLabel(/I agree to the/).check();
await u.po.signIn.continue();

await u.page.waitForAppUrl('/protected');
await u.po.expect.toBeSignedIn();
});
},
);

testAgainstRunningApps({ withEnv: [appConfigs.envs.withLegalConsent] })(
'oauth flows with legal consent @nextjs',
({ app }) => {
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/hooks/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,3 @@ export * from './useSafeState';
export * from './useScrollLock';
export * from './useSearchInput';
export * from './useTotalEnabledAuthMethods';
export * from './useWindowEventListener';
15 changes: 0 additions & 15 deletions packages/clerk-js/src/ui/hooks/useWindowEventListener.ts

This file was deleted.

158 changes: 152 additions & 6 deletions packages/clerk-js/src/ui/router/BaseRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,140 @@
import { useClerk } from '@clerk/shared/react';
import type { NavigateOptions } from '@clerk/shared/types';
import React from 'react';
import { flushSync } from 'react-dom';

import { getQueryParams, stringifyQueryParams, trimTrailingSlash } from '../../utils';
import { useWindowEventListener } from '../hooks';
import { newPaths } from './newPaths';
import { match } from './pathToRegexp';
import { Route } from './Route';
import { RouteContext } from './RouteContext';

// Custom events that don't exist on WindowEventMap but are handled
// by wrapping history.pushState/replaceState in the fallback path.
type HistoryEvent = 'pushstate' | 'replacestate';
type RefreshEvent = keyof WindowEventMap | HistoryEvent;
type NavigationType = 'push' | 'replace' | 'traverse';

const isWindowRefreshEvent = (event: RefreshEvent): event is keyof WindowEventMap => {
return event !== 'pushstate' && event !== 'replacestate';
};

// Maps refresh events to Navigation API navigationType values.
const eventToNavigationType: Partial<Record<RefreshEvent, NavigationType>> = {
popstate: 'traverse',
pushstate: 'push',
replacestate: 'replace',
};

// Global subscription sets for the history monkey-patching fallback.
// Using a single patch with subscriber sets avoids conflicts when
// multiple BaseRouter instances mount simultaneously.
const pushStateSubscribers = new Set<() => void>();
const replaceStateSubscribers = new Set<() => void>();
let originalPushState: History['pushState'] | null = null;
let originalReplaceState: History['replaceState'] | null = null;

function ensurePushStatePatched(): void {
if (originalPushState) {
return;
}
const original = history.pushState.bind(history);
originalPushState = original;
history.pushState = (...args: Parameters<History['pushState']>) => {
original(...args);
pushStateSubscribers.forEach(fn => fn());
};
}

function ensureReplaceStatePatched(): void {
if (originalReplaceState) {
return;
}
const original = history.replaceState.bind(history);
originalReplaceState = original;
history.replaceState = (...args: Parameters<History['replaceState']>) => {
original(...args);
replaceStateSubscribers.forEach(fn => fn());
};
}

/**
* Observes history changes so the router's internal state stays in sync
* with the URL. Uses the Navigation API when available, falling back to
* monkey-patching history.pushState/replaceState plus native window events.
*
* Note: `events` should be a stable array reference to avoid
* re-subscribing on every render.
*/
function useHistoryChangeObserver(events: Array<RefreshEvent> | undefined, callback: () => void): void {
const callbackRef = React.useRef(callback);
callbackRef.current = callback;

React.useEffect(() => {
if (!events) {
return;
}

const notify = () => callbackRef.current();
const windowEvents = events.filter(isWindowRefreshEvent);
const navigationTypes = events
.map(e => eventToNavigationType[e])
.filter((type): type is NavigationType => Boolean(type));

const hasNavigationAPI =
typeof window !== 'undefined' &&
'navigation' in window &&
typeof (window as any).navigation?.addEventListener === 'function';

if (hasNavigationAPI) {
const nav = (window as any).navigation;
const allowedTypes = new Set(navigationTypes);
const handler = (e: { navigationType: NavigationType }) => {
if (allowedTypes.has(e.navigationType)) {
Promise.resolve().then(notify);
}
};
nav.addEventListener('currententrychange', handler);

// Events without a navigationType mapping (e.g. hashchange) still
// need native listeners even when the Navigation API is available.
const unmappedEvents = windowEvents.filter(e => !eventToNavigationType[e]);
unmappedEvents.forEach(e => window.addEventListener(e, notify));

return () => {
nav.removeEventListener('currententrychange', handler);
unmappedEvents.forEach(e => window.removeEventListener(e, notify));
};
}

// Fallback: use global subscriber sets for pushState/replaceState
// so that multiple BaseRouter instances don't conflict.
if (events.includes('pushstate')) {
ensurePushStatePatched();
pushStateSubscribers.add(notify);
}
if (events.includes('replacestate')) {
ensureReplaceStatePatched();
replaceStateSubscribers.add(notify);
}

windowEvents.forEach(e => window.addEventListener(e, notify));

return () => {
pushStateSubscribers.delete(notify);
replaceStateSubscribers.delete(notify);
windowEvents.forEach(e => window.removeEventListener(e, notify));
};
}, [events]);
}

interface BaseRouterProps {
basePath: string;
startPath: string;
getPath: () => string;
getQueryString: () => string;
internalNavigate: (toURL: URL, options?: NavigateOptions) => Promise<any> | any;
refreshEvents?: Array<keyof WindowEventMap>;
refreshEvents?: Array<RefreshEvent>;
preservedParams?: string[];
urlStateParam?: {
startPath: string;
Expand DownExpand Up@@ -86,7 +205,23 @@ export const BaseRouter = ({
}
}, [currentPath, currentQueryString, getPath, getQueryString]);

useWindowEventListener(refreshEvents, refresh);
// Suppresses the history observer during baseNavigate's internal navigation.
// Without this, the observer's microtask triggers a render before setActive's
// #updateAccessors sets clerk.session, causing task guards to see stale state.
const isNavigatingRef = React.useRef(false);

const observerRefresh = React.useCallback((): void => {
if (isNavigatingRef.current) {
return;
}
const newPath = getPath();
if (basePath && !newPath.startsWith('/' + basePath)) {
return;
}
refresh();
}, [basePath, getPath, refresh]);

useHistoryChangeObserver(refreshEvents, observerRefresh);

// TODO: Look into the real possible types of globalNavigate
const baseNavigate = async (toURL: URL | undefined): Promise<unknown> => {
Expand DownExpand Up@@ -116,9 +251,20 @@ export const BaseRouter = ({

toURL.search = stringifyQueryParams(toQueryParams);
}
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
return internalNavRes;
isNavigatingRef.current = true;
try {
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
// We need to flushSync to guarantee the re-render happens before handing things back to the caller,
// otherwise setActive might emit, and children re-render with the old navigation state.
// An alternative solution here could be to return a deferred promise, set that to state together
// with the routeParts and resolve it in an effect. That way we could avoid the flushSync performance penalty.
flushSync(() => {
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
});
return internalNavRes;
} finally {
isNavigatingRef.current = false;
}
};

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/router/PathRouter.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@ export const PathRouter = ({ basePath, preservedParams, children }: PathRouterPr
getPath={getPath}
getQueryString={getQueryString}
internalNavigate={internalNavigate}
refreshEvents={['popstate']}
refreshEvents={['pushstate', 'replacestate', 'popstate']}
preservedParams={preservedParams}
>
{children}
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
5 changes: 5 additions & 0 deletions .changeset/fix-router-sync-popup-oauth.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix BaseRouter state not syncing after popup OAuth by observing `pushState`/`replaceState` changes in addition to `popstate`
1 change: 1 addition & 0 deletions integration/presets/longRunningApps.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ export const createLongRunningApps = () => {
{ id: 'react.vite.withEmailCodes', config: react.vite, env: envs.withEmailCodes },
{ id: 'react.vite.withEmailCodes_persist_client', config: react.vite, env: envs.withEmailCodes_destroy_client },
{ id: 'react.vite.withEmailLinks', config: react.vite, env: envs.withEmailLinks },
{ id: 'react.vite.withLegalConsent', config: react.vite, env: envs.withLegalConsent },
{ id: 'vue.vite', config: vue.vite, env: envs.withCustomRoles },

/**
Expand Down
9 changes: 9 additions & 0 deletions integration/templates/react-vite/src/buttons/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,15 @@ export default function Home() {
Sign in button (force)
</SignInButton>

<SignInButton
mode='modal'
oauthFlow='popup'
forceRedirectUrl='/protected'
signUpForceRedirectUrl='/protected'
>
Sign in button (force, popup)
</SignInButton>

<SignInButton
mode='modal'
fallbackRedirectUrl='/protected'
Expand Down
5 changes: 5 additions & 0 deletions integration/templates/react-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import { createBrowserRouter, Outlet, RouterProvider, useNavigate } from 'react-
import App from './App.tsx';
import Protected from './protected';
import SignIn from './sign-in';
import SignInPopup from './sign-in-popup';
import SignUp from './sign-up';
import UserProfile from './user';
import UserProfileCustom from './custom-user-profile';
Expand DownExpand Up@@ -57,6 +58,10 @@ const router = createBrowserRouter([
path: '/sign-in/*',
element: <SignIn />,
},
{
path: '/sign-in-popup/*',
element: <SignInPopup />,
},
{
path: '/sign-up/*',
element: <SignUp />,
Expand Down
15 changes: 15 additions & 0 deletions integration/templates/react-vite/src/sign-in-popup/index.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
import { SignIn } from '@clerk/clerk-react';

export default function Page() {
return (
<div>
<SignIn
path={'/sign-in-popup'}
signUpUrl={'/sign-up'}
oauthFlow='popup'
fallbackRedirectUrl='/protected'
fallback={<>Loading sign in</>}
/>
</div>
);
}
57 changes: 57 additions & 0 deletions integration/tests/oauth-flows.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,63 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('oauth flo
});
});

testAgainstRunningApps({ withPattern: ['react.vite.withLegalConsent'] })(
'oauth popup with path-based routing @react',
({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

test.beforeAll(async () => {
const client = createClerkClient({
secretKey: instanceKeys.get('oauth-provider').sk,
publishableKey: instanceKeys.get('oauth-provider').pk,
});
const users = createUserService(client);
fakeUser = users.createFakeUser({
withUsername: true,
});
await users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
const u = createTestUtils({ app });
await fakeUser.deleteIfExists();
await u.services.users.deleteIfExists({ email: fakeUser.email });
await app.teardown();
});

test('popup OAuth navigates through sso-callback with path-based routing', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.page.goToRelative('/sign-in-popup');
await u.page.waitForClerkJsLoaded();
await u.po.signIn.waitForMounted();

const popupPromise = context.waitForEvent('page');
await u.page.getByRole('button', { name: 'E2E OAuth Provider' }).click();
const popup = await popupPromise;
const popupUtils = createTestUtils({ app, page: popup, context });
await popupUtils.page.getByText('Sign in to oauth-provider').waitFor();

// Complete OAuth in the popup
await popupUtils.po.signIn.setIdentifier(fakeUser.email);
await popupUtils.po.signIn.continue();
await popupUtils.po.signIn.enterTestOtpCode();

// Because the user is new to the app and legal consent is required,
// the sign-up can't complete in the popup. The popup sends return_url
// back to the parent, which navigates to /sso-callback via pushState.
await u.page.getByRole('heading', { name: 'Legal consent' }).waitFor();
await u.page.getByLabel(/I agree to the/).check();
await u.po.signIn.continue();

await u.page.waitForAppUrl('/protected');
await u.po.expect.toBeSignedIn();
});
},
);

testAgainstRunningApps({ withEnv: [appConfigs.envs.withLegalConsent] })(
'oauth flows with legal consent @nextjs',
({ app }) => {
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/hooks/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,3 @@ export * from './useSafeState';
export * from './useScrollLock';
export * from './useSearchInput';
export * from './useTotalEnabledAuthMethods';
export * from './useWindowEventListener';
15 changes: 0 additions & 15 deletions packages/clerk-js/src/ui/hooks/useWindowEventListener.ts

This file was deleted.

158 changes: 152 additions & 6 deletions packages/clerk-js/src/ui/router/BaseRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,140 @@
import { useClerk } from '@clerk/shared/react';
import type { NavigateOptions } from '@clerk/shared/types';
import React from 'react';
import { flushSync } from 'react-dom';

import { getQueryParams, stringifyQueryParams, trimTrailingSlash } from '../../utils';
import { useWindowEventListener } from '../hooks';
import { newPaths } from './newPaths';
import { match } from './pathToRegexp';
import { Route } from './Route';
import { RouteContext } from './RouteContext';

// Custom events that don't exist on WindowEventMap but are handled
// by wrapping history.pushState/replaceState in the fallback path.
type HistoryEvent = 'pushstate' | 'replacestate';
type RefreshEvent = keyof WindowEventMap | HistoryEvent;
type NavigationType = 'push' | 'replace' | 'traverse';

const isWindowRefreshEvent = (event: RefreshEvent): event is keyof WindowEventMap => {
return event !== 'pushstate' && event !== 'replacestate';
};

// Maps refresh events to Navigation API navigationType values.
const eventToNavigationType: Partial<Record<RefreshEvent, NavigationType>> = {
popstate: 'traverse',
pushstate: 'push',
replacestate: 'replace',
};

// Global subscription sets for the history monkey-patching fallback.
// Using a single patch with subscriber sets avoids conflicts when
// multiple BaseRouter instances mount simultaneously.
const pushStateSubscribers = new Set<() => void>();
const replaceStateSubscribers = new Set<() => void>();
let originalPushState: History['pushState'] | null = null;
let originalReplaceState: History['replaceState'] | null = null;

function ensurePushStatePatched(): void {
if (originalPushState) {
return;
}
const original = history.pushState.bind(history);
originalPushState = original;
history.pushState = (...args: Parameters<History['pushState']>) => {
original(...args);
pushStateSubscribers.forEach(fn => fn());
};
}

function ensureReplaceStatePatched(): void {
if (originalReplaceState) {
return;
}
const original = history.replaceState.bind(history);
originalReplaceState = original;
history.replaceState = (...args: Parameters<History['replaceState']>) => {
original(...args);
replaceStateSubscribers.forEach(fn => fn());
};
}

/**
* Observes history changes so the router's internal state stays in sync
* with the URL. Uses the Navigation API when available, falling back to
* monkey-patching history.pushState/replaceState plus native window events.
*
* Note: `events` should be a stable array reference to avoid
* re-subscribing on every render.
*/
function useHistoryChangeObserver(events: Array<RefreshEvent> | undefined, callback: () => void): void {
const callbackRef = React.useRef(callback);
callbackRef.current = callback;

React.useEffect(() => {
if (!events) {
return;
}

const notify = () => callbackRef.current();
const windowEvents = events.filter(isWindowRefreshEvent);
const navigationTypes = events
.map(e => eventToNavigationType[e])
.filter((type): type is NavigationType => Boolean(type));

const hasNavigationAPI =
typeof window !== 'undefined' &&
'navigation' in window &&
typeof (window as any).navigation?.addEventListener === 'function';

if (hasNavigationAPI) {
const nav = (window as any).navigation;
const allowedTypes = new Set(navigationTypes);
const handler = (e: { navigationType: NavigationType }) => {
if (allowedTypes.has(e.navigationType)) {
Promise.resolve().then(notify);
}
};
nav.addEventListener('currententrychange', handler);

// Events without a navigationType mapping (e.g. hashchange) still
// need native listeners even when the Navigation API is available.
const unmappedEvents = windowEvents.filter(e => !eventToNavigationType[e]);
unmappedEvents.forEach(e => window.addEventListener(e, notify));

return () => {
nav.removeEventListener('currententrychange', handler);
unmappedEvents.forEach(e => window.removeEventListener(e, notify));
};
}

// Fallback: use global subscriber sets for pushState/replaceState
// so that multiple BaseRouter instances don't conflict.
if (events.includes('pushstate')) {
ensurePushStatePatched();
pushStateSubscribers.add(notify);
}
if (events.includes('replacestate')) {
ensureReplaceStatePatched();
replaceStateSubscribers.add(notify);
}

windowEvents.forEach(e => window.addEventListener(e, notify));

return () => {
pushStateSubscribers.delete(notify);
replaceStateSubscribers.delete(notify);
windowEvents.forEach(e => window.removeEventListener(e, notify));
};
}, [events]);
}

interface BaseRouterProps {
basePath: string;
startPath: string;
getPath: () => string;
getQueryString: () => string;
internalNavigate: (toURL: URL, options?: NavigateOptions) => Promise<any> | any;
refreshEvents?: Array<keyof WindowEventMap>;
refreshEvents?: Array<RefreshEvent>;
preservedParams?: string[];
urlStateParam?: {
startPath: string;
Expand DownExpand Up@@ -86,7 +205,23 @@ export const BaseRouter = ({
}
}, [currentPath, currentQueryString, getPath, getQueryString]);

useWindowEventListener(refreshEvents, refresh);
// Suppresses the history observer during baseNavigate's internal navigation.
// Without this, the observer's microtask triggers a render before setActive's
// #updateAccessors sets clerk.session, causing task guards to see stale state.
const isNavigatingRef = React.useRef(false);

const observerRefresh = React.useCallback((): void => {
if (isNavigatingRef.current) {
return;
}
const newPath = getPath();
if (basePath && !newPath.startsWith('/' + basePath)) {
return;
}
refresh();
}, [basePath, getPath, refresh]);

useHistoryChangeObserver(refreshEvents, observerRefresh);

// TODO: Look into the real possible types of globalNavigate
const baseNavigate = async (toURL: URL | undefined): Promise<unknown> => {
Expand DownExpand Up@@ -116,9 +251,20 @@ export const BaseRouter = ({

toURL.search = stringifyQueryParams(toQueryParams);
}
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
return internalNavRes;
isNavigatingRef.current = true;
try {
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
// We need to flushSync to guarantee the re-render happens before handing things back to the caller,
// otherwise setActive might emit, and children re-render with the old navigation state.
// An alternative solution here could be to return a deferred promise, set that to state together
// with the routeParts and resolve it in an effect. That way we could avoid the flushSync performance penalty.
flushSync(() => {
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
});
return internalNavRes;
} finally {
isNavigatingRef.current = false;
}
};

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/router/PathRouter.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@ export const PathRouter = ({ basePath, preservedParams, children }: PathRouterPr
getPath={getPath}
getQueryString={getQueryString}
internalNavigate={internalNavigate}
refreshEvents={['popstate']}
refreshEvents={['pushstate', 'replacestate', 'popstate']}
preservedParams={preservedParams}
>
{children}
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
5 changes: 5 additions & 0 deletions .changeset/fix-router-sync-popup-oauth.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix BaseRouter state not syncing after popup OAuth by observing `pushState`/`replaceState` changes in addition to `popstate`
1 change: 1 addition & 0 deletions integration/presets/longRunningApps.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ export const createLongRunningApps = () => {
{ id: 'react.vite.withEmailCodes', config: react.vite, env: envs.withEmailCodes },
{ id: 'react.vite.withEmailCodes_persist_client', config: react.vite, env: envs.withEmailCodes_destroy_client },
{ id: 'react.vite.withEmailLinks', config: react.vite, env: envs.withEmailLinks },
{ id: 'react.vite.withLegalConsent', config: react.vite, env: envs.withLegalConsent },
{ id: 'vue.vite', config: vue.vite, env: envs.withCustomRoles },

/**
Expand Down
9 changes: 9 additions & 0 deletions integration/templates/react-vite/src/buttons/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,15 @@ export default function Home() {
Sign in button (force)
</SignInButton>

<SignInButton
mode='modal'
oauthFlow='popup'
forceRedirectUrl='/protected'
signUpForceRedirectUrl='/protected'
>
Sign in button (force, popup)
</SignInButton>

<SignInButton
mode='modal'
fallbackRedirectUrl='/protected'
Expand Down
5 changes: 5 additions & 0 deletions integration/templates/react-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import { createBrowserRouter, Outlet, RouterProvider, useNavigate } from 'react-
import App from './App.tsx';
import Protected from './protected';
import SignIn from './sign-in';
import SignInPopup from './sign-in-popup';
import SignUp from './sign-up';
import UserProfile from './user';
import UserProfileCustom from './custom-user-profile';
Expand DownExpand Up@@ -57,6 +58,10 @@ const router = createBrowserRouter([
path: '/sign-in/*',
element: <SignIn />,
},
{
path: '/sign-in-popup/*',
element: <SignInPopup />,
},
{
path: '/sign-up/*',
element: <SignUp />,
Expand Down
15 changes: 15 additions & 0 deletions integration/templates/react-vite/src/sign-in-popup/index.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
import { SignIn } from '@clerk/clerk-react';

export default function Page() {
return (
<div>
<SignIn
path={'/sign-in-popup'}
signUpUrl={'/sign-up'}
oauthFlow='popup'
fallbackRedirectUrl='/protected'
fallback={<>Loading sign in</>}
/>
</div>
);
}
57 changes: 57 additions & 0 deletions integration/tests/oauth-flows.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,63 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('oauth flo
});
});

testAgainstRunningApps({ withPattern: ['react.vite.withLegalConsent'] })(
'oauth popup with path-based routing @react',
({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

test.beforeAll(async () => {
const client = createClerkClient({
secretKey: instanceKeys.get('oauth-provider').sk,
publishableKey: instanceKeys.get('oauth-provider').pk,
});
const users = createUserService(client);
fakeUser = users.createFakeUser({
withUsername: true,
});
await users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
const u = createTestUtils({ app });
await fakeUser.deleteIfExists();
await u.services.users.deleteIfExists({ email: fakeUser.email });
await app.teardown();
});

test('popup OAuth navigates through sso-callback with path-based routing', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.page.goToRelative('/sign-in-popup');
await u.page.waitForClerkJsLoaded();
await u.po.signIn.waitForMounted();

const popupPromise = context.waitForEvent('page');
await u.page.getByRole('button', { name: 'E2E OAuth Provider' }).click();
const popup = await popupPromise;
const popupUtils = createTestUtils({ app, page: popup, context });
await popupUtils.page.getByText('Sign in to oauth-provider').waitFor();

// Complete OAuth in the popup
await popupUtils.po.signIn.setIdentifier(fakeUser.email);
await popupUtils.po.signIn.continue();
await popupUtils.po.signIn.enterTestOtpCode();

// Because the user is new to the app and legal consent is required,
// the sign-up can't complete in the popup. The popup sends return_url
// back to the parent, which navigates to /sso-callback via pushState.
await u.page.getByRole('heading', { name: 'Legal consent' }).waitFor();
await u.page.getByLabel(/I agree to the/).check();
await u.po.signIn.continue();

await u.page.waitForAppUrl('/protected');
await u.po.expect.toBeSignedIn();
});
},
);

testAgainstRunningApps({ withEnv: [appConfigs.envs.withLegalConsent] })(
'oauth flows with legal consent @nextjs',
({ app }) => {
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/hooks/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,3 @@ export * from './useSafeState';
export * from './useScrollLock';
export * from './useSearchInput';
export * from './useTotalEnabledAuthMethods';
export * from './useWindowEventListener';
15 changes: 0 additions & 15 deletions packages/clerk-js/src/ui/hooks/useWindowEventListener.ts

This file was deleted.

158 changes: 152 additions & 6 deletions packages/clerk-js/src/ui/router/BaseRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,140 @@
import { useClerk } from '@clerk/shared/react';
import type { NavigateOptions } from '@clerk/shared/types';
import React from 'react';
import { flushSync } from 'react-dom';

import { getQueryParams, stringifyQueryParams, trimTrailingSlash } from '../../utils';
import { useWindowEventListener } from '../hooks';
import { newPaths } from './newPaths';
import { match } from './pathToRegexp';
import { Route } from './Route';
import { RouteContext } from './RouteContext';

// Custom events that don't exist on WindowEventMap but are handled
// by wrapping history.pushState/replaceState in the fallback path.
type HistoryEvent = 'pushstate' | 'replacestate';
type RefreshEvent = keyof WindowEventMap | HistoryEvent;
type NavigationType = 'push' | 'replace' | 'traverse';

const isWindowRefreshEvent = (event: RefreshEvent): event is keyof WindowEventMap => {
return event !== 'pushstate' && event !== 'replacestate';
};

// Maps refresh events to Navigation API navigationType values.
const eventToNavigationType: Partial<Record<RefreshEvent, NavigationType>> = {
popstate: 'traverse',
pushstate: 'push',
replacestate: 'replace',
};

// Global subscription sets for the history monkey-patching fallback.
// Using a single patch with subscriber sets avoids conflicts when
// multiple BaseRouter instances mount simultaneously.
const pushStateSubscribers = new Set<() => void>();
const replaceStateSubscribers = new Set<() => void>();
let originalPushState: History['pushState'] | null = null;
let originalReplaceState: History['replaceState'] | null = null;

function ensurePushStatePatched(): void {
if (originalPushState) {
return;
}
const original = history.pushState.bind(history);
originalPushState = original;
history.pushState = (...args: Parameters<History['pushState']>) => {
original(...args);
pushStateSubscribers.forEach(fn => fn());
};
}

function ensureReplaceStatePatched(): void {
if (originalReplaceState) {
return;
}
const original = history.replaceState.bind(history);
originalReplaceState = original;
history.replaceState = (...args: Parameters<History['replaceState']>) => {
original(...args);
replaceStateSubscribers.forEach(fn => fn());
};
}

/**
* Observes history changes so the router's internal state stays in sync
* with the URL. Uses the Navigation API when available, falling back to
* monkey-patching history.pushState/replaceState plus native window events.
*
* Note: `events` should be a stable array reference to avoid
* re-subscribing on every render.
*/
function useHistoryChangeObserver(events: Array<RefreshEvent> | undefined, callback: () => void): void {
const callbackRef = React.useRef(callback);
callbackRef.current = callback;

React.useEffect(() => {
if (!events) {
return;
}

const notify = () => callbackRef.current();
const windowEvents = events.filter(isWindowRefreshEvent);
const navigationTypes = events
.map(e => eventToNavigationType[e])
.filter((type): type is NavigationType => Boolean(type));

const hasNavigationAPI =
typeof window !== 'undefined' &&
'navigation' in window &&
typeof (window as any).navigation?.addEventListener === 'function';

if (hasNavigationAPI) {
const nav = (window as any).navigation;
const allowedTypes = new Set(navigationTypes);
const handler = (e: { navigationType: NavigationType }) => {
if (allowedTypes.has(e.navigationType)) {
Promise.resolve().then(notify);
}
};
nav.addEventListener('currententrychange', handler);

// Events without a navigationType mapping (e.g. hashchange) still
// need native listeners even when the Navigation API is available.
const unmappedEvents = windowEvents.filter(e => !eventToNavigationType[e]);
unmappedEvents.forEach(e => window.addEventListener(e, notify));

return () => {
nav.removeEventListener('currententrychange', handler);
unmappedEvents.forEach(e => window.removeEventListener(e, notify));
};
}

// Fallback: use global subscriber sets for pushState/replaceState
// so that multiple BaseRouter instances don't conflict.
if (events.includes('pushstate')) {
ensurePushStatePatched();
pushStateSubscribers.add(notify);
}
if (events.includes('replacestate')) {
ensureReplaceStatePatched();
replaceStateSubscribers.add(notify);
}

windowEvents.forEach(e => window.addEventListener(e, notify));

return () => {
pushStateSubscribers.delete(notify);
replaceStateSubscribers.delete(notify);
windowEvents.forEach(e => window.removeEventListener(e, notify));
};
}, [events]);
}

interface BaseRouterProps {
basePath: string;
startPath: string;
getPath: () => string;
getQueryString: () => string;
internalNavigate: (toURL: URL, options?: NavigateOptions) => Promise<any> | any;
refreshEvents?: Array<keyof WindowEventMap>;
refreshEvents?: Array<RefreshEvent>;
preservedParams?: string[];
urlStateParam?: {
startPath: string;
Expand DownExpand Up@@ -86,7 +205,23 @@ export const BaseRouter = ({
}
}, [currentPath, currentQueryString, getPath, getQueryString]);

useWindowEventListener(refreshEvents, refresh);
// Suppresses the history observer during baseNavigate's internal navigation.
// Without this, the observer's microtask triggers a render before setActive's
// #updateAccessors sets clerk.session, causing task guards to see stale state.
const isNavigatingRef = React.useRef(false);

const observerRefresh = React.useCallback((): void => {
if (isNavigatingRef.current) {
return;
}
const newPath = getPath();
if (basePath && !newPath.startsWith('/' + basePath)) {
return;
}
refresh();
}, [basePath, getPath, refresh]);

useHistoryChangeObserver(refreshEvents, observerRefresh);

// TODO: Look into the real possible types of globalNavigate
const baseNavigate = async (toURL: URL | undefined): Promise<unknown> => {
Expand DownExpand Up@@ -116,9 +251,20 @@ export const BaseRouter = ({

toURL.search = stringifyQueryParams(toQueryParams);
}
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
return internalNavRes;
isNavigatingRef.current = true;
try {
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
// We need to flushSync to guarantee the re-render happens before handing things back to the caller,
// otherwise setActive might emit, and children re-render with the old navigation state.
// An alternative solution here could be to return a deferred promise, set that to state together
// with the routeParts and resolve it in an effect. That way we could avoid the flushSync performance penalty.
flushSync(() => {
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
});
return internalNavRes;
} finally {
isNavigatingRef.current = false;
}
};

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/router/PathRouter.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@ export const PathRouter = ({ basePath, preservedParams, children }: PathRouterPr
getPath={getPath}
getQueryString={getQueryString}
internalNavigate={internalNavigate}
refreshEvents={['popstate']}
refreshEvents={['pushstate', 'replacestate', 'popstate']}
preservedParams={preservedParams}
>
{children}
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
5 changes: 5 additions & 0 deletions .changeset/fix-router-sync-popup-oauth.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix BaseRouter state not syncing after popup OAuth by observing `pushState`/`replaceState` changes in addition to `popstate`
1 change: 1 addition & 0 deletions integration/presets/longRunningApps.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ export const createLongRunningApps = () => {
{ id: 'react.vite.withEmailCodes', config: react.vite, env: envs.withEmailCodes },
{ id: 'react.vite.withEmailCodes_persist_client', config: react.vite, env: envs.withEmailCodes_destroy_client },
{ id: 'react.vite.withEmailLinks', config: react.vite, env: envs.withEmailLinks },
{ id: 'react.vite.withLegalConsent', config: react.vite, env: envs.withLegalConsent },
{ id: 'vue.vite', config: vue.vite, env: envs.withCustomRoles },

/**
Expand Down
9 changes: 9 additions & 0 deletions integration/templates/react-vite/src/buttons/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,15 @@ export default function Home() {
Sign in button (force)
</SignInButton>

<SignInButton
mode='modal'
oauthFlow='popup'
forceRedirectUrl='/protected'
signUpForceRedirectUrl='/protected'
>
Sign in button (force, popup)
</SignInButton>

<SignInButton
mode='modal'
fallbackRedirectUrl='/protected'
Expand Down
5 changes: 5 additions & 0 deletions integration/templates/react-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import { createBrowserRouter, Outlet, RouterProvider, useNavigate } from 'react-
import App from './App.tsx';
import Protected from './protected';
import SignIn from './sign-in';
import SignInPopup from './sign-in-popup';
import SignUp from './sign-up';
import UserProfile from './user';
import UserProfileCustom from './custom-user-profile';
Expand DownExpand Up@@ -57,6 +58,10 @@ const router = createBrowserRouter([
path: '/sign-in/*',
element: <SignIn />,
},
{
path: '/sign-in-popup/*',
element: <SignInPopup />,
},
{
path: '/sign-up/*',
element: <SignUp />,
Expand Down
15 changes: 15 additions & 0 deletions integration/templates/react-vite/src/sign-in-popup/index.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
import { SignIn } from '@clerk/clerk-react';

export default function Page() {
return (
<div>
<SignIn
path={'/sign-in-popup'}
signUpUrl={'/sign-up'}
oauthFlow='popup'
fallbackRedirectUrl='/protected'
fallback={<>Loading sign in</>}
/>
</div>
);
}
57 changes: 57 additions & 0 deletions integration/tests/oauth-flows.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,63 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('oauth flo
});
});

testAgainstRunningApps({ withPattern: ['react.vite.withLegalConsent'] })(
'oauth popup with path-based routing @react',
({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

test.beforeAll(async () => {
const client = createClerkClient({
secretKey: instanceKeys.get('oauth-provider').sk,
publishableKey: instanceKeys.get('oauth-provider').pk,
});
const users = createUserService(client);
fakeUser = users.createFakeUser({
withUsername: true,
});
await users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
const u = createTestUtils({ app });
await fakeUser.deleteIfExists();
await u.services.users.deleteIfExists({ email: fakeUser.email });
await app.teardown();
});

test('popup OAuth navigates through sso-callback with path-based routing', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.page.goToRelative('/sign-in-popup');
await u.page.waitForClerkJsLoaded();
await u.po.signIn.waitForMounted();

const popupPromise = context.waitForEvent('page');
await u.page.getByRole('button', { name: 'E2E OAuth Provider' }).click();
const popup = await popupPromise;
const popupUtils = createTestUtils({ app, page: popup, context });
await popupUtils.page.getByText('Sign in to oauth-provider').waitFor();

// Complete OAuth in the popup
await popupUtils.po.signIn.setIdentifier(fakeUser.email);
await popupUtils.po.signIn.continue();
await popupUtils.po.signIn.enterTestOtpCode();

// Because the user is new to the app and legal consent is required,
// the sign-up can't complete in the popup. The popup sends return_url
// back to the parent, which navigates to /sso-callback via pushState.
await u.page.getByRole('heading', { name: 'Legal consent' }).waitFor();
await u.page.getByLabel(/I agree to the/).check();
await u.po.signIn.continue();

await u.page.waitForAppUrl('/protected');
await u.po.expect.toBeSignedIn();
});
},
);

testAgainstRunningApps({ withEnv: [appConfigs.envs.withLegalConsent] })(
'oauth flows with legal consent @nextjs',
({ app }) => {
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/hooks/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,3 @@ export * from './useSafeState';
export * from './useScrollLock';
export * from './useSearchInput';
export * from './useTotalEnabledAuthMethods';
export * from './useWindowEventListener';
15 changes: 0 additions & 15 deletions packages/clerk-js/src/ui/hooks/useWindowEventListener.ts

This file was deleted.

158 changes: 152 additions & 6 deletions packages/clerk-js/src/ui/router/BaseRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,140 @@
import { useClerk } from '@clerk/shared/react';
import type { NavigateOptions } from '@clerk/shared/types';
import React from 'react';
import { flushSync } from 'react-dom';

import { getQueryParams, stringifyQueryParams, trimTrailingSlash } from '../../utils';
import { useWindowEventListener } from '../hooks';
import { newPaths } from './newPaths';
import { match } from './pathToRegexp';
import { Route } from './Route';
import { RouteContext } from './RouteContext';

// Custom events that don't exist on WindowEventMap but are handled
// by wrapping history.pushState/replaceState in the fallback path.
type HistoryEvent = 'pushstate' | 'replacestate';
type RefreshEvent = keyof WindowEventMap | HistoryEvent;
type NavigationType = 'push' | 'replace' | 'traverse';

const isWindowRefreshEvent = (event: RefreshEvent): event is keyof WindowEventMap => {
return event !== 'pushstate' && event !== 'replacestate';
};

// Maps refresh events to Navigation API navigationType values.
const eventToNavigationType: Partial<Record<RefreshEvent, NavigationType>> = {
popstate: 'traverse',
pushstate: 'push',
replacestate: 'replace',
};

// Global subscription sets for the history monkey-patching fallback.
// Using a single patch with subscriber sets avoids conflicts when
// multiple BaseRouter instances mount simultaneously.
const pushStateSubscribers = new Set<() => void>();
const replaceStateSubscribers = new Set<() => void>();
let originalPushState: History['pushState'] | null = null;
let originalReplaceState: History['replaceState'] | null = null;

function ensurePushStatePatched(): void {
if (originalPushState) {
return;
}
const original = history.pushState.bind(history);
originalPushState = original;
history.pushState = (...args: Parameters<History['pushState']>) => {
original(...args);
pushStateSubscribers.forEach(fn => fn());
};
}

function ensureReplaceStatePatched(): void {
if (originalReplaceState) {
return;
}
const original = history.replaceState.bind(history);
originalReplaceState = original;
history.replaceState = (...args: Parameters<History['replaceState']>) => {
original(...args);
replaceStateSubscribers.forEach(fn => fn());
};
}

/**
* Observes history changes so the router's internal state stays in sync
* with the URL. Uses the Navigation API when available, falling back to
* monkey-patching history.pushState/replaceState plus native window events.
*
* Note: `events` should be a stable array reference to avoid
* re-subscribing on every render.
*/
function useHistoryChangeObserver(events: Array<RefreshEvent> | undefined, callback: () => void): void {
const callbackRef = React.useRef(callback);
callbackRef.current = callback;

React.useEffect(() => {
if (!events) {
return;
}

const notify = () => callbackRef.current();
const windowEvents = events.filter(isWindowRefreshEvent);
const navigationTypes = events
.map(e => eventToNavigationType[e])
.filter((type): type is NavigationType => Boolean(type));

const hasNavigationAPI =
typeof window !== 'undefined' &&
'navigation' in window &&
typeof (window as any).navigation?.addEventListener === 'function';

if (hasNavigationAPI) {
const nav = (window as any).navigation;
const allowedTypes = new Set(navigationTypes);
const handler = (e: { navigationType: NavigationType }) => {
if (allowedTypes.has(e.navigationType)) {
Promise.resolve().then(notify);
}
};
nav.addEventListener('currententrychange', handler);

// Events without a navigationType mapping (e.g. hashchange) still
// need native listeners even when the Navigation API is available.
const unmappedEvents = windowEvents.filter(e => !eventToNavigationType[e]);
unmappedEvents.forEach(e => window.addEventListener(e, notify));

return () => {
nav.removeEventListener('currententrychange', handler);
unmappedEvents.forEach(e => window.removeEventListener(e, notify));
};
}

// Fallback: use global subscriber sets for pushState/replaceState
// so that multiple BaseRouter instances don't conflict.
if (events.includes('pushstate')) {
ensurePushStatePatched();
pushStateSubscribers.add(notify);
}
if (events.includes('replacestate')) {
ensureReplaceStatePatched();
replaceStateSubscribers.add(notify);
}

windowEvents.forEach(e => window.addEventListener(e, notify));

return () => {
pushStateSubscribers.delete(notify);
replaceStateSubscribers.delete(notify);
windowEvents.forEach(e => window.removeEventListener(e, notify));
};
}, [events]);
}

interface BaseRouterProps {
basePath: string;
startPath: string;
getPath: () => string;
getQueryString: () => string;
internalNavigate: (toURL: URL, options?: NavigateOptions) => Promise<any> | any;
refreshEvents?: Array<keyof WindowEventMap>;
refreshEvents?: Array<RefreshEvent>;
preservedParams?: string[];
urlStateParam?: {
startPath: string;
Expand DownExpand Up@@ -86,7 +205,23 @@ export const BaseRouter = ({
}
}, [currentPath, currentQueryString, getPath, getQueryString]);

useWindowEventListener(refreshEvents, refresh);
// Suppresses the history observer during baseNavigate's internal navigation.
// Without this, the observer's microtask triggers a render before setActive's
// #updateAccessors sets clerk.session, causing task guards to see stale state.
const isNavigatingRef = React.useRef(false);

const observerRefresh = React.useCallback((): void => {
if (isNavigatingRef.current) {
return;
}
const newPath = getPath();
if (basePath && !newPath.startsWith('/' + basePath)) {
return;
}
refresh();
}, [basePath, getPath, refresh]);

useHistoryChangeObserver(refreshEvents, observerRefresh);

// TODO: Look into the real possible types of globalNavigate
const baseNavigate = async (toURL: URL | undefined): Promise<unknown> => {
Expand DownExpand Up@@ -116,9 +251,20 @@ export const BaseRouter = ({

toURL.search = stringifyQueryParams(toQueryParams);
}
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
return internalNavRes;
isNavigatingRef.current = true;
try {
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
// We need to flushSync to guarantee the re-render happens before handing things back to the caller,
// otherwise setActive might emit, and children re-render with the old navigation state.
// An alternative solution here could be to return a deferred promise, set that to state together
// with the routeParts and resolve it in an effect. That way we could avoid the flushSync performance penalty.
flushSync(() => {
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
});
return internalNavRes;
} finally {
isNavigatingRef.current = false;
}
};

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/router/PathRouter.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@ export const PathRouter = ({ basePath, preservedParams, children }: PathRouterPr
getPath={getPath}
getQueryString={getQueryString}
internalNavigate={internalNavigate}
refreshEvents={['popstate']}
refreshEvents={['pushstate', 'replacestate', 'popstate']}
preservedParams={preservedParams}
>
{children}
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
5 changes: 5 additions & 0 deletions .changeset/fix-router-sync-popup-oauth.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix BaseRouter state not syncing after popup OAuth by observing `pushState`/`replaceState` changes in addition to `popstate`
1 change: 1 addition & 0 deletions integration/presets/longRunningApps.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ export const createLongRunningApps = () => {
{ id: 'react.vite.withEmailCodes', config: react.vite, env: envs.withEmailCodes },
{ id: 'react.vite.withEmailCodes_persist_client', config: react.vite, env: envs.withEmailCodes_destroy_client },
{ id: 'react.vite.withEmailLinks', config: react.vite, env: envs.withEmailLinks },
{ id: 'react.vite.withLegalConsent', config: react.vite, env: envs.withLegalConsent },
{ id: 'vue.vite', config: vue.vite, env: envs.withCustomRoles },

/**
Expand Down
9 changes: 9 additions & 0 deletions integration/templates/react-vite/src/buttons/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,15 @@ export default function Home() {
Sign in button (force)
</SignInButton>

<SignInButton
mode='modal'
oauthFlow='popup'
forceRedirectUrl='/protected'
signUpForceRedirectUrl='/protected'
>
Sign in button (force, popup)
</SignInButton>

<SignInButton
mode='modal'
fallbackRedirectUrl='/protected'
Expand Down
5 changes: 5 additions & 0 deletions integration/templates/react-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import { createBrowserRouter, Outlet, RouterProvider, useNavigate } from 'react-
import App from './App.tsx';
import Protected from './protected';
import SignIn from './sign-in';
import SignInPopup from './sign-in-popup';
import SignUp from './sign-up';
import UserProfile from './user';
import UserProfileCustom from './custom-user-profile';
Expand DownExpand Up@@ -57,6 +58,10 @@ const router = createBrowserRouter([
path: '/sign-in/*',
element: <SignIn />,
},
{
path: '/sign-in-popup/*',
element: <SignInPopup />,
},
{
path: '/sign-up/*',
element: <SignUp />,
Expand Down
15 changes: 15 additions & 0 deletions integration/templates/react-vite/src/sign-in-popup/index.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
import { SignIn } from '@clerk/clerk-react';

export default function Page() {
return (
<div>
<SignIn
path={'/sign-in-popup'}
signUpUrl={'/sign-up'}
oauthFlow='popup'
fallbackRedirectUrl='/protected'
fallback={<>Loading sign in</>}
/>
</div>
);
}
57 changes: 57 additions & 0 deletions integration/tests/oauth-flows.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,63 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('oauth flo
});
});

testAgainstRunningApps({ withPattern: ['react.vite.withLegalConsent'] })(
'oauth popup with path-based routing @react',
({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

test.beforeAll(async () => {
const client = createClerkClient({
secretKey: instanceKeys.get('oauth-provider').sk,
publishableKey: instanceKeys.get('oauth-provider').pk,
});
const users = createUserService(client);
fakeUser = users.createFakeUser({
withUsername: true,
});
await users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
const u = createTestUtils({ app });
await fakeUser.deleteIfExists();
await u.services.users.deleteIfExists({ email: fakeUser.email });
await app.teardown();
});

test('popup OAuth navigates through sso-callback with path-based routing', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.page.goToRelative('/sign-in-popup');
await u.page.waitForClerkJsLoaded();
await u.po.signIn.waitForMounted();

const popupPromise = context.waitForEvent('page');
await u.page.getByRole('button', { name: 'E2E OAuth Provider' }).click();
const popup = await popupPromise;
const popupUtils = createTestUtils({ app, page: popup, context });
await popupUtils.page.getByText('Sign in to oauth-provider').waitFor();

// Complete OAuth in the popup
await popupUtils.po.signIn.setIdentifier(fakeUser.email);
await popupUtils.po.signIn.continue();
await popupUtils.po.signIn.enterTestOtpCode();

// Because the user is new to the app and legal consent is required,
// the sign-up can't complete in the popup. The popup sends return_url
// back to the parent, which navigates to /sso-callback via pushState.
await u.page.getByRole('heading', { name: 'Legal consent' }).waitFor();
await u.page.getByLabel(/I agree to the/).check();
await u.po.signIn.continue();

await u.page.waitForAppUrl('/protected');
await u.po.expect.toBeSignedIn();
});
},
);

testAgainstRunningApps({ withEnv: [appConfigs.envs.withLegalConsent] })(
'oauth flows with legal consent @nextjs',
({ app }) => {
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/hooks/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,3 @@ export * from './useSafeState';
export * from './useScrollLock';
export * from './useSearchInput';
export * from './useTotalEnabledAuthMethods';
export * from './useWindowEventListener';
15 changes: 0 additions & 15 deletions packages/clerk-js/src/ui/hooks/useWindowEventListener.ts

This file was deleted.

158 changes: 152 additions & 6 deletions packages/clerk-js/src/ui/router/BaseRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,140 @@
import { useClerk } from '@clerk/shared/react';
import type { NavigateOptions } from '@clerk/shared/types';
import React from 'react';
import { flushSync } from 'react-dom';

import { getQueryParams, stringifyQueryParams, trimTrailingSlash } from '../../utils';
import { useWindowEventListener } from '../hooks';
import { newPaths } from './newPaths';
import { match } from './pathToRegexp';
import { Route } from './Route';
import { RouteContext } from './RouteContext';

// Custom events that don't exist on WindowEventMap but are handled
// by wrapping history.pushState/replaceState in the fallback path.
type HistoryEvent = 'pushstate' | 'replacestate';
type RefreshEvent = keyof WindowEventMap | HistoryEvent;
type NavigationType = 'push' | 'replace' | 'traverse';

const isWindowRefreshEvent = (event: RefreshEvent): event is keyof WindowEventMap => {
return event !== 'pushstate' && event !== 'replacestate';
};

// Maps refresh events to Navigation API navigationType values.
const eventToNavigationType: Partial<Record<RefreshEvent, NavigationType>> = {
popstate: 'traverse',
pushstate: 'push',
replacestate: 'replace',
};

// Global subscription sets for the history monkey-patching fallback.
// Using a single patch with subscriber sets avoids conflicts when
// multiple BaseRouter instances mount simultaneously.
const pushStateSubscribers = new Set<() => void>();
const replaceStateSubscribers = new Set<() => void>();
let originalPushState: History['pushState'] | null = null;
let originalReplaceState: History['replaceState'] | null = null;

function ensurePushStatePatched(): void {
if (originalPushState) {
return;
}
const original = history.pushState.bind(history);
originalPushState = original;
history.pushState = (...args: Parameters<History['pushState']>) => {
original(...args);
pushStateSubscribers.forEach(fn => fn());
};
}

function ensureReplaceStatePatched(): void {
if (originalReplaceState) {
return;
}
const original = history.replaceState.bind(history);
originalReplaceState = original;
history.replaceState = (...args: Parameters<History['replaceState']>) => {
original(...args);
replaceStateSubscribers.forEach(fn => fn());
};
}

/**
* Observes history changes so the router's internal state stays in sync
* with the URL. Uses the Navigation API when available, falling back to
* monkey-patching history.pushState/replaceState plus native window events.
*
* Note: `events` should be a stable array reference to avoid
* re-subscribing on every render.
*/
function useHistoryChangeObserver(events: Array<RefreshEvent> | undefined, callback: () => void): void {
const callbackRef = React.useRef(callback);
callbackRef.current = callback;

React.useEffect(() => {
if (!events) {
return;
}

const notify = () => callbackRef.current();
const windowEvents = events.filter(isWindowRefreshEvent);
const navigationTypes = events
.map(e => eventToNavigationType[e])
.filter((type): type is NavigationType => Boolean(type));

const hasNavigationAPI =
typeof window !== 'undefined' &&
'navigation' in window &&
typeof (window as any).navigation?.addEventListener === 'function';

if (hasNavigationAPI) {
const nav = (window as any).navigation;
const allowedTypes = new Set(navigationTypes);
const handler = (e: { navigationType: NavigationType }) => {
if (allowedTypes.has(e.navigationType)) {
Promise.resolve().then(notify);
}
};
nav.addEventListener('currententrychange', handler);

// Events without a navigationType mapping (e.g. hashchange) still
// need native listeners even when the Navigation API is available.
const unmappedEvents = windowEvents.filter(e => !eventToNavigationType[e]);
unmappedEvents.forEach(e => window.addEventListener(e, notify));

return () => {
nav.removeEventListener('currententrychange', handler);
unmappedEvents.forEach(e => window.removeEventListener(e, notify));
};
}

// Fallback: use global subscriber sets for pushState/replaceState
// so that multiple BaseRouter instances don't conflict.
if (events.includes('pushstate')) {
ensurePushStatePatched();
pushStateSubscribers.add(notify);
}
if (events.includes('replacestate')) {
ensureReplaceStatePatched();
replaceStateSubscribers.add(notify);
}

windowEvents.forEach(e => window.addEventListener(e, notify));

return () => {
pushStateSubscribers.delete(notify);
replaceStateSubscribers.delete(notify);
windowEvents.forEach(e => window.removeEventListener(e, notify));
};
}, [events]);
}

interface BaseRouterProps {
basePath: string;
startPath: string;
getPath: () => string;
getQueryString: () => string;
internalNavigate: (toURL: URL, options?: NavigateOptions) => Promise<any> | any;
refreshEvents?: Array<keyof WindowEventMap>;
refreshEvents?: Array<RefreshEvent>;
preservedParams?: string[];
urlStateParam?: {
startPath: string;
Expand DownExpand Up@@ -86,7 +205,23 @@ export const BaseRouter = ({
}
}, [currentPath, currentQueryString, getPath, getQueryString]);

useWindowEventListener(refreshEvents, refresh);
// Suppresses the history observer during baseNavigate's internal navigation.
// Without this, the observer's microtask triggers a render before setActive's
// #updateAccessors sets clerk.session, causing task guards to see stale state.
const isNavigatingRef = React.useRef(false);

const observerRefresh = React.useCallback((): void => {
if (isNavigatingRef.current) {
return;
}
const newPath = getPath();
if (basePath && !newPath.startsWith('/' + basePath)) {
return;
}
refresh();
}, [basePath, getPath, refresh]);

useHistoryChangeObserver(refreshEvents, observerRefresh);

// TODO: Look into the real possible types of globalNavigate
const baseNavigate = async (toURL: URL | undefined): Promise<unknown> => {
Expand DownExpand Up@@ -116,9 +251,20 @@ export const BaseRouter = ({

toURL.search = stringifyQueryParams(toQueryParams);
}
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
return internalNavRes;
isNavigatingRef.current = true;
try {
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
// We need to flushSync to guarantee the re-render happens before handing things back to the caller,
// otherwise setActive might emit, and children re-render with the old navigation state.
// An alternative solution here could be to return a deferred promise, set that to state together
// with the routeParts and resolve it in an effect. That way we could avoid the flushSync performance penalty.
flushSync(() => {
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
});
return internalNavRes;
} finally {
isNavigatingRef.current = false;
}
};

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/router/PathRouter.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@ export const PathRouter = ({ basePath, preservedParams, children }: PathRouterPr
getPath={getPath}
getQueryString={getQueryString}
internalNavigate={internalNavigate}
refreshEvents={['popstate']}
refreshEvents={['pushstate', 'replacestate', 'popstate']}
preservedParams={preservedParams}
>
{children}
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
5 changes: 5 additions & 0 deletions .changeset/fix-router-sync-popup-oauth.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix BaseRouter state not syncing after popup OAuth by observing `pushState`/`replaceState` changes in addition to `popstate`
1 change: 1 addition & 0 deletions integration/presets/longRunningApps.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ export const createLongRunningApps = () => {
{ id: 'react.vite.withEmailCodes', config: react.vite, env: envs.withEmailCodes },
{ id: 'react.vite.withEmailCodes_persist_client', config: react.vite, env: envs.withEmailCodes_destroy_client },
{ id: 'react.vite.withEmailLinks', config: react.vite, env: envs.withEmailLinks },
{ id: 'react.vite.withLegalConsent', config: react.vite, env: envs.withLegalConsent },
{ id: 'vue.vite', config: vue.vite, env: envs.withCustomRoles },

/**
Expand Down
9 changes: 9 additions & 0 deletions integration/templates/react-vite/src/buttons/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,15 @@ export default function Home() {
Sign in button (force)
</SignInButton>

<SignInButton
mode='modal'
oauthFlow='popup'
forceRedirectUrl='/protected'
signUpForceRedirectUrl='/protected'
>
Sign in button (force, popup)
</SignInButton>

<SignInButton
mode='modal'
fallbackRedirectUrl='/protected'
Expand Down
5 changes: 5 additions & 0 deletions integration/templates/react-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import { createBrowserRouter, Outlet, RouterProvider, useNavigate } from 'react-
import App from './App.tsx';
import Protected from './protected';
import SignIn from './sign-in';
import SignInPopup from './sign-in-popup';
import SignUp from './sign-up';
import UserProfile from './user';
import UserProfileCustom from './custom-user-profile';
Expand DownExpand Up@@ -57,6 +58,10 @@ const router = createBrowserRouter([
path: '/sign-in/*',
element: <SignIn />,
},
{
path: '/sign-in-popup/*',
element: <SignInPopup />,
},
{
path: '/sign-up/*',
element: <SignUp />,
Expand Down
15 changes: 15 additions & 0 deletions integration/templates/react-vite/src/sign-in-popup/index.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
import { SignIn } from '@clerk/clerk-react';

export default function Page() {
return (
<div>
<SignIn
path={'/sign-in-popup'}
signUpUrl={'/sign-up'}
oauthFlow='popup'
fallbackRedirectUrl='/protected'
fallback={<>Loading sign in</>}
/>
</div>
);
}
57 changes: 57 additions & 0 deletions integration/tests/oauth-flows.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,63 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('oauth flo
});
});

testAgainstRunningApps({ withPattern: ['react.vite.withLegalConsent'] })(
'oauth popup with path-based routing @react',
({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

test.beforeAll(async () => {
const client = createClerkClient({
secretKey: instanceKeys.get('oauth-provider').sk,
publishableKey: instanceKeys.get('oauth-provider').pk,
});
const users = createUserService(client);
fakeUser = users.createFakeUser({
withUsername: true,
});
await users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
const u = createTestUtils({ app });
await fakeUser.deleteIfExists();
await u.services.users.deleteIfExists({ email: fakeUser.email });
await app.teardown();
});

test('popup OAuth navigates through sso-callback with path-based routing', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.page.goToRelative('/sign-in-popup');
await u.page.waitForClerkJsLoaded();
await u.po.signIn.waitForMounted();

const popupPromise = context.waitForEvent('page');
await u.page.getByRole('button', { name: 'E2E OAuth Provider' }).click();
const popup = await popupPromise;
const popupUtils = createTestUtils({ app, page: popup, context });
await popupUtils.page.getByText('Sign in to oauth-provider').waitFor();

// Complete OAuth in the popup
await popupUtils.po.signIn.setIdentifier(fakeUser.email);
await popupUtils.po.signIn.continue();
await popupUtils.po.signIn.enterTestOtpCode();

// Because the user is new to the app and legal consent is required,
// the sign-up can't complete in the popup. The popup sends return_url
// back to the parent, which navigates to /sso-callback via pushState.
await u.page.getByRole('heading', { name: 'Legal consent' }).waitFor();
await u.page.getByLabel(/I agree to the/).check();
await u.po.signIn.continue();

await u.page.waitForAppUrl('/protected');
await u.po.expect.toBeSignedIn();
});
},
);

testAgainstRunningApps({ withEnv: [appConfigs.envs.withLegalConsent] })(
'oauth flows with legal consent @nextjs',
({ app }) => {
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/hooks/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,3 @@ export * from './useSafeState';
export * from './useScrollLock';
export * from './useSearchInput';
export * from './useTotalEnabledAuthMethods';
export * from './useWindowEventListener';
15 changes: 0 additions & 15 deletions packages/clerk-js/src/ui/hooks/useWindowEventListener.ts

This file was deleted.

158 changes: 152 additions & 6 deletions packages/clerk-js/src/ui/router/BaseRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,140 @@
import { useClerk } from '@clerk/shared/react';
import type { NavigateOptions } from '@clerk/shared/types';
import React from 'react';
import { flushSync } from 'react-dom';

import { getQueryParams, stringifyQueryParams, trimTrailingSlash } from '../../utils';
import { useWindowEventListener } from '../hooks';
import { newPaths } from './newPaths';
import { match } from './pathToRegexp';
import { Route } from './Route';
import { RouteContext } from './RouteContext';

// Custom events that don't exist on WindowEventMap but are handled
// by wrapping history.pushState/replaceState in the fallback path.
type HistoryEvent = 'pushstate' | 'replacestate';
type RefreshEvent = keyof WindowEventMap | HistoryEvent;
type NavigationType = 'push' | 'replace' | 'traverse';

const isWindowRefreshEvent = (event: RefreshEvent): event is keyof WindowEventMap => {
return event !== 'pushstate' && event !== 'replacestate';
};

// Maps refresh events to Navigation API navigationType values.
const eventToNavigationType: Partial<Record<RefreshEvent, NavigationType>> = {
popstate: 'traverse',
pushstate: 'push',
replacestate: 'replace',
};

// Global subscription sets for the history monkey-patching fallback.
// Using a single patch with subscriber sets avoids conflicts when
// multiple BaseRouter instances mount simultaneously.
const pushStateSubscribers = new Set<() => void>();
const replaceStateSubscribers = new Set<() => void>();
let originalPushState: History['pushState'] | null = null;
let originalReplaceState: History['replaceState'] | null = null;

function ensurePushStatePatched(): void {
if (originalPushState) {
return;
}
const original = history.pushState.bind(history);
originalPushState = original;
history.pushState = (...args: Parameters<History['pushState']>) => {
original(...args);
pushStateSubscribers.forEach(fn => fn());
};
}

function ensureReplaceStatePatched(): void {
if (originalReplaceState) {
return;
}
const original = history.replaceState.bind(history);
originalReplaceState = original;
history.replaceState = (...args: Parameters<History['replaceState']>) => {
original(...args);
replaceStateSubscribers.forEach(fn => fn());
};
}

/**
* Observes history changes so the router's internal state stays in sync
* with the URL. Uses the Navigation API when available, falling back to
* monkey-patching history.pushState/replaceState plus native window events.
*
* Note: `events` should be a stable array reference to avoid
* re-subscribing on every render.
*/
function useHistoryChangeObserver(events: Array<RefreshEvent> | undefined, callback: () => void): void {
const callbackRef = React.useRef(callback);
callbackRef.current = callback;

React.useEffect(() => {
if (!events) {
return;
}

const notify = () => callbackRef.current();
const windowEvents = events.filter(isWindowRefreshEvent);
const navigationTypes = events
.map(e => eventToNavigationType[e])
.filter((type): type is NavigationType => Boolean(type));

const hasNavigationAPI =
typeof window !== 'undefined' &&
'navigation' in window &&
typeof (window as any).navigation?.addEventListener === 'function';

if (hasNavigationAPI) {
const nav = (window as any).navigation;
const allowedTypes = new Set(navigationTypes);
const handler = (e: { navigationType: NavigationType }) => {
if (allowedTypes.has(e.navigationType)) {
Promise.resolve().then(notify);
}
};
nav.addEventListener('currententrychange', handler);

// Events without a navigationType mapping (e.g. hashchange) still
// need native listeners even when the Navigation API is available.
const unmappedEvents = windowEvents.filter(e => !eventToNavigationType[e]);
unmappedEvents.forEach(e => window.addEventListener(e, notify));

return () => {
nav.removeEventListener('currententrychange', handler);
unmappedEvents.forEach(e => window.removeEventListener(e, notify));
};
}

// Fallback: use global subscriber sets for pushState/replaceState
// so that multiple BaseRouter instances don't conflict.
if (events.includes('pushstate')) {
ensurePushStatePatched();
pushStateSubscribers.add(notify);
}
if (events.includes('replacestate')) {
ensureReplaceStatePatched();
replaceStateSubscribers.add(notify);
}

windowEvents.forEach(e => window.addEventListener(e, notify));

return () => {
pushStateSubscribers.delete(notify);
replaceStateSubscribers.delete(notify);
windowEvents.forEach(e => window.removeEventListener(e, notify));
};
}, [events]);
}

interface BaseRouterProps {
basePath: string;
startPath: string;
getPath: () => string;
getQueryString: () => string;
internalNavigate: (toURL: URL, options?: NavigateOptions) => Promise<any> | any;
refreshEvents?: Array<keyof WindowEventMap>;
refreshEvents?: Array<RefreshEvent>;
preservedParams?: string[];
urlStateParam?: {
startPath: string;
Expand DownExpand Up@@ -86,7 +205,23 @@ export const BaseRouter = ({
}
}, [currentPath, currentQueryString, getPath, getQueryString]);

useWindowEventListener(refreshEvents, refresh);
// Suppresses the history observer during baseNavigate's internal navigation.
// Without this, the observer's microtask triggers a render before setActive's
// #updateAccessors sets clerk.session, causing task guards to see stale state.
const isNavigatingRef = React.useRef(false);

const observerRefresh = React.useCallback((): void => {
if (isNavigatingRef.current) {
return;
}
const newPath = getPath();
if (basePath && !newPath.startsWith('/' + basePath)) {
return;
}
refresh();
}, [basePath, getPath, refresh]);

useHistoryChangeObserver(refreshEvents, observerRefresh);

// TODO: Look into the real possible types of globalNavigate
const baseNavigate = async (toURL: URL | undefined): Promise<unknown> => {
Expand DownExpand Up@@ -116,9 +251,20 @@ export const BaseRouter = ({

toURL.search = stringifyQueryParams(toQueryParams);
}
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
return internalNavRes;
isNavigatingRef.current = true;
try {
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
// We need to flushSync to guarantee the re-render happens before handing things back to the caller,
// otherwise setActive might emit, and children re-render with the old navigation state.
// An alternative solution here could be to return a deferred promise, set that to state together
// with the routeParts and resolve it in an effect. That way we could avoid the flushSync performance penalty.
flushSync(() => {
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
});
return internalNavRes;
} finally {
isNavigatingRef.current = false;
}
};

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/router/PathRouter.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@ export const PathRouter = ({ basePath, preservedParams, children }: PathRouterPr
getPath={getPath}
getQueryString={getQueryString}
internalNavigate={internalNavigate}
refreshEvents={['popstate']}
refreshEvents={['pushstate', 'replacestate', 'popstate']}
preservedParams={preservedParams}
>
{children}
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
5 changes: 5 additions & 0 deletions .changeset/fix-router-sync-popup-oauth.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix BaseRouter state not syncing after popup OAuth by observing `pushState`/`replaceState` changes in addition to `popstate`
1 change: 1 addition & 0 deletions integration/presets/longRunningApps.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ export const createLongRunningApps = () => {
{ id: 'react.vite.withEmailCodes', config: react.vite, env: envs.withEmailCodes },
{ id: 'react.vite.withEmailCodes_persist_client', config: react.vite, env: envs.withEmailCodes_destroy_client },
{ id: 'react.vite.withEmailLinks', config: react.vite, env: envs.withEmailLinks },
{ id: 'react.vite.withLegalConsent', config: react.vite, env: envs.withLegalConsent },
{ id: 'vue.vite', config: vue.vite, env: envs.withCustomRoles },

/**
Expand Down
9 changes: 9 additions & 0 deletions integration/templates/react-vite/src/buttons/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,15 @@ export default function Home() {
Sign in button (force)
</SignInButton>

<SignInButton
mode='modal'
oauthFlow='popup'
forceRedirectUrl='/protected'
signUpForceRedirectUrl='/protected'
>
Sign in button (force, popup)
</SignInButton>

<SignInButton
mode='modal'
fallbackRedirectUrl='/protected'
Expand Down
5 changes: 5 additions & 0 deletions integration/templates/react-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import { createBrowserRouter, Outlet, RouterProvider, useNavigate } from 'react-
import App from './App.tsx';
import Protected from './protected';
import SignIn from './sign-in';
import SignInPopup from './sign-in-popup';
import SignUp from './sign-up';
import UserProfile from './user';
import UserProfileCustom from './custom-user-profile';
Expand DownExpand Up@@ -57,6 +58,10 @@ const router = createBrowserRouter([
path: '/sign-in/*',
element: <SignIn />,
},
{
path: '/sign-in-popup/*',
element: <SignInPopup />,
},
{
path: '/sign-up/*',
element: <SignUp />,
Expand Down
15 changes: 15 additions & 0 deletions integration/templates/react-vite/src/sign-in-popup/index.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
import { SignIn } from '@clerk/clerk-react';

export default function Page() {
return (
<div>
<SignIn
path={'/sign-in-popup'}
signUpUrl={'/sign-up'}
oauthFlow='popup'
fallbackRedirectUrl='/protected'
fallback={<>Loading sign in</>}
/>
</div>
);
}
57 changes: 57 additions & 0 deletions integration/tests/oauth-flows.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,63 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('oauth flo
});
});

testAgainstRunningApps({ withPattern: ['react.vite.withLegalConsent'] })(
'oauth popup with path-based routing @react',
({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

test.beforeAll(async () => {
const client = createClerkClient({
secretKey: instanceKeys.get('oauth-provider').sk,
publishableKey: instanceKeys.get('oauth-provider').pk,
});
const users = createUserService(client);
fakeUser = users.createFakeUser({
withUsername: true,
});
await users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
const u = createTestUtils({ app });
await fakeUser.deleteIfExists();
await u.services.users.deleteIfExists({ email: fakeUser.email });
await app.teardown();
});

test('popup OAuth navigates through sso-callback with path-based routing', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.page.goToRelative('/sign-in-popup');
await u.page.waitForClerkJsLoaded();
await u.po.signIn.waitForMounted();

const popupPromise = context.waitForEvent('page');
await u.page.getByRole('button', { name: 'E2E OAuth Provider' }).click();
const popup = await popupPromise;
const popupUtils = createTestUtils({ app, page: popup, context });
await popupUtils.page.getByText('Sign in to oauth-provider').waitFor();

// Complete OAuth in the popup
await popupUtils.po.signIn.setIdentifier(fakeUser.email);
await popupUtils.po.signIn.continue();
await popupUtils.po.signIn.enterTestOtpCode();

// Because the user is new to the app and legal consent is required,
// the sign-up can't complete in the popup. The popup sends return_url
// back to the parent, which navigates to /sso-callback via pushState.
await u.page.getByRole('heading', { name: 'Legal consent' }).waitFor();
await u.page.getByLabel(/I agree to the/).check();
await u.po.signIn.continue();

await u.page.waitForAppUrl('/protected');
await u.po.expect.toBeSignedIn();
});
},
);

testAgainstRunningApps({ withEnv: [appConfigs.envs.withLegalConsent] })(
'oauth flows with legal consent @nextjs',
({ app }) => {
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/hooks/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,3 @@ export * from './useSafeState';
export * from './useScrollLock';
export * from './useSearchInput';
export * from './useTotalEnabledAuthMethods';
export * from './useWindowEventListener';
15 changes: 0 additions & 15 deletions packages/clerk-js/src/ui/hooks/useWindowEventListener.ts

This file was deleted.

158 changes: 152 additions & 6 deletions packages/clerk-js/src/ui/router/BaseRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,140 @@
import { useClerk } from '@clerk/shared/react';
import type { NavigateOptions } from '@clerk/shared/types';
import React from 'react';
import { flushSync } from 'react-dom';

import { getQueryParams, stringifyQueryParams, trimTrailingSlash } from '../../utils';
import { useWindowEventListener } from '../hooks';
import { newPaths } from './newPaths';
import { match } from './pathToRegexp';
import { Route } from './Route';
import { RouteContext } from './RouteContext';

// Custom events that don't exist on WindowEventMap but are handled
// by wrapping history.pushState/replaceState in the fallback path.
type HistoryEvent = 'pushstate' | 'replacestate';
type RefreshEvent = keyof WindowEventMap | HistoryEvent;
type NavigationType = 'push' | 'replace' | 'traverse';

const isWindowRefreshEvent = (event: RefreshEvent): event is keyof WindowEventMap => {
return event !== 'pushstate' && event !== 'replacestate';
};

// Maps refresh events to Navigation API navigationType values.
const eventToNavigationType: Partial<Record<RefreshEvent, NavigationType>> = {
popstate: 'traverse',
pushstate: 'push',
replacestate: 'replace',
};

// Global subscription sets for the history monkey-patching fallback.
// Using a single patch with subscriber sets avoids conflicts when
// multiple BaseRouter instances mount simultaneously.
const pushStateSubscribers = new Set<() => void>();
const replaceStateSubscribers = new Set<() => void>();
let originalPushState: History['pushState'] | null = null;
let originalReplaceState: History['replaceState'] | null = null;

function ensurePushStatePatched(): void {
if (originalPushState) {
return;
}
const original = history.pushState.bind(history);
originalPushState = original;
history.pushState = (...args: Parameters<History['pushState']>) => {
original(...args);
pushStateSubscribers.forEach(fn => fn());
};
}

function ensureReplaceStatePatched(): void {
if (originalReplaceState) {
return;
}
const original = history.replaceState.bind(history);
originalReplaceState = original;
history.replaceState = (...args: Parameters<History['replaceState']>) => {
original(...args);
replaceStateSubscribers.forEach(fn => fn());
};
}

/**
* Observes history changes so the router's internal state stays in sync
* with the URL. Uses the Navigation API when available, falling back to
* monkey-patching history.pushState/replaceState plus native window events.
*
* Note: `events` should be a stable array reference to avoid
* re-subscribing on every render.
*/
function useHistoryChangeObserver(events: Array<RefreshEvent> | undefined, callback: () => void): void {
const callbackRef = React.useRef(callback);
callbackRef.current = callback;

React.useEffect(() => {
if (!events) {
return;
}

const notify = () => callbackRef.current();
const windowEvents = events.filter(isWindowRefreshEvent);
const navigationTypes = events
.map(e => eventToNavigationType[e])
.filter((type): type is NavigationType => Boolean(type));

const hasNavigationAPI =
typeof window !== 'undefined' &&
'navigation' in window &&
typeof (window as any).navigation?.addEventListener === 'function';

if (hasNavigationAPI) {
const nav = (window as any).navigation;
const allowedTypes = new Set(navigationTypes);
const handler = (e: { navigationType: NavigationType }) => {
if (allowedTypes.has(e.navigationType)) {
Promise.resolve().then(notify);
}
};
nav.addEventListener('currententrychange', handler);

// Events without a navigationType mapping (e.g. hashchange) still
// need native listeners even when the Navigation API is available.
const unmappedEvents = windowEvents.filter(e => !eventToNavigationType[e]);
unmappedEvents.forEach(e => window.addEventListener(e, notify));

return () => {
nav.removeEventListener('currententrychange', handler);
unmappedEvents.forEach(e => window.removeEventListener(e, notify));
};
}

// Fallback: use global subscriber sets for pushState/replaceState
// so that multiple BaseRouter instances don't conflict.
if (events.includes('pushstate')) {
ensurePushStatePatched();
pushStateSubscribers.add(notify);
}
if (events.includes('replacestate')) {
ensureReplaceStatePatched();
replaceStateSubscribers.add(notify);
}

windowEvents.forEach(e => window.addEventListener(e, notify));

return () => {
pushStateSubscribers.delete(notify);
replaceStateSubscribers.delete(notify);
windowEvents.forEach(e => window.removeEventListener(e, notify));
};
}, [events]);
}

interface BaseRouterProps {
basePath: string;
startPath: string;
getPath: () => string;
getQueryString: () => string;
internalNavigate: (toURL: URL, options?: NavigateOptions) => Promise<any> | any;
refreshEvents?: Array<keyof WindowEventMap>;
refreshEvents?: Array<RefreshEvent>;
preservedParams?: string[];
urlStateParam?: {
startPath: string;
Expand DownExpand Up@@ -86,7 +205,23 @@ export const BaseRouter = ({
}
}, [currentPath, currentQueryString, getPath, getQueryString]);

useWindowEventListener(refreshEvents, refresh);
// Suppresses the history observer during baseNavigate's internal navigation.
// Without this, the observer's microtask triggers a render before setActive's
// #updateAccessors sets clerk.session, causing task guards to see stale state.
const isNavigatingRef = React.useRef(false);

const observerRefresh = React.useCallback((): void => {
if (isNavigatingRef.current) {
return;
}
const newPath = getPath();
if (basePath && !newPath.startsWith('/' + basePath)) {
return;
}
refresh();
}, [basePath, getPath, refresh]);

useHistoryChangeObserver(refreshEvents, observerRefresh);

// TODO: Look into the real possible types of globalNavigate
const baseNavigate = async (toURL: URL | undefined): Promise<unknown> => {
Expand DownExpand Up@@ -116,9 +251,20 @@ export const BaseRouter = ({

toURL.search = stringifyQueryParams(toQueryParams);
}
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
return internalNavRes;
isNavigatingRef.current = true;
try {
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
// We need to flushSync to guarantee the re-render happens before handing things back to the caller,
// otherwise setActive might emit, and children re-render with the old navigation state.
// An alternative solution here could be to return a deferred promise, set that to state together
// with the routeParts and resolve it in an effect. That way we could avoid the flushSync performance penalty.
flushSync(() => {
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
});
return internalNavRes;
} finally {
isNavigatingRef.current = false;
}
};

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/router/PathRouter.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@ export const PathRouter = ({ basePath, preservedParams, children }: PathRouterPr
getPath={getPath}
getQueryString={getQueryString}
internalNavigate={internalNavigate}
refreshEvents={['popstate']}
refreshEvents={['pushstate', 'replacestate', 'popstate']}
preservedParams={preservedParams}
>
{children}
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
5 changes: 5 additions & 0 deletions .changeset/fix-router-sync-popup-oauth.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix BaseRouter state not syncing after popup OAuth by observing `pushState`/`replaceState` changes in addition to `popstate`
1 change: 1 addition & 0 deletions integration/presets/longRunningApps.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ export const createLongRunningApps = () => {
{ id: 'react.vite.withEmailCodes', config: react.vite, env: envs.withEmailCodes },
{ id: 'react.vite.withEmailCodes_persist_client', config: react.vite, env: envs.withEmailCodes_destroy_client },
{ id: 'react.vite.withEmailLinks', config: react.vite, env: envs.withEmailLinks },
{ id: 'react.vite.withLegalConsent', config: react.vite, env: envs.withLegalConsent },
{ id: 'vue.vite', config: vue.vite, env: envs.withCustomRoles },

/**
Expand Down
9 changes: 9 additions & 0 deletions integration/templates/react-vite/src/buttons/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,15 @@ export default function Home() {
Sign in button (force)
</SignInButton>

<SignInButton
mode='modal'
oauthFlow='popup'
forceRedirectUrl='/protected'
signUpForceRedirectUrl='/protected'
>
Sign in button (force, popup)
</SignInButton>

<SignInButton
mode='modal'
fallbackRedirectUrl='/protected'
Expand Down
5 changes: 5 additions & 0 deletions integration/templates/react-vite/src/main.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import { createBrowserRouter, Outlet, RouterProvider, useNavigate } from 'react-
import App from './App.tsx';
import Protected from './protected';
import SignIn from './sign-in';
import SignInPopup from './sign-in-popup';
import SignUp from './sign-up';
import UserProfile from './user';
import UserProfileCustom from './custom-user-profile';
Expand DownExpand Up@@ -57,6 +58,10 @@ const router = createBrowserRouter([
path: '/sign-in/*',
element: <SignIn />,
},
{
path: '/sign-in-popup/*',
element: <SignInPopup />,
},
{
path: '/sign-up/*',
element: <SignUp />,
Expand Down
15 changes: 15 additions & 0 deletions integration/templates/react-vite/src/sign-in-popup/index.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
import { SignIn } from '@clerk/clerk-react';

export default function Page() {
return (
<div>
<SignIn
path={'/sign-in-popup'}
signUpUrl={'/sign-up'}
oauthFlow='popup'
fallbackRedirectUrl='/protected'
fallback={<>Loading sign in</>}
/>
</div>
);
}
57 changes: 57 additions & 0 deletions integration/tests/oauth-flows.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,6 +181,63 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })('oauth flo
});
});

testAgainstRunningApps({ withPattern: ['react.vite.withLegalConsent'] })(
'oauth popup with path-based routing @react',
({ app }) => {
test.describe.configure({ mode: 'serial' });

let fakeUser: FakeUser;

test.beforeAll(async () => {
const client = createClerkClient({
secretKey: instanceKeys.get('oauth-provider').sk,
publishableKey: instanceKeys.get('oauth-provider').pk,
});
const users = createUserService(client);
fakeUser = users.createFakeUser({
withUsername: true,
});
await users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
const u = createTestUtils({ app });
await fakeUser.deleteIfExists();
await u.services.users.deleteIfExists({ email: fakeUser.email });
await app.teardown();
});

test('popup OAuth navigates through sso-callback with path-based routing', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.page.goToRelative('/sign-in-popup');
await u.page.waitForClerkJsLoaded();
await u.po.signIn.waitForMounted();

const popupPromise = context.waitForEvent('page');
await u.page.getByRole('button', { name: 'E2E OAuth Provider' }).click();
const popup = await popupPromise;
const popupUtils = createTestUtils({ app, page: popup, context });
await popupUtils.page.getByText('Sign in to oauth-provider').waitFor();

// Complete OAuth in the popup
await popupUtils.po.signIn.setIdentifier(fakeUser.email);
await popupUtils.po.signIn.continue();
await popupUtils.po.signIn.enterTestOtpCode();

// Because the user is new to the app and legal consent is required,
// the sign-up can't complete in the popup. The popup sends return_url
// back to the parent, which navigates to /sso-callback via pushState.
await u.page.getByRole('heading', { name: 'Legal consent' }).waitFor();
await u.page.getByLabel(/I agree to the/).check();
await u.po.signIn.continue();

await u.page.waitForAppUrl('/protected');
await u.po.expect.toBeSignedIn();
});
},
);

testAgainstRunningApps({ withEnv: [appConfigs.envs.withLegalConsent] })(
'oauth flows with legal consent @nextjs',
({ app }) => {
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/hooks/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,4 +17,3 @@ export * from './useSafeState';
export * from './useScrollLock';
export * from './useSearchInput';
export * from './useTotalEnabledAuthMethods';
export * from './useWindowEventListener';
15 changes: 0 additions & 15 deletions packages/clerk-js/src/ui/hooks/useWindowEventListener.ts

This file was deleted.

158 changes: 152 additions & 6 deletions packages/clerk-js/src/ui/router/BaseRouter.tsx
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,140 @@
import { useClerk } from '@clerk/shared/react';
import type { NavigateOptions } from '@clerk/shared/types';
import React from 'react';
import { flushSync } from 'react-dom';

import { getQueryParams, stringifyQueryParams, trimTrailingSlash } from '../../utils';
import { useWindowEventListener } from '../hooks';
import { newPaths } from './newPaths';
import { match } from './pathToRegexp';
import { Route } from './Route';
import { RouteContext } from './RouteContext';

// Custom events that don't exist on WindowEventMap but are handled
// by wrapping history.pushState/replaceState in the fallback path.
type HistoryEvent = 'pushstate' | 'replacestate';
type RefreshEvent = keyof WindowEventMap | HistoryEvent;
type NavigationType = 'push' | 'replace' | 'traverse';

const isWindowRefreshEvent = (event: RefreshEvent): event is keyof WindowEventMap => {
return event !== 'pushstate' && event !== 'replacestate';
};

// Maps refresh events to Navigation API navigationType values.
const eventToNavigationType: Partial<Record<RefreshEvent, NavigationType>> = {
popstate: 'traverse',
pushstate: 'push',
replacestate: 'replace',
};

// Global subscription sets for the history monkey-patching fallback.
// Using a single patch with subscriber sets avoids conflicts when
// multiple BaseRouter instances mount simultaneously.
const pushStateSubscribers = new Set<() => void>();
const replaceStateSubscribers = new Set<() => void>();
let originalPushState: History['pushState'] | null = null;
let originalReplaceState: History['replaceState'] | null = null;

function ensurePushStatePatched(): void {
if (originalPushState) {
return;
}
const original = history.pushState.bind(history);
originalPushState = original;
history.pushState = (...args: Parameters<History['pushState']>) => {
original(...args);
pushStateSubscribers.forEach(fn => fn());
};
}

function ensureReplaceStatePatched(): void {
if (originalReplaceState) {
return;
}
const original = history.replaceState.bind(history);
originalReplaceState = original;
history.replaceState = (...args: Parameters<History['replaceState']>) => {
original(...args);
replaceStateSubscribers.forEach(fn => fn());
};
}

/**
* Observes history changes so the router's internal state stays in sync
* with the URL. Uses the Navigation API when available, falling back to
* monkey-patching history.pushState/replaceState plus native window events.
*
* Note: `events` should be a stable array reference to avoid
* re-subscribing on every render.
*/
function useHistoryChangeObserver(events: Array<RefreshEvent> | undefined, callback: () => void): void {
const callbackRef = React.useRef(callback);
callbackRef.current = callback;

React.useEffect(() => {
if (!events) {
return;
}

const notify = () => callbackRef.current();
const windowEvents = events.filter(isWindowRefreshEvent);
const navigationTypes = events
.map(e => eventToNavigationType[e])
.filter((type): type is NavigationType => Boolean(type));

const hasNavigationAPI =
typeof window !== 'undefined' &&
'navigation' in window &&
typeof (window as any).navigation?.addEventListener === 'function';

if (hasNavigationAPI) {
const nav = (window as any).navigation;
const allowedTypes = new Set(navigationTypes);
const handler = (e: { navigationType: NavigationType }) => {
if (allowedTypes.has(e.navigationType)) {
Promise.resolve().then(notify);
}
};
nav.addEventListener('currententrychange', handler);

// Events without a navigationType mapping (e.g. hashchange) still
// need native listeners even when the Navigation API is available.
const unmappedEvents = windowEvents.filter(e => !eventToNavigationType[e]);
unmappedEvents.forEach(e => window.addEventListener(e, notify));

return () => {
nav.removeEventListener('currententrychange', handler);
unmappedEvents.forEach(e => window.removeEventListener(e, notify));
};
}

// Fallback: use global subscriber sets for pushState/replaceState
// so that multiple BaseRouter instances don't conflict.
if (events.includes('pushstate')) {
ensurePushStatePatched();
pushStateSubscribers.add(notify);
}
if (events.includes('replacestate')) {
ensureReplaceStatePatched();
replaceStateSubscribers.add(notify);
}

windowEvents.forEach(e => window.addEventListener(e, notify));

return () => {
pushStateSubscribers.delete(notify);
replaceStateSubscribers.delete(notify);
windowEvents.forEach(e => window.removeEventListener(e, notify));
};
}, [events]);
}

interface BaseRouterProps {
basePath: string;
startPath: string;
getPath: () => string;
getQueryString: () => string;
internalNavigate: (toURL: URL, options?: NavigateOptions) => Promise<any> | any;
refreshEvents?: Array<keyof WindowEventMap>;
refreshEvents?: Array<RefreshEvent>;
preservedParams?: string[];
urlStateParam?: {
startPath: string;
Expand DownExpand Up@@ -86,7 +205,23 @@ export const BaseRouter = ({
}
}, [currentPath, currentQueryString, getPath, getQueryString]);

useWindowEventListener(refreshEvents, refresh);
// Suppresses the history observer during baseNavigate's internal navigation.
// Without this, the observer's microtask triggers a render before setActive's
// #updateAccessors sets clerk.session, causing task guards to see stale state.
const isNavigatingRef = React.useRef(false);

const observerRefresh = React.useCallback((): void => {
if (isNavigatingRef.current) {
return;
}
const newPath = getPath();
if (basePath && !newPath.startsWith('/' + basePath)) {
return;
}
refresh();
}, [basePath, getPath, refresh]);

useHistoryChangeObserver(refreshEvents, observerRefresh);

// TODO: Look into the real possible types of globalNavigate
const baseNavigate = async (toURL: URL | undefined): Promise<unknown> => {
Expand DownExpand Up@@ -116,9 +251,20 @@ export const BaseRouter = ({

toURL.search = stringifyQueryParams(toQueryParams);
}
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
return internalNavRes;
isNavigatingRef.current = true;
try {
const internalNavRes = await internalNavigate(toURL, { metadata: { navigationType: 'internal' } });
// We need to flushSync to guarantee the re-render happens before handing things back to the caller,
// otherwise setActive might emit, and children re-render with the old navigation state.
// An alternative solution here could be to return a deferred promise, set that to state together
// with the routeParts and resolve it in an effect. That way we could avoid the flushSync performance penalty.
flushSync(() => {
setRouteParts({ path: toURL.pathname, queryString: toURL.search });
});
return internalNavRes;
} finally {
isNavigatingRef.current = false;
}
};

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/router/PathRouter.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@ export const PathRouter = ({ basePath, preservedParams, children }: PathRouterPr
getPath={getPath}
getQueryString={getQueryString}
internalNavigate={internalNavigate}
refreshEvents={['popstate']}
refreshEvents={['pushstate', 'replacestate', 'popstate']}
preservedParams={preservedParams}
>
{children}
Expand Down
Loading