fix(tanstack-react-start): Handle serialization issue when doing handshake#6345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikosdouvlis merged 8 commits into from
Jul 18, 2025
Merged

fix(tanstack-react-start): Handle serialization issue when doing handshake #6345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0f0a367
chore(tanstack-react-start): Fix serialization issues with handshake
wobsoriano Jul 17, 2025
4ce9edb
chore: add changeset
wobsoriano Jul 17, 2025
4cc7c3d
chore: add getAuth tests
wobsoriano Jul 17, 2025
5bdf2a4
chore: set minimum version to 1.127.0
wobsoriano Jul 17, 2025
edee388
Merge branch 'main' into rob/user-2383-tanstack-serialization-response
wobsoriano Jul 17, 2025
ce72d49
chore: update changeset
wobsoriano Jul 17, 2025
db0666c
chore: reinstall deps
wobsoriano Jul 17, 2025
f813e9f
chore: reinstall deps
wobsoriano Jul 17, 2025
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
6 changes: 6 additions & 0 deletions .changeset/fifty-buses-fix.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/tanstack-react-start': minor
---

- Fixes serialization errors during handshake
- Bump `@tanstack/react-start` and `@tanstack/react-router` peer dependency to 1.127.0
6 changes: 3 additions & 3 deletions integration/templates/tanstack-react-router/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,9 +9,9 @@
"start": "vite"
},
"dependencies": {
"@tanstack/react-router": "^1.121.27",
"@tanstack/react-router-devtools": "^1.121.27",
"@tanstack/router-plugin": "^1.121.27",
"@tanstack/react-router": "^1.128.0",
"@tanstack/react-router-devtools": "^1.128.0",
"@tanstack/router-plugin": "^1.128.0",
"react": "18.3.1",
"react-dom": "18.3.1"
},
Expand Down
6 changes: 3 additions & 3 deletions integration/templates/tanstack-react-start/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
"start": "vite start --port=$PORT"
},
"dependencies": {
"@tanstack/react-router": "^1.121.27",
"@tanstack/react-router-devtools": "^1.121.27",
"@tanstack/react-start": "^1.121.28",
"@tanstack/react-router": "^1.128.0",
"@tanstack/react-router-devtools": "^1.128.0",
"@tanstack/react-start": "^1.128.0",
"react": "18.3.1",
"react-dom": "18.3.1",
"tailwind-merge": "^2.5.4"
Expand Down
29 changes: 29 additions & 0 deletions integration/templates/tanstack-react-start/src/routes/user.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { createFileRoute, redirect } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { getAuth } from '@clerk/tanstack-react-start/server';
import { getWebRequest } from '@tanstack/react-start/server';

const fetchClerkAuth = createServerFn({ method: 'GET' }).handler(async () => {
const request = getWebRequest();
if (!request) throw new Error('No request found');

const { userId } = await getAuth(request);

return {
userId,
};
});

export const Route = createFileRoute('/')({
component: Page,
beforeLoad: async () => await fetchClerkAuth(),
loader: async ({ context }) => {
return { userId: context.userId };
},
});
Comment on lines +17 to +23

@coderabbitaicoderabbitaiBotJul 17, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix the route configuration logic.

The route configuration has several critical issues:

  1. Incorrect beforeLoad implementation: The beforeLoad hook should return data that becomes available in the context
  2. Missing error handling: No handling for failed authentication
  3. Type safety: The loader assumes context.userId exists without validation
 export const Route = createFileRoute('/')({
component: Page,
- beforeLoad: async () => await fetchClerkAuth(),+ beforeLoad: async () => {+ const authData = await fetchClerkAuth();+ return authData;+ },
loader: async ({ context }) => {
- return { userId: context.userId };+ return { userId: (context as any).userId || null };
},
});
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>awaitfetchClerkAuth(),
loader: async({ context })=>{
return{userId: context.userId};
},
});
exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>{
constauthData=awaitfetchClerkAuth();
returnauthData;
},
loader: async({ context })=>{
return{userId: (contextasany).userId||null};
},
});
🤖 Prompt for AI Agents
In integration/templates/tanstack-react-start/src/routes/user.tsx around lines
17 to 23, fix the route configuration by updating beforeLoad to return the
authentication data so it becomes part of the context, add error handling to
manage failed authentication cases gracefully, and ensure the loader validates
the presence of userId in the context before accessing it to maintain type
safety and avoid runtime errors.


function Page() {
const state = Route.useLoaderData();

return state.userId ? <h1>Welcome! Your ID is {state.userId}!</h1> : <h1>You are not signed in</h1>;
}
23 changes: 22 additions & 1 deletion integration/tests/tanstack-start/basic.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { User } from '@clerk/backend';
import { expect, test } from '@playwright/test';

import { appConfigs } from '../../presets';
Expand All@@ -16,6 +17,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
test.describe.configure({ mode: 'parallel' });

let fakeUser: FakeUser;
let bapiUser: User;

test.beforeAll(async () => {
const u = createTestUtils({ app });
Expand All@@ -24,7 +26,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
withPhoneNumber: true,
withUsername: true,
});
await u.services.users.createBapiUser(fakeUser);
bapiUser = await u.services.users.createBapiUser(fakeUser);
});

test.afterAll(async () => {
Expand DownExpand Up@@ -72,6 +74,25 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
expect(clerkInitialState !== undefined).toBeTruthy();
});

test('retrieve auth state in server functions', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

await u.page.goToRelative('/user');

await expect(u.page.getByText('You are not signed in')).toBeVisible();

await u.po.signIn.goTo();

await u.po.signIn.setIdentifier(fakeUser.email);
await u.po.signIn.setPassword(fakeUser.password);
await u.po.signIn.continue();
await u.po.expect.toBeSignedIn();

await u.page.goToRelative('/user');

await expect(u.page.getByText(`Welcome! Your ID is ${bapiUser.id}!`)).toBeVisible();
});

test('clerk handler sets headers', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const r = await u.po.signIn.goTo();
Expand Down
8 changes: 4 additions & 4 deletions packages/tanstack-react-start/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,13 +74,13 @@
"tslib": "catalog:repo"
},
"devDependencies": {
"@tanstack/react-router": "^1.121.41",
"@tanstack/react-start": "^1.121.41",
"@tanstack/react-router": "^1.127.0",
"@tanstack/react-start": "^1.127.0",
"esbuild-plugin-file-path-extensions": "^2.1.4"
},
"peerDependencies": {
"@tanstack/react-router": "^1.121.0",
"@tanstack/react-start": "^1.121.0",
"@tanstack/react-router": "^1.127.0",
"@tanstack/react-start": "^1.127.0",
"react": "catalog:peer-react",
"react-dom": "catalog:peer-react"
},
Expand Down
5 changes: 3 additions & 2 deletions packages/tanstack-react-start/src/server/authenticateRequest.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { AuthStatus, constants } from '@clerk/backend/internal';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';

import { errorThrower } from '../utils';
import { ClerkHandshakeRedirect } from './errors';
import { patchRequest } from './utils';

export async function authenticateRequest(
Expand DownExpand Up@@ -41,9 +42,9 @@ export async function authenticateRequest(
requestStateHeaders: requestState.headers,
publishableKey: requestState.publishableKey,
});

// triggering a handshake redirect
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw new Response(null, { status: 307, headers: requestState.headers });
throw new ClerkHandshakeRedirect(307, requestState.headers);
}

