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-tanstack-navigation-query-params.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/tanstack-react-start': patch
---

Fix navigation with query parameters in TanStack Start apps. Previously, URLs with query parameters (e.g., `/sign-in?redirect_url=...`) would cause "Not Found" errors because TanStack Router doesn't parse query strings from the `to` parameter. The fix properly separates pathname, search params, and hash when calling TanStack Router's navigate function.
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { useRef } from 'react';
import { useLocation, useParams } from 'react-router';

export const usePathnameWithoutSplatRouteParams = () => {
Expand All@@ -14,5 +15,13 @@ export const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When the router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
import { parseUrlForNavigation } from '../client/utils';

const BASE_URL = 'https://example.com';

describe('parseUrlForNavigation', () => {
it('parses pathname only', () => {
const result = parseUrlForNavigation('/sign-in', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('parses pathname with query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: undefined,
});
});

it('parses pathname with multiple query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com&foo=bar', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com', foo: 'bar' },
hash: undefined,
});
});

it('parses pathname with hash', () => {
const result = parseUrlForNavigation('/sign-in#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: 'section',
});
});

it('parses pathname with query parameters and hash', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: 'section',
});
});

it('handles encoded query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https%3A%2F%2Fexample.com%2Fpath', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com/path' },
hash: undefined,
});
});

it('handles root path', () => {
const result = parseUrlForNavigation('/', BASE_URL);
expect(result).toEqual({
to: '/',
search: undefined,
hash: undefined,
});
});

it('handles nested paths', () => {
const result = parseUrlForNavigation('/auth/sign-in?foo=bar', BASE_URL);
expect(result).toEqual({
to: '/auth/sign-in',
search: { foo: 'bar' },
hash: undefined,
});
});

it('handles empty hash', () => {
const result = parseUrlForNavigation('/sign-in#', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('handles complex satellite redirect URL', () => {
const result = parseUrlForNavigation(
'/sign-in?redirect_url=https%3A%2F%2Fsatellite.example.com%2Fdashboard&sign_in_force_redirect_url=https%3A%2F%2Fmain.example.com',
BASE_URL,
);
expect(result).toEqual({
to: '/sign-in',
search: {
redirect_url: 'https://satellite.example.com/dashboard',
sign_in_force_redirect_url: 'https://main.example.com',
},
hash: undefined,
});
});

it('handles hash that looks like a path with query params (PathRouter format)', () => {
// This is what PathRouter converts from: /sign-in#/?redirect_url=...
// After mergeFragmentIntoUrl, it becomes: /sign-in?redirect_url=...
// We should correctly handle both formats
const result = parseUrlForNavigation('/sign-in?redirect_url=https://satellite.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://satellite.com' },
hash: undefined,
});
});
});
28 changes: 17 additions & 11 deletions packages/tanstack-react-start/src/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import { isClient } from '../utils';
import { ClerkOptionsProvider } from './OptionsContext';
import type { TanstackStartClerkProviderProps } from './types';
import { useAwaitableNavigate } from './useAwaitableNavigate';
import { mergeWithPublicEnvs, pickFromClerkInitState } from './utils';
import { mergeWithPublicEnvs, parseUrlForNavigation, pickFromClerkInitState } from './utils';

export * from '@clerk/react';

Expand DownExpand Up@@ -57,18 +57,24 @@ export function ClerkProvider<TUi extends Ui = Ui>({
<ReactClerkProvider
initialState={clerkSsrState}
sdkMetadata={SDK_METADATA}
routerPush={(to: string) =>
awaitableNavigateRef.current?.({
to,
routerPush={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: false,
})
}
routerReplace={(to: string) =>
awaitableNavigateRef.current?.({
to,
});
}}
routerReplace={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: true,
})
}
});
}}
{...mergedProps}
{...keylessProps}
>
Expand Down
11 changes: 10 additions & 1 deletion packages/tanstack-react-start/src/client/uiComponents.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
import { useRoutingProps } from '@clerk/react/internal';
import type { OrganizationProfileProps, SignInProps, SignUpProps, UserProfileProps } from '@clerk/shared/types';
import { useLocation, useParams } from '@tanstack/react-router';
import { useRef } from 'react';

const usePathnameWithoutSplatRouteParams = () => {
const { _splat } = useParams({
Expand All@@ -24,7 +25,15 @@ const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When TanStack Router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};

// The assignment of UserProfile with BaseUserProfile props is used
Expand Down
21 changes: 21 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,24 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
};
};

export type ParsedNavigationUrl = {
to: string;
search?: Record<string, string>;
hash?: string;
};

/**
* Parses a URL string into TanStack Router navigation options.
* TanStack Router doesn't parse query strings from the `to` parameter,
* so we need to extract pathname, search params, and hash separately.
*/
export function parseUrlForNavigation(to: string, baseUrl: string): ParsedNavigationUrl {
const url = new URL(to, baseUrl);
const searchParams = Object.fromEntries(url.searchParams);
return {
to: url.pathname,
search: Object.keys(searchParams).length > 0 ? searchParams : undefined,
hash: url.hash ? url.hash.slice(1) : undefined,
};
}
, '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-tanstack-navigation-query-params.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/tanstack-react-start': patch
---

