Skip to content

Commit c5ad329

Browse files
fix react server exports for start and react-router (#7183)
Co-authored-by: nx-cloud[bot] <71083854+nx-cloud[bot]@users.noreply.github.com>
1 parent f1a4973 commit c5ad329

11 files changed

Lines changed: 245 additions & 0 deletions

File tree

‎.changeset/neat-melons-worry.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'@tanstack/react-router': patch
3+
---
4+
5+
Fix React Server Component imports from `@tanstack/react-router` by adding a `react-server` root export that preserves the normal API surface while resolving `notFound` and `redirect` from a server-safe entry.
6+
7+
This fixes RSC routes that throw `notFound()` or `redirect()` from server functions so they behave correctly during SSR and client navigation.

‎e2e/react-start/rsc/src/routeTree.gen.ts‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ import { Route as RscSsrFalseRouteImport } from './routes/rsc-ssr-false'
1919
import { Route as RscSsrDataOnlyRouteImport } from './routes/rsc-ssr-data-only'
2020
import { Route as RscSlotsRouteImport } from './routes/rsc-slots'
2121
import { Route as RscSlotJsxArgsRouteImport } from './routes/rsc-slot-jsx-args'
22+
import { Route as RscServerRedirectRouteImport } from './routes/rsc-server-redirect'
23+
import { Route as RscServerNotFoundRouteImport } from './routes/rsc-server-not-found'
2224
import { Route as RscRequestHeadersRouteImport } from './routes/rsc-request-headers'
2325
import { Route as RscReactCacheRouteImport } from './routes/rsc-react-cache'
2426
import { Route as RscParallelRouteImport } from './routes/rsc-parallel'
@@ -103,6 +105,16 @@ const RscSlotJsxArgsRoute = RscSlotJsxArgsRouteImport.update({
103105
path: '/rsc-slot-jsx-args',
104106
getParentRoute: () => rootRouteImport,
105107
} as any)
108+
const RscServerRedirectRoute = RscServerRedirectRouteImport.update({
109+
id: '/rsc-server-redirect',
110+
path: '/rsc-server-redirect',
111+
getParentRoute: () => rootRouteImport,
112+
} as any)
113+
const RscServerNotFoundRoute = RscServerNotFoundRouteImport.update({
114+
id: '/rsc-server-not-found',
115+
path: '/rsc-server-not-found',
116+
getParentRoute: () => rootRouteImport,
117+
} as any)
106118
const RscRequestHeadersRoute = RscRequestHeadersRouteImport.update({
107119
id: '/rsc-request-headers',
108120
path: '/rsc-request-headers',
@@ -298,6 +310,8 @@ export interface FileRoutesByFullPath {
298310
'/rsc-parallel': typeof RscParallelRoute
299311
'/rsc-react-cache': typeof RscReactCacheRoute
300312
'/rsc-request-headers': typeof RscRequestHeadersRoute
313+
'/rsc-server-not-found': typeof RscServerNotFoundRoute
314+
'/rsc-server-redirect': typeof RscServerRedirectRoute
301315
'/rsc-slot-jsx-args': typeof RscSlotJsxArgsRoute
302316
'/rsc-slots': typeof RscSlotsRoute
303317
'/rsc-ssr-data-only': typeof RscSsrDataOnlyRoute
@@ -343,6 +357,8 @@ export interface FileRoutesByTo {
343357
'/rsc-parallel': typeof RscParallelRoute
344358
'/rsc-react-cache': typeof RscReactCacheRoute
345359
'/rsc-request-headers': typeof RscRequestHeadersRoute
360+
'/rsc-server-not-found': typeof RscServerNotFoundRoute
361+
'/rsc-server-redirect': typeof RscServerRedirectRoute
346362
'/rsc-slot-jsx-args': typeof RscSlotJsxArgsRoute
347363
'/rsc-slots': typeof RscSlotsRoute
348364
'/rsc-ssr-data-only': typeof RscSsrDataOnlyRoute
@@ -389,6 +405,8 @@ export interface FileRoutesById {
389405
'/rsc-parallel': typeof RscParallelRoute
390406
'/rsc-react-cache': typeof RscReactCacheRoute
391407
'/rsc-request-headers': typeof RscRequestHeadersRoute
408+
'/rsc-server-not-found': typeof RscServerNotFoundRoute
409+
'/rsc-server-redirect': typeof RscServerRedirectRoute
392410
'/rsc-slot-jsx-args': typeof RscSlotJsxArgsRoute
393411
'/rsc-slots': typeof RscSlotsRoute
394412
'/rsc-ssr-data-only': typeof RscSsrDataOnlyRoute
@@ -436,6 +454,8 @@ export interface FileRouteTypes {
436454
| '/rsc-parallel'
437455
| '/rsc-react-cache'
438456
| '/rsc-request-headers'
457+
| '/rsc-server-not-found'
458+
| '/rsc-server-redirect'
439459
| '/rsc-slot-jsx-args'
440460
| '/rsc-slots'
441461
| '/rsc-ssr-data-only'
@@ -481,6 +501,8 @@ export interface FileRouteTypes {
481501
| '/rsc-parallel'
482502
| '/rsc-react-cache'
483503
| '/rsc-request-headers'
504+
| '/rsc-server-not-found'
505+
| '/rsc-server-redirect'
484506
| '/rsc-slot-jsx-args'
485507
| '/rsc-slots'
486508
| '/rsc-ssr-data-only'
@@ -526,6 +548,8 @@ export interface FileRouteTypes {
526548
| '/rsc-parallel'
527549
| '/rsc-react-cache'
528550
| '/rsc-request-headers'
551+
| '/rsc-server-not-found'
552+
| '/rsc-server-redirect'
529553
| '/rsc-slot-jsx-args'
530554
| '/rsc-slots'
531555
| '/rsc-ssr-data-only'
@@ -572,6 +596,8 @@ export interface RootRouteChildren {
572596
RscParallelRoute: typeof RscParallelRoute
573597
RscReactCacheRoute: typeof RscReactCacheRoute
574598
RscRequestHeadersRoute: typeof RscRequestHeadersRoute
599+
RscServerNotFoundRoute: typeof RscServerNotFoundRoute
600+
RscServerRedirectRoute: typeof RscServerRedirectRoute
575601
RscSlotJsxArgsRoute: typeof RscSlotJsxArgsRoute
576602
RscSlotsRoute: typeof RscSlotsRoute
577603
RscSsrDataOnlyRoute: typeof RscSsrDataOnlyRoute
@@ -661,6 +687,20 @@ declare module '@tanstack/react-router' {
661687
preLoaderRoute: typeof RscSlotJsxArgsRouteImport
662688
parentRoute: typeof rootRouteImport
663689
}
690+
'/rsc-server-redirect': {
691+
id: '/rsc-server-redirect'
692+
path: '/rsc-server-redirect'
693+
fullPath: '/rsc-server-redirect'
694+
preLoaderRoute: typeof RscServerRedirectRouteImport
695+
parentRoute: typeof rootRouteImport
696+
}
697+
'/rsc-server-not-found': {
698+
id: '/rsc-server-not-found'
699+
path: '/rsc-server-not-found'
700+
fullPath: '/rsc-server-not-found'
701+
preLoaderRoute: typeof RscServerNotFoundRouteImport
702+
parentRoute: typeof rootRouteImport
703+
}
664704
'/rsc-request-headers': {
665705
id: '/rsc-request-headers'
666706
path: '/rsc-request-headers'
@@ -924,6 +964,8 @@ const rootRouteChildren: RootRouteChildren = {
924964
RscParallelRoute: RscParallelRoute,
925965
RscReactCacheRoute: RscReactCacheRoute,
926966
RscRequestHeadersRoute: RscRequestHeadersRoute,
967+
RscServerNotFoundRoute: RscServerNotFoundRoute,
968+
RscServerRedirectRoute: RscServerRedirectRoute,
927969
RscSlotJsxArgsRoute: RscSlotJsxArgsRoute,
928970
RscSlotsRoute: RscSlotsRoute,
929971
RscSsrDataOnlyRoute: RscSsrDataOnlyRoute,

‎e2e/react-start/rsc/src/routes/__root.tsx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,22 @@ function RootComponent() {
312312
>
313313
Request Headers
314314
</Link>
315+
<Link
316+
to="/rsc-server-not-found"
317+
className="nav-link"
318+
activeProps={{ className: 'nav-link active' }}
319+
data-testid="nav-server-not-found"
320+
>
321+
Server Not Found
322+
</Link>
323+
<Link
324+
to="/rsc-server-redirect"
325+
className="nav-link"
326+
activeProps={{ className: 'nav-link active' }}
327+
data-testid="nav-server-redirect"
328+
>
329+
Server Redirect
330+
</Link>
315331
<Link
316332
to="/rsc-react-cache"
317333
className="nav-link"

‎e2e/react-start/rsc/src/routes/index.tsx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,20 @@ const examples = linkOptions([
209209
'Loader calls a server function that reads the incoming Cookie header in the RSC environment',
210210
icon: '🍪',
211211
},
212+
{
213+
to: '/rsc-server-not-found',
214+
title: 'RSC Server Not Found',
215+
description:
216+
'A server function throws notFound() and the route-level notFoundComponent handles it for both SSR and client navigation',
217+
icon: '🚧',
218+
},
219+
{
220+
to: '/rsc-server-redirect',
221+
title: 'RSC Server Redirect',
222+
description:
223+
'A server function throws redirect() and navigation lands on the redirected route for both SSR and client navigation',
224+
icon: '↪',
225+
},
212226
{
213227
to: '/rsc-react-cache',
214228
title: 'RSC React.cache',
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
import { Link, createFileRoute, notFound } from '@tanstack/react-router'
2+
import { createServerFn } from '@tanstack/react-start'
3+
import { pageStyles } from '~/utils/styles'
4+
5+
const getMissingResource = createServerFn({
6+
method: 'GET',
7+
}).handler(async () => {
8+
throw notFound()
9+
})
10+
11+
export const Route = createFileRoute('/rsc-server-not-found')({
12+
loader: async () => {
13+
await getMissingResource()
14+
},
15+
component: RscServerNotFoundComponent,
16+
notFoundComponent: RscServerNotFoundBoundary,
17+
})
18+
19+
function RscServerNotFoundComponent() {
20+
return (
21+
<div style={pageStyles.container}>
22+
<h1 data-testid="rsc-server-not-found-title" style={pageStyles.title}>
23+
RSC Server Not Found
24+
</h1>
25+
</div>
26+
)
27+
}
28+
29+
function RscServerNotFoundBoundary() {
30+
return (
31+
<div
32+
style={pageStyles.container}
33+
data-testid="rsc-server-not-found-boundary"
34+
>
35+
<h1 data-testid="rsc-server-not-found-heading" style={pageStyles.title}>
36+
RSC Server Function Not Found
37+
</h1>
38+
<p
39+
data-testid="rsc-server-not-found-message"
40+
style={pageStyles.description}
41+
>
42+
The server function threw `notFound()` and the route-level not found
43+
boundary rendered instead of crashing.
44+
</p>
45+
<Link to="/" data-testid="rsc-server-not-found-home-link">
46+
Back home
47+
</Link>
48+
</div>
49+
)
50+
}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import { createFileRoute, redirect } from '@tanstack/react-router'
2+
import { createServerFn } from '@tanstack/react-start'
3+
import { pageStyles } from '~/utils/styles'
4+
5+
const redirectToBasic = createServerFn({
6+
method: 'GET',
7+
}).handler(async () => {
8+
throw redirect({ to: '/rsc-basic' })
9+
})
10+
11+
export const Route = createFileRoute('/rsc-server-redirect')({
12+
loader: async () => {
13+
await redirectToBasic()
14+
},
15+
component: RscServerRedirectComponent,
16+
})
17+
18+
function RscServerRedirectComponent() {
19+
return (
20+
<div style={pageStyles.container}>
21+
<h1 data-testid="rsc-server-redirect-title" style={pageStyles.title}>
22+
RSC Server Redirect
23+
</h1>
24+
</div>
25+
)
26+
}
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
import { expect } from '@playwright/test'
2+
import { test } from '@tanstack/router-e2e-utils'
3+
4+
test.describe('RSC Server Not Found Tests', () => {
5+
test.use({
6+
whitelistErrors: [
7+
'Failed to load resource: the server responded with a status of 404',
8+
],
9+
})
10+
11+
test('SSR renders the route notFoundComponent when a server function throws notFound', async ({
12+
page,
13+
}) => {
14+
const response = await page.goto('/rsc-server-not-found')
15+
await page.waitForURL('/rsc-server-not-found')
16+
17+
expect(response?.status()).toBe(404)
18+
19+
await expect(
20+
page.getByTestId('rsc-server-not-found-boundary'),
21+
).toBeVisible()
22+
await expect(page.getByTestId('rsc-server-not-found-heading')).toHaveText(
23+
'RSC Server Function Not Found',
24+
)
25+
await expect(
26+
page.getByTestId('rsc-server-not-found-message'),
27+
).toContainText('server function threw `notFound()`')
28+
})
29+
30+
test('client navigation renders the route notFoundComponent when a server function throws notFound', async ({
31+
page,
32+
}) => {
33+
await page.goto('/')
34+
await page.waitForURL('/')
35+
await expect(page.getByTestId('app-hydrated')).toHaveText('hydrated')
36+
37+
await page.getByTestId('nav-server-not-found').click()
38+
await page.waitForURL('/rsc-server-not-found')
39+
40+
await expect(
41+
page.getByTestId('rsc-server-not-found-boundary'),
42+
).toBeVisible()
43+
await expect(page.getByTestId('rsc-server-not-found-heading')).toHaveText(
44+
'RSC Server Function Not Found',
45+
)
46+
})
47+
})
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import { expect } from '@playwright/test'
2+
import { test } from '@tanstack/router-e2e-utils'
3+
4+
test.describe('RSC Server Redirect Tests', () => {
5+
test('SSR follows route redirect when a server function throws redirect', async ({
6+
page,
7+
}) => {
8+
const response = await page.goto('/rsc-server-redirect')
9+
await page.waitForURL('/rsc-basic')
10+
11+
expect(response?.status()).toBe(200)
12+
await expect(page.getByTestId('rsc-basic-content')).toBeVisible()
13+
})
14+
15+
test('client navigation follows route redirect when a server function throws redirect', async ({
16+
page,
17+
}) => {
18+
await page.goto('/')
19+
await page.waitForURL('/')
20+
await expect(page.getByTestId('app-hydrated')).toHaveText('hydrated')
21+
22+
await page.getByTestId('nav-server-redirect').click()
23+
await page.waitForURL('/rsc-basic')
24+
25+
await expect(page.getByTestId('rsc-basic-content')).toBeVisible()
26+
})
27+
})

‎packages/react-router/package.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@
4848
"module": "dist/esm/index.js",
4949
"exports": {
5050
".": {
51+
"react-server": {
52+
"types": "./dist/esm/index.rsc.d.ts",
53+
"default": "./dist/esm/index.rsc.js"
54+
},
5155
"import": {
5256
"types": "./dist/esm/index.d.ts",
5357
"development": "./dist/esm/index.dev.js",
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
export * from './index'
2+
3+
export {
4+
notFound,
5+
isNotFound,
6+
redirect,
7+
isRedirect,
8+
rootRouteId,
9+
} from '@tanstack/router-core'
10+
11+
export type { NotFoundError } from '@tanstack/router-core'

0 commit comments

Comments
 (0)