if (requestState.status === AuthStatus.Handshake) {
Expand Down
11 changes: 11 additions & 0 deletions packages/tanstack-react-start/src/server/errors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
export class ClerkHandshakeRedirect extends Error {
constructor(
public status: number,
public headers: Headers,
) {
super('Clerk handshake redirect required');
this.name = 'ClerkHandshakeRedirect';
this.status = status;
this.headers = headers;
}
}
8 changes: 6 additions & 2 deletions packages/tanstack-react-start/src/server/middlewareHandler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { AnyRouter } from '@tanstack/react-router';
import type { CustomizeStartHandler, HandlerCallback, RequestHandler } from '@tanstack/react-start/server';

import { authenticateRequest } from './authenticateRequest';
import { ClerkHandshakeRedirect } from './errors';
import { loadOptions } from './loadOptions';
import type { LoaderOptions } from './types';
import { getResponseClerkState } from './utils';
Expand DownExpand Up@@ -33,9 +34,12 @@ export function createClerkHandler<TRouter extends AnyRouter>(

await router.load();
} catch (error) {
if (error instanceof Response) {
if (error instanceof ClerkHandshakeRedirect) {
// returning the response
return error;
return new Response(null, {
status: error.status,
headers: error.headers,
});
}

// rethrowing the error if it is not a Response
Expand Down
Loading
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
fix(tanstack-react-start): Handle serialization issue when doing handshake#6345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 8 commits into

from

Jul 18, 2025
 Merged


fix(tanstack-react-start): Handle serialization issue when doing handshake
#6345
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0f0a367

chore(tanstack-react-start): Fix serialization issues with handshake


wobsoriano Jul 17, 2025
4ce9edb

chore: add changeset


wobsoriano Jul 17, 2025
4cc7c3d

chore: add getAuth tests


wobsoriano Jul 17, 2025
5bdf2a4

chore: set minimum version to 1.127.0


wobsoriano Jul 17, 2025
edee388

Merge branch 'main' into rob/user-2383-tanstack-serialization-response


wobsoriano Jul 17, 2025
ce72d49

chore: update changeset


wobsoriano Jul 17, 2025
db0666c

chore: reinstall deps


wobsoriano Jul 17, 2025
f813e9f

chore: reinstall deps


wobsoriano Jul 17, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/fifty-buses-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/tanstack-react-start': minor
---

- Fixes serialization errors during handshake
- Bump `@tanstack/react-start` and `@tanstack/react-router` peer dependency to 1.127.0

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-router/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,9 +9,9 @@
 "start": "vite"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/router-plugin": "^1.121.27",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/router-plugin": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1"
 },
Expand Down

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 "start": "vite start --port=$PORT"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/react-start": "^1.121.28",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/react-start": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1",
 "tailwind-merge": "^2.5.4"
Expand Down

29 changes: 29 additions & 0 deletions
integration/templates/tanstack-react-start/src/routes/user.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { createFileRoute, redirect } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { getAuth } from '@clerk/tanstack-react-start/server';
import { getWebRequest } from '@tanstack/react-start/server';

const fetchClerkAuth = createServerFn({ method: 'GET' }).handler(async () => {
 const request = getWebRequest();
 if (!request) throw new Error('No request found');

 const { userId } = await getAuth(request);

 return {
 userId,
 };
});

export const Route = createFileRoute('/')({
 component: Page,
 beforeLoad: async () => await fetchClerkAuth(),
 loader: async ({ context }) => {
 return { userId: context.userId };
 },
});

Comment on lines

+17
 to 
+23

@coderabbitaicoderabbitaiBotJul 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

⚠️ Potential issue
Fix the route configuration logic.
The route configuration has several critical issues:
  1. Incorrect beforeLoad implementation: The beforeLoad hook should return data that becomes available in the context
  2. Missing error handling: No handling for failed authentication
  3. Type safety: The loader assumes context.userId exists without validation
 export const Route = createFileRoute('/')({
component: Page,
- beforeLoad: async () => await fetchClerkAuth(),+ beforeLoad: async () => {+ const authData = await fetchClerkAuth();+ return authData;+ },
loader: async ({ context }) => {
- return { userId: context.userId };+ return { userId: (context as any).userId || null };
},
});
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>awaitfetchClerkAuth(),
loader: async({ context })=>{
return{userId: context.userId};
},
});
exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>{
constauthData=awaitfetchClerkAuth();
returnauthData;
},
loader: async({ context })=>{
return{userId: (contextasany).userId||null};
},
});
🤖 Prompt for AI Agents
In integration/templates/tanstack-react-start/src/routes/user.tsx around lines
17 to 23, fix the route configuration by updating beforeLoad to return the
authentication data so it becomes part of the context, add error handling to
manage failed authentication cases gracefully, and ensure the loader validates
the presence of userId in the context before accessing it to maintain type
safety and avoid runtime errors.


function Page() {
 const state = Route.useLoaderData();

 return state.userId ? <h1>Welcome! Your ID is {state.userId}!</h1> : <h1>You are not signed in</h1>;
}

23 changes: 22 additions & 1 deletion
integration/tests/tanstack-start/basic.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { User } from '@clerk/backend';
import { expect, test } from '@playwright/test';

import { appConfigs } from '../../presets';
Expand All@@ -16,6 +17,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 test.describe.configure({ mode: 'parallel' });

 let fakeUser: FakeUser;
 let bapiUser: User;

 test.beforeAll(async () => {
 const u = createTestUtils({ app });
Expand All@@ -24,7 +26,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 withPhoneNumber: true,
 withUsername: true,
 });
 await u.services.users.createBapiUser(fakeUser);
bapiUser = await u.services.users.createBapiUser(fakeUser);
 });

 test.afterAll(async () => {
Expand DownExpand Up@@ -72,6 +74,25 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 expect(clerkInitialState !== undefined).toBeTruthy();
 });

 test('retrieve auth state in server functions', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });

 await u.page.goToRelative('/user');

 await expect(u.page.getByText('You are not signed in')).toBeVisible();

 await u.po.signIn.goTo();

 await u.po.signIn.setIdentifier(fakeUser.email);
 await u.po.signIn.setPassword(fakeUser.password);
 await u.po.signIn.continue();
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/user');

 await expect(u.page.getByText(`Welcome! Your ID is ${bapiUser.id}!`)).toBeVisible();
 });

 test('clerk handler sets headers', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const r = await u.po.signIn.goTo();
Expand Down

8 changes: 4 additions & 4 deletions
packages/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,13 +74,13 @@
 "tslib": "catalog:repo"
 },
 "devDependencies": {
 "@tanstack/react-router": "^1.121.41",
 "@tanstack/react-start": "^1.121.41",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "esbuild-plugin-file-path-extensions": "^2.1.4"
 },
 "peerDependencies": {
 "@tanstack/react-router": "^1.121.0",
 "@tanstack/react-start": "^1.121.0",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "react": "catalog:peer-react",
 "react-dom": "catalog:peer-react"
 },
Expand Down

5 changes: 3 additions & 2 deletions
packages/tanstack-react-start/src/server/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { AuthStatus, constants } from '@clerk/backend/internal';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';

import { errorThrower } from '../utils';
import { ClerkHandshakeRedirect } from './errors';
import { patchRequest } from './utils';