Fix navigation with query parameters in TanStack Start apps. Previously, URLs with query parameters (e.g., `/sign-in?redirect_url=...`) would cause "Not Found" errors because TanStack Router doesn't parse query strings from the `to` parameter. The fix properly separates pathname, search params, and hash when calling TanStack Router's navigate function.
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { useRef } from 'react';
import { useLocation, useParams } from 'react-router';

export const usePathnameWithoutSplatRouteParams = () => {
Expand All@@ -14,5 +15,13 @@ export const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When the router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
import { parseUrlForNavigation } from '../client/utils';

const BASE_URL = 'https://example.com';

describe('parseUrlForNavigation', () => {
it('parses pathname only', () => {
const result = parseUrlForNavigation('/sign-in', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('parses pathname with query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: undefined,
});
});

it('parses pathname with multiple query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com&foo=bar', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com', foo: 'bar' },
hash: undefined,
});
});

it('parses pathname with hash', () => {
const result = parseUrlForNavigation('/sign-in#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: 'section',
});
});

it('parses pathname with query parameters and hash', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: 'section',
});
});

it('handles encoded query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https%3A%2F%2Fexample.com%2Fpath', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com/path' },
hash: undefined,
});
});

it('handles root path', () => {
const result = parseUrlForNavigation('/', BASE_URL);
expect(result).toEqual({
to: '/',
search: undefined,
hash: undefined,
});
});

it('handles nested paths', () => {
const result = parseUrlForNavigation('/auth/sign-in?foo=bar', BASE_URL);
expect(result).toEqual({
to: '/auth/sign-in',
search: { foo: 'bar' },
hash: undefined,
});
});

it('handles empty hash', () => {
const result = parseUrlForNavigation('/sign-in#', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('handles complex satellite redirect URL', () => {
const result = parseUrlForNavigation(
'/sign-in?redirect_url=https%3A%2F%2Fsatellite.example.com%2Fdashboard&sign_in_force_redirect_url=https%3A%2F%2Fmain.example.com',
BASE_URL,
);
expect(result).toEqual({
to: '/sign-in',
search: {
redirect_url: 'https://satellite.example.com/dashboard',
sign_in_force_redirect_url: 'https://main.example.com',
},
hash: undefined,
});
});

it('handles hash that looks like a path with query params (PathRouter format)', () => {
// This is what PathRouter converts from: /sign-in#/?redirect_url=...
// After mergeFragmentIntoUrl, it becomes: /sign-in?redirect_url=...
// We should correctly handle both formats
const result = parseUrlForNavigation('/sign-in?redirect_url=https://satellite.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://satellite.com' },
hash: undefined,
});
});
});
28 changes: 17 additions & 11 deletions packages/tanstack-react-start/src/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import { isClient } from '../utils';
import { ClerkOptionsProvider } from './OptionsContext';
import type { TanstackStartClerkProviderProps } from './types';
import { useAwaitableNavigate } from './useAwaitableNavigate';
import { mergeWithPublicEnvs, pickFromClerkInitState } from './utils';
import { mergeWithPublicEnvs, parseUrlForNavigation, pickFromClerkInitState } from './utils';

export * from '@clerk/react';

Expand DownExpand Up@@ -57,18 +57,24 @@ export function ClerkProvider<TUi extends Ui = Ui>({
<ReactClerkProvider
initialState={clerkSsrState}
sdkMetadata={SDK_METADATA}
routerPush={(to: string) =>
awaitableNavigateRef.current?.({
to,
routerPush={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: false,
})
}
routerReplace={(to: string) =>
awaitableNavigateRef.current?.({
to,
});
}}
routerReplace={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: true,
})
}
});
}}
{...mergedProps}
{...keylessProps}
>
Expand Down
11 changes: 10 additions & 1 deletion packages/tanstack-react-start/src/client/uiComponents.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
import { useRoutingProps } from '@clerk/react/internal';
import type { OrganizationProfileProps, SignInProps, SignUpProps, UserProfileProps } from '@clerk/shared/types';
import { useLocation, useParams } from '@tanstack/react-router';
import { useRef } from 'react';

const usePathnameWithoutSplatRouteParams = () => {
const { _splat } = useParams({
Expand All@@ -24,7 +25,15 @@ const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When TanStack Router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};

// The assignment of UserProfile with BaseUserProfile props is used
Expand Down
21 changes: 21 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,24 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
};
};

export type ParsedNavigationUrl = {
to: string;
search?: Record<string, string>;
hash?: string;
};

/**
* Parses a URL string into TanStack Router navigation options.
* TanStack Router doesn't parse query strings from the `to` parameter,
* so we need to extract pathname, search params, and hash separately.
*/
export function parseUrlForNavigation(to: string, baseUrl: string): ParsedNavigationUrl {
const url = new URL(to, baseUrl);
const searchParams = Object.fromEntries(url.searchParams);
return {
to: url.pathname,
search: Object.keys(searchParams).length > 0 ? searchParams : undefined,
hash: url.hash ? url.hash.slice(1) : undefined,
};
}
, '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-tanstack-navigation-query-params.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/tanstack-react-start': patch
---

Fix navigation with query parameters in TanStack Start apps. Previously, URLs with query parameters (e.g., `/sign-in?redirect_url=...`) would cause "Not Found" errors because TanStack Router doesn't parse query strings from the `to` parameter. The fix properly separates pathname, search params, and hash when calling TanStack Router's navigate function.
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { useRef } from 'react';
import { useLocation, useParams } from 'react-router';

