Merge pull request #1021 from traPtitech/bot_message_stamps_update_event

BOT_MESSAGE_STAMPS_UPDATEDイベント実装

cmd/serve.go

@@ -167,6 +167,7 @@ func (s *Server) Start(address string) error {
 		}
 	}()
 	s.SS.BOT.Start()
+	s.SS.StampThrottler.Start()
 	return s.Router.Start(address)
 }
 

cmd/serve_wire.go

@@ -12,6 +12,7 @@ import (
 	"github.com/traPtitech/traQ/service/bot"
 	"github.com/traPtitech/traQ/service/channel"
 	"github.com/traPtitech/traQ/service/counter"
+	"github.com/traPtitech/traQ/service/exevent"
 	"github.com/traPtitech/traQ/service/file"
 	"github.com/traPtitech/traQ/service/imaging"
 	"github.com/traPtitech/traQ/service/message"
@@ -34,6 +35,7 @@ func newServer(hub *hub.Hub, db *gorm.DB, repo repository.Repository, fs storage
 		counter.NewUnreadMessageCounter,
 		counter.NewMessageCounter,
 		counter.NewChannelCounter,
+		exevent.NewStampThrottler,
 		imaging.NewProcessor,
 		notification.NewService,
 		rbac2.New,

dev/bin/bot_debugger.go

@@ -0,0 +1,29 @@
+// +build tools
+
+package main
+
+import (
+	"flag"
+	"fmt"
+	"net/http"
+	"net/http/httputil"
+)
+
+func main() {
+	var port int
+	flag.IntVar(&port, "p", 5555, "listen port")
+	flag.Parse()
+	http.HandleFunc("/", botHandler)
+	http.ListenAndServe(fmt.Sprintf(":%d", port), nil)
+}
+
+func botHandler(w http.ResponseWriter, r *http.Request) {
+	dump, err := httputil.DumpRequest(r, true)
+	if err != nil {
+		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+		return
+	}
+	fmt.Printf("%s\n", dump)
+
+	w.WriteHeader(http.StatusNoContent)
+}

docker-compose.yml

@@ -54,3 +54,10 @@ services:
       - "8080"
     ports:
       - "3001:8080"
+
+  botdebugger:
+    image: golang:alpine
+    restart: always
+    volumes:
+      - ./dev/bin:/app
+    command: go run /app/bot_debugger.go -p 80

event/topic.go

@@ -305,4 +305,10 @@ const (
 	//		clip_folder_message_id: uuid.UUID
 	//		clip_folder_message: *model.ClipFolderMessage
 	ClipFolderMessageAdded = "clip_folder_message.added"
+
+	// MessageStampsUpdated メッセージに押されているスタンプが変化した。このイベントはスロットリングされています
+	// 	Fields:
+	// 		message_id: uuid.UUID
+	// 		message: message.Message
+	MessageStampsUpdated = "message.stamps.updated"
 )

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/NYTimes/gziphandler v1.1.1
 	github.com/blendle/zapdriver v1.3.1
 	github.com/bluele/gcache v0.0.0-20190518031135-bc40bd653833
+	github.com/boz/go-throttle v0.0.0-20160922054636-fdc4eab740c1
 	github.com/coreos/go-oidc v2.2.1+incompatible
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
 	github.com/disintegration/imaging v1.6.2

service/bot/event/events.go

@@ -15,6 +15,8 @@ const (
 	MessageDeleted model.BotEventType = "MESSAGE_DELETED"
 	// MessageUpdated メッセージ編集イベント
 	MessageUpdated model.BotEventType = "MESSAGE_UPDATED"
+	// BotMessageStampsUpdated BOTメッセージスタンプ更新イベント
+	BotMessageStampsUpdated model.BotEventType = "BOT_MESSAGE_STAMPS_UPDATED"
 	// MentionMessageCreated メンションメッセージ作成イベント
 	MentionMessageCreated model.BotEventType = "MENTION_MESSAGE_CREATED"
 	// DirectMessageCreated ダイレクトメッセージ作成イベント
@@ -49,6 +51,7 @@ func init() {
 		MessageCreated,
 		MessageDeleted,
 		MessageUpdated,
+		BotMessageStampsUpdated,
 		MentionMessageCreated,
 		DirectMessageCreated,
 		DirectMessageUpdated,

service/bot/event/payload/ev_bot_message_stamps_updated.go

@@ -0,0 +1,22 @@
+package payload
+
+import (
+	"github.com/gofrs/uuid"
+	"github.com/traPtitech/traQ/model"
+	"time"
+)
+
+// BotMessageStampsUpdated BOT_MESSAGE_STAMPS_UPDATEDイベントペイロード
+type BotMessageStampsUpdated struct {
+	Base
+	MessageID uuid.UUID            `json:"messageId"`
+	Stamps    []model.MessageStamp `json:"stamps"`
+}
+
+func MakeBotMessageStampsUpdated(eventTime time.Time, mid uuid.UUID, stamps []model.MessageStamp) *BotMessageStampsUpdated {
+	return &BotMessageStampsUpdated{
+		Base:      MakeBase(eventTime),
+		MessageID: mid,
+		Stamps:    stamps,
+	}
+}

service/bot/handler/ev_message_stamps_updated.go

@@ -0,0 +1,31 @@
+package handler
+
+import (
+	"fmt"
+	"github.com/leandro-lugaresi/hub"
+	"github.com/traPtitech/traQ/service/bot/event"
+	"github.com/traPtitech/traQ/service/bot/event/payload"
+	"github.com/traPtitech/traQ/service/message"
+	"time"
+)
+
+func MessageStampsUpdated(ctx Context, datetime time.Time, _ string, fields hub.Fields) error {
+	m := fields["message"].(message.Message)
+
+	bot, err := ctx.GetBotByBotUserID(m.GetUserID())
+	if err != nil {
+		return fmt.Errorf("failed to GetBotByBotUserID: %w", err)
+	}
+	if bot == nil || !bot.SubscribeEvents.Contains(event.BotMessageStampsUpdated) {
+		return nil
+	}
+
+	if err := ctx.Unicast(
+		event.BotMessageStampsUpdated,
+		payload.MakeBotMessageStampsUpdated(datetime, m.GetID(), m.GetStamps()),
+		bot,
+	); err != nil {
+		return fmt.Errorf("failed to unicast: %w", err)
+	}
+	return nil
+}

service/bot/handler/ev_message_stamps_updated_test.go

@@ -0,0 +1,93 @@
+package handler
+
+import (
+	"github.com/gofrs/uuid"
+	"github.com/golang/mock/gomock"
+	"github.com/leandro-lugaresi/hub"
+	"github.com/stretchr/testify/assert"
+	intevent "github.com/traPtitech/traQ/event"
+	"github.com/traPtitech/traQ/model"
+	"github.com/traPtitech/traQ/service/bot/event"
+	"github.com/traPtitech/traQ/service/bot/event/payload"
+	"github.com/traPtitech/traQ/service/bot/handler/mock_handler"
+	"github.com/traPtitech/traQ/service/message"
+	"testing"
+	"time"
+)
+
+func TestMessageStampsUpdated(t *testing.T) {
+	t.Parallel()
+
+	b := &model.Bot{
+		ID:              uuid.NewV3(uuid.Nil, "b"),
+		BotUserID:       uuid.NewV3(uuid.Nil, "bu"),
+		SubscribeEvents: model.BotEventTypesFromArray([]string{event.BotMessageStampsUpdated.String()}),
+		State:           model.BotActive,
+	}
+
+	t.Run("success", func(t *testing.T) {
+		t.Parallel()
+		ctrl := gomock.NewController(t)
+		handlerCtx := mock_handler.NewMockContext(ctrl)
+
+		registerBot(t, handlerCtx, b)
+
+		m := &messageImpl{
+			ID:     uuid.NewV3(uuid.Nil, "m"),
+			UID:    uuid.NewV3(uuid.Nil, "bu"),
+			Stamps: []model.MessageStamp{},
+		}
+		et := time.Now()
+
+		expectUnicast(handlerCtx, event.BotMessageStampsUpdated, payload.MakeBotMessageStampsUpdated(et, m.ID, m.Stamps), b)
+		assert.NoError(t, MessageStampsUpdated(handlerCtx, et, intevent.MessageStampsUpdated, hub.Fields{
+			"message":    m,
+			"message_id": m.ID,
+		}))
+	})
+
+	t.Run("not subscribe BotMessageStampsUpdated", func(t *testing.T) {
+		t.Parallel()
+		ctrl := gomock.NewController(t)
+		handlerCtx := mock_handler.NewMockContext(ctrl)
+
+		b := &model.Bot{
+			ID:              uuid.NewV3(uuid.Nil, "b"),
+			BotUserID:       uuid.NewV3(uuid.Nil, "bu"),
+			SubscribeEvents: model.BotEventTypesFromArray([]string{event.MessageCreated.String()}),
+			State:           model.BotActive,
+		}
+		registerBot(t, handlerCtx, b)
+
+		m := &messageImpl{
+			ID:     uuid.NewV3(uuid.Nil, "m"),
+			UID:    b.BotUserID,
+			Stamps: []model.MessageStamp{},
+		}
+		et := time.Now()
+
+		assert.NoError(t, MessageStampsUpdated(handlerCtx, et, intevent.MessageStampsUpdated, hub.Fields{
+			"message":    m,
+			"message_id": m.ID,
+		}))
+	})
+}
+
+type messageImpl struct {
+	message.Message
+	ID     uuid.UUID
+	UID    uuid.UUID
+	Stamps []model.MessageStamp
+}
+
+func (m *messageImpl) GetID() uuid.UUID {
+	return m.ID
+}
+
+func (m *messageImpl) GetUserID() uuid.UUID {
+	return m.UID
+}
+
+func (m *messageImpl) GetStamps() []model.MessageStamp {
+	return m.Stamps
+}

service/bot/handlers.go

@@ -10,16 +10,17 @@ import (
 type eventHandler func(ctx handler.Context, datetime time.Time, event string, fields hub.Fields) error
 
 var eventHandlerSet = map[string]eventHandler{
-	intevent.BotJoined:           handler.BotJoined,
-	intevent.BotLeft:             handler.BotLeft,
-	intevent.BotPingRequest:      handler.BotPingRequest,
-	intevent.MessageCreated:      handler.MessageCreated,
-	intevent.MessageDeleted:      handler.MessageDeleted,
-	intevent.MessageUpdated:      handler.MessageUpdated,
-	intevent.UserCreated:         handler.UserCreated,
-	intevent.ChannelCreated:      handler.ChannelCreated,
-	intevent.ChannelTopicUpdated: handler.ChannelTopicUpdated,
-	intevent.StampCreated:        handler.StampCreated,
-	intevent.UserTagAdded:        handler.UserTagAdded,
-	intevent.UserTagRemoved:      handler.UserTagRemoved,
+	intevent.BotJoined:            handler.BotJoined,
+	intevent.BotLeft:              handler.BotLeft,
+	intevent.BotPingRequest:       handler.BotPingRequest,
+	intevent.MessageCreated:       handler.MessageCreated,
+	intevent.MessageDeleted:       handler.MessageDeleted,
+	intevent.MessageUpdated:       handler.MessageUpdated,
+	intevent.UserCreated:          handler.UserCreated,
+	intevent.ChannelCreated:       handler.ChannelCreated,
+	intevent.ChannelTopicUpdated:  handler.ChannelTopicUpdated,
+	intevent.StampCreated:         handler.StampCreated,
+	intevent.UserTagAdded:         handler.UserTagAdded,
+	intevent.UserTagRemoved:       handler.UserTagRemoved,
+	intevent.MessageStampsUpdated: handler.MessageStampsUpdated,
 }