export async function authenticateRequest(
Expand DownExpand Up@@ -41,9 +42,9 @@ export async function authenticateRequest(
 requestStateHeaders: requestState.headers,
 publishableKey: requestState.publishableKey,
 });

 // triggering a handshake redirect
 // eslint-disable-next-line @typescript-eslint/only-throw-error
 throw new Response(null, { status: 307, headers: requestState.headers });
 throw new ClerkHandshakeRedirect(307, requestState.headers);
 }

 if (requestState.status === AuthStatus.Handshake) {
Expand Down

11 changes: 11 additions & 0 deletions
packages/tanstack-react-start/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
export class ClerkHandshakeRedirect extends Error {
 constructor(
 public status: number,
 public headers: Headers,
 ) {
 super('Clerk handshake redirect required');
 this.name = 'ClerkHandshakeRedirect';
 this.status = status;
 this.headers = headers;
 }
}

8 changes: 6 additions & 2 deletions
packages/tanstack-react-start/src/server/middlewareHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { AnyRouter } from '@tanstack/react-router';
import type { CustomizeStartHandler, HandlerCallback, RequestHandler } from '@tanstack/react-start/server';

import { authenticateRequest } from './authenticateRequest';
import { ClerkHandshakeRedirect } from './errors';
import { loadOptions } from './loadOptions';
import type { LoaderOptions } from './types';
import { getResponseClerkState } from './utils';
Expand DownExpand Up@@ -33,9 +34,12 @@ export function createClerkHandler<TRouter extends AnyRouter>(

 await router.load();
 } catch (error) {
 if (error instanceof Response) {
 if (error instanceof ClerkHandshakeRedirect) {
 // returning the response
 return error;
 return new Response(null, {
 status: error.status,
 headers: error.headers,
 });
 }

 // rethrowing the error if it is not a Response
Expand Down
Loading
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
fix(tanstack-react-start): Handle serialization issue when doing handshake#6345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 8 commits into

from

Jul 18, 2025
 Merged


fix(tanstack-react-start): Handle serialization issue when doing handshake
#6345
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0f0a367

chore(tanstack-react-start): Fix serialization issues with handshake


wobsoriano Jul 17, 2025
4ce9edb

chore: add changeset


wobsoriano Jul 17, 2025
4cc7c3d

chore: add getAuth tests


wobsoriano Jul 17, 2025
5bdf2a4

chore: set minimum version to 1.127.0


wobsoriano Jul 17, 2025
edee388

Merge branch 'main' into rob/user-2383-tanstack-serialization-response


wobsoriano Jul 17, 2025
ce72d49

chore: update changeset


wobsoriano Jul 17, 2025
db0666c

chore: reinstall deps


wobsoriano Jul 17, 2025
f813e9f

chore: reinstall deps


wobsoriano Jul 17, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/fifty-buses-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/tanstack-react-start': minor
---

- Fixes serialization errors during handshake
- Bump `@tanstack/react-start` and `@tanstack/react-router` peer dependency to 1.127.0

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-router/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,9 +9,9 @@
 "start": "vite"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/router-plugin": "^1.121.27",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/router-plugin": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1"
 },
Expand Down

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 "start": "vite start --port=$PORT"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/react-start": "^1.121.28",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/react-start": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1",
 "tailwind-merge": "^2.5.4"
Expand Down

29 changes: 29 additions & 0 deletions
integration/templates/tanstack-react-start/src/routes/user.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { createFileRoute, redirect } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { getAuth } from '@clerk/tanstack-react-start/server';
import { getWebRequest } from '@tanstack/react-start/server';

const fetchClerkAuth = createServerFn({ method: 'GET' }).handler(async () => {
 const request = getWebRequest();
 if (!request) throw new Error('No request found');

 const { userId } = await getAuth(request);

 return {
 userId,
 };
});

export const Route = createFileRoute('/')({
 component: Page,
 beforeLoad: async () => await fetchClerkAuth(),
 loader: async ({ context }) => {
 return { userId: context.userId };
 },
});

Comment on lines

+17
 to 
+23

@coderabbitaicoderabbitaiBotJul 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

⚠️ Potential issue
Fix the route configuration logic.
The route configuration has several critical issues:
  1. Incorrect beforeLoad implementation: The beforeLoad hook should return data that becomes available in the context
  2. Missing error handling: No handling for failed authentication
  3. Type safety: The loader assumes context.userId exists without validation
 export const Route = createFileRoute('/')({
component: Page,
- beforeLoad: async () => await fetchClerkAuth(),+ beforeLoad: async () => {+ const authData = await fetchClerkAuth();+ return authData;+ },
loader: async ({ context }) => {
- return { userId: context.userId };+ return { userId: (context as any).userId || null };
},
});
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>awaitfetchClerkAuth(),
loader: async({ context })=>{
return{userId: context.userId};
},
});
exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>{
constauthData=awaitfetchClerkAuth();
returnauthData;
},
loader: async({ context })=>{
return{userId: (contextasany).userId||null};
},
});
🤖 Prompt for AI Agents
In integration/templates/tanstack-react-start/src/routes/user.tsx around lines
17 to 23, fix the route configuration by updating beforeLoad to return the
authentication data so it becomes part of the context, add error handling to
manage failed authentication cases gracefully, and ensure the loader validates
the presence of userId in the context before accessing it to maintain type
safety and avoid runtime errors.


function Page() {
 const state = Route.useLoaderData();

 return state.userId ? <h1>Welcome! Your ID is {state.userId}!</h1> : <h1>You are not signed in</h1>;
}

23 changes: 22 additions & 1 deletion
integration/tests/tanstack-start/basic.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { User } from '@clerk/backend';
import { expect, test } from '@playwright/test';

import { appConfigs } from '../../presets';
Expand All@@ -16,6 +17,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 test.describe.configure({ mode: 'parallel' });

 let fakeUser: FakeUser;
 let bapiUser: User;

 test.beforeAll(async () => {
 const u = createTestUtils({ app });
Expand All@@ -24,7 +26,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 withPhoneNumber: true,
 withUsername: true,
 });
 await u.services.users.createBapiUser(fakeUser);
bapiUser = await u.services.users.createBapiUser(fakeUser);
 });

 test.afterAll(async () => {
Expand DownExpand Up@@ -72,6 +74,25 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 expect(clerkInitialState !== undefined).toBeTruthy();
 });

 test('retrieve auth state in server functions', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });

 await u.page.goToRelative('/user');

 await expect(u.page.getByText('You are not signed in')).toBeVisible();

 await u.po.signIn.goTo();

 await u.po.signIn.setIdentifier(fakeUser.email);
 await u.po.signIn.setPassword(fakeUser.password);
 await u.po.signIn.continue();
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/user');

 await expect(u.page.getByText(`Welcome! Your ID is ${bapiUser.id}!`)).toBeVisible();
 });

 test('clerk handler sets headers', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const r = await u.po.signIn.goTo();
Expand Down

8 changes: 4 additions & 4 deletions
packages/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,13 +74,13 @@
 "tslib": "catalog:repo"
 },
 "devDependencies": {
 "@tanstack/react-router": "^1.121.41",
 "@tanstack/react-start": "^1.121.41",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "esbuild-plugin-file-path-extensions": "^2.1.4"
 },
 "peerDependencies": {
 "@tanstack/react-router": "^1.121.0",
 "@tanstack/react-start": "^1.121.0",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "react": "catalog:peer-react",
 "react-dom": "catalog:peer-react"
 },
Expand Down

5 changes: 3 additions & 2 deletions
packages/tanstack-react-start/src/server/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { AuthStatus, constants } from '@clerk/backend/internal';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';

import { errorThrower } from '../utils';
import { ClerkHandshakeRedirect } from './errors';
import { patchRequest } from './utils';

