feat: Handle more interaction types

Convert BlockID to InteractionID field into the InteractionDefinition struct, and add the necessary dispatch mechanisms to handle the following interactions: - shortcut - message_actions - view_submission - view_closed Add Interaction type to interaction definition
shomali11 · Oct 31, 2023 · 8ac097a · 8ac097a
1 parent 32e6347
commit 8ac097a
Show file tree

Hide file tree

Showing 6 changed files with 234 additions and 24 deletions.
diff --git a/examples/interaction-middleware/main.go b/examples/interaction-middleware/main.go
@@ -20,8 +20,9 @@ func main() {
 
 	bot.AddInteractionMiddleware(LoggingInteractionMiddleware())
 	bot.AddInteraction(&slacker.InteractionDefinition{
-		BlockID: "mood",
-		Handler: slackerInteractive,
+		InteractionID: "mood",
+		Handler:       slackerInteractive,
+		Type:          slack.InteractionTypeBlockActions,
 	})
 
 	ctx, cancel := context.WithCancel(context.Background())
@@ -68,7 +69,7 @@ func LoggingInteractionMiddleware() slacker.InteractionMiddlewareHandler {
 			ctx.Logger().Infof(
 				"%s initiated \"%s\" with action \"%v\" in channel %s\n",
 				ctx.Callback().User.ID,
-				ctx.Definition().BlockID,
+				ctx.Definition().InteractionID,
 				ctx.Callback().ActionCallback.BlockActions[0].ActionID,
 				ctx.Callback().Channel.ID,
 			)

diff --git a/examples/interaction-shortcut/main.go b/examples/interaction-shortcut/main.go
@@ -0,0 +1,54 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/shomali11/slacker/v2"
+	"github.com/slack-go/slack"
+)
+
+// Implements a basic interactive command with modal view.
+
+func main() {
+	bot := slacker.NewClient(
+		os.Getenv("SLACK_BOT_TOKEN"),
+		os.Getenv("SLACK_APP_TOKEN"),
+		slacker.WithDebug(false),
+	)
+
+	bot.AddInteraction(&slacker.InteractionDefinition{
+		InteractionID: "mood-survey-message-shortcut-callback-id",
+		Handler:       moodShortcutHandler,
+		Type:          slack.InteractionTypeMessageAction,
+	})
+
+	bot.AddInteraction(&slacker.InteractionDefinition{
+		InteractionID: "mood-survey-global-shortcut-callback-id",
+		Handler:       moodShortcutHandler,
+		Type:          slack.InteractionTypeShortcut,
+	})
+
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	err := bot.Listen(ctx)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
+func moodShortcutHandler(ctx *slacker.InteractionContext) {
+	switch ctx.Callback().Type {
+	case slack.InteractionTypeMessageAction:
+		{
+			fmt.Print("Message shortcut.\n")
+		}
+	case slack.InteractionTypeShortcut:
+		{
+			fmt.Print("Global shortcut.\n")
+		}
+	}
+}
diff --git a/examples/interaction-view/main.go b/examples/interaction-view/main.go
@@ -0,0 +1,118 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/shomali11/slacker/v2"
+	"github.com/slack-go/slack"
+)
+
+var moodSurveyView = slack.ModalViewRequest{
+	Type:       "modal",
+	CallbackID: "mood-survey-callback-id",
+	Title: &slack.TextBlockObject{
+		Type: "plain_text",
+		Text: "Which mood are you in?",
+	},
+	Submit: &slack.TextBlockObject{
+		Type: "plain_text",
+		Text: "Submit",
+	},
+	NotifyOnClose: true,
+	Blocks: slack.Blocks{
+		BlockSet: []slack.Block{
+			&slack.InputBlock{
+				Type:    slack.MBTInput,
+				BlockID: "mood",
+				Label: &slack.TextBlockObject{
+					Type: "plain_text",
+					Text: "Mood",
+				},
+				Element: &slack.SelectBlockElement{
+					Type:     slack.OptTypeStatic,
+					ActionID: "mood",
+					Options: []*slack.OptionBlockObject{
+						{
+							Text: &slack.TextBlockObject{
+								Type: "plain_text",
+								Text: "Happy",
+							},
+							Value: "Happy",
+						},
+						{
+							Text: &slack.TextBlockObject{
+								Type: "plain_text",
+								Text: "Sad",
+							},
+							Value: "Sad",
+						},
+					},
+				},
+			},
+		},
+	},
+}
+
+// Implements a basic interactive command with modal view.
+func main() {
+	bot := slacker.NewClient(
+		os.Getenv("SLACK_BOT_TOKEN"),
+		os.Getenv("SLACK_APP_TOKEN"),
+		slacker.WithDebug(false),
+	)
+
+	bot.AddCommand(&slacker.CommandDefinition{
+		Command: "mood",
+		Handler: moodCmdHandler,
+	})
+
+	bot.AddInteraction(&slacker.InteractionDefinition{
+		InteractionID: "mood-survey-callback-id",
+		Handler:       moodViewHandler,
+		Type:          slack.InteractionTypeViewSubmission,
+	})
+
+	bot.AddInteraction(&slacker.InteractionDefinition{
+		InteractionID: "mood-survey-callback-id",
+		Handler:       moodViewHandler,
+		Type:          slack.InteractionTypeViewClosed,
+	})
+
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	err := bot.Listen(ctx)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
+func moodCmdHandler(ctx *slacker.CommandContext) {
+	_, err := ctx.SlackClient().OpenView(
+		ctx.Event().Data.(*slack.SlashCommand).TriggerID,
+		moodSurveyView,
+	)
+	if err != nil {
+		log.Printf("ERROR openEscalationModal: %v", err)
+	}
+}
+
+func moodViewHandler(ctx *slacker.InteractionContext) {
+	switch ctx.Callback().Type {
+	case slack.InteractionTypeViewSubmission:
+		{
+			viewState := ctx.Callback().View.State.Values
+			fmt.Printf(
+				"Mood view submitted.\nMood: %s\n",
+				viewState["mood"]["mood"].SelectedOption.Value,
+			)
+		}
+	case slack.InteractionTypeViewClosed:
+		{
+			fmt.Print("Mood view closed.\n")
+		}
+	}
+}
diff --git a/examples/interaction/main.go b/examples/interaction/main.go
@@ -19,8 +19,9 @@ func main() {
 	})
 
 	bot.AddInteraction(&slacker.InteractionDefinition{
-		BlockID: "mood",
-		Handler: slackerInteractive,
+		InteractionID: "mood",
+		Handler:       slackerInteractive,
+		Type:          slack.InteractionTypeBlockActions,
 	})
 
 	ctx, cancel := context.WithCancel(context.Background())

diff --git a/interaction.go b/interaction.go
@@ -1,10 +1,13 @@
 package slacker
 
+import "github.com/slack-go/slack"
+
 // InteractionDefinition structure contains definition of the bot interaction
 type InteractionDefinition struct {
-	BlockID     string
-	Middlewares []InteractionMiddlewareHandler
-	Handler     InteractionHandler
+	InteractionID string
+	Middlewares   []InteractionMiddlewareHandler
+	Handler       InteractionHandler
+	Type          slack.InteractionType
 }
 
 // newInteraction creates a new bot interaction object

diff --git a/slacker.go b/slacker.go
@@ -42,6 +42,7 @@ func NewClient(botToken, appToken string, clientOptions ...ClientOption) *Slacke
 		botInteractionMode:       options.BotMode,
 		sanitizeEventTextHandler: defaultEventTextSanitizer,
 		logger:                   options.Logger,
+		interactions:             make(map[slack.InteractionType][]*Interaction),
 	}
 	return slacker
 }
