add context to handler events

disgoorg · Feb 7, 2024 · f3c3625 · f3c3625
1 parent d3e0672
commit f3c3625
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 5 deletions.
diff --git a/handler/autocomplete.go b/handler/autocomplete.go
@@ -1,6 +1,8 @@
 package handler
 
 import (
+	"context"
+
 	"github.com/disgoorg/snowflake/v2"
 
 	"github.com/disgoorg/disgo/discord"
@@ -11,6 +13,7 @@ import (
 type AutocompleteEvent struct {
 	*events.AutocompleteInteractionCreate
 	Variables map[string]string
+	Ctx       context.Context
 }
 
 func (e *AutocompleteEvent) GetFollowupMessage(messageID snowflake.ID, opts ...rest.RequestOpt) (*discord.Message, error) {

diff --git a/handler/command.go b/handler/command.go
@@ -1,6 +1,8 @@
 package handler
 
 import (
+	"context"
+
 	"github.com/disgoorg/snowflake/v2"
 
 	"github.com/disgoorg/disgo/discord"
@@ -11,6 +13,7 @@ import (
 type CommandEvent struct {
 	*events.ApplicationCommandInteractionCreate
 	Variables map[string]string
+	Ctx       context.Context
 }
 
 func (e *CommandEvent) GetInteractionResponse(opts ...rest.RequestOpt) (*discord.Message, error) {

diff --git a/handler/component.go b/handler/component.go
@@ -1,6 +1,8 @@
 package handler
 
 import (
+	"context"
+
 	"github.com/disgoorg/snowflake/v2"
 
 	"github.com/disgoorg/disgo/discord"
@@ -11,6 +13,7 @@ import (
 type ComponentEvent struct {
 	*events.ComponentInteractionCreate
 	Variables map[string]string
+	Ctx       context.Context
 }
 
 func (e *ComponentEvent) GetInteractionResponse(opts ...rest.RequestOpt) (*discord.Message, error) {

diff --git a/handler/handler.go b/handler/handler.go
@@ -18,6 +18,7 @@
 package handler
 
 import (
+	"context"
 	"errors"
 	"strings"
 
@@ -69,7 +70,7 @@ func (h *handlerHolder[T]) Match(path string, t discord.InteractionType) bool {
 	return true
 }
 
-func (h *handlerHolder[T]) Handle(path string, variables map[string]string, event *events.InteractionCreate) error {
+func (h *handlerHolder[T]) Handle(ctx context.Context, path string, variables map[string]string, event *events.InteractionCreate) error {
 	parseVariables(path, h.pattern, variables)
 
 	switch handler := any(h.handler).(type) {
@@ -81,6 +82,7 @@ func (h *handlerHolder[T]) Handle(path string, variables map[string]string, even
 				Respond:                       event.Respond,
 			},
 			Variables: variables,
+			Ctx:       ctx,
 		})
 	case AutocompleteHandler:
 		return handler(&AutocompleteEvent{
@@ -90,6 +92,7 @@ func (h *handlerHolder[T]) Handle(path string, variables map[string]string, even
 				Respond:                 event.Respond,
 			},
 			Variables: variables,
+			Ctx:       ctx,
 		})
 	case ComponentHandler:
 		return handler(&ComponentEvent{
@@ -99,6 +102,7 @@ func (h *handlerHolder[T]) Handle(path string, variables map[string]string, even
 				Respond:              event.Respond,
 			},
 			Variables: variables,
+			Ctx:       ctx,
 		})
 	case ModalHandler:
 		return handler(&ModalEvent{
@@ -108,6 +112,7 @@ func (h *handlerHolder[T]) Handle(path string, variables map[string]string, even
 				Respond:                event.Respond,
 			},
 			Variables: variables,
+			Ctx:       ctx,
 		})
 	}
 	return errors.New("unknown handler type")

diff --git a/handler/middleware.go b/handler/middleware.go
@@ -1,11 +1,13 @@
 package handler
 
 import (
+	"context"
+
 	"github.com/disgoorg/disgo/events"
 )
 
 type (
-	Handler func(e *events.InteractionCreate) error
+	Handler func(ctx context.Context, e *events.InteractionCreate) error
 
 	Middleware func(next Handler) Handler
 

diff --git a/handler/modal.go b/handler/modal.go
@@ -1,6 +1,8 @@
 package handler
 
 import (
+	"context"
+
 	"github.com/disgoorg/snowflake/v2"
 
 	"github.com/disgoorg/disgo/discord"
@@ -11,6 +13,7 @@ import (
 type ModalEvent struct {
 	*events.ModalSubmitInteractionCreate
 	Variables map[string]string
+	Ctx       context.Context
 }
 
 func (e *ModalEvent) GetInteractionResponse(opts ...rest.RequestOpt) (*discord.Message, error) {

diff --git a/handler/mux.go b/handler/mux.go
@@ -2,6 +2,7 @@ package handler
 
 import (
 	"log/slog"
+	"context"
 	"strings"
 
 	"github.com/disgoorg/disgo/bot"
@@ -33,6 +34,7 @@ type Mux struct {
 	routes          []Route
 	notFoundHandler NotFoundHandler
 	errorHandler    ErrorHandler
+	defaultContext  func() context.Context
 }
 
 // OnEvent is called when a new event is received.
@@ -58,7 +60,7 @@ func (r *Mux) OnEvent(event bot.Event) {
 		path = i.Data.CustomID
 	}
 
-	if err := r.Handle(path, make(map[string]string), e); err != nil {
+	if err := r.Handle(r.defaultContext(), path, make(map[string]string), e); err != nil {
 		if r.errorHandler != nil {
 			r.errorHandler(e, err)
 			return
@@ -109,7 +111,7 @@ func (r *Mux) Handle(path string, variables map[string]string, e *events.Interac
 	}
 
 	for i := len(r.middlewares) - 1; i >= 0; i-- {
-		handlerChain = r.middlewares[i](handlerChain)
+		handlerChain = r.middlewares[i](ctx, handlerChain)
 	}
 
 	return handlerChain(e)

diff --git a/handler/router.go b/handler/router.go
@@ -1,6 +1,8 @@
 package handler
 
 import (
+	"context"
+
 	"github.com/disgoorg/disgo/bot"
 	"github.com/disgoorg/disgo/discord"
 	"github.com/disgoorg/disgo/events"
@@ -29,7 +31,7 @@ type Route interface {
 	Match(path string, t discord.InteractionType) bool
 
 	// Handle handles the given interaction event.
-	Handle(path string, variables map[string]string, e *events.InteractionCreate) error
+	Handle(ctx context.Context, path string, variables map[string]string, e *events.InteractionCreate) error
 }
 
 // Router provides with the core routing functionality.