export async function authenticateRequest(
Expand DownExpand Up@@ -41,9 +42,9 @@ export async function authenticateRequest(
 requestStateHeaders: requestState.headers,
 publishableKey: requestState.publishableKey,
 });

 // triggering a handshake redirect
 // eslint-disable-next-line @typescript-eslint/only-throw-error
 throw new Response(null, { status: 307, headers: requestState.headers });
 throw new ClerkHandshakeRedirect(307, requestState.headers);
 }

 if (requestState.status === AuthStatus.Handshake) {
Expand Down

11 changes: 11 additions & 0 deletions
packages/tanstack-react-start/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
export class ClerkHandshakeRedirect extends Error {
 constructor(
 public status: number,
 public headers: Headers,
 ) {
 super('Clerk handshake redirect required');
 this.name = 'ClerkHandshakeRedirect';
 this.status = status;
 this.headers = headers;
 }
}

8 changes: 6 additions & 2 deletions
packages/tanstack-react-start/src/server/middlewareHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { AnyRouter } from '@tanstack/react-router';
import type { CustomizeStartHandler, HandlerCallback, RequestHandler } from '@tanstack/react-start/server';

import { authenticateRequest } from './authenticateRequest';
import { ClerkHandshakeRedirect } from './errors';
import { loadOptions } from './loadOptions';
import type { LoaderOptions } from './types';
import { getResponseClerkState } from './utils';
Expand DownExpand Up@@ -33,9 +34,12 @@ export function createClerkHandler<TRouter extends AnyRouter>(

 await router.load();
 } catch (error) {
 if (error instanceof Response) {
 if (error instanceof ClerkHandshakeRedirect) {
 // returning the response
 return error;
 return new Response(null, {
 status: error.status,
 headers: error.headers,
 });
 }

 // rethrowing the error if it is not a Response
Expand Down
Loading
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
fix(tanstack-react-start): Handle serialization issue when doing handshake#6345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 8 commits into

from

Jul 18, 2025
 Merged


fix(tanstack-react-start): Handle serialization issue when doing handshake
#6345
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0f0a367

chore(tanstack-react-start): Fix serialization issues with handshake


wobsoriano Jul 17, 2025
4ce9edb

chore: add changeset


wobsoriano Jul 17, 2025
4cc7c3d

chore: add getAuth tests


wobsoriano Jul 17, 2025
5bdf2a4

chore: set minimum version to 1.127.0


wobsoriano Jul 17, 2025
edee388

Merge branch 'main' into rob/user-2383-tanstack-serialization-response


wobsoriano Jul 17, 2025
ce72d49

chore: update changeset


wobsoriano Jul 17, 2025
db0666c

chore: reinstall deps


wobsoriano Jul 17, 2025
f813e9f

chore: reinstall deps


wobsoriano Jul 17, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/fifty-buses-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/tanstack-react-start': minor
---

- Fixes serialization errors during handshake
- Bump `@tanstack/react-start` and `@tanstack/react-router` peer dependency to 1.127.0

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-router/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,9 +9,9 @@
 "start": "vite"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/router-plugin": "^1.121.27",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/router-plugin": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1"
 },
Expand Down

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 "start": "vite start --port=$PORT"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/react-start": "^1.121.28",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/react-start": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1",
 "tailwind-merge": "^2.5.4"
Expand Down

29 changes: 29 additions & 0 deletions
integration/templates/tanstack-react-start/src/routes/user.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { createFileRoute, redirect } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { getAuth } from '@clerk/tanstack-react-start/server';
import { getWebRequest } from '@tanstack/react-start/server';

const fetchClerkAuth = createServerFn({ method: 'GET' }).handler(async () => {
 const request = getWebRequest();
 if (!request) throw new Error('No request found');

 const { userId } = await getAuth(request);

 return {
 userId,
 };
});

export const Route = createFileRoute('/')({
 component: Page,
 beforeLoad: async () => await fetchClerkAuth(),
 loader: async ({ context }) => {
 return { userId: context.userId };
 },
});

Comment on lines

+17
 to 
+23

@coderabbitaicoderabbitaiBotJul 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

⚠️ Potential issue
Fix the route configuration logic.
The route configuration has several critical issues:
  1. Incorrect beforeLoad implementation: The beforeLoad hook should return data that becomes available in the context
  2. Missing error handling: No handling for failed authentication
  3. Type safety: The loader assumes context.userId exists without validation
 export const Route = createFileRoute('/')({
component: Page,
- beforeLoad: async () => await fetchClerkAuth(),+ beforeLoad: async () => {+ const authData = await fetchClerkAuth();+ return authData;+ },
loader: async ({ context }) => {
- return { userId: context.userId };+ return { userId: (context as any).userId || null };
},
});
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>awaitfetchClerkAuth(),
loader: async({ context })=>{
return{userId: context.userId};
},
});
exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>{
constauthData=awaitfetchClerkAuth();
returnauthData;
},
loader: async({ context })=>{
return{userId: (contextasany).userId||null};
},
});
🤖 Prompt for AI Agents
In integration/templates/tanstack-react-start/src/routes/user.tsx around lines
17 to 23, fix the route configuration by updating beforeLoad to return the
authentication data so it becomes part of the context, add error handling to
manage failed authentication cases gracefully, and ensure the loader validates
the presence of userId in the context before accessing it to maintain type
safety and avoid runtime errors.


function Page() {
 const state = Route.useLoaderData();

 return state.userId ? <h1>Welcome! Your ID is {state.userId}!</h1> : <h1>You are not signed in</h1>;
}

23 changes: 22 additions & 1 deletion
integration/tests/tanstack-start/basic.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { User } from '@clerk/backend';
import { expect, test } from '@playwright/test';

import { appConfigs } from '../../presets';
Expand All@@ -16,6 +17,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 test.describe.configure({ mode: 'parallel' });

 let fakeUser: FakeUser;
 let bapiUser: User;

 test.beforeAll(async () => {
 const u = createTestUtils({ app });
Expand All@@ -24,7 +26,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 withPhoneNumber: true,
 withUsername: true,
 });
 await u.services.users.createBapiUser(fakeUser);
bapiUser = await u.services.users.createBapiUser(fakeUser);
 });

 test.afterAll(async () => {
Expand DownExpand Up@@ -72,6 +74,25 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 expect(clerkInitialState !== undefined).toBeTruthy();
 });

 test('retrieve auth state in server functions', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });

 await u.page.goToRelative('/user');

 await expect(u.page.getByText('You are not signed in')).toBeVisible();

 await u.po.signIn.goTo();

 await u.po.signIn.setIdentifier(fakeUser.email);
 await u.po.signIn.setPassword(fakeUser.password);
 await u.po.signIn.continue();
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/user');

 await expect(u.page.getByText(`Welcome! Your ID is ${bapiUser.id}!`)).toBeVisible();
 });

 test('clerk handler sets headers', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const r = await u.po.signIn.goTo();
Expand Down

8 changes: 4 additions & 4 deletions
packages/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,13 +74,13 @@
 "tslib": "catalog:repo"
 },
 "devDependencies": {
 "@tanstack/react-router": "^1.121.41",
 "@tanstack/react-start": "^1.121.41",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "esbuild-plugin-file-path-extensions": "^2.1.4"
 },
 "peerDependencies": {
 "@tanstack/react-router": "^1.121.0",
 "@tanstack/react-start": "^1.121.0",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "react": "catalog:peer-react",
 "react-dom": "catalog:peer-react"
 },
Expand Down

5 changes: 3 additions & 2 deletions
packages/tanstack-react-start/src/server/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { AuthStatus, constants } from '@clerk/backend/internal';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';

import { errorThrower } from '../utils';
import { ClerkHandshakeRedirect } from './errors';
import { patchRequest } from './utils';

