[WIP] feat: add generalized redirect AuthAction

src/AuthAction.js

@@ -6,6 +6,7 @@ const AuthAction = {
   RETURN_NULL: 'returnNull',
   REDIRECT_TO_LOGIN: 'redirectToLogin',
   REDIRECT_TO_APP: 'redirectToApp',
+  REDIRECT: 'redirect',
 }
 
 export default AuthAction

src/__tests__/AuthAction.test.js

@@ -8,6 +8,7 @@ describe('index.js: AuthAction', () => {
       RETURN_NULL: 'returnNull',
       REDIRECT_TO_LOGIN: 'redirectToLogin',
       REDIRECT_TO_APP: 'redirectToApp',
+      REDIRECT: 'redirect',
     })
   })
 })

src/__tests__/index.test.js

@@ -205,6 +205,7 @@ describe('index.js: AuthAction', () => {
       RETURN_NULL: 'returnNull',
       REDIRECT_TO_LOGIN: 'redirectToLogin',
       REDIRECT_TO_APP: 'redirectToApp',
+      REDIRECT: 'redirect',
     })
   })
 })

src/testHelpers/createMockConfig.js

@@ -25,6 +25,16 @@ const createMockConfig = ({ clientSide } = {}) => {
       databaseURL: 'https://my-example-app.firebaseio.com',
       projectId: 'my-example-app-id',
     },
+    onRedirect: {
+      whenAuthed: {
+        destination: '/',
+        permanent: false,
+      },
+      whenUnauthed: {
+        destination: '/login',
+        permanent: false,
+      },
+    },
     cookies: {
       name: 'someExample',
       keys: useClientSideConfig ? [] : ['abc', 'def'],

src/withAuthUser.js

@@ -46,6 +46,7 @@ const withAuthUser =
     appPageURL = null,
     authPageURL = null,
     LoaderComponent = null,
+    onRedirect = null,
   } = {}) =>
   (ChildComponent) => {
     const WithAuthUserHOC = (props) => {
@@ -117,6 +118,12 @@ const withAuthUser =
           ? authRequestCompleted
           : true)
 
+      const shouldUseCustomRedirect = [
+        whenAuthed,
+        whenUnauthedBeforeInit,
+        whenUnauthedAfterInit,
+      ].includes(AuthAction.REDIRECT)
+
       const router = useRouter()
       const redirectToApp = useCallback(() => {
         logDebug('Redirecting to app.')
@@ -160,6 +167,36 @@ const withAuthUser =
         }
         router.replace(destination)
       }, [router, AuthUser])
+      const redirectToCustom = useCallback(() => {
+        logDebug('Redirecting to user-specified endpoint')
+        const redirectConfig = onRedirect || getConfig().onRedirect
+        if (!redirectConfig) {
+          throw new Error(
+            'The "onRedirect" config setting must be set when using `REDIRECT`.'
+          )
+        }
+
+        const authStateConfig = isAuthed
+          ? onRedirect.whenAuthed
+          : onRedirect.whenUnauthed
+
+        if (!authStateConfig || !authStateConfig.destination) {
+          throw new Error(
+            `The "destination" in the "onRedirect.whenAuthed" and "onRedirect.whenUnauthed" redirect configs must resolve to a non-empty string`
+          )
+        }
+
+        if (
+          authStateConfig &&
+          (!authStateConfig.destination ||
+            typeof authStateConfig.destination !== 'string')
+        ) {
+          throw new Error(
+            'The "destination" must be set to a non-empty string or resolve to a non-empty string'
+          )
+        }
+        router.replace(authStateConfig.destination)
+      }, [router, isAuthed])
 
       useEffect(() => {
         // Only redirect on the client side. To redirect server-side,
@@ -171,12 +208,16 @@ const withAuthUser =
           redirectToApp()
         } else if (shouldRedirectToLogin) {
           redirectToLogin()
+        } else if (shouldUseCustomRedirect) {
+          redirectToCustom()
         }
       }, [
         shouldRedirectToApp,
         shouldRedirectToLogin,
+        shouldUseCustomRedirect,
         redirectToApp,
         redirectToLogin,
+        redirectToCustom,
       ])
 
       // Decide what to render.

src/withAuthUserTokenSSR.js

@@ -38,6 +38,7 @@ const withAuthUserTokenSSR =
       whenUnauthed = AuthAction.RENDER,
       appPageURL = null,
       authPageURL = null,
+      onRedirect = null,
     } = {},
     { useToken = true } = {}
   ) =>
@@ -144,6 +145,39 @@ const withAuthUserTokenSSR =
       }
     }
 
+    if ([whenAuthed, whenUnauthed].includes(AuthAction.REDIRECT)) {
+      const redirectConfig = onRedirect || getConfig().onRedirect
+      if (!redirectConfig) {
+        throw new Error(
+          `When "whenAuthed" or "whenUnauthed" are set to AuthAction.REDIRECT, "onRedirect" must be set.`
+        )
+      }
+
+      const authStateConfig = AuthUser.id
+        ? onRedirect.whenAuthed
+        : onRedirect.whenUnauthed
+
+      if (!authStateConfig || !authStateConfig.destination) {
+        throw new Error(
+          `The "destination" in the "onRedirect.whenAuthed" and "onRedirect.whenUnauthed" redirect configs must resolve to a non-empty string`
+        )
+      }
+
+      if (
+        authStateConfig &&
+        (!authStateConfig.destination ||
+          typeof authStateConfig.destination !== 'string')
+      ) {
+        throw new Error(
+          'The "destination" must be set to a non-empty string or resolve to a non-empty string'
+        )
+      }
+
+      return {
+        redirect: authStateConfig,
+      }
+    }
+
     // Prepare return data
     let returnData = { props: { AuthUserSerialized } }