Improve examples and tests

Author: ndthuan

examples/chat-client/main.go

@@ -45,7 +45,7 @@ func main() {
 		}
 	}()
 
-	time.Sleep(10 * time.Second)
+	time.Sleep(5 * time.Second)
 
 	c.WriteJSON(websocketserver.Message{
 		Type:    "logout",

examples/chat-server/main.go

@@ -6,7 +6,7 @@ import (
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"
 	"github.com/ndthuan/websocketserver"
-	"math/rand"
+	"log"
 	"time"
 )
 
@@ -31,6 +31,7 @@ func broadcast(msg string, excluded *websocket.Conn) {
 
 func loginHandler() websocketserver.MessageHandler {
 	return func(connection *websocket.Conn, listener *websocketserver.Server, message websocketserver.Message) error {
+		log.Println("Login handler triggered")
 		username := message.Payload
 
 		authenticatedConnections[connection] = username
@@ -43,9 +44,14 @@ func loginHandler() websocketserver.MessageHandler {
 
 func logoutHandler() websocketserver.MessageHandler {
 	return func(connection *websocket.Conn, listener *websocketserver.Server, message websocketserver.Message) error {
+		log.Println("Logout handler triggered")
 		username, loggedIn := authenticatedConnections[connection]
 
 		if loggedIn {
+			connection.WriteJSON(websocketserver.Message{
+				Type:    "system-message",
+				Payload: "Bye-bye, " + username,
+			})
 			delete(authenticatedConnections, connection)
 			broadcast(fmt.Sprintf("%s left the room", username), connection)
 			_ = connection.WriteMessage(websocket.CloseMessage, []byte{})
@@ -57,9 +63,10 @@ func logoutHandler() websocketserver.MessageHandler {
 
 func disconnectedCallback() websocketserver.ConnectionCallback {
 	return func(connection *websocket.Conn, listener *websocketserver.Server) error {
+		log.Println("Client disconnected")
 		loggedInUser, already := authenticatedConnections[connection]
 		if already {
-			broadcast(fmt.Sprintf("%s disconnected", loggedInUser), connection)
+			broadcast(fmt.Sprintf("%s was disconnected", loggedInUser), connection)
 			delete(authenticatedConnections, connection)
 		}
 		return nil
@@ -68,9 +75,10 @@ func disconnectedCallback() websocketserver.ConnectionCallback {
 
 func connectedCallback() websocketserver.ConnectionCallback {
 	return func(connection *websocket.Conn, listener *websocketserver.Server) error {
+		log.Println("Client connected")
 		return connection.WriteJSON(websocketserver.Message{
 			Type:    "system-message",
-			Payload: "Hi there, this is private message to you. Welcome!",
+			Payload: "You are connected",
 		})
 	}
 }
@@ -89,8 +97,9 @@ func humanMessageHandler() websocketserver.MessageHandler {
 
 func standaloneRunner() websocketserver.StandaloneRunner {
 	return func(server *websocketserver.Server) {
+		log.Println("Standalone runner was started")
 		for {
-			time.Sleep(time.Duration(rand.Intn(10)) * time.Second)
+			time.Sleep(time.Second)
 
 			server.Broadcast(func(conn *websocket.Conn) (*websocketserver.Message, bool) {
 				if username, loggedIn := authenticatedConnections[conn]; loggedIn {

go.sum

@@ -50,8 +50,11 @@ golang.org/x/text v0.3.3 h1:cokOdA+Jmi5PJGXLlLllQSgYigAEfHXJAERHVMaCc2k=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 h1:Hir2P/De0WpUhtrKGGjvSb2YxUgyZ7EFOSLIcSSpiwE=
 golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e h1:FDhOuMEY4JVRztM/gsbk+IKUQ8kj74bxZrgw87eMMVc=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

scripts/test.sh

@@ -1,39 +1,54 @@
 #!/usr/bin/env bash
 
-set -e
+set -ex
 
 if [ "$(gofmt -s -l . | wc -l)" -gt 0 ]; then
   echo "Bad code format"
   exit 1
 fi
 
+echo "=== mod download ==="
+
+go mod download
+
 echo "=== unit test ==="
 
 go test
 
 echo "=== functional test ==="
 
 go build -o /tmp/chatserver ./examples/chat-server/
+go build -o /tmp/chatclient ./examples/chat-client/
 
 /tmp/chatserver > /tmp/output 2>&1 &
 SERVER_PID=$!
-go run examples/chat-client/main.go >> /tmp/output 2>&1 &
-go run examples/chat-client/main.go >> /tmp/output 2>&1 &
+
+sleep 3
+
+/tmp/chatclient > /tmp/client-output 2>&1 &
+/tmp/chatclient >> /tmp/client-output 2>&1 &
+/tmp/chatclient >> /tmp/client-output 2>&1 &
 
 sleep 10
 
 kill $SERVER_PID
 
-grep -q "http server started on" /tmp/output || (echo "server not started"; exit 1)
+grep -q "http server started on" /tmp/output || (echo "server was not started"; exit 1)
 
-clientsConnected=$(grep -c 'Hi there, this is private message to you. Welcome!' /tmp/output)
-if [ "$clientsConnected" != "2" ]; then
-  echo "there must be 2 clients connected, found: $clientsConnected"
+clientsConnected=$(grep -c 'Client connected' /tmp/output)
+if [ "$clientsConnected" != "3" ]; then
+  echo "there must be 3 clients connected, found: $clientsConnected"
   exit 1
 fi
 
-grep -q "Everyone, please welcome" /tmp/output || (echo "broadcast messages not sent"; exit 1)
+standaloneStarted=$(grep -c "Standalone runner was started" /tmp/output)
+if [ "$standaloneStarted" != "1" ]; then
+  echo "standalone runner should be started only once, found: $standaloneStarted"
+  exit 1
+fi
 
-grep -q "how are you" /tmp/output || (echo "standalone runner's messages not sent"; exit 1)
+grep -q "Login handler triggered" /tmp/output || (echo "login handler was not triggered"; exit 1)
+grep -q "Logout handler triggered" /tmp/output || (echo "logout handler was not triggered"; exit 1)
+grep -q "Client disconnected" /tmp/output || (echo "disconnection callback was not triggered"; exit 1)
 
 echo "All good"

server.go

@@ -60,8 +60,8 @@ func (s *Server) Handlers() map[string]MessageHandler {
 	return s.handlers
 }
 
-//OnAll registers a catch-all handler that will be executed on all message types. If there is a specific handler
-//registered on a type, this will be executed after.
+//OnAll registers a catch-all handler that will be executed on all message types.
+//If there is a specific handler registered on a type, this will be executed after.
 func (s *Server) OnAll(handler MessageHandler) {
 	s.allHandler = handler
 }