feat: Allow returning null from getRedirectionURL override

lib/ts/logger.ts

@@ -0,0 +1,33 @@
+/* Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
+ *
+ * This software is licensed under the Apache License, Version 2.0 (the
+ * "License") as published by the Apache Software Foundation.
+ *
+ * You may not use this file except in compliance with the License. You may
+ * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { package_version as version } from "./version";
+
+const SUPERTOKENS_DEBUG_NAMESPACE = "com.supertokens.auth-react";
+
+let __debugLogsEnabled = false;
+
+export function enableLogging(): void {
+    __debugLogsEnabled = true;
+}
+
+export function logDebugMessage(message: string): void {
+    if (__debugLogsEnabled) {
+        // eslint-disable-next-line no-console
+        console.log(
+            `${SUPERTOKENS_DEBUG_NAMESPACE} {t: "${new Date().toISOString()}", message: "${message}", supertokens-auth-react-ver: "${version}"}`
+        );
+    }
+}

lib/ts/recipe/recipeModule/index.ts

@@ -13,6 +13,7 @@
  * under the License.
  */
 
+import { logDebugMessage } from "../../logger";
 import SuperTokens from "../../superTokens";
 import { appendQueryParamsToURL } from "../../utils";
 
@@ -32,12 +33,24 @@ export default abstract class RecipeModule<
         queryParams?: Record<string, string>
     ): Promise<void> => {
         let redirectUrl = await this.getRedirectUrl(context);
+
+        if (redirectUrl === null) {
+            logDebugMessage(
+                `Skipping redirection because the user override returned null for context ${JSON.stringify(
+                    context,
+                    null,
+                    2
+                )}`
+            );
+            return;
+        }
+
         redirectUrl = appendQueryParamsToURL(redirectUrl, queryParams);
         return SuperTokens.getInstanceOrThrow().redirectToUrl(redirectUrl, history);
     };
 
     // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    getRedirectUrl = async (context: GetRedirectionURLContextType): Promise<string> => {
+    getRedirectUrl = async (context: GetRedirectionURLContextType): Promise<string | null> => {
         // If getRedirectionURL provided by user.
         const redirectUrl = await this.config.getRedirectionURL(context);
         if (redirectUrl !== undefined) {

lib/ts/recipe/recipeModule/types.ts

@@ -22,7 +22,7 @@ export type RecipePostAPIHookFunction<Action> = (context: RecipePostAPIHookConte
 export type RecipeOnHandleEventFunction<EventType> = (context: EventType) => void;
 
 export type UserInput<GetRedirectionURLContextType, Action, OnHandleEventContextType> = {
-    getRedirectionURL?: (context: GetRedirectionURLContextType) => Promise<string | undefined>;
+    getRedirectionURL?: (context: GetRedirectionURLContextType) => Promise<string | undefined | null>;
     preAPIHook?: RecipePreAPIHookFunction<Action>;
     postAPIHook?: RecipePostAPIHookFunction<Action>;
     onHandleEvent?: RecipeOnHandleEventFunction<OnHandleEventContextType>;
@@ -37,7 +37,7 @@ export type Config<GetRedirectionURLContextType, Action, OnHandleEventContextTyp
 >;
 
 export type NormalisedConfig<GetRedirectionURLContextType, Action, OnHandleEventContextType> = {
-    getRedirectionURL: (context: GetRedirectionURLContextType) => Promise<string | undefined>;
+    getRedirectionURL: (context: GetRedirectionURLContextType) => Promise<string | undefined | null>;
     onHandleEvent: RecipeOnHandleEventFunction<OnHandleEventContextType>;
     useShadowDom: boolean;
     rootStyle: string;