refactor: put different middlewares under their own namespaces

go-lark · Jan 2, 2024 · 41ac45d · 41ac45d
1 parent 0c87678
commit 41ac45d
Show file tree

Hide file tree

Showing 9 changed files with 485 additions and 423 deletions.
diff --git a/challenge.go b/challenge.go
@@ -0,0 +1,47 @@
+package larkgin
+
+import (
+	"encoding/json"
+	"log"
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+	"github.com/go-lark/lark"
+)
+
+// LarkChallengeHandler Lark challenge handler
+func (opt LarkMiddleware) LarkChallengeHandler() gin.HandlerFunc {
+	return func(c *gin.Context) {
+		defer c.Next()
+		if opt.enableURLBinding && c.Request.URL.String() != opt.urlPrefix {
+			// url not match just pass
+			return
+		}
+
+		body, err := fetchBody(c)
+		if err != nil {
+			return
+		}
+		var inputBody = body
+		if opt.enableEncryption {
+			decryptedData, err := opt.decodeEncryptedJSON(body)
+			if err != nil {
+				log.Println("Decrypt failed:", err)
+				return
+			}
+			inputBody = decryptedData
+		}
+
+		var challenge lark.EventChallenge
+		err = json.Unmarshal(inputBody, &challenge)
+		if err != nil {
+			return
+		}
+		if challenge.Type == "url_verification" {
+			log.Println("Handling challenge:", challenge.Challenge)
+			c.AbortWithStatusJSON(http.StatusOK, gin.H{
+				"challenge": challenge.Challenge,
+			})
+		}
+	}
+}
diff --git a/challenge_test.go b/challenge_test.go
@@ -0,0 +1,52 @@
+package larkgin
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/gin-gonic/gin"
+	"github.com/go-lark/lark"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestChallengePassed(t *testing.T) {
+	var (
+		r          = gin.Default()
+		middleware = NewLarkMiddleware()
+	)
+	r.Use(middleware.LarkChallengeHandler())
+	r.POST("/", func(c *gin.Context) {
+		// do nothing
+	})
+
+	message := lark.EventChallenge{
+		Challenge: "test",
+		Type:      "url_verification",
+	}
+	resp := performRequest(r, "POST", "/", message)
+	var respData lark.EventChallengeReq
+	if assert.NotNil(t, resp.Body) {
+		json.NewDecoder(resp.Body).Decode(&respData)
+		assert.Equal(t, "test", respData.Challenge)
+	}
+}
+
+func TestChallengeMismatch(t *testing.T) {
+	r := gin.Default()
+	middleware := NewLarkMiddleware().BindURLPrefix("/abc")
+	r.Use(middleware.LarkChallengeHandler())
+	r.POST("/", func(c *gin.Context) {
+		// do nothing
+	})
+
+	message := lark.EventChallenge{
+		Challenge: "test",
+		Type:      "url_verification",
+	}
+	resp := performRequest(r, "POST", "/", message)
+	var respData lark.EventChallenge
+	if assert.NotNil(t, resp.Body) {
+		err := json.NewDecoder(resp.Body).Decode(&respData)
+		assert.Error(t, err)
+	}
+}
diff --git a/event_v1.go b/event_v1.go
@@ -0,0 +1,57 @@
+package larkgin
+
+import (
+	"encoding/json"
+	"log"
+
+	"github.com/gin-gonic/gin"
+	"github.com/go-lark/lark"
+)
+
+// GetMessage from gin context
+func (opt LarkMiddleware) GetMessage(c *gin.Context) (*lark.EventMessage, bool) {
+	if message, ok := c.Get(opt.messageKey); ok {
+		msg, ok := message.(lark.EventMessage)
+		return &msg, ok
+	}
+
+	return nil, false
+}
+
+// LarkMessageHandler Lark message handler
+func (opt LarkMiddleware) LarkMessageHandler() gin.HandlerFunc {
+	return func(c *gin.Context) {
+		defer c.Next()
+		if opt.enableURLBinding && c.Request.URL.String() != opt.urlPrefix {
+			// url not match just pass
+			return
+		}
+
+		body, err := fetchBody(c)
+		if err != nil {
+			return
+		}
+		var inputBody = body
+		if opt.enableEncryption {
+			decryptedData, err := opt.decodeEncryptedJSON(body)
+			if err != nil {
+				log.Println("Decrypt failed:", err)
+				return
+			}
+			inputBody = decryptedData
+		}
+
+		var message lark.EventMessage
+		err = json.Unmarshal(inputBody, &message)
+		if err != nil {
+			return
+		}
+
+		if opt.enableTokenVerification && message.Token != opt.verificationToken {
+			log.Println("Token verification failed")
+			return
+		}
+		log.Println("Handling message:", message.EventType)
+		c.Set(opt.messageKey, message)
+	}
+}
diff --git a/event_v1_test.go b/event_v1_test.go
@@ -0,0 +1,170 @@
+package larkgin
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/gin-gonic/gin"
+	"github.com/go-lark/lark"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMessageStandard(t *testing.T) {
+	var (
+		r          = gin.Default()
+		middleware = NewLarkMiddleware()
+
+		ok bool
+		m  *lark.EventMessage
+	)
+	r.Use(middleware.LarkMessageHandler())
+	r.POST("/", func(c *gin.Context) {
+		m, ok = middleware.GetMessage(c)
+	})
+
+	message := lark.EventMessage{
+		Timestamp: "",
+		Token:     "",
+		EventType: "event_callback",
+		Event: lark.EventBody{
+			Type:          "message",
+			ChatType:      "private",
+			MsgType:       "text",
+			OpenID:        "ou_08198ccd6a37644b49f4789c92369c80",
+			Text:          "tlb",
+			Title:         "",
+			OpenMessageID: "",
+			ImageKey:      "",
+			ImageURL:      "",
+		},
+	}
+	performRequest(r, "POST", "/", message)
+	assert.True(t, ok)
+	assert.Equal(t, "tlb", m.Event.Text)
+}
+
+func TestMessageMismatch(t *testing.T) {
+	r := gin.Default()
+	middleware := NewLarkMiddleware().BindURLPrefix("/abc")
+	r.Use(middleware.LarkMessageHandler())
+	r.POST("/", func(c *gin.Context) {
+		// do nothing
+	})
+
+	message := lark.EventMessage{
+		Timestamp: "",
+		Token:     "",
+		EventType: "event_callback",
+		Event: lark.EventBody{
+			Type:          "message",
+			ChatType:      "private",
+			MsgType:       "text",
+			OpenID:        "ou_08198ccd6a37644b49f4789c92369c80",
+			Text:          "tlb",
+			Title:         "",
+			OpenMessageID: "",
+			ImageKey:      "",
+			ImageURL:      "",
+		},
+	}
+	resp := performRequest(r, "POST", "/", message)
+	var respData lark.EventMessage
+	if assert.NotNil(t, resp.Body) {
+		err := json.NewDecoder(resp.Body).Decode(&respData)
+		assert.Error(t, err)
+	}
+}
+
+func TestMessaggeEncryted(t *testing.T) {
+	var (
+		r          = gin.Default()
+		middleware = NewLarkMiddleware().WithEncryption("ocTiICyJdYyvxD6gLkYdsewM41Qc48bx")
+
+		ok bool
+		m  *lark.EventMessage
+
+		encryptText = "dSb7qqosP3fKQfSk1+wHkhmKX6ucVAZg2/BrkAe5ETqFTP6X/gvzWkVt7YtecaGuN5PuuYECHHEr1xvSXeIJ0Ijr1g85o8EwK12IcatCNhyHb+rOoPRrm4/BYOHVEmp8nmnOzZBWRBnqzAj7qZh5+qBcO1z7XaU70uRXW7CZQCAZF/MY/hEtgIzcQKYiP4J3G7jMJEfj9OWqtaKMTOCJWz/JG0vpP6Mj5dv2P1qvgt+JjdgpsYXqAoO+T7ZbEW7k7olXLhN66osKADTSUP7RsPROfsEywuPagZXSIe0QXZtayDazcjPrfJRtc59U2j2I43+dVw0tJT3U//Wik4ISq3g8RCAJKnRl4AMJKpWzEq3qU27aRQlNj032cQQV28d4ji6AybnGuIvJzhtVnYZ6/2Uvlt1x9+11M/qDLftVzf5n2tAu1zdDlU1Lu3ctPbD0Q1wmTQ0cEJYXXPivtxv+jwqdRY3OTU6F1OlMiVOyKD0RIzudpivNyfYSreIEIa+LwGHIcXQE3pSgn//LFrJ5TgRen0cF4F1n6w0dtTMqM3PvCdSaDgIv8IHgKgyLYiT7U8aFLAvbLMw0Vutw7l2efL1P4Mv8gfIXHVpvVTkSkVa/kYrxQEtNO8A4lYghR6fB5CTiK23O5GQEd65A/R9s/eduaAkzC1Csp4H0NFX0CFxlF0/QJB8i72v3tBFppo/5U2Pfs0Drx2uYI4ijalv9XDvYpwiFxLiwEx35/9fKJ6nND7CSi1ShWdkkbVkN+fPE/r9suWHZtw3r1TPI3pEAWo3sV3xMnmpTnh6xp2CPi10ZIKCU0fN0Un3a1kEXIiTcpu02Y60trr8HiTUa0kUgQhbHg9seDGXmDrcTbm8oGFk/1HMQ/DA6S9Fb7lIBKEMbVKQf01XreAJZtKtCT2FSlNu49I/ho2sN9ueUWkAVfdR95AezX2oNmZI2yTyJD2B+B7aTPWBW6+f/nS7t9Ehc/l6cGgVC5/2w6pZsIeHeRSqaYe3x+YocE/gFwWXfkJ9AoJMz2us3ZRBQmKY1IfOK19KAyMuSyJ/YrQmLCl0Oroxg86nTH2nFpo4j85V5nW9e9YpZW6+6jb8vROAcoQN9yJA2o2hkw3Us9JvCpDZ7Y0JDoDzPq0JiBwKc7NMe5SVNZ++FZWKn7NR/vYfM5bAqew77a46P6sTVJBjwhK1OYVNUSmSdZ+jv2jqgSj1oJpwZWwmwwzQCrHV6h7VbzhgP7XliJKEj6yIR4a5vfRpTalI="
+	)
+
+	r.Use(middleware.LarkMessageHandler())
+	r.POST("/", func(c *gin.Context) {
+		m, ok = middleware.GetMessage(c)
+	})
+
+	encryptMessage := lark.EncryptedReq{
+		Encrypt: encryptText,
+	}
+	performRequest(r, "POST", "/", encryptMessage)
+	assert.True(t, ok)
+	assert.Equal(t, "hello", m.Event.Text)
+	assert.Equal(t, "9378d8f0122244e0920644d114e761d5", m.Token)
+}
+
+func TestMessageRawFetch(t *testing.T) {
+	var (
+		r          = gin.Default()
+		middleware = NewLarkMiddleware()
+
+		ok bool
+		m  lark.EventMessage
+	)
+	r.Use(middleware.LarkMessageHandler())
+	r.POST("/", func(c *gin.Context) {
+		message, _ := c.Get(defaultLarkMessageKey)
+		m, ok = message.(lark.EventMessage)
+	})
+
+	message := lark.EventMessage{
+		Timestamp: "",
+		Token:     "",
+		EventType: "event_callback",
+		Event: lark.EventBody{
+			Type:          "message",
+			ChatType:      "private",
+			MsgType:       "text",
+			OpenID:        "ou_08198ccd6a37644b49f4789c92369c80",
+			Text:          "tlb",
+			Title:         "",
+			OpenMessageID: "",
+			ImageKey:      "",
+			ImageURL:      "",
+		},
+	}
+	performRequest(r, "POST", "/", message)
+	assert.True(t, ok)
+	assert.Equal(t, "tlb", m.Event.Text)
+}
+
+func TestMessageWithTokenVerifcation(t *testing.T) {
+	var (
+		r          = gin.Default()
+		middleware = NewLarkMiddleware().WithTokenVerification("abc")
+
+		ok bool
+		m  *lark.EventMessage
+	)
+	r.Use(middleware.LarkMessageHandler())
+	r.POST("/", func(c *gin.Context) {
+		m, ok = middleware.GetMessage(c)
+	})
+
+	message := lark.EventMessage{
+		Timestamp: "",
+		Token:     "abc1",
+		EventType: "event_callback",
+		Event: lark.EventBody{
+			Type:          "message",
+			ChatType:      "private",
+			MsgType:       "text",
+			OpenID:        "ou_08198ccd6a37644b49f4789c92369c80",
+			Text:          "tlb",
+			Title:         "",
+			OpenMessageID: "",
+			ImageKey:      "",
+			ImageURL:      "",
+		},
+	}
+	performRequest(r, "POST", "/", message)
+	assert.False(t, ok)
+	assert.Nil(t, m)
+}
diff --git a/event_v2.go b/event_v2.go
@@ -0,0 +1,55 @@
+package larkgin
+
+import (
+	"encoding/json"
+	"log"
+
+	"github.com/gin-gonic/gin"
+	"github.com/go-lark/lark"
+)
+
+// GetEvent should call GetEvent if you're using EventV2
+func (opt LarkMiddleware) GetEvent(c *gin.Context) (*lark.EventV2, bool) {
+	if message, ok := c.Get(opt.messageKey); ok {
+		event, ok := message.(lark.EventV2)
+		if event.Schema != "2.0" {
+			return nil, false
+		}
+		return &event, ok
+	}
+
+	return nil, false
+}
+
+// LarkEventHandler handle lark event v2
+func (opt LarkMiddleware) LarkEventHandler() gin.HandlerFunc {
+	return func(c *gin.Context) {
+		defer c.Next()
+		body, err := fetchBody(c)
+		if err != nil {
+			return
+		}
+		var inputBody = body
+		if opt.enableEncryption {
+			decryptedData, err := opt.decodeEncryptedJSON(body)
+			if err != nil {
+				log.Println("Decrypt failed:", err)
+				return
+			}
+			inputBody = decryptedData
+		}
+
+		var event lark.EventV2
+		err = json.Unmarshal(inputBody, &event)
+		if err != nil {
+			log.Println(err)
+			return
+		}
+		if opt.enableTokenVerification && event.Header.Token != opt.verificationToken {
+			log.Println("Token verification failed")
+			return
+		}
+		log.Println("Handling event:", event.Header.EventType)
+		c.Set(opt.messageKey, event)
+	}
+}