export const usePathnameWithoutSplatRouteParams = () => {
Expand All@@ -14,5 +15,13 @@ export const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When the router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
import { parseUrlForNavigation } from '../client/utils';

const BASE_URL = 'https://example.com';

describe('parseUrlForNavigation', () => {
it('parses pathname only', () => {
const result = parseUrlForNavigation('/sign-in', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('parses pathname with query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: undefined,
});
});

it('parses pathname with multiple query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com&foo=bar', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com', foo: 'bar' },
hash: undefined,
});
});

it('parses pathname with hash', () => {
const result = parseUrlForNavigation('/sign-in#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: 'section',
});
});

it('parses pathname with query parameters and hash', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: 'section',
});
});

it('handles encoded query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https%3A%2F%2Fexample.com%2Fpath', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com/path' },
hash: undefined,
});
});

it('handles root path', () => {
const result = parseUrlForNavigation('/', BASE_URL);
expect(result).toEqual({
to: '/',
search: undefined,
hash: undefined,
});
});

it('handles nested paths', () => {
const result = parseUrlForNavigation('/auth/sign-in?foo=bar', BASE_URL);
expect(result).toEqual({
to: '/auth/sign-in',
search: { foo: 'bar' },
hash: undefined,
});
});

it('handles empty hash', () => {
const result = parseUrlForNavigation('/sign-in#', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('handles complex satellite redirect URL', () => {
const result = parseUrlForNavigation(
'/sign-in?redirect_url=https%3A%2F%2Fsatellite.example.com%2Fdashboard&sign_in_force_redirect_url=https%3A%2F%2Fmain.example.com',
BASE_URL,
);
expect(result).toEqual({
to: '/sign-in',
search: {
redirect_url: 'https://satellite.example.com/dashboard',
sign_in_force_redirect_url: 'https://main.example.com',
},
hash: undefined,
});
});

it('handles hash that looks like a path with query params (PathRouter format)', () => {
// This is what PathRouter converts from: /sign-in#/?redirect_url=...
// After mergeFragmentIntoUrl, it becomes: /sign-in?redirect_url=...
// We should correctly handle both formats
const result = parseUrlForNavigation('/sign-in?redirect_url=https://satellite.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://satellite.com' },
hash: undefined,
});
});
});
28 changes: 17 additions & 11 deletions packages/tanstack-react-start/src/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import { isClient } from '../utils';
import { ClerkOptionsProvider } from './OptionsContext';
import type { TanstackStartClerkProviderProps } from './types';
import { useAwaitableNavigate } from './useAwaitableNavigate';
import { mergeWithPublicEnvs, pickFromClerkInitState } from './utils';
import { mergeWithPublicEnvs, parseUrlForNavigation, pickFromClerkInitState } from './utils';

export * from '@clerk/react';

Expand DownExpand Up@@ -57,18 +57,24 @@ export function ClerkProvider<TUi extends Ui = Ui>({
<ReactClerkProvider
initialState={clerkSsrState}
sdkMetadata={SDK_METADATA}
routerPush={(to: string) =>
awaitableNavigateRef.current?.({
to,
routerPush={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: false,
})
}
routerReplace={(to: string) =>
awaitableNavigateRef.current?.({
to,
});
}}
routerReplace={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: true,
})
}
});
}}
{...mergedProps}
{...keylessProps}
>
Expand Down
11 changes: 10 additions & 1 deletion packages/tanstack-react-start/src/client/uiComponents.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
import { useRoutingProps } from '@clerk/react/internal';
import type { OrganizationProfileProps, SignInProps, SignUpProps, UserProfileProps } from '@clerk/shared/types';
import { useLocation, useParams } from '@tanstack/react-router';
import { useRef } from 'react';

const usePathnameWithoutSplatRouteParams = () => {
const { _splat } = useParams({
Expand All@@ -24,7 +25,15 @@ const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When TanStack Router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};

// The assignment of UserProfile with BaseUserProfile props is used
Expand Down
21 changes: 21 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,24 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
};
};

export type ParsedNavigationUrl = {
to: string;
search?: Record<string, string>;
hash?: string;
};

/**
* Parses a URL string into TanStack Router navigation options.
* TanStack Router doesn't parse query strings from the `to` parameter,
* so we need to extract pathname, search params, and hash separately.
*/
export function parseUrlForNavigation(to: string, baseUrl: string): ParsedNavigationUrl {
const url = new URL(to, baseUrl);
const searchParams = Object.fromEntries(url.searchParams);
return {
to: url.pathname,
search: Object.keys(searchParams).length > 0 ? searchParams : undefined,
hash: url.hash ? url.hash.slice(1) : undefined,
};
}
, '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-tanstack-navigation-query-params.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/tanstack-react-start': patch
---

Fix navigation with query parameters in TanStack Start apps. Previously, URLs with query parameters (e.g., `/sign-in?redirect_url=...`) would cause "Not Found" errors because TanStack Router doesn't parse query strings from the `to` parameter. The fix properly separates pathname, search params, and hash when calling TanStack Router's navigate function.
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { useRef } from 'react';
import { useLocation, useParams } from 'react-router';

