feat(core): redirect to previous path after login (#5932)

Author: ricokahler

packages/sanity/src/core/store/_legacy/authStore/createLoginComponent.tsx

@@ -59,7 +59,7 @@ interface CreateLoginComponentOptions extends AuthConfig {
 }
 
 interface CreateHrefForProviderOptions {
-  basePath: string
+  redirectPath: string
   loginMethod: AuthConfig['loginMethod']
   projectId: string
   url: string
@@ -69,10 +69,10 @@ function createHrefForProvider({
   loginMethod = 'dual',
   projectId,
   url,
-  basePath,
+  redirectPath,
 }: CreateHrefForProviderOptions) {
   const params = new URLSearchParams()
-  params.set('origin', `${window.location.origin}${basePath}`)
+  params.set('origin', `${window.location.origin}${redirectPath}`)
   params.set('projectId', projectId)
 
   // Setting `type=token` will return the sid as part of the _query_, which may end up in
@@ -96,7 +96,9 @@ export function createLoginComponent({
 }: CreateLoginComponentOptions) {
   const useClient = createHookFromObservableFactory(getClient)
 
-  function LoginComponent({projectId, basePath}: LoginComponentProps) {
+  function LoginComponent({projectId, ...props}: LoginComponentProps) {
+    const redirectPath = props.redirectPath || props.basePath || '/'
+
     const [providers, setProviders] = useState<AuthProvider[] | null>(null)
     const [error, setError] = useState<unknown>(null)
     if (error) throw error
@@ -113,24 +115,24 @@ export function createLoginComponent({
 
     // only create a direct URL if `redirectOnSingle` is true and there is only
     // one provider available
-    const redirectUrl =
+    const redirectUrlForRedirectOnSingle =
       redirectOnSingle &&
       providers?.length === 1 &&
       providers?.[0] &&
       createHrefForProvider({
         loginMethod,
         projectId,
         url: providers[0].url,
-        basePath,
+        redirectPath,
       })
 
-    const loading = !providers || redirectUrl
+    const loading = !providers || redirectUrlForRedirectOnSingle
 
     useEffect(() => {
-      if (redirectUrl) {
-        window.location.href = redirectUrl
+      if (redirectUrlForRedirectOnSingle) {
+        window.location.href = redirectUrlForRedirectOnSingle
       }
-    }, [redirectUrl])
+    }, [redirectUrlForRedirectOnSingle])
 
     if (loading) {
       return <LoadingBlock showText />
@@ -153,7 +155,7 @@ export function createLoginComponent({
                 loginMethod,
                 projectId,
                 url: provider.url,
-                basePath,
+                redirectPath,
               })}
               mode="ghost"
               size="large"

packages/sanity/src/core/store/_legacy/authStore/types.ts

@@ -78,7 +78,16 @@ export interface AuthState {
  * @beta
  * @hidden
  */
-export interface LoginComponentProps {
-  projectId: string
-  basePath: string
-}
+export type LoginComponentProps =
+  | {
+      projectId: string
+      /** @deprecated use redirectPath instead */
+      basePath: string
+      redirectPath?: string
+    }
+  | {
+      projectId: string
+      redirectPath: string
+      /** @deprecated use redirectPath instead */
+      basePath?: string
+    }

packages/sanity/src/core/studio/components/navbar/workspace/WorkspaceAuth/WorkspaceAuth.tsx

@@ -1,6 +1,5 @@
 import {AddIcon, ArrowLeftIcon, ChevronRightIcon} from '@sanity/icons'
 import {Box, Card, Flex, Stack} from '@sanity/ui'
-import {omit} from 'lodash'
 import {useCallback, useState} from 'react'
 
 import {Button} from '../../../../../../ui-components'
@@ -58,7 +57,14 @@ export function WorkspaceAuth() {
         >
           <Stack padding={2} paddingBottom={3} paddingTop={4}>
             <LoginComponent
-              {...omit(selectedWorkspace, ['type', '__internal'])}
+              projectId={selectedWorkspace.projectId}
+              redirectPath={
+                window.location.pathname.startsWith(selectedWorkspace.basePath)
+                  ? // NOTE: the fragment cannot be preserved because it's used
+                    // to transfer an sid to a token
+                    `${window.location.pathname}${window.location.search}`
+                  : selectedWorkspace.basePath
+              }
               key={selectedWorkspaceName}
             />
           </Stack>