Adds configurable redirect path after login

gousta · May 1, 2024 · 9e17187 · 9e17187
1 parent 3dd8046
commit 9e17187
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 9 deletions.
diff --git a/src/components/SignInButton/SignInButton.tsx b/src/components/SignInButton/SignInButton.tsx
@@ -2,11 +2,22 @@ import Button from 'payload/dist/admin/components/elements/Button';
 import React from 'react';
 
 export default function SignInButton() {
+  let signInUrl = '/oidc/signin';
+
+  try {
+    const redirectUrl = new URLSearchParams(window.location.search).get('redirect');
+    if (redirectUrl) {
+      signInUrl = `${signInUrl}?redirect=${redirectUrl}`;
+    }
+  } catch (e) {
+    console.error('Failed to read `redirect` query parameter from the url', e);
+  }
+
   return (
     <div style={{ width: '100%', textAlign: 'center' }}>
       <h4 style={{ marginBottom: 0 }}>Deliverback Content</h4>
 
-      <Button className="SignInButton" el="anchor" url="/oidc/signin">
+      <Button className="SignInButton" el="anchor" url={signInUrl}>
         Sign in with your identity
       </Button>
     </div>

diff --git a/src/lib/login.ts b/src/lib/login.ts
@@ -6,7 +6,8 @@ import getCookieExpiration from 'payload/dist/utilities/getCookieExpiration';
 import { PayloadRequest, SanitizedCollectionConfig } from 'payload/types';
 
 export const loginHandler =
-  (userCollectionSlug: string) => async (req: PayloadRequest, res: Response) => {
+  (userCollectionSlug: string, redirectPathAfterLogin: string) =>
+  async (req: PayloadRequest, res: Response) => {
     // Get the Mongoose user
     const collectionConfig = payload.collections[userCollectionSlug].config;
 
@@ -33,7 +34,7 @@ export const loginHandler =
     });
 
     // Redirect to admin dashboard
-    return res.redirect('/admin');
+    return res.redirect(redirectPathAfterLogin);
   };
 
 const getFieldsToSign = (collectionConfig: SanitizedCollectionConfig, user: any) => {

diff --git a/src/plugin.ts b/src/plugin.ts
@@ -18,10 +18,10 @@ export const oidcPlugin =
   (opts: oidcPluginOptions) =>
   (incomingConfig: Config): Config => {
     let config = { ...incomingConfig };
-    const buttonComponentPosition = opts.components?.position ?? "beforeLogin";
+    const buttonComponentPosition = opts.components?.position ?? 'beforeLogin';
     let componentConfigs = config.admin?.components?.beforeLogin || [];
 
-    if(buttonComponentPosition == "afterLogin"){
+    if (buttonComponentPosition == 'afterLogin') {
       componentConfigs = config.admin?.components?.afterLogin || [];
     }
 
@@ -33,9 +33,9 @@ export const oidcPlugin =
         ...(config.admin?.components || {}),
         [buttonComponentPosition]: [
           ...(componentConfigs || []),
-          opts.components?.Button ?? SignInButton
-        ]
-      }
+          opts.components?.Button ?? SignInButton,
+        ],
+      },
     };
 
     if (isUI) return config;
@@ -75,7 +75,7 @@ export const oidcPlugin =
         path: callbackPath,
         method: 'get',
         root: true,
-        handler: loginHandler(userCollectionSlug),
+        handler: loginHandler(userCollectionSlug, opts.redirectPathAfterLogin || '/admin'),
       },
     ];
 

diff --git a/src/types.ts b/src/types.ts
@@ -28,6 +28,9 @@ export interface oidcPluginOptions extends StrategyOptions {
   /** Which path to mount for the callback endpoint in express, defaults to the path in callbackURL */
   callbackPath?: string;
 
+  /** Path to redirect to after login, defaults to `/admin` */
+  redirectPathAfterLogin?: string;
+
   /** Override button component */
   components?: {
     Button?: ComponentType<any>;