fix(websocket): add missing events (apps, activity, badge count)

Closes #1544.

Author: nlopes

examples/unmapped_events/unmapped_events.go

@@ -0,0 +1,74 @@
+// This example connects to Slack via RTM and listens for events.
+//
+// Before the fix for #1544, the events "apps_uninstalled", "activity", and
+// "badge_counts_updated" were not mapped and would appear as
+// UnmarshallingErrorEvent with an "Received unmapped event" message.
+//
+// Usage:
+//
+//	export SLACK_BOT_TOKEN=xoxb-...
+//	go run ./examples/unmapped_events/
+//
+// Then interact with your workspace (open channels, browse around) and watch
+// for unmapped event errors in the output. The "activity" and
+// "badge_counts_updated" events tend to appear during normal workspace usage.
+// The "apps_uninstalled" event appears when an app is removed.
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/slack-go/slack"
+)
+
+func main() {
+	token := os.Getenv("SLACK_BOT_TOKEN")
+	if token == "" {
+		fmt.Println("SLACK_BOT_TOKEN environment variable is required")
+		os.Exit(1)
+	}
+
+	api := slack.New(
+		token,
+		slack.OptionDebug(true),
+		slack.OptionLog(log.New(os.Stdout, "slack-bot: ", log.Lshortfile|log.LstdFlags)),
+	)
+
+	rtm := api.NewRTM()
+	go rtm.ManageConnection()
+
+	for msg := range rtm.IncomingEvents {
+		switch ev := msg.Data.(type) {
+		case *slack.ConnectedEvent:
+			fmt.Printf("Connected: %s (connection count: %d)\n", ev.Info.User.ID, ev.ConnectionCount)
+
+		case *slack.AppsUninstalledEvent:
+			fmt.Printf("Apps uninstalled: %+v\n", ev)
+
+		case *slack.ActivityEvent:
+			fmt.Printf("Activity: subtype=%s key=%s\n", ev.SubType, ev.Key)
+
+		case *slack.BadgeCountsUpdatedEvent:
+			fmt.Printf("Badge counts updated: %+v\n", ev)
+
+		case *slack.UnmarshallingErrorEvent:
+			// Before the fix, apps_uninstalled/activity/badge_counts_updated
+			// end up here as unmapped events.
+			fmt.Printf("UNMAPPED EVENT ERROR: %v\n", ev.ErrorObj)
+
+		case *slack.InvalidAuthEvent:
+			fmt.Println("Invalid credentials")
+			return
+
+		case *slack.DisconnectedEvent:
+			if ev.Intentional {
+				return
+			}
+
+		default:
+			fmt.Printf("Event: type=%s data=%T\n", msg.Type, ev)
+		}
+	}
+}

websocket_managed_conn.go

@@ -598,6 +598,10 @@ var EventMapping = map[string]interface{}{
 
 	"accounts_changed": AccountsChangedEvent{},
 
+	"apps_uninstalled":     AppsUninstalledEvent{},
+	"activity":             ActivityEvent{},
+	"badge_counts_updated": BadgeCountsUpdatedEvent{},
+
 	"reconnect_url": ReconnectUrlEvent{},
 
 	"member_joined_channel": MemberJoinedChannelEvent{},

websocket_misc.go

@@ -166,7 +166,8 @@ type MemberLeftChannelEvent struct {
 	Team        string `json:"team"`
 }
 
-// ChannelUpdatedEvent is fired when a channel's properties are updated (tabs, meeting notes, etc.).
+// ChannelUpdatedEvent is fired when a channel's properties are updated (tabs, meeting
+// notes, etc.).
 type ChannelUpdatedEvent struct {
 	Type     string         `json:"type"`
 	Updates  map[string]any `json:"updates"`
@@ -253,3 +254,26 @@ type SHRoomUpdateEvent struct {
 	EventTS string        `json:"event_ts"`
 	TS      string        `json:"ts"`
 }
+
+// AppsUninstalledEvent represents the apps_uninstalled event sent via RTM
+// when one or more apps are uninstalled from the workspace.
+type AppsUninstalledEvent struct {
+	Type string `json:"type"`
+}
+
+// ActivityEvent represents the activity event sent via RTM. This is an
+// internal Slack event that fires during normal workspace usage (e.g. new
+// messages, bundle updates).
+type ActivityEvent struct {
+	Type           string          `json:"type"`
+	SubType        string          `json:"subtype"`
+	Key            string          `json:"key"`
+	Entry          json.RawMessage `json:"entry"`
+	EventTimestamp string          `json:"event_ts"`
+}
+
+// BadgeCountsUpdatedEvent represents the badge_counts_updated event sent via
+// RTM when notification badge counts change.
+type BadgeCountsUpdatedEvent struct {
+	Type string `json:"type"`
+}