feat(tanstack-react-start): Introduce middleware and support for TanStack Start RC #6859
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| "@clerk/tanstack-react-start": minor | ||
| --- | ||
|
|
||
| Added support for [TanStack Start v1 RC](https://tanstack.com/blog/announcing-tanstack-start-v1)! Includes a new `clerkMiddleware()` global middleware replacing the custom server handler. | ||
|
|
||
| Usage: | ||
|
|
||
| 1. Create a `src/start.ts` file and add `clerkMiddleware()` to the list of request middlewares: | ||
|
|
||
| ```ts | ||
| // src/start.ts | ||
| import { clerkMiddleware } from '@clerk/tanstack-react-start/server' | ||
| import { createStart } from '@tanstack/react-start' | ||
|
|
||
| export const startInstance = createStart(() => { | ||
| return { | ||
| requestMiddleware: [clerkMiddleware()], | ||
| } | ||
| }) | ||
| ``` | ||
|
|
||
| 2. Add `<ClerkProvider>` to your root route | ||
|
|
||
| ```tsx | ||
| // src/routes/__root.tsx | ||
| import { ClerkProvider } from '@clerk/tanstack-react-start' | ||
|
|
||
| export const Route = createRootRoute({...}) | ||
|
|
||
| function RootDocument({ children }: { children: React.ReactNode }) { | ||
| return ( | ||
| <html> | ||
| <head> | ||
| <HeadContent /> | ||
| </head> | ||
| <body> | ||
| <ClerkProvider> | ||
| {children} | ||
| </ClerkProvider> | ||
| <Scripts /> | ||
| </body> | ||
| </html> | ||
| ) | ||
| } | ||
| ``` | ||
|
|
||
| The `getAuth()` helper is now `auth()` and can now be called within server routes and functions, without passing a Request object: | ||
|
|
||
| ```ts | ||
| import { auth } from '@clerk/tanstack-react-start/server' | ||
|
|
||
| const authStateFn = createServerFn().handler(async () => { | ||
| const { userId } = await auth() | ||
|
|
||
| if (!userId) { | ||
| throw redirect({ | ||
| to: '/sign-in', | ||
| }) | ||
| } | ||
|
|
||
| return { userId } | ||
| }) | ||
|
|
||
| export const Route = createFileRoute('/')({ | ||
| component: Home, | ||
| beforeLoad: async () => await authStateFn(), | ||
| loader: async ({ context }) => { | ||
| return { userId: context.userId } | ||
| }, | ||
| }) | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { clerkMiddleware } from '@clerk/tanstack-react-start/server'; | ||
| import { createStart } from '@tanstack/react-start'; | ||
|
|
||
| export const startInstance = createStart(() => { | ||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return { | ||
| requestMiddleware: [clerkMiddleware()], | ||
| }; | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| import type { SessionAuthObject } from '@clerk/backend'; | ||
| import type { AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal'; | ||
| import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal'; | ||
| import { getGlobalStartContext } from '@tanstack/react-start'; | ||
|
|
||
| import { errorThrower } from '../utils'; | ||
| import { clerkMiddlewareNotConfigured } from '../utils/errors'; | ||
|
|
||
| export const auth: GetAuthFnNoRequest<SessionAuthObject, true> = (async (opts?: AuthOptions) => { | ||
| // @ts-expect-error: Untyped internal Clerk start context | ||
| const authObjectFn = getGlobalStartContext().auth; | ||
|
|
||
| if (!authObjectFn) { | ||
| return errorThrower.throw(clerkMiddlewareNotConfigured); | ||
| } | ||
|
|
||
| // We're keeping it a promise for now for future changes | ||
| const authObject = await Promise.resolve(authObjectFn({ treatPendingAsSignedOut: opts?.treatPendingAsSignedOut })); | ||
|
|
||
| return getAuthObjectForAcceptedToken({ authObject, acceptsToken: opts?.acceptsToken }); | ||
| }) as GetAuthFnNoRequest<SessionAuthObject, true>; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import type { RequestState } from '@clerk/backend/internal'; | ||
| import { AuthStatus, constants } from '@clerk/backend/internal'; | ||
| import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler'; | ||
| import type { PendingSessionOptions } from '@clerk/types'; | ||
| import type { AnyRequestMiddleware } from '@tanstack/react-start'; | ||
| import { createMiddleware, json } from '@tanstack/react-start'; | ||
|
|
||
| import { clerkClient } from './clerkClient'; | ||
| import { loadOptions } from './loadOptions'; | ||
| import type { ClerkMiddlewareOptions } from './types'; | ||
| import { getResponseClerkState } from './utils'; | ||
|
|
||
| export const clerkMiddleware = (options?: ClerkMiddlewareOptions): AnyRequestMiddleware => { | ||
| return createMiddleware().server(async args => { | ||
| const loadedOptions = loadOptions(args.request, options); | ||
| const requestState = await clerkClient().authenticateRequest(args.request, { | ||
| ...loadedOptions, | ||
| acceptsToken: 'any', | ||
| }); | ||
|
|
||
| const locationHeader = requestState.headers.get(constants.Headers.Location); | ||
| if (locationHeader) { | ||
| handleNetlifyCacheInDevInstance({ | ||
| locationHeader, | ||
| requestStateHeaders: requestState.headers, | ||
| publishableKey: requestState.publishableKey, | ||
| }); | ||
| // Trigger a handshake redirect | ||
| // eslint-disable-next-line @typescript-eslint/only-throw-error | ||
| throw json(null, { status: 307, headers: requestState.headers }); | ||
| } | ||
|
|
||
| if (requestState.status === AuthStatus.Handshake) { | ||
| throw new Error('Clerk: handshake status without redirect'); | ||
| } | ||
|
|
||
| const clerkInitialState = getResponseClerkState(requestState as RequestState, loadedOptions); | ||
|
|
||
| const result = await args.next({ | ||
| context: { | ||
| clerkInitialState, | ||
|
There was a problem hiding this comment. This will be accessed by |
||
| auth: (opts?: PendingSessionOptions) => requestState.toAuth(opts), | ||
|
There was a problem hiding this comment. This one is for |
||
| }, | ||
| }); | ||
|
|
||
| if (requestState.headers) { | ||
| requestState.headers.forEach((value, key) => { | ||
| result.response.headers.append(key, value); | ||
| }); | ||
| } | ||
|
|
||
| return result; | ||
| }); | ||
| }; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.