export async function authenticateRequest(
Expand DownExpand Up@@ -41,9 +42,9 @@ export async function authenticateRequest(
 requestStateHeaders: requestState.headers,
 publishableKey: requestState.publishableKey,
 });

 // triggering a handshake redirect
 // eslint-disable-next-line @typescript-eslint/only-throw-error
 throw new Response(null, { status: 307, headers: requestState.headers });
 throw new ClerkHandshakeRedirect(307, requestState.headers);
 }

 if (requestState.status === AuthStatus.Handshake) {
Expand Down

11 changes: 11 additions & 0 deletions
packages/tanstack-react-start/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
export class ClerkHandshakeRedirect extends Error {
 constructor(
 public status: number,
 public headers: Headers,
 ) {
 super('Clerk handshake redirect required');
 this.name = 'ClerkHandshakeRedirect';
 this.status = status;
 this.headers = headers;
 }
}

8 changes: 6 additions & 2 deletions
packages/tanstack-react-start/src/server/middlewareHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { AnyRouter } from '@tanstack/react-router';
import type { CustomizeStartHandler, HandlerCallback, RequestHandler } from '@tanstack/react-start/server';

import { authenticateRequest } from './authenticateRequest';
import { ClerkHandshakeRedirect } from './errors';
import { loadOptions } from './loadOptions';
import type { LoaderOptions } from './types';
import { getResponseClerkState } from './utils';
Expand DownExpand Up@@ -33,9 +34,12 @@ export function createClerkHandler<TRouter extends AnyRouter>(

 await router.load();
 } catch (error) {
 if (error instanceof Response) {
 if (error instanceof ClerkHandshakeRedirect) {
 // returning the response
 return error;
 return new Response(null, {
 status: error.status,
 headers: error.headers,
 });
 }

 // rethrowing the error if it is not a Response
Expand Down
Loading
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
fix(tanstack-react-start): Handle serialization issue when doing handshake#6345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 8 commits into

from

Jul 18, 2025
 Merged


fix(tanstack-react-start): Handle serialization issue when doing handshake
#6345
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0f0a367

chore(tanstack-react-start): Fix serialization issues with handshake


wobsoriano Jul 17, 2025
4ce9edb

chore: add changeset


wobsoriano Jul 17, 2025
4cc7c3d

chore: add getAuth tests


wobsoriano Jul 17, 2025
5bdf2a4

chore: set minimum version to 1.127.0


wobsoriano Jul 17, 2025
edee388

Merge branch 'main' into rob/user-2383-tanstack-serialization-response


wobsoriano Jul 17, 2025
ce72d49

chore: update changeset


wobsoriano Jul 17, 2025
db0666c

chore: reinstall deps


wobsoriano Jul 17, 2025
f813e9f

chore: reinstall deps


wobsoriano Jul 17, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/fifty-buses-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/tanstack-react-start': minor
---

- Fixes serialization errors during handshake
- Bump `@tanstack/react-start` and `@tanstack/react-router` peer dependency to 1.127.0

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-router/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,9 +9,9 @@
 "start": "vite"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/router-plugin": "^1.121.27",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/router-plugin": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1"
 },
Expand Down

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 "start": "vite start --port=$PORT"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/react-start": "^1.121.28",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/react-start": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1",
 "tailwind-merge": "^2.5.4"
Expand Down

29 changes: 29 additions & 0 deletions
integration/templates/tanstack-react-start/src/routes/user.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { createFileRoute, redirect } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { getAuth } from '@clerk/tanstack-react-start/server';
import { getWebRequest } from '@tanstack/react-start/server';

const fetchClerkAuth = createServerFn({ method: 'GET' }).handler(async () => {
 const request = getWebRequest();
 if (!request) throw new Error('No request found');

 const { userId } = await getAuth(request);

 return {
 userId,
 };
});

export const Route = createFileRoute('/')({
 component: Page,
 beforeLoad: async () => await fetchClerkAuth(),
 loader: async ({ context }) => {
 return { userId: context.userId };
 },
});

Comment on lines

+17
 to 
+23

@coderabbitaicoderabbitaiBotJul 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

⚠️ Potential issue
Fix the route configuration logic.
The route configuration has several critical issues:
  1. Incorrect beforeLoad implementation: The beforeLoad hook should return data that becomes available in the context
  2. Missing error handling: No handling for failed authentication
  3. Type safety: The loader assumes context.userId exists without validation
 export const Route = createFileRoute('/')({
component: Page,
- beforeLoad: async () => await fetchClerkAuth(),+ beforeLoad: async () => {+ const authData = await fetchClerkAuth();+ return authData;+ },
loader: async ({ context }) => {
- return { userId: context.userId };+ return { userId: (context as any).userId || null };
},
});
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>awaitfetchClerkAuth(),
loader: async({ context })=>{
return{userId: context.userId};
},
});
exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>{
constauthData=awaitfetchClerkAuth();
returnauthData;
},
loader: async({ context })=>{
return{userId: (contextasany).userId||null};
},
});
🤖 Prompt for AI Agents
In integration/templates/tanstack-react-start/src/routes/user.tsx around lines
17 to 23, fix the route configuration by updating beforeLoad to return the
authentication data so it becomes part of the context, add error handling to
manage failed authentication cases gracefully, and ensure the loader validates
the presence of userId in the context before accessing it to maintain type
safety and avoid runtime errors.


function Page() {
 const state = Route.useLoaderData();

 return state.userId ? <h1>Welcome! Your ID is {state.userId}!</h1> : <h1>You are not signed in</h1>;
}

23 changes: 22 additions & 1 deletion
integration/tests/tanstack-start/basic.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { User } from '@clerk/backend';
import { expect, test } from '@playwright/test';

import { appConfigs } from '../../presets';
Expand All@@ -16,6 +17,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 test.describe.configure({ mode: 'parallel' });

 let fakeUser: FakeUser;
 let bapiUser: User;

 test.beforeAll(async () => {
 const u = createTestUtils({ app });
Expand All@@ -24,7 +26,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 withPhoneNumber: true,
 withUsername: true,
 });
 await u.services.users.createBapiUser(fakeUser);
bapiUser = await u.services.users.createBapiUser(fakeUser);
 });

 test.afterAll(async () => {
Expand DownExpand Up@@ -72,6 +74,25 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 expect(clerkInitialState !== undefined).toBeTruthy();
 });

 test('retrieve auth state in server functions', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });

 await u.page.goToRelative('/user');

 await expect(u.page.getByText('You are not signed in')).toBeVisible();

 await u.po.signIn.goTo();

 await u.po.signIn.setIdentifier(fakeUser.email);
 await u.po.signIn.setPassword(fakeUser.password);
 await u.po.signIn.continue();
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/user');

 await expect(u.page.getByText(`Welcome! Your ID is ${bapiUser.id}!`)).toBeVisible();
 });

 test('clerk handler sets headers', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const r = await u.po.signIn.goTo();
Expand Down

8 changes: 4 additions & 4 deletions
packages/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,13 +74,13 @@
 "tslib": "catalog:repo"
 },
 "devDependencies": {
 "@tanstack/react-router": "^1.121.41",
 "@tanstack/react-start": "^1.121.41",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "esbuild-plugin-file-path-extensions": "^2.1.4"
 },
 "peerDependencies": {
 "@tanstack/react-router": "^1.121.0",
 "@tanstack/react-start": "^1.121.0",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "react": "catalog:peer-react",
 "react-dom": "catalog:peer-react"
 },
Expand Down

5 changes: 3 additions & 2 deletions
packages/tanstack-react-start/src/server/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { AuthStatus, constants } from '@clerk/backend/internal';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';

import { errorThrower } from '../utils';
import { ClerkHandshakeRedirect } from './errors';
import { patchRequest } from './utils';

