examples: Update commands to use cmdroute

2025-03-21 09:29:21 +00:00 · 2022-12-10 06:03:04 -08:00 · 2022-12-10 06:03:04 -08:00 · ced922d377
parent 080c734b37
commit ced922d377
4 changed files with 137 additions and 158 deletions
--- a/0-examples/commands-hybrid/main.go
+++ b/0-examples/commands-hybrid/main.go
@ -2,7 +2,6 @@ package main

 import (
 	"context"
-	"fmt"
 	"log"
 	"math/rand"
 	"net/http"
@ -10,12 +9,12 @@ import (
 	"time"

 	"github.com/diamondburned/arikawa/v3/api"
+	"github.com/diamondburned/arikawa/v3/api/cmdroute"
 	"github.com/diamondburned/arikawa/v3/api/webhook"
 	"github.com/diamondburned/arikawa/v3/discord"
 	"github.com/diamondburned/arikawa/v3/gateway"
 	"github.com/diamondburned/arikawa/v3/state"
 	"github.com/diamondburned/arikawa/v3/utils/json/option"
-	"github.com/pkg/errors"
 )

 var commands = []api.CreateCommandData{
@ -46,37 +45,39 @@ func main() {
 		log.Fatalln("No $BOT_TOKEN given.")
 	}

-	var h handler
-
 	var (
 		webhookAddr   = os.Getenv("WEBHOOK_ADDR")
 		webhookPubkey = os.Getenv("WEBHOOK_PUBKEY")
 	)

 	if webhookAddr != "" {
-		h.s = state.NewAPIOnlyState(token, nil)
+		state := state.NewAPIOnlyState(token, nil)

-		srv, err := webhook.NewInteractionServer(webhookPubkey, &h)
-		if err != nil {
-			log.Fatalln("cannot create interaction server:", err)
+		h := newHandler(state)
+
+		if err := overwriteCommands(state); err != nil {
+			log.Fatalln("cannot update commands:", err)
 		}

-		if err := overwriteCommands(h.s); err != nil {
-			log.Fatalln("cannot update commands:", err)
+		srv, err := webhook.NewInteractionServer(webhookPubkey, h)
+		if err != nil {
+			log.Fatalln("cannot create interaction server:", err)
 		}

 		log.Println("listening and serving at", webhookAddr+"/")
 		log.Fatalln(http.ListenAndServe(webhookAddr, srv))
 	} else {
-		h.s = state.New("Bot " + token)
-		h.s.AddInteractionHandler(&h)
-		h.s.AddIntents(gateway.IntentGuilds)
-		h.s.AddHandler(func(*gateway.ReadyEvent) {
-			me, _ := h.s.Me()
+		state := state.New("Bot " + token)
+		state.AddIntents(gateway.IntentGuilds)
+		state.AddHandler(func(*gateway.ReadyEvent) {
+			me, _ := state.Me()
 			log.Println("connected to the gateway as", me.Tag())
 		})

-		if err := overwriteCommands(h.s); err != nil {
+		h := newHandler(state)
+		state.AddInteractionHandler(h)
+
+		if err := overwriteCommands(state); err != nil {
 			log.Fatalln("cannot update commands:", err)
 		}

@ -87,47 +88,34 @@ func main() {
 }

 func overwriteCommands(s *state.State) error {
-	app, err := s.CurrentApplication()
-	if err != nil {
-		return errors.Wrap(err, "cannot get current app ID")
-	}
-
-	_, err = s.BulkOverwriteCommands(app.ID, commands)
-	return err
+	return cmdroute.OverwriteCommands(s, commands)
 }

 type handler struct {
+	*cmdroute.Router
 	s *state.State
 }

-func (h *handler) HandleInteraction(ev *discord.InteractionEvent) *api.InteractionResponse {
-	switch data := ev.Data.(type) {
-	case *discord.CommandInteraction:
-		switch data.Name {
-		case "ping":
-			return h.cmdPing(ev, data)
-		case "echo":
-			return h.cmdEcho(ev, data)
-		case "thonk":
-			return h.cmdThonk(ev, data)
-		default:
-			return errorResponse(fmt.Errorf("unknown command %q", data.Name))
-		}
-	default:
-		return errorResponse(fmt.Errorf("unknown interaction %T", ev.Data))
+func newHandler(s *state.State) *handler {
+	h := &handler{s: s}
+
+	h.Router = cmdroute.NewRouter()
+	// Automatically defer handles if they're slow.
+	h.Use(cmdroute.Deferrable(s, cmdroute.DeferOpts{}))
+	h.AddFunc("ping", h.cmdPing)
+	h.AddFunc("echo", h.cmdEcho)
+	h.AddFunc("thonk", h.cmdThonk)
+
+	return h
+}
+
+func (h *handler) cmdPing(ctx context.Context, cmd cmdroute.CommandData) *api.InteractionResponseData {
+	return &api.InteractionResponseData{
+		Content: option.NewNullableString("Pong!"),
 	}
 }

-func (h *handler) cmdPing(ev *discord.InteractionEvent, _ *discord.CommandInteraction) *api.InteractionResponse {
-	return &api.InteractionResponse{
-		Type: api.MessageInteractionWithSource,
-		Data: &api.InteractionResponseData{
-			Content: option.NewNullableString("Pong!"),
-		},
-	}
-}
-
-func (h *handler) cmdEcho(ev *discord.InteractionEvent, data *discord.CommandInteraction) *api.InteractionResponse {
+func (h *handler) cmdEcho(ctx context.Context, data cmdroute.CommandData) *api.InteractionResponseData {
 	var options struct {
 		Arg string `discord:"argument"`
 	}
@ -136,43 +124,23 @@ func (h *handler) cmdEcho(ev *discord.InteractionEvent, data *discord.CommandInt
 		return errorResponse(err)
 	}

-	return &api.InteractionResponse{
-		Type: api.MessageInteractionWithSource,
-		Data: &api.InteractionResponseData{
-			Content:         option.NewNullableString(options.Arg),
-			AllowedMentions: &api.AllowedMentions{},
-		},
+	return &api.InteractionResponseData{
+		Content:         option.NewNullableString(options.Arg),
+		AllowedMentions: &api.AllowedMentions{}, // don't mention anyone
 	}
 }

-func (h *handler) cmdThonk(ev *discord.InteractionEvent, data *discord.CommandInteraction) *api.InteractionResponse {
-	go func() {
-		time.Sleep(time.Duration(3+rand.Intn(5)) * time.Second)
-
-		h.s.FollowUpInteraction(ev.AppID, ev.Token, api.InteractionResponseData{
-			Content: option.NewNullableString("https://tenor.com/view/thonk-thinking-sun-thonk-sun-thinking-sun-gif-14999983"),
-		})
-	}()
-
-	return deferResponse(0)
-}
-
-func errorResponse(err error) *api.InteractionResponse {
-	return &api.InteractionResponse{
-		Type: api.MessageInteractionWithSource,
-		Data: &api.InteractionResponseData{
-			Content:         option.NewNullableString("**Error:** " + err.Error()),
-			Flags:           discord.EphemeralMessage,
-			AllowedMentions: &api.AllowedMentions{ /* none */ },
-		},
+func (h *handler) cmdThonk(ctx context.Context, data cmdroute.CommandData) *api.InteractionResponseData {
+	time.Sleep(time.Duration(3+rand.Intn(5)) * time.Second)
+	return &api.InteractionResponseData{
+		Content: option.NewNullableString("https://tenor.com/view/thonk-thinking-sun-thonk-sun-thinking-sun-gif-14999983"),
 	}
 }

-func deferResponse(flags discord.MessageFlags) *api.InteractionResponse {
-	return &api.InteractionResponse{
-		Type: api.DeferredMessageInteractionWithSource,
-		Data: &api.InteractionResponseData{
-			Flags: flags,
-		},
+func errorResponse(err error) *api.InteractionResponseData {
+	return &api.InteractionResponseData{
+		Content:         option.NewNullableString("**Error:** " + err.Error()),
+		Flags:           discord.EphemeralMessage,
+		AllowedMentions: &api.AllowedMentions{ /* none */ },
 	}
 }
--- a/0-examples/commands-minimal/main.go
+++ b/0-examples/commands-minimal/main.go
@ -0,0 +1,34 @@
+package main
+
+import (
+	"context"
+	"log"
+	"os"
+
+	"github.com/diamondburned/arikawa/v3/api"
+	"github.com/diamondburned/arikawa/v3/api/cmdroute"
+	"github.com/diamondburned/arikawa/v3/gateway"
+	"github.com/diamondburned/arikawa/v3/state"
+	"github.com/diamondburned/arikawa/v3/utils/json/option"
+)
+
+var commands = []api.CreateCommandData{{Name: "ping", Description: "Ping!"}}
+
+func main() {
+	r := cmdroute.NewRouter()
+	r.AddFunc("ping", func(ctx context.Context, data cmdroute.CommandData) *api.InteractionResponseData {
+		return &api.InteractionResponseData{Content: option.NewNullableString("Pong!")}
+	})
+
+	s := state.New("Bot " + os.Getenv("BOT_TOKEN"))
+	s.AddInteractionHandler(r)
+	s.AddIntents(gateway.IntentGuilds)
+
+	if err := cmdroute.OverwriteCommands(s, commands); err != nil {
+		log.Fatalln("cannot update commands:", err)
+	}
+
+	if err := s.Connect(context.TODO()); err != nil {
+		log.Println("cannot connect:", err)
+	}
+}
--- a/0-examples/commands/main.go
+++ b/0-examples/commands/main.go
@ -2,18 +2,18 @@ package main

 import (
 	"context"
-	"fmt"
 	"log"
 	"math/rand"
 	"os"
+	"os/signal"
 	"time"

 	"github.com/diamondburned/arikawa/v3/api"
+	"github.com/diamondburned/arikawa/v3/api/cmdroute"
 	"github.com/diamondburned/arikawa/v3/discord"
 	"github.com/diamondburned/arikawa/v3/gateway"
 	"github.com/diamondburned/arikawa/v3/state"
 	"github.com/diamondburned/arikawa/v3/utils/json/option"
-	"github.com/pkg/errors"
 )

 // To run, do `BOT_TOKEN="TOKEN HERE" go run .`
@ -46,9 +46,8 @@ func main() {
 		log.Fatalln("No $BOT_TOKEN given.")
 	}

-	var h handler
-	h.s = state.New("Bot " + token)
-	h.s.AddInteractionHandler(&h)
+	h := newHandler(state.New("Bot " + token))
+	h.s.AddInteractionHandler(h)
 	h.s.AddIntents(gateway.IntentGuilds)
 	h.s.AddHandler(func(*gateway.ReadyEvent) {
 		me, _ := h.s.Me()
@ -59,53 +58,43 @@ func main() {
 		log.Fatalln("cannot update commands:", err)
 	}

-	if err := h.s.Connect(context.Background()); err != nil {
+	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
+	defer cancel()
+
+	if err := h.s.Connect(ctx); err != nil {
 		log.Fatalln("cannot connect:", err)
 	}
 }

 func overwriteCommands(s *state.State) error {
-	app, err := s.CurrentApplication()
-	if err != nil {
-		return errors.Wrap(err, "cannot get current app ID")
-	}
-
-	_, err = s.BulkOverwriteCommands(app.ID, commands)
-	return err
+	return cmdroute.OverwriteCommands(s, commands)
 }

 type handler struct {
+	*cmdroute.Router
 	s *state.State
 }

-func (h *handler) HandleInteraction(ev *discord.InteractionEvent) *api.InteractionResponse {
-	switch data := ev.Data.(type) {
-	case *discord.CommandInteraction:
-		switch data.Name {
-		case "ping":
-			return h.cmdPing(ev, data)
-		case "echo":
-			return h.cmdEcho(ev, data)
-		case "thonk":
-			return h.cmdThonk(ev, data)
-		default:
-			return errorResponse(fmt.Errorf("unknown command %q", data.Name))
-		}
-	default:
-		return errorResponse(fmt.Errorf("unknown interaction %T", ev.Data))
+func newHandler(s *state.State) *handler {
+	h := &handler{s: s}
+
+	h.Router = cmdroute.NewRouter()
+	// Automatically defer handles if they're slow.
+	h.Use(cmdroute.Deferrable(s, cmdroute.DeferOpts{}))
+	h.AddFunc("ping", h.cmdPing)
+	h.AddFunc("echo", h.cmdEcho)
+	h.AddFunc("thonk", h.cmdThonk)
+
+	return h
+}
+
+func (h *handler) cmdPing(ctx context.Context, cmd cmdroute.CommandData) *api.InteractionResponseData {
+	return &api.InteractionResponseData{
+		Content: option.NewNullableString("Pong!"),
 	}
 }

-func (h *handler) cmdPing(ev *discord.InteractionEvent, _ *discord.CommandInteraction) *api.InteractionResponse {
-	return &api.InteractionResponse{
-		Type: api.MessageInteractionWithSource,
-		Data: &api.InteractionResponseData{
-			Content: option.NewNullableString("Pong!"),
-		},
-	}
-}
-
-func (h *handler) cmdEcho(ev *discord.InteractionEvent, data *discord.CommandInteraction) *api.InteractionResponse {
+func (h *handler) cmdEcho(ctx context.Context, data cmdroute.CommandData) *api.InteractionResponseData {
 	var options struct {
 		Arg string `discord:"argument"`
 	}
@ -114,43 +103,23 @@ func (h *handler) cmdEcho(ev *discord.InteractionEvent, data *discord.CommandInt
 		return errorResponse(err)
 	}

-	return &api.InteractionResponse{
-		Type: api.MessageInteractionWithSource,
-		Data: &api.InteractionResponseData{
-			Content:         option.NewNullableString(options.Arg),
-			AllowedMentions: &api.AllowedMentions{},
-		},
+	return &api.InteractionResponseData{
+		Content:         option.NewNullableString(options.Arg),
+		AllowedMentions: &api.AllowedMentions{}, // don't mention anyone
 	}
 }

-func (h *handler) cmdThonk(ev *discord.InteractionEvent, data *discord.CommandInteraction) *api.InteractionResponse {
-	go func() {
-		time.Sleep(time.Duration(3+rand.Intn(5)) * time.Second)
-
-		h.s.FollowUpInteraction(ev.AppID, ev.Token, api.InteractionResponseData{
-			Content: option.NewNullableString("https://tenor.com/view/thonk-thinking-sun-thonk-sun-thinking-sun-gif-14999983"),
-		})
-	}()
-
-	return deferResponse(0)
-}
-
-func errorResponse(err error) *api.InteractionResponse {
-	return &api.InteractionResponse{
-		Type: api.MessageInteractionWithSource,
-		Data: &api.InteractionResponseData{
-			Content:         option.NewNullableString("**Error:** " + err.Error()),
-			Flags:           discord.EphemeralMessage,
-			AllowedMentions: &api.AllowedMentions{ /* none */ },
-		},
+func (h *handler) cmdThonk(ctx context.Context, data cmdroute.CommandData) *api.InteractionResponseData {
+	time.Sleep(time.Duration(3+rand.Intn(5)) * time.Second)
+	return &api.InteractionResponseData{
+		Content: option.NewNullableString("https://tenor.com/view/thonk-thinking-sun-thonk-sun-thinking-sun-gif-14999983"),
 	}
 }

-func deferResponse(flags discord.MessageFlags) *api.InteractionResponse {
-	return &api.InteractionResponse{
-		Type: api.DeferredMessageInteractionWithSource,
-		Data: &api.InteractionResponseData{
-			Flags: flags,
-		},
+func errorResponse(err error) *api.InteractionResponseData {
+	return &api.InteractionResponseData{
+		Content:         option.NewNullableString("**Error:** " + err.Error()),
+		Flags:           discord.EphemeralMessage,
+		AllowedMentions: &api.AllowedMentions{ /* none */ },
 	}
 }
--- a/README.md
+++ b/README.md
@ -93,23 +93,31 @@ import (
 	"context"
 	"log"
 	"os"
-	"os/signal"

+	"github.com/diamondburned/arikawa/v3/api"
+	"github.com/diamondburned/arikawa/v3/api/cmdroute"
 	"github.com/diamondburned/arikawa/v3/gateway"
 	"github.com/diamondburned/arikawa/v3/state"
+	"github.com/diamondburned/arikawa/v3/utils/json/option"
 )

+var commands = []api.CreateCommandData{{Name: "ping", Description: "Ping!"}}
+
 func main() {
-	s := state.New("Bot " + os.Getenv("BOT_TOKEN"))
-	s.AddIntents(gateway.IntentGuilds | gateway.IntentGuildMessages)
-	s.AddHandler(func(m *gateway.MessageCreateEvent) {
-		log.Printf("%s: %s", m.Author.Username, m.Content)
+	r := cmdroute.NewRouter()
+	r.AddFunc("ping", func(ctx context.Context, data cmdroute.CommandData) *api.InteractionResponseData {
+		return &api.InteractionResponseData{Content: option.NewNullableString("Pong!")}
 	})

-	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
-	defer cancel()
+	s := state.New("Bot " + os.Getenv("BOT_TOKEN"))
+	s.AddInteractionHandler(r)
+	s.AddIntents(gateway.IntentGuilds)

-	if err := s.Connect(ctx); err != nil {
+	if err := cmdroute.OverwriteCommands(s, commands); err != nil {
+		log.Fatalln("cannot update commands:", err)
+	}
+
+	if err := s.Connect(context.TODO()); err != nil {
 		log.Println("cannot connect:", err)
 	}
 }