@@ -54,7 +55,7 @@ type Slacker struct {
 	commandMiddlewares            []CommandMiddlewareHandler
 	commandGroups                 []*CommandGroup
 	interactionMiddlewares        []InteractionMiddlewareHandler
-	interactions                  []*Interaction
+	interactions                  map[slack.InteractionType][]*Interaction
 	jobMiddlewares                []JobMiddlewareHandler
 	jobs                          []*Job
 	onHello                       func(socketmode.Event)
@@ -78,7 +79,7 @@ func (s *Slacker) GetCommandGroups() []*CommandGroup {
 }
 
 // GetInteractions returns Groups
-func (s *Slacker) GetInteractions() []*Interaction {
+func (s *Slacker) GetInteractions() map[slack.InteractionType][]*Interaction {
 	return s.interactions
 }
 
@@ -174,11 +175,15 @@ func (s *Slacker) AddCommandGroup(prefix string) *CommandGroup {
 
 // AddInteraction define a new interaction and append it to the list of interactions
 func (s *Slacker) AddInteraction(definition *InteractionDefinition) {
-	if len(definition.BlockID) == 0 {
-		s.logger.Error("missing `BlockID`")
+	if len(definition.InteractionID) == 0 {
+		s.logger.Error("missing `ID`")
 		return
 	}
-	s.interactions = append(s.interactions, newInteraction(definition))
+	if len(definition.Type) == 0 {
+		s.logger.Error("missing `Type`")
+		return
+	}
+	s.interactions[definition.Type] = append(s.interactions[definition.Type], newInteraction(definition))
 }
 
 // AddInteractionMiddleware appends a new interaction middleware to the list of root level interaction middlewares
@@ -437,21 +442,49 @@ func (s *Slacker) handleInteractionEvent(ctx context.Context, callback *slack.In
 	middlewares := make([]InteractionMiddlewareHandler, 0)
 	middlewares = append(middlewares, s.interactionMiddlewares...)
 
-	for _, interaction := range s.interactions {
-		for _, action := range callback.ActionCallback.BlockActions {
-			definition := interaction.Definition()
-			if action.BlockID != definition.BlockID {
-				continue
+	var interaction *Interaction
+	var definition *InteractionDefinition
+
+	switch callback.Type {
+	case slack.InteractionTypeBlockActions:
+		for _, i := range s.interactions[callback.Type] {
+			for _, a := range callback.ActionCallback.BlockActions {
+				definition = i.Definition()
+				if a.BlockID == definition.InteractionID {
+					interaction = i
+					break
+				}
+			}
+			if interaction != nil {
+				break
 			}
-
-			interactionCtx := newInteractionContext(ctx, s.logger, s.slackClient, callback, definition)
-
-			middlewares = append(middlewares, definition.Middlewares...)
-			executeInteraction(interactionCtx, definition.Handler, middlewares...)
-			return
 		}
+	case slack.InteractionTypeViewClosed, slack.InteractionTypeViewSubmission:
+		for _, i := range s.interactions[callback.Type] {
+			definition = i.Definition()
+			if definition.InteractionID == callback.View.CallbackID {
+				interaction = i
+				break
+			}
+		}
+	case slack.InteractionTypeShortcut, slack.InteractionTypeMessageAction:
+		for _, i := range s.interactions[callback.Type] {
+			definition = i.Definition()
+			if definition.InteractionID == callback.CallbackID {
+				interaction = i
+				break
+			}
+		}
+	}
+
+	if interaction != nil {
+		interactionCtx := newInteractionContext(ctx, s.logger, s.slackClient, callback, definition)
+		middlewares = append(middlewares, definition.Middlewares...)
+		executeInteraction(interactionCtx, definition.Handler, middlewares...)
+		return
 	}
 
+	s.logger.Debugf("unsupported interaction type received %s\n", callback.Type)
 	if s.unsupportedInteractionHandler != nil {
 		interactionCtx := newInteractionContext(ctx, s.logger, s.slackClient, callback, nil)
 		executeInteraction(interactionCtx, s.unsupportedInteractionHandler, middlewares...)