Merge pull request #1168 from CruGlobal/8386-login-redirect

[MPDX-8386] Redirect after login

pages/accountLists.page.test.tsx

@@ -20,10 +20,12 @@ interface GetServerSidePropsReturn {
   redirect: unknown;
 }
 
-const accountListId = 'accountID1';
+const accountListId = 'account-list-1';
 
 describe('Account Lists page', () => {
-  const context = {} as GetServerSidePropsContext;
+  const context = {
+    resolvedUrl: '/accountLists/account-list-1',
+  } as GetServerSidePropsContext;
 
   describe('NextAuth unauthorized', () => {
     it('should redirect to login', async () => {
@@ -35,7 +37,7 @@ describe('Account Lists page', () => {
 
       expect(props).toBeUndefined();
       expect(redirect).toEqual({
-        destination: '/login',
+        destination: '/login?redirect=%2FaccountLists%2Faccount-list-1',
         permanent: false,
       });
     });

pages/accountLists/[accountListId].page.test.tsx

@@ -5,7 +5,6 @@ import { render } from '@testing-library/react';
 import { GraphQLError } from 'graphql';
 import { getSession } from 'next-auth/react';
 import { I18nextProvider } from 'react-i18next';
-import { session } from '__tests__/fixtures/session';
 import TestRouter from '__tests__/util/TestRouter';
 import { GqlMockedProvider } from '__tests__/util/graphqlMocking';
 import makeSsrClient from 'src/lib/apollo/ssrClient';
@@ -29,29 +28,26 @@ describe('AccountListsId page', () => {
     query: {
       accountListId: 'account-list-1',
     },
+    resolvedUrl: '/accountLists/account-list-1',
   } as unknown as GetServerSidePropsContext;
 
   describe('NextAuth unauthorized', () => {
     it('should redirect to login', async () => {
-      (getSession as jest.Mock).mockResolvedValue(null);
+      (getSession as jest.Mock).mockResolvedValueOnce(null);
 
       const { props, redirect } = (await getServerSideProps(
         context,
       )) as GetServerSidePropsReturn;
 
       expect(props).toBeUndefined();
       expect(redirect).toEqual({
-        destination: '/login',
+        destination: '/login?redirect=%2FaccountLists%2Faccount-list-1',
         permanent: false,
       });
     });
   });
 
   describe('NextAuth authorized', () => {
-    beforeEach(() => {
-      (getSession as jest.Mock).mockResolvedValue(session);
-    });
-
     it('redirects to the home page on GraphQL query error', async () => {
       (makeSsrClient as jest.Mock).mockReturnValue({
         query: jest

pages/account_lists/[accountListId]/accept_invite/[inviteId].page.test.tsx

@@ -1,5 +1,4 @@
 import { GetServerSidePropsContext } from 'next';
-import { session } from '__tests__/fixtures/session';
 import { getServerSideProps } from './[inviteId].page';
 
 describe('Account Invite Link Redirect', () => {
@@ -24,9 +23,6 @@ describe('Account Invite Link Redirect', () => {
           '/acceptInvite?accountListId=test-account-list-id&accountInviteId=test-invite-id&inviteCode=test-code',
         permanent: true,
       },
-      props: {
-        session: session,
-      },
     });
   });
 
@@ -45,9 +41,6 @@ describe('Account Invite Link Redirect', () => {
         destination: '/accountLists/_/',
         permanent: true,
       },
-      props: {
-        session: session,
-      },
     });
   });
 });

pages/account_lists/[accountListId]/accept_invite/[inviteId].page.tsx

@@ -1,32 +1,27 @@
 import { GetServerSideProps } from 'next';
 import { ReactNode } from 'react';
 import { getSession } from 'next-auth/react';
+import { loginRedirect } from 'pages/api/utils/pagePropsHelpers';
 
 // This page redirect old email invite links to the new page that handles invites
 const InvitePage = (): ReactNode => null;
 
 export const getServerSideProps: GetServerSideProps = async (context) => {
   const session = await getSession(context);
-  const { accountListId, inviteId, code } = context.query;
+  if (!session) {
+    return loginRedirect(context);
+  }
 
+  const { accountListId, inviteId, code } = context.query;
   const redirectURL =
     accountListId && inviteId && code
       ? `/acceptInvite?accountListId=${accountListId}&accountInviteId=${inviteId}&inviteCode=${code}`
       : // Intentionally redirect to invalid accountListId since we don't have the current user's accountListId
         '/accountLists/_/';
-
   return {
-    redirect: session
-      ? {
-          destination: redirectURL,
-          permanent: true,
-        }
-      : {
-          destination: '/login',
-          permanent: false,
-        },
-    props: {
-      session,
+    redirect: {
+      destination: redirectURL,
+      permanent: true,
     },
   };
 };

pages/api/utils/pagePropsHelpers.test.ts

@@ -4,15 +4,28 @@ import { session } from '__tests__/fixtures/session';
 import {
   enforceAdmin,
   loadSession,
+  loginRedirect,
   makeGetServerSideProps,
 } from './pagePropsHelpers';
 
 jest.mock('next-auth/react');
 
 const context = {
   query: { accountListId: 'account-list-1' },
+  resolvedUrl: '/page?param=value',
 } as unknown as GetServerSidePropsContext;
 
+describe('loginRedirect', () => {
+  it('returns redirect with current URL', () => {
+    expect(loginRedirect(context)).toEqual({
+      redirect: {
+        destination: '/login?redirect=%2Fpage%3Fparam%3Dvalue',
+        permanent: false,
+      },
+    });
+  });
+});
+
 describe('enforceAdmin', () => {
   it('does not return a redirect if the user is an admin', async () => {
     (getSession as jest.Mock).mockResolvedValue({ user: { admin: true } });
@@ -50,7 +63,7 @@ describe('loadSession', () => {
 
     await expect(loadSession(context)).resolves.toMatchObject({
       redirect: {
-        destination: '/login',
+        destination: '/login?redirect=%2Fpage%3Fparam%3Dvalue',
       },
     });
   });
@@ -67,7 +80,7 @@ describe('makeGetServerSideProps', () => {
 
     await expect(getServerSideProps(context)).resolves.toEqual({
       redirect: {
-        destination: '/login',
+        destination: '/login?redirect=%2Fpage%3Fparam%3Dvalue',
         permanent: false,
       },
     });

pages/api/utils/pagePropsHelpers.ts

@@ -10,6 +10,16 @@ interface PagePropsWithSession {
   session: Session;
 }
 
+// Return a redirect to the login page
+export const loginRedirect = (
+  context: GetServerSidePropsContext,
+): GetServerSidePropsResult<never> => ({
+  redirect: {
+    destination: `/login?redirect=${encodeURIComponent(context.resolvedUrl)}`,
+    permanent: false,
+  },
+});
+
 // Redirect back to the dashboard if the user isn't an admin
 export const enforceAdmin: GetServerSideProps<PagePropsWithSession> = async (
   context,
@@ -36,13 +46,9 @@ export const loadSession: GetServerSideProps<PagePropsWithSession> = async (
 ) => {
   const session = await getSession(context);
   if (!session?.user.apiToken) {
-    return {
-      redirect: {
-        destination: '/login',
-        permanent: false,
-      },
-    };
+    return loginRedirect(context);
   }
+
   return {
     props: {
       session,
@@ -102,12 +108,7 @@ export const makeGetServerSideProps = <PageProps = Record<string, unknown>>(
     // Start by loading the session and redirecting to the login page if it is missing
     const session = await getSession(context);
     if (!session) {
-      return {
-        redirect: {
-          destination: '/login',
-          permanent: false,
-        },
-      };
+      return loginRedirect(context);
     }
 
     // Pass the session to the page's custom logic to generate the page props

pages/index.page.tsx

@@ -2,22 +2,23 @@ import { GetServerSideProps } from 'next';
 import { ReactNode } from 'react';
 import { getSession } from 'next-auth/react';
 import BaseLayout from 'src/components/Layouts/Basic';
+import { loginRedirect } from './api/utils/pagePropsHelpers';
 
 const IndexPage = (): ReactNode => null;
 
 IndexPage.layout = BaseLayout;
 
 export const getServerSideProps: GetServerSideProps = async (context) => {
   const session = await getSession(context);
+  if (!session) {
+    return loginRedirect(context);
+  }
 
   return {
     redirect: {
-      destination: session ? '/accountLists' : '/login',
+      destination: '/accountLists',
       permanent: false,
     },
-    props: {
-      session,
-    },
   };
 };
 

pages/login.page.tsx

@@ -11,6 +11,7 @@ import Welcome from 'src/components/Welcome';
 import useGetAppSettings from 'src/hooks/useGetAppSettings';
 import { extractCookie } from 'src/lib/extractCookie';
 import i18n from 'src/lib/i18n';
+import { getQueryParam } from 'src/utils/queryParam';
 
 const SignUpBox = styled('div')(({ theme }) => ({
   marginBlock: theme.spacing(2),
@@ -124,10 +125,11 @@ export const getServerSideProps: GetServerSideProps = async (context) => {
       `mpdx-handoff.redirect-url=; HttpOnly; path=/; Max-Age=0`,
     );
   }
-  if (context.res && session && !impersonateCookie) {
+  if (session && !impersonateCookie) {
+    const queryRedirectUrl = getQueryParam(context.query, 'redirect');
     return {
       redirect: {
-        destination: redirectCookie ?? '/accountLists',
+        destination: redirectCookie ?? queryRedirectUrl ?? '/accountLists',
         permanent: false,
       },
     };

pages/organizations/[orgId]/accept_invite/[inviteId].page.test.tsx

@@ -1,5 +1,4 @@
 import { GetServerSidePropsContext } from 'next';
-import { session } from '__tests__/fixtures/session';
 import { getServerSideProps } from './[inviteId].page';
 
 describe('Org Invite Link Redirect', () => {
@@ -24,9 +23,6 @@ describe('Org Invite Link Redirect', () => {
           '/acceptInvite?orgId=test-org-id&orgInviteId=test-invite-id&inviteCode=test-code',
         permanent: true,
       },
-      props: {
-        session: session,
-      },
     });
   });
 
@@ -45,9 +41,6 @@ describe('Org Invite Link Redirect', () => {
         destination: '/accountLists/_/',
         permanent: true,
       },
-      props: {
-        session: session,
-      },
     });
   });
 });

pages/organizations/[orgId]/accept_invite/[inviteId].page.tsx

@@ -1,32 +1,27 @@
 import { GetServerSideProps } from 'next';
 import { ReactNode } from 'react';
 import { getSession } from 'next-auth/react';
+import { loginRedirect } from 'pages/api/utils/pagePropsHelpers';
 
 // This page redirect old email invite links to the new page that handles invites
 const OrgInvitePage = (): ReactNode => null;
 
 export const getServerSideProps: GetServerSideProps = async (context) => {
   const session = await getSession(context);
-  const { orgId, inviteId, code } = context.query;
+  if (!session) {
+    return loginRedirect(context);
+  }
 
+  const { orgId, inviteId, code } = context.query;
   const redirectURL =
     orgId && inviteId && code
       ? `/acceptInvite?orgId=${orgId}&orgInviteId=${inviteId}&inviteCode=${code}`
       : // Intentionally redirect to invalid accountListId since we don't have the current user's accountListId
         '/accountLists/_/';
-
   return {
-    redirect: session
-      ? {
-          destination: redirectURL,
-          permanent: true,
-        }
-      : {
-          destination: '/login',
-          permanent: false,
-        },
-    props: {
-      session,
+    redirect: {
+      destination: redirectURL,
+      permanent: true,
     },
   };
 };

pages/setup/account.page.test.tsx

@@ -23,7 +23,9 @@ const router = {
   push,
 };
 
-const context = {} as unknown as GetServerSidePropsContext;
+const context = {
+  resolvedUrl: '/accountLists/account-list-1',
+} as unknown as GetServerSidePropsContext;
 
 const mutationSpy = jest.fn();
 
@@ -97,7 +99,7 @@ describe('getServerSideProps', () => {
 
     await expect(getServerSideProps(context)).resolves.toEqual({
       redirect: {
-        destination: '/login',
+        destination: '/login?redirect=%2FaccountLists%2Faccount-list-1',
         permanent: false,
       },
     });

src/components/RouterGuard/RouterGuard.tsx

@@ -14,7 +14,7 @@ export const RouterGuard: React.FC<Props> = ({ children = null }) => {
   const session = useSession({
     required: true,
     onUnauthenticated: () => {
-      push('/login');
+      push({ pathname: '/login', query: { redirect: window.location.href } });
     },
   });
 

src/components/Settings/Admin/ImpersonateUser/ImpersonateUserAccordion.tsx

@@ -1,3 +1,4 @@
+import { useRouter } from 'next/router';
 import { ReactElement } from 'react';
 import {
   Box,
@@ -43,6 +44,7 @@ export const ImpersonateUserAccordion: React.FC<AccordionProps> = ({
   const accordionName = t('Impersonate User');
   const { enqueueSnackbar } = useSnackbar();
   const { appName } = useGetAppSettings();
+  const { push } = useRouter();
 
   const onSubmit = async (attributes: ImpersonateUserFormType) => {
     try {
@@ -66,7 +68,7 @@ export const ImpersonateUserAccordion: React.FC<AccordionProps> = ({
             variant: 'success',
           },
         );
-        window.location.href = `/login`;
+        push('/login');
       } else {
         setupImpersonateJson.errors.forEach((error) => {
           enqueueSnackbar(error.detail, {