Merge pull request #385 from supertokens/feat/use-flag-for-logging

feat: added `debug` flag in the SuperTokenConfig logging

Author: rishabhpoddar

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+
+## [0.16.5] - 2023-11-1
+
+-   Adds `debug` flag to the `TypeInput`. If set to `true`, debug logs will be printed.
+
 ## [0.16.4] - 2023-10-20
 
 -   Fixes an issue where sometimes the `Access-Control-Expose-Headers` header value would contain duplicates

recipe/session/logger_test.go

@@ -0,0 +1,167 @@
+package session
+
+import (
+	"bytes"
+	"log"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/supertokens/supertokens-golang/supertokens"
+	"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 resetLogger() {
+	supertokens.Logger = log.New(os.Stdout, "com.supertokens", 0)
+	os.Unsetenv("SUPERTOKENS_DEBUG")
+	supertokens.DebugEnabled = false
+}
+
+func TestLogDebugMessageWhenDebugTrue(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{
+			ConnectionURI: "http://localhost:8080",
+		},
+		AppInfo: supertokens.AppInfo{
+			AppName:       "SuperTokens",
+			APIDomain:     "api.supertokens.io",
+			WebsiteDomain: "supertokens.io",
+		},
+		RecipeList: []supertokens.Recipe{
+			Init(nil),
+		},
+		Debug: true,
+	}
+	BeforeEach()
+
+	unittesting.StartUpST("localhost", "8080")
+
+	defer AfterEach()
+	defer resetLogger()
+
+	err := supertokens.Init(configValue)
+
+	if err != nil {
+		t.Error(err.Error())
+	}
+
+	supertokens.LogDebugMessage(logMessage)
+	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
+
+	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())
+	}
+
+	supertokens.LogDebugMessage(logMessage)
+	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{
+			ConnectionURI: "http://localhost:8080",
+		},
+		AppInfo: supertokens.AppInfo{
+			AppName:       "SuperTokens",
+			APIDomain:     "api.supertokens.io",
+			WebsiteDomain: "supertokens.io",
+		},
+		RecipeList: []supertokens.Recipe{
+			Init(nil),
+		},
+	}
+	BeforeEach()
+
+	unittesting.StartUpST("localhost", "8080")
+
+	defer AfterEach()
+	defer resetLogger()
+
+	err := supertokens.Init(configValue)
+
+	if err != nil {
+		t.Error(err.Error())
+	}
+
+	supertokens.LogDebugMessage(logMessage)
+	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, "test", 0)
+	os.Setenv("SUPERTOKENS_DEBUG", "1")
+
+	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),
+		},
+	}
+	BeforeEach()
+
+	unittesting.StartUpST("localhost", "8080")
+
+	defer AfterEach()
+	defer resetLogger()
+
+	err := supertokens.Init(configValue)
+
+	if err != nil {
+		t.Error(err.Error())
+	}
+
+	supertokens.LogDebugMessage(logMessage)
+	assert.Contains(t, buf.String(), logMessage, "checking log message in logs")
+}

supertokens/constants.go

@@ -21,7 +21,7 @@ const (
 )
 
 // VERSION current version of the lib
-const VERSION = "0.16.4"
+const VERSION = "0.16.5"
 
 var (
 	cdiSupported = []string{"3.0"}

supertokens/logger.go

@@ -16,7 +16,8 @@ const supertokens_namespace = "com.supertokens"
 */
 
 var (
-	logger = log.New(os.Stdout, supertokens_namespace, 0)
+	Logger       = log.New(os.Stdout, supertokens_namespace, 0)
+	DebugEnabled = false
 )
 
 func formatMessage(message string) string {
@@ -26,8 +27,7 @@ func formatMessage(message string) string {
 
 func LogDebugMessage(message string) {
 	_, exists := os.LookupEnv("SUPERTOKENS_DEBUG")
-	if exists {
-		logger.Printf(formatMessage(message))
-
+	if exists || DebugEnabled == true {
+		Logger.Printf(formatMessage(message))
 	}
 }

supertokens/models.go

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

supertokens/supertokens.go

@@ -54,6 +54,8 @@ func supertokensInit(config TypeInput) error {
 		superTokens.OnSuperTokensAPIError = config.OnSuperTokensAPIError
 	}
 
+	DebugEnabled = config.Debug
+
 	LogDebugMessage("Started SuperTokens with debug logging (supertokens.Init called)")
 
 	appInfoJsonString, _ := json.Marshal(config.AppInfo)