feat: added debug flag in the SuperTokenConfig in the init() for logging

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 
+## [16.4.0] - 2023-10-26
+
+-   Added `debug` property to `TypeInput`. When set to `true`, it will enable debug logs.
+
 ## [16.3.4] - 2023-10-22
 
 ### Fixes

lib/build/framework/fastify/index.d.ts

@@ -1,18 +1,21 @@
 // @ts-nocheck
 /// <reference types="node" />
 export type { SessionRequest } from "./framework";
-export declare const plugin: import("fastify").FastifyPluginCallback<Record<never, never>, import("http").Server>;
+export declare const plugin: import("fastify").FastifyPluginCallback<
+    Record<never, never>,
+    import("fastify").RawServerDefault
+>;
 export declare const errorHandler: () => (
     err: any,
     req: import("fastify").FastifyRequest<
         import("fastify/types/route").RouteGenericInterface,
-        import("http").Server,
+        import("fastify").RawServerDefault,
         import("http").IncomingMessage
     >,
     res: import("fastify").FastifyReply<
-        import("http").Server,
+        import("fastify").RawServerDefault,
         import("http").IncomingMessage,
-        import("http").ServerResponse,
+        import("http").ServerResponse<import("http").IncomingMessage>,
         import("fastify/types/route").RouteGenericInterface,
         unknown
     >

lib/build/framework/utils.d.ts

@@ -45,7 +45,7 @@ export declare function setCookieForServerResponse(
     expires: number,
     path: string,
     sameSite: "strict" | "lax" | "none"
-): ServerResponse;
+): ServerResponse<IncomingMessage>;
 export declare function getCookieValueToSetInHeader(
     prev: string | string[] | undefined,
     val: string | string[],

lib/ts/logger.ts

@@ -23,12 +23,14 @@ const SUPERTOKENS_DEBUG_NAMESPACE = "com.supertokens";
 */
 
 function logDebugMessage(message: string) {
-    if (debug.enabled(SUPERTOKENS_DEBUG_NAMESPACE)) {
-        debug(SUPERTOKENS_DEBUG_NAMESPACE)(
-            `{t: "${new Date().toISOString()}", message: \"${message}\", file: \"${getFileLocation()}\" sdkVer: "${version}"}`
-        );
-        console.log();
-    }
+    debug(SUPERTOKENS_DEBUG_NAMESPACE)(
+        `{t: "${new Date().toISOString()}", message: \"${message}\", file: \"${getFileLocation()}\" sdkVer: "${version}"}`
+    );
+    console.log();
+}
+
+function enableDebugLogs() {
+    debug.enable(SUPERTOKENS_DEBUG_NAMESPACE);
 }
 
 let getFileLocation = () => {
@@ -50,4 +52,4 @@ let getFileLocation = () => {
     return "N/A";
 };
 
-export { logDebugMessage };
+export { logDebugMessage, enableDebugLogs, SUPERTOKENS_DEBUG_NAMESPACE };

lib/ts/supertokens.ts

@@ -29,7 +29,7 @@ import NormalisedURLPath from "./normalisedURLPath";
 import type { BaseRequest, BaseResponse } from "./framework";
 import type { TypeFramework } from "./framework/types";
 import STError from "./error";
-import { logDebugMessage } from "./logger";
+import { enableDebugLogs, logDebugMessage } from "./logger";
 import { PostSuperTokensInitCallbacks } from "./postSuperTokensInitCallbacks";
 import { DEFAULT_TENANT_ID } from "./recipe/multitenancy/constants";
 
@@ -48,7 +48,16 @@ export default class SuperTokens {
 
     telemetryEnabled: boolean;
 
+    debugEnabled: boolean;
+
     constructor(config: TypeInput) {
+        if (config.debug === true) {
+            this.debugEnabled = true;
+            enableDebugLogs();
+        } else {
+            this.debugEnabled = false;
+        }
+
         logDebugMessage("Started SuperTokens with debug logging (supertokens.init called)");
         const originToPrint =
             config.appInfo.origin === undefined

lib/ts/types.ts

@@ -53,6 +53,7 @@ export type TypeInput = {
     recipeList: RecipeListFunction[];
     telemetry?: boolean;
     isInServerlessEnv?: boolean;
+    debug?: boolean;
 };
 
 export type RecipeListFunction = (appInfo: NormalisedAppinfo, isInServerlessEnv: boolean) => RecipeModule;

lib/ts/version.ts

@@ -12,7 +12,7 @@
  * License for the specific language governing permissions and limitations
  * under the License.
  */
-export const version = "16.3.4";
+export const version = "16.4.0";
 
 export const cdiSupported = ["4.0"];
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "supertokens-node",
-    "version": "16.3.4",
+    "version": "16.4.0",
     "description": "NodeJS driver for SuperTokens core",
     "main": "index.js",
     "scripts": {

test/config.test.js

@@ -26,6 +26,7 @@ const {
 } = require("./utils");
 const request = require("supertest");
 const express = require("express");
+const debug = require("debug");
 let STExpress = require("../");
 let Session = require("../recipe/session");
 let SessionRecipe = require("../lib/build/recipe/session/recipe").default;
@@ -41,6 +42,7 @@ let EmailPassword = require("../lib/build/recipe/emailpassword");
 let EmailPasswordRecipe = require("../lib/build/recipe/emailpassword/recipe").default;
 const { getTopLevelDomainForSameSiteResolution } = require("../lib/build/utils");
 const { middleware } = require("../framework/express");
+const { SUPERTOKENS_DEBUG_NAMESPACE } = require("../lib/build/logger");
 
 describe(`configTest: ${printPath("[test/config.test.js]")}`, function () {
     beforeEach(async function () {
@@ -1192,6 +1194,64 @@ describe(`configTest: ${printPath("[test/config.test.js]")}`, function () {
         }
     });
 
+    it("testing that the debug mode is set", async function () {
+        const connectionURI = await startST();
+        {
+            STExpress.init({
+                supertokens: {
+                    connectionURI,
+                },
+                appInfo: {
+                    apiDomain: "api.supertokens.io",
+                    appName: "SuperTokens",
+                    websiteDomain: "supertokens.io",
+                },
+                recipeList: [Session.init({ getTokenTransferMethod: () => "cookie" })],
+                debug: true,
+            });
+            assert(SuperTokens.getInstanceOrThrowError().debugEnabled === true);
+            assert(debug.enabled(SUPERTOKENS_DEBUG_NAMESPACE) === true);
+            resetAll();
+        }
+
+        {
+            debug.disable();
+            STExpress.init({
+                supertokens: {
+                    connectionURI,
+                },
+                appInfo: {
+                    apiDomain: "api.supertokens.io",
+                    appName: "SuperTokens",
+                    websiteDomain: "supertokens.io",
+                },
+                recipeList: [Session.init({ getTokenTransferMethod: () => "cookie" })],
+                debug: false,
+            });
+            assert(SuperTokens.getInstanceOrThrowError().debugEnabled === false);
+            assert(debug.enabled(SUPERTOKENS_DEBUG_NAMESPACE) === false);
+            resetAll();
+        }
+
+        {
+            debug.disable();
+            STExpress.init({
+                supertokens: {
+                    connectionURI,
+                },
+                appInfo: {
+                    apiDomain: "api.supertokens.io",
+                    appName: "SuperTokens",
+                    websiteDomain: "supertokens.io",
+                },
+                recipeList: [Session.init({ getTokenTransferMethod: () => "cookie" })],
+            });
+            assert(SuperTokens.getInstanceOrThrowError().debugEnabled === false);
+            assert(debug.enabled(SUPERTOKENS_DEBUG_NAMESPACE) === false);
+            resetAll();
+        }
+    });
+
     it("checking for default cookie config", async function () {
         const connectionURI = await startST();
         STExpress.init({