Fixes SocketMode support in slacktest

examples/socketmode_handler/socketmode_handler.go

@@ -199,7 +199,3 @@ func middlewareSlashCommand(evt *socketmode.Event, client *socketmode.Client) {
 		}}
 	client.Ack(*evt.Request, payload)
 }
-
-func middlewareDefault(evt *socketmode.Event, client *socketmode.Client) {
-	// fmt.Fprintf(os.Stderr, "Unexpected event type received: %s\n", evt.Type)
-}

go.mod

@@ -9,4 +9,5 @@ require (
 	github.com/gorilla/websocket v1.4.2
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/stretchr/testify v1.2.2
+	go.mills.io/logger v0.0.0-20230806012737-485dbd691907
 )

go.sum

@@ -10,5 +10,7 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+go.mills.io/logger v0.0.0-20230806012737-485dbd691907 h1:KXwGupN4n3h/t9HyTLykODg1ope7KtXaknALkBMaaz4=
+go.mills.io/logger v0.0.0-20230806012737-485dbd691907/go.mod h1:A+23JY9iOHzujHnRYbFKVzLLAQVObxHnsap8kjAjuQ8=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

slacktest/funcs.go

@@ -89,6 +89,15 @@ func BotNameFromContext(ctx context.Context) string {
 	return botname
 }
 
