Skip to content

Commit 55b636c

Browse files
committed
fix: refactor middleware
1 parent a0c7142 commit 55b636c

5 files changed

Lines changed: 120 additions & 54 deletions

File tree

‎e2e/react-start/server-functions/src/routeTree.gen.ts‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { Route as MiddlewareIndexRouteImport } from './routes/middleware/index'
2727
import { Route as FormdataRedirectIndexRouteImport } from './routes/formdata-redirect/index'
2828
import { Route as FactoryIndexRouteImport } from './routes/factory/index'
2929
import { Route as CookiesIndexRouteImport } from './routes/cookies/index'
30+
import { Route as MiddlewareUnhandledExceptionRouteImport } from './routes/middleware/unhandled-exception'
3031
import { Route as MiddlewareSendServerFnRouteImport } from './routes/middleware/send-serverFn'
3132
import { Route as MiddlewareRequestMiddlewareRouteImport } from './routes/middleware/request-middleware'
3233
import { Route as MiddlewareClientMiddlewareRouterRouteImport } from './routes/middleware/client-middleware-router'
@@ -123,6 +124,12 @@ const CookiesIndexRoute = CookiesIndexRouteImport.update({
123124
path: '/cookies/',
124125
getParentRoute: () => rootRouteImport,
125126
} as any)
127+
const MiddlewareUnhandledExceptionRoute =
128+
MiddlewareUnhandledExceptionRouteImport.update({
129+
id: '/middleware/unhandled-exception',
130+
path: '/middleware/unhandled-exception',
131+
getParentRoute: () => rootRouteImport,
132+
} as any)
126133
const MiddlewareSendServerFnRoute = MiddlewareSendServerFnRouteImport.update({
127134
id: '/middleware/send-serverFn',
128135
path: '/middleware/send-serverFn',
@@ -170,6 +177,7 @@ export interface FileRoutesByFullPath {
170177
'/middleware/client-middleware-router': typeof MiddlewareClientMiddlewareRouterRoute
171178
'/middleware/request-middleware': typeof MiddlewareRequestMiddlewareRoute
172179
'/middleware/send-serverFn': typeof MiddlewareSendServerFnRoute
180+
'/middleware/unhandled-exception': typeof MiddlewareUnhandledExceptionRoute
173181
'/cookies': typeof CookiesIndexRoute
174182
'/factory': typeof FactoryIndexRoute
175183
'/formdata-redirect': typeof FormdataRedirectIndexRoute
@@ -195,6 +203,7 @@ export interface FileRoutesByTo {
195203
'/middleware/client-middleware-router': typeof MiddlewareClientMiddlewareRouterRoute
196204
'/middleware/request-middleware': typeof MiddlewareRequestMiddlewareRoute
197205
'/middleware/send-serverFn': typeof MiddlewareSendServerFnRoute
206+
'/middleware/unhandled-exception': typeof MiddlewareUnhandledExceptionRoute
198207
'/cookies': typeof CookiesIndexRoute
199208
'/factory': typeof FactoryIndexRoute
200209
'/formdata-redirect': typeof FormdataRedirectIndexRoute
@@ -221,6 +230,7 @@ export interface FileRoutesById {
221230
'/middleware/client-middleware-router': typeof MiddlewareClientMiddlewareRouterRoute
222231
'/middleware/request-middleware': typeof MiddlewareRequestMiddlewareRoute
223232
'/middleware/send-serverFn': typeof MiddlewareSendServerFnRoute
233+
'/middleware/unhandled-exception': typeof MiddlewareUnhandledExceptionRoute
224234
'/cookies/': typeof CookiesIndexRoute
225235
'/factory/': typeof FactoryIndexRoute
226236
'/formdata-redirect/': typeof FormdataRedirectIndexRoute
@@ -248,6 +258,7 @@ export interface FileRouteTypes {
248258
| '/middleware/client-middleware-router'
249259
| '/middleware/request-middleware'
250260
| '/middleware/send-serverFn'
261+
| '/middleware/unhandled-exception'
251262
| '/cookies'
252263
| '/factory'
253264
| '/formdata-redirect'
@@ -273,6 +284,7 @@ export interface FileRouteTypes {
273284
| '/middleware/client-middleware-router'
274285
| '/middleware/request-middleware'
275286
| '/middleware/send-serverFn'
287+
| '/middleware/unhandled-exception'
276288
| '/cookies'
277289
| '/factory'
278290
| '/formdata-redirect'
@@ -298,6 +310,7 @@ export interface FileRouteTypes {
298310
| '/middleware/client-middleware-router'
299311
| '/middleware/request-middleware'
300312
| '/middleware/send-serverFn'
313+
| '/middleware/unhandled-exception'
301314
| '/cookies/'
302315
| '/factory/'
303316
| '/formdata-redirect/'
@@ -324,6 +337,7 @@ export interface RootRouteChildren {
324337
MiddlewareClientMiddlewareRouterRoute: typeof MiddlewareClientMiddlewareRouterRoute
325338
MiddlewareRequestMiddlewareRoute: typeof MiddlewareRequestMiddlewareRoute
326339
MiddlewareSendServerFnRoute: typeof MiddlewareSendServerFnRoute
340+
MiddlewareUnhandledExceptionRoute: typeof MiddlewareUnhandledExceptionRoute
327341
CookiesIndexRoute: typeof CookiesIndexRoute
328342
FactoryIndexRoute: typeof FactoryIndexRoute
329343
FormdataRedirectIndexRoute: typeof FormdataRedirectIndexRoute
@@ -460,6 +474,13 @@ declare module '@tanstack/react-router' {
460474
preLoaderRoute: typeof CookiesIndexRouteImport
461475
parentRoute: typeof rootRouteImport
462476
}
477+
'/middleware/unhandled-exception': {
478+
id: '/middleware/unhandled-exception'
479+
path: '/middleware/unhandled-exception'
480+
fullPath: '/middleware/unhandled-exception'
481+
preLoaderRoute: typeof MiddlewareUnhandledExceptionRouteImport
482+
parentRoute: typeof rootRouteImport
483+
}
463484
'/middleware/send-serverFn': {
464485
id: '/middleware/send-serverFn'
465486
path: '/middleware/send-serverFn'
@@ -516,6 +537,7 @@ const rootRouteChildren: RootRouteChildren = {
516537
MiddlewareClientMiddlewareRouterRoute: MiddlewareClientMiddlewareRouterRoute,
517538
MiddlewareRequestMiddlewareRoute: MiddlewareRequestMiddlewareRoute,
518539
MiddlewareSendServerFnRoute: MiddlewareSendServerFnRoute,
540+
MiddlewareUnhandledExceptionRoute: MiddlewareUnhandledExceptionRoute,
519541
CookiesIndexRoute: CookiesIndexRoute,
520542
FactoryIndexRoute: FactoryIndexRoute,
521543
FormdataRedirectIndexRoute: FormdataRedirectIndexRoute,

‎e2e/react-start/server-functions/src/routes/index.tsx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@ function Home() {
8888
<li>
8989
<Link to="/factory">Server Functions Factory E2E tests</Link>
9090
</li>
91+
<li>
92+
<Link to="/middleware/unhandled-exception">
93+
Server Functions Middleware Unhandled Exception E2E tests
94+
</Link>
95+
</li>
9196
</ul>
9297
</div>
9398
)
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import { createFileRoute } from '@tanstack/react-router'
2+
import { createMiddleware, createServerFn } from '@tanstack/react-start'
3+
4+
export const authMiddleware = createMiddleware({ type: 'function' }).server(
5+
async ({ next, context }) => {
6+
throw new Error('Unauthorized')
7+
},
8+
)
9+
10+
const personServerFn = createServerFn({ method: 'GET' })
11+
.middleware([authMiddleware])
12+
.inputValidator((d: string) => d)
13+
.handler(({ data: name }) => {
14+
return { name, randomNumber: Math.floor(Math.random() * 100) }
15+
})
16+
17+
export const Route = createFileRoute('/middleware/unhandled-exception')({
18+
loader: async () => {
19+
return {
20+
person: await personServerFn({ data: 'John Doe' }),
21+
}
22+
},
23+
component: RouteComponent,
24+
})
25+
26+
function RouteComponent() {
27+
const { person } = Route.useLoaderData()
28+
return (
29+
<div data-testid="regular-person">
30+
{person.name} - {person.randomNumber}
31+
</div>
32+
)
33+
}

‎packages/start-client-core/src/createServerFn.ts‎

Lines changed: 60 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { isNotFound, isRedirect } from '@tanstack/router-core'
21
import { mergeHeaders } from '@tanstack/router-core/ssr/client'
32

43
import { TSS_SERVER_FUNCTION_FACTORY } from './constants'
@@ -112,17 +111,17 @@ export const createServerFn: CreateServerFn<Register> = (options, __opts) => {
112111
return Object.assign(
113112
async (opts?: CompiledFetcherFnOptions) => {
114113
// Start by executing the client-side middleware chain
115-
return executeMiddleware(resolvedMiddleware, 'client', {
114+
const result = await executeMiddleware(resolvedMiddleware, 'client', {
116115
...extractedFn,
117116
...newOptions,
118117
data: opts?.data as any,
119118
headers: opts?.headers,
120119
signal: opts?.signal,
121120
context: {},
122-
}).then((d) => {
123-
if (d.error) throw d.error
124-
return d.result
125121
})
122+
123+
if (result.error) throw result.error
124+
return result.result
126125
},
127126
{
128127
// This copies over the URL, function ID
@@ -180,7 +179,7 @@ export async function executeMiddleware(
180179
...middlewares,
181180
])
182181

183-
const next: NextFn = async (ctx) => {
182+
const callNextMiddleware: NextFn = async (ctx) => {
184183
// Get the next middleware
185184
const nextMiddleware = flattenedMiddlewares.shift()
186185

@@ -212,27 +211,70 @@ export async function executeMiddleware(
212211
middlewareFn = nextMiddleware.options.server as MiddlewareFn | undefined
213212
}
214213

215-
if (middlewareFn) {
216-
// Execute the middleware
217-
return applyMiddleware(middlewareFn, ctx, async (newCtx) => {
218-
return next(newCtx).catch((error: any) => {
219-
if (isRedirect(error) || isNotFound(error)) {
214+
// Execute the middleware
215+
try {
216+
if (middlewareFn) {
217+
const userNext = async (
218+
userCtx: ServerFnMiddlewareResult | undefined = {} as any,
219+
) => {
220+
// Return the next middleware
221+
const nextCtx = {
222+
...ctx,
223+
...userCtx,
224+
context: {
225+
...ctx.context,
226+
...userCtx.context,
227+
},
228+
sendContext: {
229+
...ctx.sendContext,
230+
...(userCtx.sendContext ?? {}),
231+
},
232+
headers: mergeHeaders(ctx.headers, userCtx.headers),
233+
result:
234+
userCtx.result !== undefined
235+
? userCtx.result
236+
: userCtx instanceof Response
237+
? userCtx
238+
: (ctx as any).result,
239+
error: userCtx.error ?? (ctx as any).error,
240+
}
241+
242+
try {
243+
return await callNextMiddleware(nextCtx)
244+
} catch (error: any) {
220245
return {
221-
...newCtx,
246+
...nextCtx,
222247
error,
223248
}
224249
}
250+
}
225251

226-
throw error
227-
})
228-
})
229-
}
252+
// Execute the middleware
253+
const result = await middlewareFn({
254+
...ctx,
255+
next: userNext as any,
256+
} as any)
257+
258+
if (!(result as any)) {
259+
throw new Error(
260+
'User middleware returned undefined. You must call next() or return a result in your middlewares.',
261+
)
262+
}
263+
264+
return result
265+
}
230266

231-
return next(ctx)
267+
return callNextMiddleware(ctx)
268+
} catch (error: any) {
269+
return {
270+
...ctx,
271+
error,
272+
}
273+
}
232274
}
233275

234276
// Start the middleware chain
235-
return next({
277+
return callNextMiddleware({
236278
...opts,
237279
headers: opts.headers || {},
238280
sendContext: opts.sendContext || {},
@@ -628,41 +670,6 @@ export type MiddlewareFn = (
628670
},
629671
) => Promise<ServerFnMiddlewareResult>
630672

631-
export const applyMiddleware = async (
632-
middlewareFn: MiddlewareFn,
633-
ctx: ServerFnMiddlewareOptions,
634-
nextFn: NextFn,
635-
) => {
636-
return middlewareFn({
637-
...ctx,
638-
next: (async (
639-
userCtx: ServerFnMiddlewareResult | undefined = {} as any,
640-
) => {
641-
// Return the next middleware
642-
return nextFn({
643-
...ctx,
644-
...userCtx,
645-
context: {
646-
...ctx.context,
647-
...userCtx.context,
648-
},
649-
sendContext: {
650-
...ctx.sendContext,
651-
...(userCtx.sendContext ?? {}),
652-
},
653-
headers: mergeHeaders(ctx.headers, userCtx.headers),
654-
result:
655-
userCtx.result !== undefined
656-
? userCtx.result
657-
: userCtx instanceof Response
658-
? userCtx
659-
: (ctx as any).result,
660-
error: userCtx.error ?? (ctx as any).error,
661-
})
662-
}) as any,
663-
} as any)
664-
}
665-
666673
export function execValidator(
667674
validator: AnyValidator,
668675
input: unknown,

‎packages/start-client-core/src/index.tsx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ export type {
7474
RequiredFetcher,
7575
} from './createServerFn'
7676
export {
77-
applyMiddleware,
7877
execValidator,
7978
flattenMiddlewares,
8079
executeMiddleware,

0 commit comments

Comments
 (0)