export async function authenticateRequest(
Expand DownExpand Up@@ -41,9 +42,9 @@ export async function authenticateRequest(
 requestStateHeaders: requestState.headers,
 publishableKey: requestState.publishableKey,
 });

 // triggering a handshake redirect
 // eslint-disable-next-line @typescript-eslint/only-throw-error
 throw new Response(null, { status: 307, headers: requestState.headers });
 throw new ClerkHandshakeRedirect(307, requestState.headers);
 }

 if (requestState.status === AuthStatus.Handshake) {
Expand Down

11 changes: 11 additions & 0 deletions
packages/tanstack-react-start/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
export class ClerkHandshakeRedirect extends Error {
 constructor(
 public status: number,
 public headers: Headers,
 ) {
 super('Clerk handshake redirect required');
 this.name = 'ClerkHandshakeRedirect';
 this.status = status;
 this.headers = headers;
 }
}

8 changes: 6 additions & 2 deletions
packages/tanstack-react-start/src/server/middlewareHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { AnyRouter } from '@tanstack/react-router';
import type { CustomizeStartHandler, HandlerCallback, RequestHandler } from '@tanstack/react-start/server';

import { authenticateRequest } from './authenticateRequest';
import { ClerkHandshakeRedirect } from './errors';
import { loadOptions } from './loadOptions';
import type { LoaderOptions } from './types';
import { getResponseClerkState } from './utils';
Expand DownExpand Up@@ -33,9 +34,12 @@ export function createClerkHandler<TRouter extends AnyRouter>(

 await router.load();
 } catch (error) {
 if (error instanceof Response) {
 if (error instanceof ClerkHandshakeRedirect) {
 // returning the response
 return error;
 return new Response(null, {
 status: error.status,
 headers: error.headers,
 });
 }

 // rethrowing the error if it is not a Response
Expand Down
Loading
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
fix(tanstack-react-start): Handle serialization issue when doing handshake#6345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 8 commits into

from

Jul 18, 2025
 Merged


fix(tanstack-react-start): Handle serialization issue when doing handshake
#6345
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0f0a367

chore(tanstack-react-start): Fix serialization issues with handshake


wobsoriano Jul 17, 2025
4ce9edb

chore: add changeset


wobsoriano Jul 17, 2025
4cc7c3d

chore: add getAuth tests


wobsoriano Jul 17, 2025
5bdf2a4

chore: set minimum version to 1.127.0


wobsoriano Jul 17, 2025
edee388

Merge branch 'main' into rob/user-2383-tanstack-serialization-response


wobsoriano Jul 17, 2025
ce72d49

chore: update changeset


wobsoriano Jul 17, 2025
db0666c

chore: reinstall deps


wobsoriano Jul 17, 2025
f813e9f

chore: reinstall deps


wobsoriano Jul 17, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/fifty-buses-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/tanstack-react-start': minor
---

- Fixes serialization errors during handshake
- Bump `@tanstack/react-start` and `@tanstack/react-router` peer dependency to 1.127.0

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-router/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,9 +9,9 @@
 "start": "vite"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/router-plugin": "^1.121.27",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/router-plugin": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1"
 },
Expand Down

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 "start": "vite start --port=$PORT"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/react-start": "^1.121.28",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/react-start": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1",
 "tailwind-merge": "^2.5.4"
Expand Down

29 changes: 29 additions & 0 deletions
integration/templates/tanstack-react-start/src/routes/user.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { createFileRoute, redirect } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { getAuth } from '@clerk/tanstack-react-start/server';
import { getWebRequest } from '@tanstack/react-start/server';

const fetchClerkAuth = createServerFn({ method: 'GET' }).handler(async () => {
 const request = getWebRequest();
 if (!request) throw new Error('No request found');

 const { userId } = await getAuth(request);

 return {
 userId,
 };
});

export const Route = createFileRoute('/')({
 component: Page,
 beforeLoad: async () => await fetchClerkAuth(),
 loader: async ({ context }) => {
 return { userId: context.userId };
 },
});

Comment on lines

+17
 to 
+23

@coderabbitaicoderabbitaiBotJul 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

⚠️ Potential issue
Fix the route configuration logic.
The route configuration has several critical issues:
  1. Incorrect beforeLoad implementation: The beforeLoad hook should return data that becomes available in the context
  2. Missing error handling: No handling for failed authentication
  3. Type safety: The loader assumes context.userId exists without validation
 export const Route = createFileRoute('/')({
component: Page,
- beforeLoad: async () => await fetchClerkAuth(),+ beforeLoad: async () => {+ const authData = await fetchClerkAuth();+ return authData;+ },
loader: async ({ context }) => {
- return { userId: context.userId };+ return { userId: (context as any).userId || null };
},
});
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>awaitfetchClerkAuth(),
loader: async({ context })=>{
return{userId: context.userId};
},
});
exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>{
constauthData=awaitfetchClerkAuth();
returnauthData;
},
loader: async({ context })=>{
return{userId: (contextasany).userId||null};
},
});
🤖 Prompt for AI Agents
In integration/templates/tanstack-react-start/src/routes/user.tsx around lines
17 to 23, fix the route configuration by updating beforeLoad to return the
authentication data so it becomes part of the context, add error handling to
manage failed authentication cases gracefully, and ensure the loader validates
the presence of userId in the context before accessing it to maintain type
safety and avoid runtime errors.


function Page() {
 const state = Route.useLoaderData();

 return state.userId ? <h1>Welcome! Your ID is {state.userId}!</h1> : <h1>You are not signed in</h1>;
}

23 changes: 22 additions & 1 deletion
integration/tests/tanstack-start/basic.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { User } from '@clerk/backend';
import { expect, test } from '@playwright/test';

import { appConfigs } from '../../presets';
Expand All@@ -16,6 +17,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 test.describe.configure({ mode: 'parallel' });

 let fakeUser: FakeUser;
 let bapiUser: User;

 test.beforeAll(async () => {
 const u = createTestUtils({ app });
Expand All@@ -24,7 +26,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 withPhoneNumber: true,
 withUsername: true,
 });
 await u.services.users.createBapiUser(fakeUser);
bapiUser = await u.services.users.createBapiUser(fakeUser);
 });

 test.afterAll(async () => {
Expand DownExpand Up@@ -72,6 +74,25 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 expect(clerkInitialState !== undefined).toBeTruthy();
 });

 test('retrieve auth state in server functions', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });

 await u.page.goToRelative('/user');

 await expect(u.page.getByText('You are not signed in')).toBeVisible();

 await u.po.signIn.goTo();

 await u.po.signIn.setIdentifier(fakeUser.email);
 await u.po.signIn.setPassword(fakeUser.password);
 await u.po.signIn.continue();
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/user');

 await expect(u.page.getByText(`Welcome! Your ID is ${bapiUser.id}!`)).toBeVisible();
 });

 test('clerk handler sets headers', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const r = await u.po.signIn.goTo();
Expand Down

8 changes: 4 additions & 4 deletions
packages/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,13 +74,13 @@
 "tslib": "catalog:repo"
 },
 "devDependencies": {
 "@tanstack/react-router": "^1.121.41",
 "@tanstack/react-start": "^1.121.41",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "esbuild-plugin-file-path-extensions": "^2.1.4"
 },
 "peerDependencies": {
 "@tanstack/react-router": "^1.121.0",
 "@tanstack/react-start": "^1.121.0",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "react": "catalog:peer-react",
 "react-dom": "catalog:peer-react"
 },
Expand Down

5 changes: 3 additions & 2 deletions
packages/tanstack-react-start/src/server/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { AuthStatus, constants } from '@clerk/backend/internal';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';

import { errorThrower } from '../utils';
import { ClerkHandshakeRedirect } from './errors';
import { patchRequest } from './utils';