+// ServerWSFromContext returns the server websocket endpoint from a provided context
+func ServerWSFromContext(ctx context.Context) string {
+	url, ok := ctx.Value(ServerWSContextKey).(string)
+	if !ok {
+		return "ws://wtf?!"
+	}
+	return url
+}
+
 // BotIDFromContext returns the bot userid from a provided context
 func BotIDFromContext(ctx context.Context) string {
 	botname, ok := ctx.Value(ServerBotIDContextKey).(string)
@@ -117,6 +126,16 @@ func nowAsJSONTime() slack.JSONTime {
 	return slack.JSONTime(time.Now().Unix())
 }
 
+func defaultAppsConnectionsJSON(ctx context.Context) string {
+	url := ServerWSFromContext(ctx)
+	return fmt.Sprintf(`
+		{
+			"ok":true,
+			"url": "%s"
+		}
+		`, url)
+}
+
 func defaultBotInfoJSON(ctx context.Context) string {
 	botid := BotIDFromContext(ctx)
 	botname := BotNameFromContext(ctx)

slacktest/handlers.go

@@ -15,6 +15,11 @@ import (
 	slack "github.com/slack-go/slack"
 )
 
+var (
+	defaultPingPeriod    = time.Second * 15
+	defaultWriteDeadline = time.Second * 3
+)
+
 func contextHandler(server *Server, next http.HandlerFunc) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		ctx := context.WithValue(r.Context(), ServerURLContextKey, server.GetAPIURL())
@@ -277,10 +282,20 @@ func rtmStartHandler(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+// handle apps.connections.open
+func appsConnectionsOpenHandler(w http.ResponseWriter, r *http.Request) {
+	_, _ = w.Write([]byte(defaultAppsConnectionsJSON(r.Context())))
+}
+
 func (sts *Server) wsHandler(w http.ResponseWriter, r *http.Request) {
 	Websocket(func(c *websocket.Conn) {
 		serverAddr := r.Context().Value(ServerBotHubNameContextKey).(string)
+		doneCh := make(chan struct{}, 1)
+		defer func() {
+			doneCh <- struct{}{}
+		}()
 		go handlePendingMessages(c, serverAddr)
+		go handlePeriodicPings(c, doneCh)
 		for {
 			var (
 				err   error
@@ -309,6 +324,21 @@ func (sts *Server) wsHandler(w http.ResponseWriter, r *http.Request) {
 	})(w, r)
 }
 
+func handlePeriodicPings(c *websocket.Conn, done chan struct{}) {
+	ticker := time.NewTicker(defaultPingPeriod)
+	defer ticker.Stop()
+	for {
+		select {
+		case <-ticker.C:
+			if err := c.WriteControl(websocket.PingMessage, []byte{}, time.Now().Add(defaultWriteDeadline)); err != nil {
+				log.Println("error sending ping:", err)
+			}
+		case <-done:
+			return
+		}
+	}
+}
+
 // Websocket handler
 func Websocket(delegate func(c *websocket.Conn)) func(w http.ResponseWriter, r *http.Request) {
 	return func(w http.ResponseWriter, r *http.Request) {

slacktest/server.go

@@ -6,9 +6,11 @@ import (
 	"log"
 	"net/http"
 	"net/http/httptest"
+	"regexp"
 	"time"
 
 	"github.com/slack-go/slack"
+	"go.mills.io/logger"
 )
 
 func newMessageChannels() *messageChannels {
@@ -61,8 +63,10 @@ func NewTestServer(custom ...Binder) *Server {
 	s.Handle("/bots.info", botsInfoHandler)
 	s.Handle("/auth.test", authTestHandler)
 	s.Handle("/reactions.add", reactionAddHandler)
+	s.Handle("/apps.connections.open", appsConnectionsOpenHandler)
 
 	httpserver := httptest.NewUnstartedServer(s.mux)
+	httpserver.Config.Handler = logger.New().Handler(httpserver.Config.Handler)
 	addr := httpserver.Listener.Addr().String()
 
 	s.ServerAddr = addr
@@ -138,8 +142,26 @@ func (sts *Server) SawOutgoingMessage(msg string) bool {
 	return false
 }
 
-// SawMessage checks if an incoming message was seen
-func (sts *Server) SawMessage(msg string) bool {
+// SawOutgoingMessageMatching checks if a message was sent to connected websocket clients that matches the given pattern
+func (sts *Server) SawOutgoingMessageMatching(pattern string) bool {
+	sts.seenOutboundMessages.RLock()
+	defer sts.seenOutboundMessages.RUnlock()
+	for _, m := range sts.seenOutboundMessages.messages {
+		evt := &slack.MessageEvent{}
+		jErr := json.Unmarshal([]byte(m), evt)
+		if jErr != nil {
+			continue
+		}
+
+		if ok, err := regexp.MatchString(pattern, evt.Text); err == nil && ok {
+			return true
+		}
+	}
+	return false
+}
+
+// SawIncomingMessage checks if an incoming message was seen
+func (sts *Server) SawIncomingMessage(msg string) bool {
 	sts.seenInboundMessages.RLock()
 	defer sts.seenInboundMessages.RUnlock()
 	for _, m := range sts.seenInboundMessages.messages {
@@ -156,6 +178,24 @@ func (sts *Server) SawMessage(msg string) bool {
 	return false
 }
 
+// SawIncomingMessageMatching checks if an incoming message was seen that matches a given pattern
+func (sts *Server) SawIncomingMessageMatching(pattern string) bool {
+	sts.seenInboundMessages.RLock()
+	defer sts.seenInboundMessages.RUnlock()
+	for _, m := range sts.seenInboundMessages.messages {
+		evt := &slack.MessageEvent{}
+		jErr := json.Unmarshal([]byte(m), evt)
+		if jErr != nil {
+			// This event isn't a message event so we'll skip it
+			continue
+		}
+		if ok, err := regexp.MatchString(pattern, evt.Text); err == nil && ok {
+			return true
+		}
+	}
+	return false
+}
+
 // GetAPIURL returns the api url you can pass to slack.SLACK_API
 func (sts *Server) GetAPIURL() string {
 	return "http://" + sts.ServerAddr + "/"
@@ -302,7 +342,7 @@ func (sts *Server) SendBotGroupInvite() {
 
 // GetTestRTMInstance will give you an RTM instance in the context of the current fake server
 func (sts *Server) GetTestRTMInstance() *slack.RTM {
-	api := slack.New("ABCEFG", slack.OptionAPIURL(sts.GetAPIURL()))
-	rtm := api.NewRTM()
+	api := slack.New("ABCEFG", slack.OptionDebug(true), slack.OptionAPIURL(sts.GetAPIURL()))
+	rtm := api.NewRTM(slack.RTMOptionPingInterval(5 * time.Second))
 	return rtm
 }

slacktest/server_test.go

@@ -102,7 +102,7 @@ func TestGetSeenInboundMessages(t *testing.T) {
 		}
 	}
 	assert.True(t, hadMessage, "did not see my sent message")
-	assert.True(t, s.SawMessage("should see this inbound message"))
+	assert.True(t, s.SawIncomingMessage("should see this inbound message"))
 }
 
 func TestSendChannelInvite(t *testing.T) {
@@ -166,7 +166,7 @@ func TestSendGroupInvite(t *testing.T) {
 func TestServerSawMessage(t *testing.T) {
 	s := NewTestServer()
 	go s.Start()
-	assert.False(t, s.SawMessage("foo"), "should not have seen any message")
+	assert.False(t, s.SawIncomingMessage("foo"), "should not have seen any message")
 }
 
 func TestServerSawOutgoingMessage(t *testing.T) {

slacktest/types.go

@@ -1,7 +1,6 @@
 package slacktest
 
 import (
-	"log"
 	"net/http"
 	"net/http/httptest"
 	"sync"
@@ -64,7 +63,6 @@ type Server struct {
 	registered           map[string]struct{}
 	server               *httptest.Server
 	mux                  *http.ServeMux
-	Logger               *log.Logger
 	BotName              string
 	BotID                string
 	ServerAddr           string

socketmode/socket_mode_managed_conn.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"log"
 	"net/http"
 	"sync"
 	"time"
@@ -312,6 +313,7 @@ func (smc *Client) openAndDial(ctx context.Context, additionalPingHandler func(s
 		return nil, nil, err
 	}
 	if additionalPingHandler == nil {
+		log.Print("no ping handler, default to null handler")
 		additionalPingHandler = func(_ string) error { return nil }
 	}
 
@@ -380,6 +382,7 @@ func (smc *Client) runRequestHandler(ctx context.Context, websocket chan json.Ra
 			// listen for incoming messages that need to be parsed
 			evt, err := smc.parseEvent(message)
 			if err != nil {
+				log.Printf("error parsing event %q: %s", message, err)
 				smc.sendEvent(ctx, newEvent(EventTypeErrorBadMessage, &ErrorBadMessage{
 					Cause:   err,
 					Message: message,

socketmode/socketmode.go

@@ -91,6 +91,7 @@ func OptionPingInterval(d time.Duration) Option {
 // OptionDebug enable debugging for the client
 func OptionDebug(b bool) func(*Client) {
 	return func(c *Client) {
+		c.log.Printf("Using debug mode: %t", b)
 		c.debug = b
 	}
 }