export const usePathnameWithoutSplatRouteParams = () => {
Expand All@@ -14,5 +15,13 @@ export const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When the router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
import { parseUrlForNavigation } from '../client/utils';

const BASE_URL = 'https://example.com';

describe('parseUrlForNavigation', () => {
it('parses pathname only', () => {
const result = parseUrlForNavigation('/sign-in', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('parses pathname with query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: undefined,
});
});

it('parses pathname with multiple query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com&foo=bar', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com', foo: 'bar' },
hash: undefined,
});
});

it('parses pathname with hash', () => {
const result = parseUrlForNavigation('/sign-in#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: 'section',
});
});

it('parses pathname with query parameters and hash', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: 'section',
});
});

it('handles encoded query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https%3A%2F%2Fexample.com%2Fpath', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com/path' },
hash: undefined,
});
});

it('handles root path', () => {
const result = parseUrlForNavigation('/', BASE_URL);
expect(result).toEqual({
to: '/',
search: undefined,
hash: undefined,
});
});

it('handles nested paths', () => {
const result = parseUrlForNavigation('/auth/sign-in?foo=bar', BASE_URL);
expect(result).toEqual({
to: '/auth/sign-in',
search: { foo: 'bar' },
hash: undefined,
});
});

it('handles empty hash', () => {
const result = parseUrlForNavigation('/sign-in#', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('handles complex satellite redirect URL', () => {
const result = parseUrlForNavigation(
'/sign-in?redirect_url=https%3A%2F%2Fsatellite.example.com%2Fdashboard&sign_in_force_redirect_url=https%3A%2F%2Fmain.example.com',
BASE_URL,
);
expect(result).toEqual({
to: '/sign-in',
search: {
redirect_url: 'https://satellite.example.com/dashboard',
sign_in_force_redirect_url: 'https://main.example.com',
},
hash: undefined,
});
});

it('handles hash that looks like a path with query params (PathRouter format)', () => {
// This is what PathRouter converts from: /sign-in#/?redirect_url=...
// After mergeFragmentIntoUrl, it becomes: /sign-in?redirect_url=...
// We should correctly handle both formats
const result = parseUrlForNavigation('/sign-in?redirect_url=https://satellite.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://satellite.com' },
hash: undefined,
});
});
});
28 changes: 17 additions & 11 deletions packages/tanstack-react-start/src/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import { isClient } from '../utils';
import { ClerkOptionsProvider } from './OptionsContext';
import type { TanstackStartClerkProviderProps } from './types';
import { useAwaitableNavigate } from './useAwaitableNavigate';
import { mergeWithPublicEnvs, pickFromClerkInitState } from './utils';
import { mergeWithPublicEnvs, parseUrlForNavigation, pickFromClerkInitState } from './utils';

export * from '@clerk/react';

Expand DownExpand Up@@ -57,18 +57,24 @@ export function ClerkProvider<TUi extends Ui = Ui>({
<ReactClerkProvider
initialState={clerkSsrState}
sdkMetadata={SDK_METADATA}
routerPush={(to: string) =>
awaitableNavigateRef.current?.({
to,
routerPush={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: false,
})
}
routerReplace={(to: string) =>
awaitableNavigateRef.current?.({
to,
});
}}
routerReplace={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: true,
})
}
});
}}
{...mergedProps}
{...keylessProps}
>
Expand Down
11 changes: 10 additions & 1 deletion packages/tanstack-react-start/src/client/uiComponents.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
import { useRoutingProps } from '@clerk/react/internal';
import type { OrganizationProfileProps, SignInProps, SignUpProps, UserProfileProps } from '@clerk/shared/types';
import { useLocation, useParams } from '@tanstack/react-router';
import { useRef } from 'react';

const usePathnameWithoutSplatRouteParams = () => {
const { _splat } = useParams({
Expand All@@ -24,7 +25,15 @@ const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When TanStack Router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};

// The assignment of UserProfile with BaseUserProfile props is used
Expand Down
21 changes: 21 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,24 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
};
};

export type ParsedNavigationUrl = {
to: string;
search?: Record<string, string>;
hash?: string;
};

/**
* Parses a URL string into TanStack Router navigation options.
* TanStack Router doesn't parse query strings from the `to` parameter,
* so we need to extract pathname, search params, and hash separately.
*/
export function parseUrlForNavigation(to: string, baseUrl: string): ParsedNavigationUrl {
const url = new URL(to, baseUrl);
const searchParams = Object.fromEntries(url.searchParams);
return {
to: url.pathname,
search: Object.keys(searchParams).length > 0 ? searchParams : undefined,
hash: url.hash ? url.hash.slice(1) : undefined,
};
}
, '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-tanstack-navigation-query-params.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/tanstack-react-start': patch
---

Fix navigation with query parameters in TanStack Start apps. Previously, URLs with query parameters (e.g., `/sign-in?redirect_url=...`) would cause "Not Found" errors because TanStack Router doesn't parse query strings from the `to` parameter. The fix properly separates pathname, search params, and hash when calling TanStack Router's navigate function.
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { useRef } from 'react';
import { useLocation, useParams } from 'react-router';