export async function authenticateRequest(
Expand DownExpand Up@@ -41,9 +42,9 @@ export async function authenticateRequest(
 requestStateHeaders: requestState.headers,
 publishableKey: requestState.publishableKey,
 });

 // triggering a handshake redirect
 // eslint-disable-next-line @typescript-eslint/only-throw-error
 throw new Response(null, { status: 307, headers: requestState.headers });
 throw new ClerkHandshakeRedirect(307, requestState.headers);
 }

 if (requestState.status === AuthStatus.Handshake) {
Expand Down

11 changes: 11 additions & 0 deletions
packages/tanstack-react-start/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
export class ClerkHandshakeRedirect extends Error {
 constructor(
 public status: number,
 public headers: Headers,
 ) {
 super('Clerk handshake redirect required');
 this.name = 'ClerkHandshakeRedirect';
 this.status = status;
 this.headers = headers;
 }
}

8 changes: 6 additions & 2 deletions
packages/tanstack-react-start/src/server/middlewareHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { AnyRouter } from '@tanstack/react-router';
import type { CustomizeStartHandler, HandlerCallback, RequestHandler } from '@tanstack/react-start/server';

import { authenticateRequest } from './authenticateRequest';
import { ClerkHandshakeRedirect } from './errors';
import { loadOptions } from './loadOptions';
import type { LoaderOptions } from './types';
import { getResponseClerkState } from './utils';
Expand DownExpand Up@@ -33,9 +34,12 @@ export function createClerkHandler<TRouter extends AnyRouter>(

 await router.load();
 } catch (error) {
 if (error instanceof Response) {
 if (error instanceof ClerkHandshakeRedirect) {
 // returning the response
 return error;
 return new Response(null, {
 status: error.status,
 headers: error.headers,
 });
 }

 // rethrowing the error if it is not a Response
Expand Down
Loading
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
fix(tanstack-react-start): Handle serialization issue when doing handshake#6345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 8 commits into

from

Jul 18, 2025
 Merged


fix(tanstack-react-start): Handle serialization issue when doing handshake
#6345
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0f0a367

chore(tanstack-react-start): Fix serialization issues with handshake


wobsoriano Jul 17, 2025
4ce9edb

chore: add changeset


wobsoriano Jul 17, 2025
4cc7c3d

chore: add getAuth tests


wobsoriano Jul 17, 2025
5bdf2a4

chore: set minimum version to 1.127.0


wobsoriano Jul 17, 2025
edee388

Merge branch 'main' into rob/user-2383-tanstack-serialization-response


wobsoriano Jul 17, 2025
ce72d49

chore: update changeset


wobsoriano Jul 17, 2025
db0666c

chore: reinstall deps


wobsoriano Jul 17, 2025
f813e9f

chore: reinstall deps


wobsoriano Jul 17, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/fifty-buses-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/tanstack-react-start': minor
---

- Fixes serialization errors during handshake
- Bump `@tanstack/react-start` and `@tanstack/react-router` peer dependency to 1.127.0

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-router/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,9 +9,9 @@
 "start": "vite"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/router-plugin": "^1.121.27",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/router-plugin": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1"
 },
Expand Down

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 "start": "vite start --port=$PORT"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/react-start": "^1.121.28",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/react-start": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1",
 "tailwind-merge": "^2.5.4"
Expand Down

29 changes: 29 additions & 0 deletions
integration/templates/tanstack-react-start/src/routes/user.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { createFileRoute, redirect } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { getAuth } from '@clerk/tanstack-react-start/server';
import { getWebRequest } from '@tanstack/react-start/server';

const fetchClerkAuth = createServerFn({ method: 'GET' }).handler(async () => {
 const request = getWebRequest();
 if (!request) throw new Error('No request found');

 const { userId } = await getAuth(request);

 return {
 userId,
 };
});

export const Route = createFileRoute('/')({
 component: Page,
 beforeLoad: async () => await fetchClerkAuth(),
 loader: async ({ context }) => {
 return { userId: context.userId };
 },
});

Comment on lines

+17
 to 
+23

@coderabbitaicoderabbitaiBotJul 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

⚠️ Potential issue
Fix the route configuration logic.
The route configuration has several critical issues:
  1. Incorrect beforeLoad implementation: The beforeLoad hook should return data that becomes available in the context
  2. Missing error handling: No handling for failed authentication
  3. Type safety: The loader assumes context.userId exists without validation
 export const Route = createFileRoute('/')({
component: Page,
- beforeLoad: async () => await fetchClerkAuth(),+ beforeLoad: async () => {+ const authData = await fetchClerkAuth();+ return authData;+ },
loader: async ({ context }) => {
- return { userId: context.userId };+ return { userId: (context as any).userId || null };
},
});
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>awaitfetchClerkAuth(),
loader: async({ context })=>{
return{userId: context.userId};
},
});
exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>{
constauthData=awaitfetchClerkAuth();
returnauthData;
},
loader: async({ context })=>{
return{userId: (contextasany).userId||null};
},
});
🤖 Prompt for AI Agents
In integration/templates/tanstack-react-start/src/routes/user.tsx around lines
17 to 23, fix the route configuration by updating beforeLoad to return the
authentication data so it becomes part of the context, add error handling to
manage failed authentication cases gracefully, and ensure the loader validates
the presence of userId in the context before accessing it to maintain type
safety and avoid runtime errors.


function Page() {
 const state = Route.useLoaderData();

 return state.userId ? <h1>Welcome! Your ID is {state.userId}!</h1> : <h1>You are not signed in</h1>;
}

23 changes: 22 additions & 1 deletion
integration/tests/tanstack-start/basic.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { User } from '@clerk/backend';
import { expect, test } from '@playwright/test';

import { appConfigs } from '../../presets';
Expand All@@ -16,6 +17,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 test.describe.configure({ mode: 'parallel' });

 let fakeUser: FakeUser;
 let bapiUser: User;

 test.beforeAll(async () => {
 const u = createTestUtils({ app });
Expand All@@ -24,7 +26,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 withPhoneNumber: true,
 withUsername: true,
 });
 await u.services.users.createBapiUser(fakeUser);
bapiUser = await u.services.users.createBapiUser(fakeUser);
 });

 test.afterAll(async () => {
Expand DownExpand Up@@ -72,6 +74,25 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 expect(clerkInitialState !== undefined).toBeTruthy();
 });

 test('retrieve auth state in server functions', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });

 await u.page.goToRelative('/user');

 await expect(u.page.getByText('You are not signed in')).toBeVisible();

 await u.po.signIn.goTo();

 await u.po.signIn.setIdentifier(fakeUser.email);
 await u.po.signIn.setPassword(fakeUser.password);
 await u.po.signIn.continue();
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/user');

 await expect(u.page.getByText(`Welcome! Your ID is ${bapiUser.id}!`)).toBeVisible();
 });

 test('clerk handler sets headers', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const r = await u.po.signIn.goTo();
Expand Down

8 changes: 4 additions & 4 deletions
packages/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,13 +74,13 @@
 "tslib": "catalog:repo"
 },
 "devDependencies": {
 "@tanstack/react-router": "^1.121.41",
 "@tanstack/react-start": "^1.121.41",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "esbuild-plugin-file-path-extensions": "^2.1.4"
 },
 "peerDependencies": {
 "@tanstack/react-router": "^1.121.0",
 "@tanstack/react-start": "^1.121.0",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "react": "catalog:peer-react",
 "react-dom": "catalog:peer-react"
 },
Expand Down

5 changes: 3 additions & 2 deletions
packages/tanstack-react-start/src/server/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { AuthStatus, constants } from '@clerk/backend/internal';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';

import { errorThrower } from '../utils';
import { ClerkHandshakeRedirect } from './errors';
import { patchRequest } from './utils';

