feat(reactions): align GetReactions with Slack API response

I think the Slack API returns the channel field at the root level of the reactions.get
response for message types, not inside the message object.

Author: nlopes

examples/reactions/reactions.go

@@ -10,23 +10,21 @@ import (
 
 func main() {
 	debug := flag.Bool("debug", false, "Show JSON output")
+	channelID := flag.String("channel", "", "Channel ID (required)")
 	flag.Parse()
 
 	// Get token from environment variable
-	apiToken := os.Getenv("SLACK_BOT_TOKEN")
+	apiToken := os.Getenv("SLACK_USER_TOKEN")
 	if apiToken == "" {
-		fmt.Println("SLACK_BOT_TOKEN environment variable is required")
+		fmt.Println("SLACK_USER_TOKEN environment variable is required")
 		os.Exit(1)
 	}
 
 	api := slack.New(apiToken, slack.OptionDebug(*debug))
 
 	var (
-		postAsUserName  string
-		postAsUserID    string
-		postToUserName  string
-		postToUserID    string
-		postToChannelID string
+		postAsUserName string
+		postAsUserID   string
 	)
 
 	// Find the user to post as.
@@ -40,29 +38,19 @@ func main() {
 	postAsUserName = authTest.User
 	postAsUserID = authTest.UserID
 
-	// Posting to DM with self causes a conversation with slackbot.
-	postToUserName = authTest.User
-	postToUserID = authTest.UserID
-
-	// Find the channel.
-	channel, _, _, err := api.OpenConversation(&slack.OpenConversationParameters{ChannelID: postToUserID})
-	if err != nil {
-		fmt.Printf("Error opening IM: %s\n", err)
-		return
-	}
-	postToChannelID = channel.ID
-
-	fmt.Printf("Posting as %s (%s) in DM with %s (%s), channel %s\n", postAsUserName, postAsUserID, postToUserName, postToUserID, postToChannelID)
+	fmt.Printf("Posting as %s (%s) in channel %s\n", postAsUserName, postAsUserID, *channelID)
 
 	// Post a message.
-	channelID, timestamp, err := api.PostMessage(postToChannelID, slack.MsgOptionText("Is this any good?", false))
+	_, timestamp, err := api.PostMessage(*channelID, slack.MsgOptionText("Is this any good?", false))
 	if err != nil {
 		fmt.Printf("Error posting message: %s\n", err)
 		return
 	}
 
-	// Grab a reference to the message.
-	msgRef := slack.NewRefToMessage(channelID, timestamp)
+	// // Grab a reference to the message.
+	msgRef := slack.NewRefToMessage(*channelID, timestamp)
+
+	fmt.Printf("Adding reaction to message with reference %v\n", msgRef)
 
 	// React with :+1:
 	if err = api.AddReaction("+1", msgRef); err != nil {
@@ -85,13 +73,19 @@ func main() {
 	fmt.Printf("\n")
 	fmt.Printf("%d reactions to message...\n", len(msgReactionsResp.Reactions))
 	for _, r := range msgReactionsResp.Reactions {
-		fmt.Printf("  %d users say %s\n", r.Count, r.Name)
+		fmt.Printf("  %d users say %s in channel %s\n", r.Count, r.Name, msgReactionsResp.Item.Channel)
 	}
 
 	// List all of the users reactions.
-	listReactions, _, err := api.ListReactions(slack.NewListReactionsParameters())
+	listParams := slack.NewListReactionsParameters()
+	fmt.Printf("Listing reactions with params: User=%q, TeamID=%q, Count=%d, Page=%d, Full=%v\n",
+		listParams.User, listParams.TeamID, listParams.Count, listParams.Page, listParams.Full)
+	listReactions, _, err := api.ListReactions(listParams)
 	if err != nil {
-		fmt.Printf("Error listing reactions: %s\n", err)
+		fmt.Printf("Error listing reactions: %v\n", err)
+		if slackErr, ok := err.(slack.SlackErrorResponse); ok {
+			fmt.Printf("  ResponseMetadata.Messages: %v\n", slackErr.ResponseMetadata.Messages)
+		}
 		return
 	}
 	fmt.Printf("\n")

reactions.go

@@ -33,8 +33,9 @@ func NewGetReactionsParameters() GetReactionsParameters {
 }
 
 type getReactionsResponseFull struct {
-	Type string
-	M    struct {
+	Type    string
+	Channel string `json:"channel,omitempty"` // channel is at the root level for message types
+	M       struct {
 		*Message // message structure already contains reactions
 	} `json:"message"`
 	F struct {
@@ -54,7 +55,7 @@ func (res getReactionsResponseFull) extractReactedItem() ReactedItem {
 
 	switch item.Type {
 	case "message":
-		item.Channel = res.M.Channel
+		item.Channel = res.Channel
 		item.Message = res.M.Message
 		item.Reactions = res.M.Reactions
 	case "file":
@@ -234,7 +235,7 @@ func (api *Client) GetReactionsContext(ctx context.Context, item ItemRef, params
 	if item.Comment != "" {
 		values.Set("file_comment", item.Comment)
 	}
-	if params.Full != DEFAULT_REACTIONS_FULL {
+	if params.Full {
 		values.Set("full", strconv.FormatBool(params.Full))
 	}
 
@@ -274,7 +275,7 @@ func (api *Client) ListReactionsContext(ctx context.Context, params ListReaction
 	if params.Page != DEFAULT_REACTIONS_PAGE {
 		values.Add("page", strconv.Itoa(params.Page))
 	}
-	if params.Full != DEFAULT_REACTIONS_FULL {
+	if params.Full {
 		values.Add("full", strconv.FormatBool(params.Full))
 	}
 

reactions_test.go

@@ -154,8 +154,8 @@ func TestSlack_GetReactions(t *testing.T) {
 			},
 			`{"ok": true,
 		 "type": "message",
+		 "channel": "ChannelID",
 		 "message": {
-			"channel": "ChannelID",
 			"text": "lorem ipsum dolor sit amet",
 			"ts": "123",
 			"user": "U2147483828",
@@ -174,10 +174,11 @@ func TestSlack_GetReactions(t *testing.T) {
 		 }}`,
 			ReactedItem{
 				Item: Item{
-					Type: "message", Message: &Message{
+					Type:    "message",
+					Channel: "ChannelID",
+					Message: &Message{
 						Msg: Msg{
 							Text:      "lorem ipsum dolor sit amet",
-							Channel:   "ChannelID",
 							User:      "U2147483828",
 							Timestamp: "123",
 						},
@@ -321,8 +322,8 @@ func TestSlack_GetReactions(t *testing.T) {
 			if got.Message.Text != test.wantReactedItem.Message.Text {
 				t.Errorf("%d: Got message text %#v, want %#v", i, got.Message.Text, test.wantReactedItem.Message.Text)
 			}
-			if got.Message.Channel != test.wantReactedItem.Message.Channel {
-				t.Errorf("%d: Got message channel %#v, want %#v", i, got.Message.Channel, test.wantReactedItem.Message.Channel)
+			if got.Channel != test.wantReactedItem.Channel {
+				t.Errorf("%d: Got channel %#v, want %#v", i, got.Channel, test.wantReactedItem.Channel)
 			}
 			if got.Message.User != test.wantReactedItem.Message.User {
 				t.Errorf("%d: Got message user %#v, want %#v", i, got.Message.User, test.wantReactedItem.Message.User)

slack.go

@@ -53,9 +53,9 @@ type authTestResponseFull struct {
 	AuthTestResponse
 }
 
-// Client for the slack api.
 type ParamOption func(*url.Values)
 
+// Client for the slack api.
 type Client struct {
 	token              string
 	appLevelToken      string
@@ -145,14 +145,14 @@ func (api *Client) AuthTestContext(ctx context.Context) (response *AuthTestRespo
 }
 
 // Debugf print a formatted debug line.
-func (api *Client) Debugf(format string, v ...interface{}) {
+func (api *Client) Debugf(format string, v ...any) {
 	if api.debug {
 		api.log.Output(2, fmt.Sprintf(format, v...))
 	}
 }
 
 // Debugln print a debug line.
-func (api *Client) Debugln(v ...interface{}) {
+func (api *Client) Debugln(v ...any) {
 	if api.debug {
 		api.log.Output(2, fmt.Sprintln(v...))
 	}
@@ -164,11 +164,11 @@ func (api *Client) Debug() bool {
 }
 
 // post to a slack web method.
-func (api *Client) postMethod(ctx context.Context, path string, values url.Values, intf interface{}) error {
+func (api *Client) postMethod(ctx context.Context, path string, values url.Values, intf any) error {
 	return postForm(ctx, api.httpclient, api.endpoint+path, values, intf, api)
 }
 
 // get a slack web method.
-func (api *Client) getMethod(ctx context.Context, path string, token string, values url.Values, intf interface{}) error {
+func (api *Client) getMethod(ctx context.Context, path string, token string, values url.Values, intf any) error {
 	return getResource(ctx, api.httpclient, api.endpoint+path, token, values, intf, api)
 }