export const usePathnameWithoutSplatRouteParams = () => {
Expand All@@ -14,5 +15,13 @@ export const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When the router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
import { parseUrlForNavigation } from '../client/utils';

const BASE_URL = 'https://example.com';

describe('parseUrlForNavigation', () => {
it('parses pathname only', () => {
const result = parseUrlForNavigation('/sign-in', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('parses pathname with query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: undefined,
});
});

it('parses pathname with multiple query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com&foo=bar', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com', foo: 'bar' },
hash: undefined,
});
});

it('parses pathname with hash', () => {
const result = parseUrlForNavigation('/sign-in#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: 'section',
});
});

it('parses pathname with query parameters and hash', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: 'section',
});
});

it('handles encoded query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https%3A%2F%2Fexample.com%2Fpath', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com/path' },
hash: undefined,
});
});

it('handles root path', () => {
const result = parseUrlForNavigation('/', BASE_URL);
expect(result).toEqual({
to: '/',
search: undefined,
hash: undefined,
});
});

it('handles nested paths', () => {
const result = parseUrlForNavigation('/auth/sign-in?foo=bar', BASE_URL);
expect(result).toEqual({
to: '/auth/sign-in',
search: { foo: 'bar' },
hash: undefined,
});
});

it('handles empty hash', () => {
const result = parseUrlForNavigation('/sign-in#', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('handles complex satellite redirect URL', () => {
const result = parseUrlForNavigation(
'/sign-in?redirect_url=https%3A%2F%2Fsatellite.example.com%2Fdashboard&sign_in_force_redirect_url=https%3A%2F%2Fmain.example.com',
BASE_URL,
);
expect(result).toEqual({
to: '/sign-in',
search: {
redirect_url: 'https://satellite.example.com/dashboard',
sign_in_force_redirect_url: 'https://main.example.com',
},
hash: undefined,
});
});

it('handles hash that looks like a path with query params (PathRouter format)', () => {
// This is what PathRouter converts from: /sign-in#/?redirect_url=...
// After mergeFragmentIntoUrl, it becomes: /sign-in?redirect_url=...
// We should correctly handle both formats
const result = parseUrlForNavigation('/sign-in?redirect_url=https://satellite.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://satellite.com' },
hash: undefined,
});
});
});
28 changes: 17 additions & 11 deletions packages/tanstack-react-start/src/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import { isClient } from '../utils';
import { ClerkOptionsProvider } from './OptionsContext';
import type { TanstackStartClerkProviderProps } from './types';
import { useAwaitableNavigate } from './useAwaitableNavigate';
import { mergeWithPublicEnvs, pickFromClerkInitState } from './utils';
import { mergeWithPublicEnvs, parseUrlForNavigation, pickFromClerkInitState } from './utils';

export * from '@clerk/react';

Expand DownExpand Up@@ -57,18 +57,24 @@ export function ClerkProvider<TUi extends Ui = Ui>({
<ReactClerkProvider
initialState={clerkSsrState}
sdkMetadata={SDK_METADATA}
routerPush={(to: string) =>
awaitableNavigateRef.current?.({
to,
routerPush={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: false,
})
}
routerReplace={(to: string) =>
awaitableNavigateRef.current?.({
to,
});
}}
routerReplace={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: true,
})
}
});
}}
{...mergedProps}
{...keylessProps}
>
Expand Down
11 changes: 10 additions & 1 deletion packages/tanstack-react-start/src/client/uiComponents.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
import { useRoutingProps } from '@clerk/react/internal';
import type { OrganizationProfileProps, SignInProps, SignUpProps, UserProfileProps } from '@clerk/shared/types';
import { useLocation, useParams } from '@tanstack/react-router';
import { useRef } from 'react';

const usePathnameWithoutSplatRouteParams = () => {
const { _splat } = useParams({
Expand All@@ -24,7 +25,15 @@ const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When TanStack Router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};

// The assignment of UserProfile with BaseUserProfile props is used
Expand Down
21 changes: 21 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,24 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
};
};

export type ParsedNavigationUrl = {
to: string;
search?: Record<string, string>;
hash?: string;
};

/**
* Parses a URL string into TanStack Router navigation options.
* TanStack Router doesn't parse query strings from the `to` parameter,
* so we need to extract pathname, search params, and hash separately.
*/
export function parseUrlForNavigation(to: string, baseUrl: string): ParsedNavigationUrl {
const url = new URL(to, baseUrl);
const searchParams = Object.fromEntries(url.searchParams);
return {
to: url.pathname,
search: Object.keys(searchParams).length > 0 ? searchParams : undefined,
hash: url.hash ? url.hash.slice(1) : undefined,
};
}
, '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-tanstack-navigation-query-params.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/tanstack-react-start': patch
---

Fix navigation with query parameters in TanStack Start apps. Previously, URLs with query parameters (e.g., `/sign-in?redirect_url=...`) would cause "Not Found" errors because TanStack Router doesn't parse query strings from the `to` parameter. The fix properly separates pathname, search params, and hash when calling TanStack Router's navigate function.
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { useRef } from 'react';
import { useLocation, useParams } from 'react-router';

export const usePathnameWithoutSplatRouteParams = () => {
Expand All@@ -14,5 +15,13 @@ export const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When the router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
import { parseUrlForNavigation } from '../client/utils';

const BASE_URL = 'https://example.com';

describe('parseUrlForNavigation', () => {
it('parses pathname only', () => {
const result = parseUrlForNavigation('/sign-in', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('parses pathname with query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: undefined,
});
});

it('parses pathname with multiple query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com&foo=bar', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com', foo: 'bar' },
hash: undefined,
});
});

