From 046c7ab3e4c08cf888d64a01f3723e8879d54649 Mon Sep 17 00:00:00 2001 From: Tanner Linsley Date: Mon, 9 Dec 2024 00:08:51 -0700 Subject: [PATCH 1/2] checkpoint --- examples/react/start-basic/app/router.tsx | 12 ++++++++- .../app/utils/loggingMiddleware.tsx | 1 + .../app/utils/randomMiddleware.tsx | 17 ++++++++++++ packages/start/src/client/createMiddleware.ts | 5 ++-- packages/start/src/client/index.tsx | 3 +++ .../src/client/registerGlobalMiddleware.ts | 27 ++++++++++++++++--- 6 files changed, 58 insertions(+), 7 deletions(-) create mode 100644 examples/react/start-basic/app/utils/randomMiddleware.tsx diff --git a/examples/react/start-basic/app/router.tsx b/examples/react/start-basic/app/router.tsx index 0886de701f..772e5c5aeb 100644 --- a/examples/react/start-basic/app/router.tsx +++ b/examples/react/start-basic/app/router.tsx @@ -1,8 +1,11 @@ import { createRouter as createTanStackRouter } from '@tanstack/react-router' +import { registerGlobalMiddleware } from '@tanstack/start' import { routeTree } from './routeTree.gen' import { DefaultCatchBoundary } from './components/DefaultCatchBoundary' import { NotFound } from './components/NotFound' +import { randomMiddleware } from './utils/randomMiddleware' +// The function that creates the router export function createRouter() { const router = createTanStackRouter({ routeTree, @@ -14,8 +17,15 @@ export function createRouter() { return router } -declare module '@tanstack/react-router' { +// Add global middleware for all middleware and server functions +const _globalMiddleware = registerGlobalMiddleware({ + middleware: [randomMiddleware], +}) + +// Register type safety +declare module '@tanstack/start' { interface Register { router: ReturnType + globalMiddleware: typeof _globalMiddleware } } diff --git a/examples/react/start-basic/app/utils/loggingMiddleware.tsx b/examples/react/start-basic/app/utils/loggingMiddleware.tsx index 52c90185d0..da13d2b1ca 100644 --- a/examples/react/start-basic/app/utils/loggingMiddleware.tsx +++ b/examples/react/start-basic/app/utils/loggingMiddleware.tsx @@ -2,6 +2,7 @@ import { createMiddleware } from '@tanstack/start' export const logMiddleware = createMiddleware() .client(async (ctx) => { + console.log(ctx.context.clientRandom) const clientTime = new Date() return ctx.next({ diff --git a/examples/react/start-basic/app/utils/randomMiddleware.tsx b/examples/react/start-basic/app/utils/randomMiddleware.tsx new file mode 100644 index 0000000000..efb3457d7a --- /dev/null +++ b/examples/react/start-basic/app/utils/randomMiddleware.tsx @@ -0,0 +1,17 @@ +import { createMiddleware } from '@tanstack/start' + +export const randomMiddleware = createMiddleware() + .client((ctx) => { + return ctx.next({ + context: { + clientRandom: Math.random(), + }, + }) + }) + .server((ctx) => { + return ctx.next({ + context: { + serverRandom: Math.random(), + }, + }) + }) diff --git a/packages/start/src/client/createMiddleware.ts b/packages/start/src/client/createMiddleware.ts index 6eefb7751f..685ea70c40 100644 --- a/packages/start/src/client/createMiddleware.ts +++ b/packages/start/src/client/createMiddleware.ts @@ -1,3 +1,4 @@ +import type { RegisteredGlobalMiddleware } from './registerGlobalMiddleware' import type { ConstrainValidator, Method } from './createServerFn' import type { Assign, @@ -499,7 +500,7 @@ export function createMiddleware< >, ): Middleware< TId, - TMiddlewares, + RegisteredGlobalMiddleware, TValidator, TServerContext, TClientContext, @@ -564,7 +565,7 @@ export function createMiddleware< }, } as unknown as Middleware< TId, - TMiddlewares, + RegisteredGlobalMiddleware, TValidator, TServerContext, TClientContext, diff --git a/packages/start/src/client/index.tsx b/packages/start/src/client/index.tsx index 08f8b6f2df..bacf781cd5 100644 --- a/packages/start/src/client/index.tsx +++ b/packages/start/src/client/index.tsx @@ -40,6 +40,9 @@ export { export { registerGlobalMiddleware, globalMiddleware, + type GlobalMiddleware, + type Register, + type RegisteredGlobalMiddleware, } from './registerGlobalMiddleware' export { serverOnly, clientOnly } from './envOnly' export { DehydrateRouter } from './DehydrateRouter' diff --git a/packages/start/src/client/registerGlobalMiddleware.ts b/packages/start/src/client/registerGlobalMiddleware.ts index 3d7effc85b..0cc211a0d9 100644 --- a/packages/start/src/client/registerGlobalMiddleware.ts +++ b/packages/start/src/client/registerGlobalMiddleware.ts @@ -1,9 +1,28 @@ import type { AnyMiddleware } from './createMiddleware' -export const globalMiddleware: Array = [] +export interface Register { + // globalMiddleware: Array +} -export function registerGlobalMiddleware(options: { - middleware: Array -}) { +export type RegisteredGlobalMiddleware = Register extends { + globalMiddleware: infer TGlobalMiddleware extends { + middleware: Array + } +} + ? TGlobalMiddleware['middleware'] + : Array + +export type GlobalMiddleware> = { + middleware: TMiddleware +} + +export const globalMiddleware: RegisteredGlobalMiddleware = [] + +export function registerGlobalMiddleware< + const TMiddleware extends Array, +>(options: { middleware: TMiddleware }): GlobalMiddleware { globalMiddleware.push(...options.middleware) + return { + middleware: options.middleware, + } } From bab568fc6ec9675f40943c0b8f2c80189b8c5a8c Mon Sep 17 00:00:00 2001 From: chorobin Date: Wed, 11 Dec 2024 19:20:14 +0100 Subject: [PATCH 2/2] chore: use `createGlobalMiddleware` for global middleware --- .../app/utils/randomMiddleware.tsx | 4 +-- packages/start/src/client/createMiddleware.ts | 28 +++++++++++++++++++ packages/start/src/client/index.tsx | 1 + 3 files changed, 31 insertions(+), 2 deletions(-) diff --git a/examples/react/start-basic/app/utils/randomMiddleware.tsx b/examples/react/start-basic/app/utils/randomMiddleware.tsx index efb3457d7a..7c6e0dc1eb 100644 --- a/examples/react/start-basic/app/utils/randomMiddleware.tsx +++ b/examples/react/start-basic/app/utils/randomMiddleware.tsx @@ -1,6 +1,6 @@ -import { createMiddleware } from '@tanstack/start' +import { createGlobalMiddleware } from '@tanstack/start' -export const randomMiddleware = createMiddleware() +export const randomMiddleware = createGlobalMiddleware() .client((ctx) => { return ctx.next({ context: { diff --git a/packages/start/src/client/createMiddleware.ts b/packages/start/src/client/createMiddleware.ts index 685ea70c40..17b60d88bd 100644 --- a/packages/start/src/client/createMiddleware.ts +++ b/packages/start/src/client/createMiddleware.ts @@ -481,6 +481,34 @@ export interface Middleware< > } +export function createGlobalMiddleware< + const TId, + const TMiddlewares, + TValidator = undefined, + TServerContext = undefined, + TClientContext = undefined, + TClientAfterContext = undefined, +>( + options?: { + validateClient?: boolean + }, + __opts?: MiddlewareOptions< + TMiddlewares, + TValidator, + TServerContext, + TClientContext + >, +): Middleware< + TId, + TMiddlewares, + TValidator, + TServerContext, + TClientContext, + TClientAfterContext +> { + return createMiddleware(options, __opts) as any +} + export function createMiddleware< const TId, const TMiddlewares, diff --git a/packages/start/src/client/index.tsx b/packages/start/src/client/index.tsx index bacf781cd5..e57a0510df 100644 --- a/packages/start/src/client/index.tsx +++ b/packages/start/src/client/index.tsx @@ -24,6 +24,7 @@ export { } from './createServerFn' export { createMiddleware, + createGlobalMiddleware, type MergeAllValidatorInputs, type MergeAllValidatorOutputs, type MiddlewareServerFn,