feat: add logger

go-lark · Jan 3, 2024 · bbfeeb3 · bbfeeb3
1 parent fc265bd
commit bbfeeb3
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -119,6 +119,13 @@ middleware.WithTokenVerfication("asodjiaoijoi121iuhiaud")
 middleware.WithEncryption("1231asda")
 ```
 
+### Logger
+
+`lark-gin` implements and uses `lark.LogWrapper`. You may set your own logger:
+```go
+middleware.SetLogger(yourOwnLogger)
+```
+
 ## About
 
 Copyright (c) go-lark Developers, 2018-2024.
diff --git a/card.go b/card.go
@@ -4,7 +4,6 @@ import (
 	"crypto/sha1"
 	"encoding/json"
 	"fmt"
-	"log"
 	"strings"
 
 	"github.com/gin-gonic/gin"
@@ -35,7 +34,7 @@ func (opt LarkMiddleware) LarkCardHandler() gin.HandlerFunc {
 		var event lark.EventCardCallback
 		err = json.Unmarshal(inputBody, &event)
 		if err != nil {
-			log.Println(err)
+			opt.logger.Log(c, lark.LogLevelWarn, fmt.Sprintf("Unmarshal JSON error: %v", err))
 			return
 		}
 		if opt.enableTokenVerification {
@@ -44,7 +43,7 @@ func (opt LarkMiddleware) LarkCardHandler() gin.HandlerFunc {
 			signature := c.Request.Header.Get("X-Lark-Signature")
 			token := opt.cardSignature(nonce, timestamp, string(body), opt.verificationToken)
 			if signature != token {
-				log.Println("Token verification failed")
+				opt.logger.Log(c, lark.LogLevelError, "Token verification failed")
 				return
 			}
 		}

diff --git a/challenge.go b/challenge.go
@@ -2,7 +2,7 @@ package larkgin
 
 import (
 	"encoding/json"
-	"log"
+	"fmt"
 	"net/http"
 
 	"github.com/gin-gonic/gin"
@@ -26,7 +26,7 @@ func (opt LarkMiddleware) LarkChallengeHandler() gin.HandlerFunc {
 		if opt.enableEncryption {
 			decryptedData, err := opt.decodeEncryptedJSON(body)
 			if err != nil {
-				log.Println("Decrypt failed:", err)
+				opt.logger.Log(c, lark.LogLevelError, fmt.Sprintf("Decrypt failed: %v", err))
 				return
 			}
 			inputBody = decryptedData
@@ -38,7 +38,7 @@ func (opt LarkMiddleware) LarkChallengeHandler() gin.HandlerFunc {
 			return
 		}
 		if challenge.Type == "url_verification" {
-			log.Println("Handling challenge:", challenge.Challenge)
+			opt.logger.Log(c, lark.LogLevelInfo, fmt.Sprintf("Handling challenge: %s", challenge.Challenge))
 			c.AbortWithStatusJSON(http.StatusOK, gin.H{
 				"challenge": challenge.Challenge,
 			})

diff --git a/event_v1.go b/event_v1.go
@@ -2,7 +2,7 @@ package larkgin
 
 import (
 	"encoding/json"
-	"log"
+	"fmt"
 
 	"github.com/gin-gonic/gin"
 	"github.com/go-lark/lark"
@@ -35,7 +35,7 @@ func (opt LarkMiddleware) LarkMessageHandler() gin.HandlerFunc {
 		if opt.enableEncryption {
 			decryptedData, err := opt.decodeEncryptedJSON(body)
 			if err != nil {
-				log.Println("Decrypt failed:", err)
+				opt.logger.Log(c, lark.LogLevelError, fmt.Sprintf("Decrypt failed: %v", err))
 				return
 			}
 			inputBody = decryptedData
@@ -48,10 +48,10 @@ func (opt LarkMiddleware) LarkMessageHandler() gin.HandlerFunc {
 		}
 
 		if opt.enableTokenVerification && message.Token != opt.verificationToken {
-			log.Println("Token verification failed")
+			opt.logger.Log(c, lark.LogLevelError, "Token verification failed")
 			return
 		}
-		log.Println("Handling message:", message.EventType)
+		opt.logger.Log(c, lark.LogLevelInfo, fmt.Sprintf("Handling message: %s", message.EventType))
 		c.Set(opt.messageKey, message)
 	}
 }
diff --git a/event_v2.go b/event_v2.go
@@ -2,7 +2,7 @@ package larkgin
 
 import (
 	"encoding/json"
-	"log"
+	"fmt"
 
 	"github.com/gin-gonic/gin"
 	"github.com/go-lark/lark"
@@ -33,7 +33,7 @@ func (opt LarkMiddleware) LarkEventHandler() gin.HandlerFunc {
 		if opt.enableEncryption {
 			decryptedData, err := opt.decodeEncryptedJSON(body)
 			if err != nil {
-				log.Println("Decrypt failed:", err)
+				opt.logger.Log(c, lark.LogLevelError, fmt.Sprintf("Decrypt failed: %v", err))
 				return
 			}
 			inputBody = decryptedData
@@ -42,14 +42,14 @@ func (opt LarkMiddleware) LarkEventHandler() gin.HandlerFunc {
 		var event lark.EventV2
 		err = json.Unmarshal(inputBody, &event)
 		if err != nil {
-			log.Println(err)
+			opt.logger.Log(c, lark.LogLevelWarn, fmt.Sprintf("Unmarshal JSON error: %v", err))
 			return
 		}
 		if opt.enableTokenVerification && event.Header.Token != opt.verificationToken {
-			log.Println("Token verification failed")
+			opt.logger.Log(c, lark.LogLevelError, "Token verification failed")
 			return
 		}
-		log.Println("Handling event:", event.Header.EventType)
+		opt.logger.Log(c, lark.LogLevelInfo, fmt.Sprintf("Handling event: %s", event.Header.EventType))
 		c.Set(opt.messageKey, event)
 	}
 }
diff --git a/gin.go b/gin.go
@@ -16,6 +16,8 @@ const (
 
 // LarkMiddleware .
 type LarkMiddleware struct {
+	logger lark.LogWrapper
+
 	messageKey string
 	cardKey    string
 
@@ -32,6 +34,7 @@ type LarkMiddleware struct {
 // NewLarkMiddleware .
 func NewLarkMiddleware() *LarkMiddleware {
 	return &LarkMiddleware{
+		logger:     initDefaultLogger(),
 		messageKey: defaultLarkMessageKey,
 		cardKey:    defaultLarkCardKey,
 	}

diff --git a/logger.go b/logger.go
@@ -0,0 +1,32 @@
+package larkgin
+
+import (
+	"context"
+	"log"
+	"os"
+
+	"github.com/go-lark/lark"
+)
+
+// SetLogger set a new logger
+func (opt *LarkMiddleware) SetLogger(logger lark.LogWrapper) {
+	opt.logger = logger
+}
+
+const logPrefix = "[go-lark] "
+
+func initDefaultLogger() lark.LogWrapper {
+	// create a default std logger
+	logger := stdLogger{
+		log.New(os.Stderr, logPrefix, log.LstdFlags),
+	}
+	return logger
+}
+
+type stdLogger struct {
+	*log.Logger
+}
+
+func (sl stdLogger) Log(_ context.Context, level lark.LogLevel, msg string) {
+	sl.Printf("[%s] %s\n", level, msg)
+}