-
-
Notifications
You must be signed in to change notification settings - Fork 174
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(#990): revamp callbackUrl computation
- Loading branch information
1 parent
172dc93
commit fff679c
Showing
6 changed files
with
151 additions
and
66 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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,116 @@ | ||
| import { getRequestURLWN } from '../composables/common/getRequestURL' | ||
| import type { RouteMiddleware } from '#app' | ||
| import { callWithNuxt, useNuxtApp, useRouter } from '#app' | ||
|
|
||
| /** Slimmed down auth runtime config for `determineCallbackUrl` */ | ||
| interface AuthRuntimeConfigForCallbackUrl { | ||
| globalAppMiddleware: { | ||
| addDefaultCallbackUrl?: string | boolean | ||
| } | boolean | ||
| } | ||
|
|
||
| // Overloads for better typing | ||
| export async function determineCallbackUrl( | ||
| authConfig: AuthRuntimeConfigForCallbackUrl, | ||
| userCallbackUrl: string | undefined, | ||
| inferFromRequest: true | ||
| ): Promise<string> | ||
| export async function determineCallbackUrl( | ||
| authConfig: AuthRuntimeConfigForCallbackUrl, | ||
| userCallbackUrl: string | undefined, | ||
| inferFromRequest?: false | undefined | ||
| ): Promise<string | undefined> | ||
|
|
||
| /** | ||
| * Determines the desired callback url based on the users desires. Either: | ||
| * - uses a hardcoded path the user provided, | ||
| * - determines the callback based on the target the user wanted to reach | ||
| * | ||
| * @param authConfig Authentication runtime module config | ||
| * @param userCallbackUrl Callback URL provided by a user, e.g. as options to `signIn` | ||
| * @param inferFromRequest When `true`, will always do inference. | ||
| * When `false`, will never infer. | ||
| * When `undefined`, inference depends on `addDefaultCallbackUrl` | ||
| */ | ||
| export async function determineCallbackUrl( | ||
| authConfig: AuthRuntimeConfigForCallbackUrl, | ||
| userCallbackUrl: string | undefined, | ||
| inferFromRequest?: boolean | undefined | ||
| ): Promise<string | undefined> { | ||
| // Priority 1: User setting | ||
| if (userCallbackUrl) { | ||
| return await normalizeCallbackUrl(userCallbackUrl) | ||
| } | ||
|
|
||
| // Priority 2: `addDefaultCallbackUrl` | ||
| const authConfigCallbackUrl = typeof authConfig.globalAppMiddleware === 'object' | ||
| ? authConfig.globalAppMiddleware.addDefaultCallbackUrl | ||
| : undefined | ||
|
|
||
| // If a string value was set, always callback to it | ||
| if (typeof authConfigCallbackUrl === 'string') { | ||
| return await normalizeCallbackUrl(authConfigCallbackUrl) | ||
| } | ||
|
|
||
| // Priority 3: Infer callback URL from the request | ||
| const shouldInferFromRequest = inferFromRequest !== false | ||
| && ( | ||
| inferFromRequest === true | ||
| || authConfigCallbackUrl === true | ||
| || (authConfigCallbackUrl === undefined && authConfig.globalAppMiddleware === true) | ||
| ) | ||
|
|
||
| if (shouldInferFromRequest) { | ||
| const nuxt = useNuxtApp() | ||
| return getRequestURLWN(nuxt) | ||
| } | ||
| } | ||
|
|
||
| // Avoid importing from `vue-router` directly | ||
| type RouteLocationNormalized = Parameters<RouteMiddleware>[0] | ||
|
|
||
| /** | ||
| * Determines the correct callback URL for usage with Nuxt Route Middleware. | ||
| * The difference with a plain `determineCallbackUrl` is that this function produces | ||
| * non-normalized URLs. It is done because the result is being passed to `signIn` which does normalization. | ||
| * | ||
| * @param authConfig NuxtAuth module config (`runtimeConfig.public.auth`) | ||
| * @param middlewareTo The `to` parameter of NuxtRouteMiddleware | ||
| */ | ||
| export function determineCallbackUrlForRouteMiddleware( | ||
| authConfig: AuthRuntimeConfigForCallbackUrl, | ||
| middlewareTo: RouteLocationNormalized | ||
| ): string | undefined { | ||
| const authConfigCallbackUrl = typeof authConfig.globalAppMiddleware === 'object' | ||
| ? authConfig.globalAppMiddleware.addDefaultCallbackUrl | ||
| : undefined | ||
|
|
||
| // Priority 1: If a string value `addDefaultCallbackUrl` was set, always callback to it | ||
| if (typeof authConfigCallbackUrl === 'string') { | ||
| return authConfigCallbackUrl | ||
| } | ||
|
|
||
| // Priority 2: `addDefaultCallbackUrl: true` or `globalAppMiddleware: true` | ||
| if ( | ||
| authConfigCallbackUrl === true | ||
| || (authConfigCallbackUrl === undefined && authConfig.globalAppMiddleware === true) | ||
| ) { | ||
| return middlewareTo.fullPath | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Normalizes the path by taking `app.baseURL` into account | ||
| * | ||
| * @see https://github.com/sidebase/nuxt-auth/issues/990#issuecomment-2630143443 | ||
| */ | ||
| async function normalizeCallbackUrl(rawCallbackUrl: string) { | ||
| const nuxt = useNuxtApp() | ||
| const router = await callWithNuxt(nuxt, useRouter) | ||
|
|
||
| const resolvedUserRoute = router.resolve(rawCallbackUrl) | ||
| // no check for `resolvedUserRoute.matched` - prefer to show default 404 instead | ||
|
|
||
| // Use `href` to include any possible `app.baseURL` | ||
| return resolvedUserRoute.href | ||
| } |
This file contains 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