it('parses pathname with hash', () => {
const result = parseUrlForNavigation('/sign-in#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: 'section',
});
});

it('parses pathname with query parameters and hash', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: 'section',
});
});

it('handles encoded query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https%3A%2F%2Fexample.com%2Fpath', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com/path' },
hash: undefined,
});
});

it('handles root path', () => {
const result = parseUrlForNavigation('/', BASE_URL);
expect(result).toEqual({
to: '/',
search: undefined,
hash: undefined,
});
});

it('handles nested paths', () => {
const result = parseUrlForNavigation('/auth/sign-in?foo=bar', BASE_URL);
expect(result).toEqual({
to: '/auth/sign-in',
search: { foo: 'bar' },
hash: undefined,
});
});

it('handles empty hash', () => {
const result = parseUrlForNavigation('/sign-in#', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('handles complex satellite redirect URL', () => {
const result = parseUrlForNavigation(
'/sign-in?redirect_url=https%3A%2F%2Fsatellite.example.com%2Fdashboard&sign_in_force_redirect_url=https%3A%2F%2Fmain.example.com',
BASE_URL,
);
expect(result).toEqual({
to: '/sign-in',
search: {
redirect_url: 'https://satellite.example.com/dashboard',
sign_in_force_redirect_url: 'https://main.example.com',
},
hash: undefined,
});
});

it('handles hash that looks like a path with query params (PathRouter format)', () => {
// This is what PathRouter converts from: /sign-in#/?redirect_url=...
// After mergeFragmentIntoUrl, it becomes: /sign-in?redirect_url=...
// We should correctly handle both formats
const result = parseUrlForNavigation('/sign-in?redirect_url=https://satellite.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://satellite.com' },
hash: undefined,
});
});
});
28 changes: 17 additions & 11 deletions packages/tanstack-react-start/src/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import { isClient } from '../utils';
import { ClerkOptionsProvider } from './OptionsContext';
import type { TanstackStartClerkProviderProps } from './types';
import { useAwaitableNavigate } from './useAwaitableNavigate';
import { mergeWithPublicEnvs, pickFromClerkInitState } from './utils';
import { mergeWithPublicEnvs, parseUrlForNavigation, pickFromClerkInitState } from './utils';

export * from '@clerk/react';

Expand DownExpand Up@@ -57,18 +57,24 @@ export function ClerkProvider<TUi extends Ui = Ui>({
<ReactClerkProvider
initialState={clerkSsrState}
sdkMetadata={SDK_METADATA}
routerPush={(to: string) =>
awaitableNavigateRef.current?.({
to,
routerPush={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: false,
})
}
routerReplace={(to: string) =>
awaitableNavigateRef.current?.({
to,
});
}}
routerReplace={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: true,
})
}
});
}}
{...mergedProps}
{...keylessProps}
>
Expand Down
11 changes: 10 additions & 1 deletion packages/tanstack-react-start/src/client/uiComponents.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
import { useRoutingProps } from '@clerk/react/internal';
import type { OrganizationProfileProps, SignInProps, SignUpProps, UserProfileProps } from '@clerk/shared/types';
import { useLocation, useParams } from '@tanstack/react-router';
import { useRef } from 'react';

const usePathnameWithoutSplatRouteParams = () => {
const { _splat } = useParams({
Expand All@@ -24,7 +25,15 @@ const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When TanStack Router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};

// The assignment of UserProfile with BaseUserProfile props is used
Expand Down
21 changes: 21 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,24 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
};
};

export type ParsedNavigationUrl = {
to: string;
search?: Record<string, string>;
hash?: string;
};

/**
* Parses a URL string into TanStack Router navigation options.
* TanStack Router doesn't parse query strings from the `to` parameter,
* so we need to extract pathname, search params, and hash separately.
*/
export function parseUrlForNavigation(to: string, baseUrl: string): ParsedNavigationUrl {
const url = new URL(to, baseUrl);
const searchParams = Object.fromEntries(url.searchParams);
return {
to: url.pathname,
search: Object.keys(searchParams).length > 0 ? searchParams : undefined,
hash: url.hash ? url.hash.slice(1) : undefined,
};
}
, '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-tanstack-navigation-query-params.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/tanstack-react-start': patch
---

Fix navigation with query parameters in TanStack Start apps. Previously, URLs with query parameters (e.g., `/sign-in?redirect_url=...`) would cause "Not Found" errors because TanStack Router doesn't parse query strings from the `to` parameter. The fix properly separates pathname, search params, and hash when calling TanStack Router's navigate function.
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { useRef } from 'react';
import { useLocation, useParams } from 'react-router';

export const usePathnameWithoutSplatRouteParams = () => {
Expand All@@ -14,5 +15,13 @@ export const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When the router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
import { parseUrlForNavigation } from '../client/utils';

const BASE_URL = 'https://example.com';

describe('parseUrlForNavigation', () => {
it('parses pathname only', () => {
const result = parseUrlForNavigation('/sign-in', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('parses pathname with query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: undefined,
});
});

it('parses pathname with multiple query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com&foo=bar', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com', foo: 'bar' },
hash: undefined,
});
});

