Merge pull request 'fix/async' (#4) from fix/async into main

Reviewed-on: #4

README.md

@@ -58,7 +58,10 @@ import (
 func main() {
 	//bolt defaults the command indicator to '.' however that can be changed with the options
 	//Example: bolt.New(bolt.WithIndicator('!')) would support commands like !ping
-	b := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd))
+	b, err := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd))
+	if err != nil {
+		panic(err)
+	}
 
 	b.AddCommands(
 		// basic ping pong command, .ping can be run at anytime by anyone and will reply "pong"
@@ -95,11 +98,12 @@ func main() {
 	)
 
 	//start is a blocking call that handles safe-shutdown, all configuration and setup should be done before calling Start()
-	err := b.Start()
+	err = b.Start()
 	if err != nil {
 		panic(err)
 	}
 }
+
 ```
 
 ## Development

bolt.go

@@ -20,7 +20,8 @@ const (
 		dg.IntentGuildMembers |
 		dg.IntentGuildPresences |
 		dg.IntentMessageContent |
-		dg.IntentsGuildMessages
+		dg.IntentsGuildMessages |
+		dg.IntentGuildMessageReactions
 )
 
 // basic bot structure containing discordgo connection as well as the command map
@@ -37,27 +38,23 @@ type Bolt interface {
 	//filtered methods
 	stop() error
 	messageHandler(s *dg.Session, msg *dg.MessageCreate)
-	handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Guild, channel *dg.Channel, lg int) error
+	handleCommand(msgEvent *MessageCreateEvent, s *dg.Session, lg int) error
 	createReply(content, message, channel, guild string) *dg.MessageSend
 	getRemainingTimeout(timeout time.Time) string
-	roleCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error)
+	roleCheck(guild string, roles []string, s *dg.Session, run Command) (bool, error)
-	timeoutCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error)
+	timeoutCheck(msgID, channelID, guildID string, s *dg.Session, run Command) (bool, error)
-}
-
-// setup
-func init() {
-	//validate environment variables
-	_, check := os.LookupEnv(TOKEN_ENV_VAR)
-	if !check {
-		log.Fatalf("the %s environment variable must be set", TOKEN_ENV_VAR)
-	}
 }
 
 // create a new bolt interface
-func New(opts ...Option) Bolt {
+func New(opts ...Option) (Bolt, error) {
+	_, check := os.LookupEnv(TOKEN_ENV_VAR)
+	if !check {
+		return nil, fmt.Errorf("environment variable %s must be set", TOKEN_ENV_VAR)
+	}
+
 	bot, err := dg.New(fmt.Sprintf("Bot %s", os.Getenv(TOKEN_ENV_VAR)))
 	if err != nil {
-		log.Fatal(err)
+		return nil, fmt.Errorf("failed to create Discord session: %e", err)
 	}
 	bot.Identify.Intents = BOT_INTENTS
 
@@ -69,23 +66,23 @@ func New(opts ...Option) Bolt {
 	//set default command indicator
 	b.indicator = "."
 
-	//apply options to bolt
+	//apply options
 	for _, opt := range opts {
 		opt(b)
 	}
 
-	return b
+	return b, nil
 }
 
-// starts the bot, commands are added and the connection to Discord is opened, this is a BLOCKING
+// starts the bot, commands are added and the connection to Discord is opened, this is a BLOCKING call
-// call that handles safe shutdown of the bot
+// that handles safe shutdown of the bot
 func (b *bolt) Start() error {
 	//register commands and open connection
 	b.AddHandler(b.messageHandler)
 
 	err := b.Open()
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to open websocket connection with Discord: %e", err)
 	}
 
 	//safe shutdown handler
@@ -112,17 +109,18 @@ func (b *bolt) AddCommands(cmd ...Command) {
 	}
 }
 
-// handler function that parses message data and executes any command payloads
+// handler function that parses message data, handles logging the message based on logLevel, and executes
+// the payload function in a goroutine
 func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
 	//get server information
 	server, err := s.Guild(msg.GuildID)
 	if err != nil {
-		log.Println(err)
+		log.Printf("failed to get guild: %e\n", err)
 		return
 	}
 	channel, err := s.Channel(msg.ChannelID)
 	if err != nil {
-		log.Println(err)
+		log.Printf("failed to get channel from guild: %e\n", err)
 		return
 	}
 
@@ -132,48 +130,61 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
 		msg.Content = "[Embedded Content]"
 	}
 
-	if b.logLvl == LogLevelAll {
-		//log message
-		log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
-	}
-
 	//the bot will ignore it's own messages to prevent command loops
 	if msg.Author.ID == s.State.User.ID {
-		if b.logLvl == LogLevelCmd {
+		if b.logLvl == LogLevelCmd || b.logLvl == LogLevelAll {
-			//log commands
+			//log command responses
 			log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
 		}
 		return
 	}
 
+	if b.logLvl == LogLevelAll {
+		//log message
+		log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
+	}
+
 	//does the message have the command indicator
 	lg := len(b.indicator)
 	if msg.Content[:lg] == b.indicator {
-		err := b.handleCommand(msg, s, server, channel, lg)
+		mCreate := &MessageCreateEvent{
-		if err != nil {
+			AuthorUsername: msg.Author.Username,
-			log.Println(err)
+			AuthorID:       msg.Author.ID,
-			return
+			AuthorRoles:    msg.Member.Roles,
+			MsgID:          msg.ID,
+			Msg:            msg.Content,
+			MsgChanID:      msg.ChannelID,
+			MsgGuildID:     msg.GuildID,
+			MsgAttachments: msg.Attachments,
 		}
+
+		if b.logLvl == LogLevelCmd {
+			//log commands
+			log.Printf("< %s | %s | %s > %s\n", mCreate.MsgGuildName, mCreate.MsgChanName, mCreate.AuthorUsername, mCreate.Msg)
+		}
+
+		//handled in its own goroutine to allow for async commands
+		go func() {
+			err := b.handleCommand(mCreate, s, lg)
+			if err != nil {
+				log.Println(err)
+			}
+		}()
 	}
 }
 
 // parses command from message and handles timeout checks, role checks, and command execution. All command responses are sent back to Discord
-func (b *bolt) handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Guild, channel *dg.Channel, lg int) error {
+func (b *bolt) handleCommand(msgEvent *MessageCreateEvent, s *dg.Session, lg int) error {
-	if b.logLvl == LogLevelCmd {
+	words := strings.Split(msgEvent.Msg, " ")
-		//log commands
-		log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
-	}
-
-	words := strings.Split(msg.Content, " ")
 	run, ok := b.commands[words[0][lg:]]
 	if !ok {
 		return nil //command doesn't exist, maybe log or respond to author
 	}
 
 	//has command met its timeout requirements
-	tc, err := b.timeoutCheck(msg, s, run)
+	tc, err := b.timeoutCheck(msgEvent.MsgID, msgEvent.MsgChanID, msgEvent.MsgGuildID, s, run)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to calculate timeout for %s\n%e", run.Trigger, err)
 	}
 	if !tc {
 		return nil
@@ -181,32 +192,38 @@ func (b *bolt) handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Gu
 
 	//does user have correct permissions
 	if run.Roles != nil {
-		check, err := b.roleCheck(msg, s, run)
+		check, err := b.roleCheck(msgEvent.MsgGuildID, msgEvent.AuthorRoles, s, run)
 		if err != nil {
-			return err
+			return fmt.Errorf("failed to perform permission checks for %s\n%e", run.Trigger, err)
 		}
 		if !check {
+			reply := b.createReply("you do not have permissions to run that command", msgEvent.MsgID, msgEvent.MsgChanID, msgEvent.MsgGuildID)
+			_, err := s.ChannelMessageSendComplex(msgEvent.MsgChanID, reply)
+			if err != nil {
+				return err
+			}
 			return nil
 		}
 	}
 
+	//populate message struct exposed to client
 	plMsg := Message{
-		Author:    msg.Author.Username,
+		Author:    msgEvent.AuthorUsername,
-		ID:        msg.Author.ID,
+		ID:        msgEvent.AuthorID,
-		msgID:     msg.ID,
+		msgID:     msgEvent.MsgID,
 		Words:     words,
-		Content:   msg.Content,
+		Content:   msgEvent.Msg,
-		Channel:   channel.Name,
+		Channel:   msgEvent.MsgChanName,
-		channelID: msg.ChannelID,
+		channelID: msgEvent.MsgChanID,
-		Server:    server.Name,
+		Server:    msgEvent.MsgGuildName,
-		serverID:  server.ID,
+		serverID:  msgEvent.MsgGuildID,
 		sesh:      b,
 	}
 
 	//check for file attachments
-	if len(msg.Attachments) > 0 {
+	if len(msgEvent.MsgAttachments) > 0 {
 		var att []MessageAttachment
-		for _, a := range msg.Attachments {
+		for _, a := range msgEvent.MsgAttachments {
 			att = append(att, MessageAttachment{
 				ID:           a.ID,
 				URL:          a.URL,
@@ -226,7 +243,7 @@ func (b *bolt) handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Gu
 	//run command payload
 	err = run.Payload(plMsg)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to execute payload function: %e", err)
 	}
 
 	//update run time
@@ -271,15 +288,15 @@ func (b *bolt) getRemainingTimeout(timeout time.Time) string {
 }
 
 // checks if the author of msg has the correct role to run the requested command
-func (b *bolt) roleCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error) {
+func (b *bolt) roleCheck(guild string, roles []string, s *dg.Session, run Command) (bool, error) {
 	var found bool
 	//loop thru author roles, there may be a better way to check for this UNION
 	//TODO: improve role search performance to support bigger lists
-	for _, r := range msg.Member.Roles {
+	for _, r := range roles {
 		//get role name from ID
-		n, err := s.State.Role(msg.GuildID, r)
+		n, err := s.State.Role(guild, r)
 		if err != nil {
-			return false, err
+			return false, fmt.Errorf("failed to get role from ID %s\n%e", guild, err)
 		}
 		//does this role exist in command roles
 		check := slices.Contains(run.Roles, n.Name)
@@ -289,13 +306,8 @@ func (b *bolt) roleCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (boo
 		}
 	}
 
-	//can't find role, don't run command, alert user of missing permissions
+	//can't find role, don't run command
 	if !found {
-		reply := b.createReply("you do not have permissions to run that command", msg.ID, msg.ChannelID, msg.GuildID)
-		_, err := s.ChannelMessageSendComplex(msg.ChannelID, reply)
-		if err != nil {
-			return false, err
-		}
 		return false, nil
 	}
 
@@ -303,13 +315,13 @@ func (b *bolt) roleCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (boo
 }
 
 // check if the command timeout has been met, responding with remaining time if timeout has not been met yet.
-func (b *bolt) timeoutCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error) {
+func (b *bolt) timeoutCheck(msgID, channelID, guildID string, s *dg.Session, run Command) (bool, error) {
 	wait := run.lastRun.Add(run.Timeout)
 	if !time.Now().After(wait) {
-		reply := b.createReply(fmt.Sprintf("that command cannot be run for another %s", b.getRemainingTimeout(wait)), msg.ID, msg.ChannelID, msg.GuildID)
+		reply := b.createReply(fmt.Sprintf("that command cannot be run for another %s", b.getRemainingTimeout(wait)), msgID, channelID, guildID)
-		_, err := s.ChannelMessageSendComplex(msg.ChannelID, reply)
+		_, err := s.ChannelMessageSendComplex(channelID, reply)
 		if err != nil {
-			return false, err
+			return false, fmt.Errorf("failed to send timeout response: %e", err)
 		}
 		return false, nil
 	}

message.go

@@ -1,21 +1,62 @@
 package bolt
 
-import "fmt"
+import (
+	"fmt"
 
-//built-in Discord reactions
+	dg "github.com/bwmarrin/discordgo"
+)
+
+// built-in Discord reactions
 type Reaction string
 
+// a few easy-to-use emojis, Discordgo/Discord API requires them to be saved like this.
 const (
-	ReactionThumbsUp      Reaction = ":+1:"
+	ReactionThumbsUp          Reaction = "👍"
-	ReactionThumbsDown    Reaction = ":-1:"
+	ReactionThumbsDown        Reaction = "👎"
-	ReactionPointUp       Reaction = ":point_up:"
+	ReactionHundred           Reaction = "💯"
-	ReactionPointDown     Reaction = ":point_down:"
+	ReactionHeart             Reaction = "❤️"
-	ReactionHotdog        Reaction = ":hotdog:"
+	ReactionPinkHeart         Reaction = "🩷"
-	ReactionGiraffe       Reaction = ":giraffe:"
+	ReactionOrangeHeart       Reaction = "🧡"
-	ReactionWatermelon    Reaction = ":watermelon:"
+	ReactionYellowHeart       Reaction = "💛"
-	ReactionNoPedestrians Reaction = ":no_pedestrian:"
+	ReactionGreenHeart        Reaction = "💚"
+	ReactionBlueHeart         Reaction = "💙"
+	ReactionBlackHeart        Reaction = "🖤"
+	ReactionPointUp           Reaction = "☝️"
+	ReactionPointDown         Reaction = "👇"
+	ReactionHotdog            Reaction = "🌭"
+	ReactionDog               Reaction = "🐶"
+	ReactionCat               Reaction = "🐱"
+	ReactionMonkey            Reaction = "🐒"
+	ReactionGiraffe           Reaction = "🦒"
+	ReactionDuck              Reaction = "🦆"
+	ReactionGoose             Reaction = "🪿"
+	ReactionWatermelon        Reaction = "🍉"
+	ReactionHoney             Reaction = "🍯"
+	ReactionSandwich          Reaction = "🥪"
+	ReactionPepper            Reaction = "🌶️"
+	ReactionNoPedestrians     Reaction = "🚷"
+	ReactionExclamation       Reaction = "❗"
+	ReactionDoubleExclamation Reaction = "‼️"
+	ReactionSkull             Reaction = "💀"
+	ReactionSpeakingHead      Reaction = "🗣️"
+	ReactionGreenCheck        Reaction = "✅"
+	ReactionDragon            Reaction = "🐉"
 )
 
+// struct containing message event fields to prevent passing MessageCreate events and holding up routines
+type MessageCreateEvent struct {
+	AuthorUsername string
+	AuthorID       string
+	AuthorRoles    []string
+	MsgID          string
+	Msg            string
+	MsgChanID      string
+	MsgChanName    string
+	MsgGuildID     string
+	MsgGuildName   string
+	MsgAttachments []*dg.MessageAttachment
+}
+
 // information about attachments to messages
 type MessageAttachment struct {
 	ID           string