fix: used superTokenInstance to check if debug is enabled, instead of the ENV variable

Author: IamMayankThakur

recipe/session/logger_test.go

@@ -11,12 +11,13 @@ import (
 	"github.com/supertokens/supertokens-golang/test/unittesting"
 )
 
+// Added the logger tests here because supertokens/logger_test.go causes cyclic import errors due to imports in test/unittesting/testingUtils.go
+
 func TestLogDebugMessageWhenDebugTrue(t *testing.T) {
 	var logMessage = "test log message"
 	var buf bytes.Buffer
 
-	debug := true
-	supertokens.Logger = log.New(&buf, "", 0)
+	supertokens.Logger = log.New(&buf, "test", 0)
 
 	configValue := supertokens.TypeInput{
 		Supertokens: &supertokens.ConnectionInfo{
@@ -30,13 +31,14 @@ func TestLogDebugMessageWhenDebugTrue(t *testing.T) {
 		RecipeList: []supertokens.Recipe{
 			Init(nil),
 		},
-		Debug: &debug,
+		Debug: true,
 	}
 	BeforeEach()
 
 	unittesting.StartUpST("localhost", "8080")
 
 	defer AfterEach()
+	defer resetLogger()
 
 	err := supertokens.Init(configValue)
 
@@ -51,16 +53,59 @@ func TestLogDebugMessageWhenDebugTrue(t *testing.T) {
 	}
 
 	supertokens.LogDebugMessage(logMessage)
-	assert.Equal(t, &debug, supertokensInstance.Debug)
+	assert.Equal(t, true, supertokensInstance.Debug)
 	assert.Contains(t, buf.String(), logMessage, "checking log message in logs")
 }
 
 func TestLogDebugMessageWhenDebugFalse(t *testing.T) {
 	var logMessage = "test log message"
 	var buf bytes.Buffer
 
-	debug := false
-	supertokens.Logger = log.New(&buf, "", 0)
+	supertokens.Logger = log.New(&buf, "test", 0)
+
+	configValue := supertokens.TypeInput{
+		Supertokens: &supertokens.ConnectionInfo{
+			ConnectionURI: "http://localhost:8080",
+		},
+		AppInfo: supertokens.AppInfo{
+			AppName:       "SuperTokens",
+			APIDomain:     "api.supertokens.io",
+			WebsiteDomain: "supertokens.io",
+		},
+		RecipeList: []supertokens.Recipe{
+			Init(nil),
+		},
+		Debug: false,
+	}
+	BeforeEach()
+
+	unittesting.StartUpST("localhost", "8080")
+
+	defer AfterEach()
+	defer resetLogger()
+
+	err := supertokens.Init(configValue)
+
+	if err != nil {
+		t.Error(err.Error())
+	}
+
+	supertokensInstance, err := supertokens.GetInstanceOrThrowError()
+
+	if err != nil {
+		t.Error(err.Error())
+	}
+
+	supertokens.LogDebugMessage(logMessage)
+	assert.Equal(t, false, supertokensInstance.Debug)
+	assert.NotContains(t, buf.String(), logMessage, "checking log message in logs")
+}
+
+func TestLogDebugMessageWhenDebugNotSet(t *testing.T) {
+	var logMessage = "test log message"
+	var buf bytes.Buffer
+
+	supertokens.Logger = log.New(&buf, "test", 0)
 
 	configValue := supertokens.TypeInput{
 		Supertokens: &supertokens.ConnectionInfo{
@@ -74,13 +119,13 @@ func TestLogDebugMessageWhenDebugFalse(t *testing.T) {
 		RecipeList: []supertokens.Recipe{
 			Init(nil),
 		},
-		Debug: &debug,
 	}
 	BeforeEach()
 
 	unittesting.StartUpST("localhost", "8080")
 
 	defer AfterEach()
+	defer resetLogger()
 
 	err := supertokens.Init(configValue)
 
@@ -95,15 +140,15 @@ func TestLogDebugMessageWhenDebugFalse(t *testing.T) {
 	}
 
 	supertokens.LogDebugMessage(logMessage)
-	assert.Equal(t, &debug, supertokensInstance.Debug)
+	assert.Equal(t, false, supertokensInstance.Debug)
 	assert.NotContains(t, buf.String(), logMessage, "checking log message in logs")
 }
 
 func TestLogDebugMessageWithEnvVar(t *testing.T) {
 	var logMessage = "test log message"
 	var buf bytes.Buffer
 
-	supertokens.Logger = log.New(&buf, "", 0)
+	supertokens.Logger = log.New(&buf, "test", 0)
 	os.Setenv("SUPERTOKENS_DEBUG", "1")
 
 	configValue := supertokens.TypeInput{
@@ -124,6 +169,7 @@ func TestLogDebugMessageWithEnvVar(t *testing.T) {
 	unittesting.StartUpST("localhost", "8080")
 
 	defer AfterEach()
+	defer resetLogger()
 
 	err := supertokens.Init(configValue)
 

recipe/session/testingUtils.go

@@ -16,7 +16,9 @@
 package session
 
 import (
+	"log"
 	"net/http"
+	"os"
 
 	"github.com/supertokens/supertokens-golang/supertokens"
 	"github.com/supertokens/supertokens-golang/test/unittesting"
@@ -48,6 +50,11 @@ func AfterEach() {
 	unittesting.CleanST()
 }
 
+func resetLogger() {
+	supertokens.Logger = log.New(os.Stdout, "com.supertokens", 0)
+	os.Unsetenv("SUPERTOKENS_DEBUG")
+}
+
 type fakeRes struct{}
 
 func (f fakeRes) Header() http.Header {

supertokens/logger.go

@@ -26,7 +26,7 @@ func formatMessage(message string) string {
 
 func LogDebugMessage(message string) {
 	_, exists := os.LookupEnv("SUPERTOKENS_DEBUG")
-	if exists {
+	if exists || superTokensInstance.Debug == true {
 		Logger.Printf(formatMessage(message))
 	}
 }

supertokens/models.go

@@ -46,7 +46,7 @@ type TypeInput struct {
 	AppInfo               AppInfo
 	RecipeList            []Recipe
 	Telemetry             *bool
-	Debug                 *bool
+	Debug                 bool
 	OnSuperTokensAPIError func(err error, req *http.Request, res http.ResponseWriter)
 }
 

supertokens/supertokens.go

@@ -20,7 +20,6 @@ import (
 	"errors"
 	"flag"
 	"net/http"
-	"os"
 	"reflect"
 	"strconv"
 	"strings"
@@ -36,7 +35,7 @@ type superTokens struct {
 	RecipeModules         []RecipeModule
 	OnSuperTokensAPIError func(err error, req *http.Request, res http.ResponseWriter)
 	Telemetry             *bool
-	Debug                 *bool
+	Debug                 bool
 }
 
 // this will be set to true if this is used in a test app environment
@@ -57,12 +56,7 @@ func supertokensInit(config TypeInput) error {
 	}
 
 	superTokens.Debug = config.Debug
-	if superTokens.Debug != nil && *superTokens.Debug == true {
-		err := os.Setenv("SUPERTOKENS_DEBUG", "1")
-		if err != nil {
-			return err
-		}
-	}
+	superTokensInstance = superTokens
 
 	LogDebugMessage("Started SuperTokens with debug logging (supertokens.Init called)")