it('parses pathname with hash', () => {
const result = parseUrlForNavigation('/sign-in#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: 'section',
});
});

it('parses pathname with query parameters and hash', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: 'section',
});
});

it('handles encoded query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https%3A%2F%2Fexample.com%2Fpath', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com/path' },
hash: undefined,
});
});

it('handles root path', () => {
const result = parseUrlForNavigation('/', BASE_URL);
expect(result).toEqual({
to: '/',
search: undefined,
hash: undefined,
});
});

it('handles nested paths', () => {
const result = parseUrlForNavigation('/auth/sign-in?foo=bar', BASE_URL);
expect(result).toEqual({
to: '/auth/sign-in',
search: { foo: 'bar' },
hash: undefined,
});
});

it('handles empty hash', () => {
const result = parseUrlForNavigation('/sign-in#', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('handles complex satellite redirect URL', () => {
const result = parseUrlForNavigation(
'/sign-in?redirect_url=https%3A%2F%2Fsatellite.example.com%2Fdashboard&sign_in_force_redirect_url=https%3A%2F%2Fmain.example.com',
BASE_URL,
);
expect(result).toEqual({
to: '/sign-in',
search: {
redirect_url: 'https://satellite.example.com/dashboard',
sign_in_force_redirect_url: 'https://main.example.com',
},
hash: undefined,
});
});

it('handles hash that looks like a path with query params (PathRouter format)', () => {
// This is what PathRouter converts from: /sign-in#/?redirect_url=...
// After mergeFragmentIntoUrl, it becomes: /sign-in?redirect_url=...
// We should correctly handle both formats
const result = parseUrlForNavigation('/sign-in?redirect_url=https://satellite.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://satellite.com' },
hash: undefined,
});
});
});
28 changes: 17 additions & 11 deletions packages/tanstack-react-start/src/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import { isClient } from '../utils';
import { ClerkOptionsProvider } from './OptionsContext';
import type { TanstackStartClerkProviderProps } from './types';
import { useAwaitableNavigate } from './useAwaitableNavigate';
import { mergeWithPublicEnvs, pickFromClerkInitState } from './utils';
import { mergeWithPublicEnvs, parseUrlForNavigation, pickFromClerkInitState } from './utils';

export * from '@clerk/react';

Expand DownExpand Up@@ -57,18 +57,24 @@ export function ClerkProvider<TUi extends Ui = Ui>({
<ReactClerkProvider
initialState={clerkSsrState}
sdkMetadata={SDK_METADATA}
routerPush={(to: string) =>
awaitableNavigateRef.current?.({
to,
routerPush={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: false,
})
}
routerReplace={(to: string) =>
awaitableNavigateRef.current?.({
to,
});
}}
routerReplace={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: true,
})
}
});
}}
{...mergedProps}
{...keylessProps}
>
Expand Down
11 changes: 10 additions & 1 deletion packages/tanstack-react-start/src/client/uiComponents.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
import { useRoutingProps } from '@clerk/react/internal';
import type { OrganizationProfileProps, SignInProps, SignUpProps, UserProfileProps } from '@clerk/shared/types';
import { useLocation, useParams } from '@tanstack/react-router';
import { useRef } from 'react';

const usePathnameWithoutSplatRouteParams = () => {
const { _splat } = useParams({
Expand All@@ -24,7 +25,15 @@ const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When TanStack Router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};

// The assignment of UserProfile with BaseUserProfile props is used
Expand Down
21 changes: 21 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,24 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
};
};

export type ParsedNavigationUrl = {
to: string;
search?: Record<string, string>;
hash?: string;
};

/**
* Parses a URL string into TanStack Router navigation options.
* TanStack Router doesn't parse query strings from the `to` parameter,
* so we need to extract pathname, search params, and hash separately.
*/
export function parseUrlForNavigation(to: string, baseUrl: string): ParsedNavigationUrl {
const url = new URL(to, baseUrl);
const searchParams = Object.fromEntries(url.searchParams);
return {
to: url.pathname,
search: Object.keys(searchParams).length > 0 ? searchParams : undefined,
hash: url.hash ? url.hash.slice(1) : undefined,
};
}
, '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-tanstack-navigation-query-params.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/tanstack-react-start': patch
---

Fix navigation with query parameters in TanStack Start apps. Previously, URLs with query parameters (e.g., `/sign-in?redirect_url=...`) would cause "Not Found" errors because TanStack Router doesn't parse query strings from the `to` parameter. The fix properly separates pathname, search params, and hash when calling TanStack Router's navigate function.
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { useRef } from 'react';
import { useLocation, useParams } from 'react-router';

export const usePathnameWithoutSplatRouteParams = () => {
Expand All@@ -14,5 +15,13 @@ export const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When the router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
import { parseUrlForNavigation } from '../client/utils';

const BASE_URL = 'https://example.com';

describe('parseUrlForNavigation', () => {
it('parses pathname only', () => {
const result = parseUrlForNavigation('/sign-in', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('parses pathname with query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: undefined,
});
});

it('parses pathname with multiple query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com&foo=bar', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com', foo: 'bar' },
hash: undefined,
});
});

it('parses pathname with hash', () => {
const result = parseUrlForNavigation('/sign-in#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: 'section',
});
});

it('parses pathname with query parameters and hash', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https://example.com#section', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com' },
hash: 'section',
});
});