export async function authenticateRequest(
Expand DownExpand Up@@ -41,9 +42,9 @@ export async function authenticateRequest(
 requestStateHeaders: requestState.headers,
 publishableKey: requestState.publishableKey,
 });

 // triggering a handshake redirect
 // eslint-disable-next-line @typescript-eslint/only-throw-error
 throw new Response(null, { status: 307, headers: requestState.headers });
 throw new ClerkHandshakeRedirect(307, requestState.headers);
 }

 if (requestState.status === AuthStatus.Handshake) {
Expand Down

11 changes: 11 additions & 0 deletions
packages/tanstack-react-start/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
export class ClerkHandshakeRedirect extends Error {
 constructor(
 public status: number,
 public headers: Headers,
 ) {
 super('Clerk handshake redirect required');
 this.name = 'ClerkHandshakeRedirect';
 this.status = status;
 this.headers = headers;
 }
}

8 changes: 6 additions & 2 deletions
packages/tanstack-react-start/src/server/middlewareHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { AnyRouter } from '@tanstack/react-router';
import type { CustomizeStartHandler, HandlerCallback, RequestHandler } from '@tanstack/react-start/server';

import { authenticateRequest } from './authenticateRequest';
import { ClerkHandshakeRedirect } from './errors';
import { loadOptions } from './loadOptions';
import type { LoaderOptions } from './types';
import { getResponseClerkState } from './utils';
Expand DownExpand Up@@ -33,9 +34,12 @@ export function createClerkHandler<TRouter extends AnyRouter>(

 await router.load();
 } catch (error) {
 if (error instanceof Response) {
 if (error instanceof ClerkHandshakeRedirect) {
 // returning the response
 return error;
 return new Response(null, {
 status: error.status,
 headers: error.headers,
 });
 }

 // rethrowing the error if it is not a Response
Expand Down
Loading
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
fix(tanstack-react-start): Handle serialization issue when doing handshake#6345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 8 commits into

from

Jul 18, 2025
 Merged


fix(tanstack-react-start): Handle serialization issue when doing handshake
#6345
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0f0a367

chore(tanstack-react-start): Fix serialization issues with handshake


wobsoriano Jul 17, 2025
4ce9edb

chore: add changeset


wobsoriano Jul 17, 2025
4cc7c3d

chore: add getAuth tests


wobsoriano Jul 17, 2025
5bdf2a4

chore: set minimum version to 1.127.0


wobsoriano Jul 17, 2025
edee388

Merge branch 'main' into rob/user-2383-tanstack-serialization-response


wobsoriano Jul 17, 2025
ce72d49

chore: update changeset


wobsoriano Jul 17, 2025
db0666c

chore: reinstall deps


wobsoriano Jul 17, 2025
f813e9f

chore: reinstall deps


wobsoriano Jul 17, 2025

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


6 changes: 6 additions & 0 deletions
.changeset/fifty-buses-fix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/tanstack-react-start': minor
---

- Fixes serialization errors during handshake
- Bump `@tanstack/react-start` and `@tanstack/react-router` peer dependency to 1.127.0

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-router/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,9 +9,9 @@
 "start": "vite"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/router-plugin": "^1.121.27",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/router-plugin": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1"
 },
Expand Down

6 changes: 3 additions & 3 deletions
integration/templates/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,9 @@
 "start": "vite start --port=$PORT"
 },
 "dependencies": {
 "@tanstack/react-router": "^1.121.27",
 "@tanstack/react-router-devtools": "^1.121.27",
 "@tanstack/react-start": "^1.121.28",
 "@tanstack/react-router": "^1.128.0",
 "@tanstack/react-router-devtools": "^1.128.0",
 "@tanstack/react-start": "^1.128.0",
 "react": "18.3.1",
 "react-dom": "18.3.1",
 "tailwind-merge": "^2.5.4"
Expand Down

29 changes: 29 additions & 0 deletions
integration/templates/tanstack-react-start/src/routes/user.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { createFileRoute, redirect } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { getAuth } from '@clerk/tanstack-react-start/server';
import { getWebRequest } from '@tanstack/react-start/server';

const fetchClerkAuth = createServerFn({ method: 'GET' }).handler(async () => {
 const request = getWebRequest();
 if (!request) throw new Error('No request found');

 const { userId } = await getAuth(request);

 return {
 userId,
 };
});

export const Route = createFileRoute('/')({
 component: Page,
 beforeLoad: async () => await fetchClerkAuth(),
 loader: async ({ context }) => {
 return { userId: context.userId };
 },
});

Comment on lines

+17
 to 
+23

@coderabbitaicoderabbitaiBotJul 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

⚠️ Potential issue
Fix the route configuration logic.
The route configuration has several critical issues:
  1. Incorrect beforeLoad implementation: The beforeLoad hook should return data that becomes available in the context
  2. Missing error handling: No handling for failed authentication
  3. Type safety: The loader assumes context.userId exists without validation
 export const Route = createFileRoute('/')({
component: Page,
- beforeLoad: async () => await fetchClerkAuth(),+ beforeLoad: async () => {+ const authData = await fetchClerkAuth();+ return authData;+ },
loader: async ({ context }) => {
- return { userId: context.userId };+ return { userId: (context as any).userId || null };
},
});
📝 Committable suggestion
‼️IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>awaitfetchClerkAuth(),
loader: async({ context })=>{
return{userId: context.userId};
},
});
exportconstRoute=createFileRoute('/')({
component: Page,
beforeLoad: async()=>{
constauthData=awaitfetchClerkAuth();
returnauthData;
},
loader: async({ context })=>{
return{userId: (contextasany).userId||null};
},
});
🤖 Prompt for AI Agents
In integration/templates/tanstack-react-start/src/routes/user.tsx around lines
17 to 23, fix the route configuration by updating beforeLoad to return the
authentication data so it becomes part of the context, add error handling to
manage failed authentication cases gracefully, and ensure the loader validates
the presence of userId in the context before accessing it to maintain type
safety and avoid runtime errors.


function Page() {
 const state = Route.useLoaderData();

 return state.userId ? <h1>Welcome! Your ID is {state.userId}!</h1> : <h1>You are not signed in</h1>;
}

23 changes: 22 additions & 1 deletion
integration/tests/tanstack-start/basic.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { User } from '@clerk/backend';
import { expect, test } from '@playwright/test';

import { appConfigs } from '../../presets';
Expand All@@ -16,6 +17,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 test.describe.configure({ mode: 'parallel' });

 let fakeUser: FakeUser;
 let bapiUser: User;

 test.beforeAll(async () => {
 const u = createTestUtils({ app });
Expand All@@ -24,7 +26,7 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 withPhoneNumber: true,
 withUsername: true,
 });
 await u.services.users.createBapiUser(fakeUser);
bapiUser = await u.services.users.createBapiUser(fakeUser);
 });

 test.afterAll(async () => {
Expand DownExpand Up@@ -72,6 +74,25 @@ testAgainstRunningApps({ withEnv: [appConfigs.envs.withEmailCodes] })(
 expect(clerkInitialState !== undefined).toBeTruthy();
 });

 test('retrieve auth state in server functions', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });

 await u.page.goToRelative('/user');

 await expect(u.page.getByText('You are not signed in')).toBeVisible();

 await u.po.signIn.goTo();

 await u.po.signIn.setIdentifier(fakeUser.email);
 await u.po.signIn.setPassword(fakeUser.password);
 await u.po.signIn.continue();
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/user');

 await expect(u.page.getByText(`Welcome! Your ID is ${bapiUser.id}!`)).toBeVisible();
 });

 test('clerk handler sets headers', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const r = await u.po.signIn.goTo();
Expand Down

8 changes: 4 additions & 4 deletions
packages/tanstack-react-start/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,13 +74,13 @@
 "tslib": "catalog:repo"
 },
 "devDependencies": {
 "@tanstack/react-router": "^1.121.41",
 "@tanstack/react-start": "^1.121.41",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "esbuild-plugin-file-path-extensions": "^2.1.4"
 },
 "peerDependencies": {
 "@tanstack/react-router": "^1.121.0",
 "@tanstack/react-start": "^1.121.0",
 "@tanstack/react-router": "^1.127.0",
 "@tanstack/react-start": "^1.127.0",
 "react": "catalog:peer-react",
 "react-dom": "catalog:peer-react"
 },
Expand Down

5 changes: 3 additions & 2 deletions
packages/tanstack-react-start/src/server/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import { AuthStatus, constants } from '@clerk/backend/internal';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';

import { errorThrower } from '../utils';
import { ClerkHandshakeRedirect } from './errors';
import { patchRequest } from './utils';

export async function authenticateRequest(
Expand DownExpand Up@@ -41,9 +42,9 @@ export async function authenticateRequest(
 requestStateHeaders: requestState.headers,
 publishableKey: requestState.publishableKey,
 });

 // triggering a handshake redirect
 // eslint-disable-next-line @typescript-eslint/only-throw-error
 throw new Response(null, { status: 307, headers: requestState.headers });
 throw new ClerkHandshakeRedirect(307, requestState.headers);
 }

 if (requestState.status === AuthStatus.Handshake) {
Expand Down

11 changes: 11 additions & 0 deletions
packages/tanstack-react-start/src/server/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
export class ClerkHandshakeRedirect extends Error {
 constructor(
 public status: number,
 public headers: Headers,
 ) {
 super('Clerk handshake redirect required');
 this.name = 'ClerkHandshakeRedirect';
 this.status = status;
 this.headers = headers;
 }
}

8 changes: 6 additions & 2 deletions
packages/tanstack-react-start/src/server/middlewareHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { AnyRouter } from '@tanstack/react-router';
import type { CustomizeStartHandler, HandlerCallback, RequestHandler } from '@tanstack/react-start/server';

import { authenticateRequest } from './authenticateRequest';
import { ClerkHandshakeRedirect } from './errors';
import { loadOptions } from './loadOptions';
import type { LoaderOptions } from './types';
import { getResponseClerkState } from './utils';
Expand DownExpand Up@@ -33,9 +34,12 @@ export function createClerkHandler<TRouter extends AnyRouter>(

 await router.load();
 } catch (error) {
 if (error instanceof Response) {
 if (error instanceof ClerkHandshakeRedirect) {
 // returning the response
 return error;
 return new Response(null, {
 status: error.status,
 headers: error.headers,
 });
 }

 // rethrowing the error if it is not a Response
Expand Down
Loading
Loading