it('handles encoded query parameters', () => {
const result = parseUrlForNavigation('/sign-in?redirect_url=https%3A%2F%2Fexample.com%2Fpath', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://example.com/path' },
hash: undefined,
});
});

it('handles root path', () => {
const result = parseUrlForNavigation('/', BASE_URL);
expect(result).toEqual({
to: '/',
search: undefined,
hash: undefined,
});
});

it('handles nested paths', () => {
const result = parseUrlForNavigation('/auth/sign-in?foo=bar', BASE_URL);
expect(result).toEqual({
to: '/auth/sign-in',
search: { foo: 'bar' },
hash: undefined,
});
});

it('handles empty hash', () => {
const result = parseUrlForNavigation('/sign-in#', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: undefined,
hash: undefined,
});
});

it('handles complex satellite redirect URL', () => {
const result = parseUrlForNavigation(
'/sign-in?redirect_url=https%3A%2F%2Fsatellite.example.com%2Fdashboard&sign_in_force_redirect_url=https%3A%2F%2Fmain.example.com',
BASE_URL,
);
expect(result).toEqual({
to: '/sign-in',
search: {
redirect_url: 'https://satellite.example.com/dashboard',
sign_in_force_redirect_url: 'https://main.example.com',
},
hash: undefined,
});
});

it('handles hash that looks like a path with query params (PathRouter format)', () => {
// This is what PathRouter converts from: /sign-in#/?redirect_url=...
// After mergeFragmentIntoUrl, it becomes: /sign-in?redirect_url=...
// We should correctly handle both formats
const result = parseUrlForNavigation('/sign-in?redirect_url=https://satellite.com', BASE_URL);
expect(result).toEqual({
to: '/sign-in',
search: { redirect_url: 'https://satellite.com' },
hash: undefined,
});
});
});
28 changes: 17 additions & 11 deletions packages/tanstack-react-start/src/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ import { isClient } from '../utils';
import { ClerkOptionsProvider } from './OptionsContext';
import type { TanstackStartClerkProviderProps } from './types';
import { useAwaitableNavigate } from './useAwaitableNavigate';
import { mergeWithPublicEnvs, pickFromClerkInitState } from './utils';
import { mergeWithPublicEnvs, parseUrlForNavigation, pickFromClerkInitState } from './utils';

export * from '@clerk/react';

Expand DownExpand Up@@ -57,18 +57,24 @@ export function ClerkProvider<TUi extends Ui = Ui>({
<ReactClerkProvider
initialState={clerkSsrState}
sdkMetadata={SDK_METADATA}
routerPush={(to: string) =>
awaitableNavigateRef.current?.({
to,
routerPush={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: false,
})
}
routerReplace={(to: string) =>
awaitableNavigateRef.current?.({
to,
});
}}
routerReplace={(to: string) => {
const { search, hash, ...rest } = parseUrlForNavigation(to, window.location.origin);
return awaitableNavigateRef.current?.({
...rest,
search: search as any,
hash,
replace: true,
})
}
});
}}
{...mergedProps}
{...keylessProps}
>
Expand Down
11 changes: 10 additions & 1 deletion packages/tanstack-react-start/src/client/uiComponents.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
import { useRoutingProps } from '@clerk/react/internal';
import type { OrganizationProfileProps, SignInProps, SignUpProps, UserProfileProps } from '@clerk/shared/types';
import { useLocation, useParams } from '@tanstack/react-router';
import { useRef } from 'react';

const usePathnameWithoutSplatRouteParams = () => {
const { _splat } = useParams({
Expand All@@ -24,7 +25,15 @@ const usePathnameWithoutSplatRouteParams = () => {
// eg /user/123/profile/security will return /user/123/profile as the path
const path = pathname.replace(splatRouteParam, '').replace(/\/$/, '').replace(/^\//, '').trim();

return `/${path}`;
const computedPath = `/${path}`;

// Stabilize the base path to prevent race conditions during navigation away.
// When TanStack Router navigates to a different route, useLocation() returns the
// new pathname before this component unmounts. This causes the basePath to change,
// which makes the SignIn/SignUp catch-all route fire RedirectToSignIn incorrectly.
// Matches the pattern used in @clerk/nextjs usePathnameWithoutCatchAll.
const stablePath = useRef(computedPath);
return stablePath.current;
};

// The assignment of UserProfile with BaseUserProfile props is used
Expand Down
21 changes: 21 additions & 0 deletions packages/tanstack-react-start/src/client/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,24 @@ export const mergeWithPublicEnvs = (restInitState: any) => {
prefetchUI: restInitState.prefetchUI ?? envVars.prefetchUI,
};
};

export type ParsedNavigationUrl = {
to: string;
search?: Record<string, string>;
hash?: string;
};

/**
* Parses a URL string into TanStack Router navigation options.
* TanStack Router doesn't parse query strings from the `to` parameter,
* so we need to extract pathname, search params, and hash separately.
*/
export function parseUrlForNavigation(to: string, baseUrl: string): ParsedNavigationUrl {
const url = new URL(to, baseUrl);
const searchParams = Object.fromEntries(url.searchParams);
return {
to: url.pathname,
search: Object.keys(searchParams).length > 0 ? searchParams : undefined,
hash: url.hash ? url.hash.slice(1) : undefined,
};
}