improve websocket connection according to gorrila example

.github/workflows/build.yml

@@ -0,0 +1,48 @@
+name: Build Go Binaries
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        goos: [linux, windows]
+        goarch: [amd64, arm, arm64]
+        exclude:
+          - goos: windows
+            goarch: arm
+          - goos: windows
+            goarch: arm64
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.24.0'
+
+      - name: Set up Git credentials for private modules
+        run: |
+          git config --global url."https://${{ secrets.GH_PAT }}@github.com/".insteadOf "https://github.com/"
+          echo "GOPRIVATE=github.com/tecamino/*" >> $GITHUB_ENV
+
+      - name: Build binary
+        run: |
+          mkdir -p build
+          if [ "${{ matrix.goos }}" == "windows" ]; then
+            GOOS=${{ matrix.goos }} GOARCH=${{ matrix.goarch }} go build -o build/tecamino-driver-artNet-${{ matrix.goos }}-${{ matrix.goarch }}.exe main.go
+          else
+            GOOS=${{ matrix.goos }} GOARCH=${{ matrix.goarch }} go build -o build/tecamino-driver-artNet-${{ matrix.goos }}-${{ matrix.goarch }} main.go
+          fi
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: binaries-${{ matrix.goos }}-${{ matrix.goarch }}
+          path: build/

.gitignore

@@ -1,2 +1,3 @@
 *.cfg
 *.log
+artNetDriver-arm64

client/client.go

@@ -1,71 +0,0 @@
-package client
-
-import (
-	"context"
-	"fmt"
-
-	"github.com/coder/websocket"
-	"github.com/coder/websocket/wsjson"
-	json_data "github.com/tecamino/tecamino-json_data"
-	json_dataModels "github.com/tecamino/tecamino-json_data/models"
-	"github.com/tecamino/tecamino-logger/logging"
-)
-
-type Client struct {
-	conn   *websocket.Conn
-	ctx    context.Context
-	cancel context.CancelFunc
-	log    *logging.Logger
-}
-
-// Initialize new websocket server
-func NewClient(log *logging.Logger) *Client {
-	c := Client{
-		log: log,
-	}
-	c.ctx, c.cancel = context.WithCancel(context.Background())
-	return &c
-}
-
-// Connect to websocket server
-// ip: ip address of server
-func (c *Client) Connect(ip, id string, port uint) (err error) {
-	c.conn, _, err = websocket.Dial(c.ctx, fmt.Sprintf("ws://%s:%d/ws?id=%s", ip, port, id), nil)
-	return
-}
-
-// Close connection to websocket server
-func (c *Client) Disconnect() {
-	c.cancel()
-}
-
-// Subscribe to websocket server
-func (c *Client) Subscribe(id string) error {
-
-	req := json_data.NewRequest()
-	req.AddDriverSubscription(".*", id, 0, true, false, false)
-	if err := wsjson.Write(c.ctx, c.conn, req); err != nil {
-		return err
-	}
-	return nil
-}
-
-func (c *Client) ReadJsonData() (response json_dataModels.Response, err error) {
-
-	err = wsjson.Read(c.ctx, c.conn, &response)
-	if err != nil {
-		code := websocket.CloseStatus(err)
-
-		switch code {
-		case websocket.StatusNormalClosure,
-			websocket.StatusGoingAway,
-			websocket.StatusNoStatusRcvd:
-			c.log.Info("webSocket.readJsonData", fmt.Sprintf("WebSocket closed: %v (code: %v)\n", err, code))
-			return
-		default:
-			c.log.Error("webSocket.readJsonData", fmt.Sprintf("WebSocket read error: %v (code: %v)\n", err, code))
-			return
-		}
-	}
-	return
-}

driver/artNet.go

@@ -2,11 +2,12 @@ package driver
 
 import (
 	"artNet/cfg"
-	"artNet/client"
 	"artNet/models"
+	ws "artNet/websocket"
 	"fmt"
 	"path"
 
+	json_data "github.com/tecamino/tecamino-json_data"
 	"github.com/tecamino/tecamino-logger/logging"
 )
 
@@ -14,7 +15,6 @@ type ArtNetDriver struct {
 	Name          string                 `yaml:"driver" json:"driver"`
 	Buses         map[string]*models.Bus `yaml:"buses,omitempty" json:"buses,omitempty"`
 	cfgHandler    *cfg.Cfg               `yaml:"-" json:"-"`
-	Conn          *client.Client         `yaml:"-" json:"-"`
 	Subscriptions models.Subscriptions   `yaml:"-" json:"-"`
 	Log           *logging.Logger        `yaml:"-" json:"-"`
 }
@@ -89,30 +89,33 @@ func (d *ArtNetDriver) SetValue(bus string, address uint, value uint8) error {
 // id: id of driver
 // port: port of server
 func (d *ArtNetDriver) Connect(ip, id string, port uint) error {
-	d.Conn = client.NewClient(d.Log)
-	if err := d.Conn.Connect(ip, id, port); err != nil {
-		return err
-	}
-	defer d.Conn.Disconnect()
-
-	if err := d.Conn.Subscribe(id); err != nil {
-		return err
-	}
-
-	for {
-		respond, err := d.Conn.ReadJsonData()
+	errChan := make(chan error)
+	client, err := ws.NewClient(ip, id, port)
 	if err != nil {
 		return err
 	}
 
-		d.Subscribe(respond.Subscribe...)
+	client.OnError = func(err error) {
+		d.Log.Error("websocket connection", err)
+		errChan <- err
+	}
 
-		for _, pub := range respond.Publish {
-			if sub, ok := d.Subscriptions[pub.Uuid]; ok {
-				if err := d.SetValue(sub.Bus, sub.Address, uint8(pub.Value.(float64))); err != nil {
-					d.Log.Info("artNet.Connect", err.Error())
+	client.OnMessage = func(data []byte) {
+		fmt.Println(100, string(data))
 	}
+
+	req := json_data.NewRequest()
+	req.AddDriverSubscription(".*", id, 0, true, false, false)
+
+	if err := client.SendRequest(req); err != nil {
+		errChan <- err
+		d.Log.Error("websocket send data", err)
 	}
+
+	for {
+		select {
+		case err := <-errChan:
+			return err
 		}
 	}
 }

driver/bus.go

@@ -105,7 +105,7 @@ func (d *ArtNetDriver) Start(c *gin.Context) {
 	}
 
 	busPayload := models.Bus{}
-	if busPayload.ParsePayload(c); err != nil {
+	if err := busPayload.ParsePayload(c); err != nil {
 		return
 	}
 

go.mod

@@ -5,11 +5,11 @@ go 1.23.0
 toolchain go1.23.8
 
 require (
-	github.com/coder/websocket v1.8.13
 	github.com/gin-gonic/gin v1.10.0
 	github.com/google/uuid v1.6.0
+	github.com/gorilla/websocket v1.5.3
 	github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e
-	github.com/tecamino/tecamino-json_data v0.0.13
+	github.com/tecamino/tecamino-json_data v0.0.16
 	github.com/tecamino/tecamino-logger v0.2.0
 	gopkg.in/yaml.v3 v3.0.1
 )

go.sum

@@ -6,8 +6,6 @@ github.com/cloudwego/base64x v0.1.4 h1:jwCgWpFanWmN8xoIUHa2rtzmkd5J2plF/dnLS6Xd/
 github.com/cloudwego/base64x v0.1.4/go.mod h1:0zlkT4Wn5C6NdauXdJRhSKRlJvmclQ1hhJgA0rcu/8w=
 github.com/cloudwego/iasm v0.2.0 h1:1KNIy1I1H9hNNFEEH3DVnI4UujN+1zjpuk6gwHLTssg=
 github.com/cloudwego/iasm v0.2.0/go.mod h1:8rXZaNYT2n95jn+zTI1sDr+IgcD2GVs0nlbbQPiEFhY=
-github.com/coder/websocket v1.8.13 h1:f3QZdXy7uGVz+4uCJy2nTZyM0yTBj8yANEHhqlXZ9FE=
-github.com/coder/websocket v1.8.13/go.mod h1:LNVeNrXQZfe5qhS9ALED3uA+l5pPqvwXg3CKoDBB2gs=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -32,6 +30,8 @@ github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
+github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
 github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
 github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
@@ -65,8 +65,8 @@ github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsT
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e h1:nt2877sKfojlHCTOBXbpWjBkuWKritFaGIfgQwbQUls=
 github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e/go.mod h1:B4+Kq1u5FlULTjFSM707Q6e/cOHFv0z/6QRoxubDIQ8=
-github.com/tecamino/tecamino-json_data v0.0.13 h1:hugbmCgXXh0F7YQAEbbJYHkSdq1caejD7SajDiMs42I=
-github.com/tecamino/tecamino-json_data v0.0.13/go.mod h1:LLlyD7Wwqplb2BP4PeO86EokEcTRidlW5MwgPd1T2JY=
+github.com/tecamino/tecamino-json_data v0.0.16 h1:aZFxnhm4g6WMDPoqy4HosUk7vl0DB0iIcVs8bbT4MzU=
+github.com/tecamino/tecamino-json_data v0.0.16/go.mod h1:LLlyD7Wwqplb2BP4PeO86EokEcTRidlW5MwgPd1T2JY=
 github.com/tecamino/tecamino-logger v0.2.0 h1:NPH/Gg9qRhmVoW8b39i1eXu/LEftHc74nyISpcRG+XU=
 github.com/tecamino/tecamino-logger v0.2.0/go.mod h1:0M1E9Uei/qw3e3WA1x3lBo1eP3H5oeYE7GjYrMahnj8=
 github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI=

main.go

@@ -56,7 +56,7 @@ func main() {
 
 	go func() {
 		if err := s.ServeHttp(*wsPort); err != nil {
-			artNetDriver.Log.Error("main", err.Error())
+			artNetDriver.Log.Error("main", err)
 		}
 	}()
 
@@ -72,7 +72,10 @@ func main() {
 
 	// connect to server
 	for {
-		artNetDriver.Log.Error("main", artNetDriver.Connect(*serverIp, DriverName, *serverPort))
+		if err := artNetDriver.Connect(*serverIp, DriverName, *serverPort); err != nil {
+			artNetDriver.Log.Error("main", err)
+		}
+		artNetDriver.Log.Info("main", "next reconnecting attempt in 10 seconds")
 		time.Sleep(10 * time.Second)
 	}
 

server/models/clients.go

@@ -1,44 +0,0 @@
-package models
-
-// type Clients map[string]Client
-
-// type Client struct {
-// 	Connected *bool           `json:"connected"`
-// 	SndConn   *websocket.Conn `json:"-"` //sending connection
-// 	RvcConn   *websocket.Conn `json:"-"` // revieving connection
-// }
-
-// func NewClients() Clients {
-// 	return make(Clients)
-// }
-
-// // Connect a recieving websocket connection
-// func (c *Clients) ConnectRecievingWsConnection(id string, ctx *gin.Context) (*websocket.Conn, error) {
-// 	conn, err := websocket.Accept(ctx.Writer, ctx.Request, &websocket.AcceptOptions{
-// 		OriginPatterns: []string{"*"},
-// 	})
-
-// 	if err != nil {
-// 		return nil, fmt.Errorf("error accept websocket client: %s", err)
-// 	}
-
-// 	b := true
-// 	(*c)[id] = Client{
-// 		Connected: &b,
-// 		RvcConn:   conn,
-// 	}
-// 	return conn, nil
-// }
-
-// func (c *Clients) RemoveClient(id string) {
-// 	delete(*c, id)
-// }
-
-// func (c *Clients) GetClientPointer(id string) *bool {
-// 	return (*c)[id].Connected
-// }
-
-// func (c *Clients) DisconnectRecievingWsConnection(id string, code websocket.StatusCode, reason string) {
-// 	*(*c)[id].Connected = false
-// 	(*c)[id].RvcConn.Close(code, reason)
-// }

websocket/client.go

@@ -0,0 +1,223 @@
+package websocket
+
+import (
+	"encoding/json"
+	"fmt"
+	"log"
+	"time"
+
+	"github.com/gorilla/websocket"
+	json_dataModels "github.com/tecamino/tecamino-json_data/models"
+)
+
+const (
+	// Time allowed to write a message to the peer.
+	writeWait = 10 * time.Second
+
+	// Time allowed to read the next pong message from the peer.
+	pongWait = 10 * time.Second
+
+	// Send pings to peer with this period. Must be less than pongWait.
+	pingPeriod = (pongWait * 9) / 10
+)
+
+type Client struct {
+	ip         string
+	port       uint
+	Connected  bool
+	conn       *websocket.Conn
+	OnOpen     func()
+	OnMessage  func(data []byte)
+	OnClose    func(code int, reason string)
+	OnError    func(err error)
+	OnPing     func()
+	OnPong     func()
+	sendPong   chan string
+	send       chan []byte
+	unregister chan []byte
+}
+
+// Connect to websocket server
+// ip: ip address of server
+func NewClient(ip, id string, port uint) (*Client, error) {
+	url := fmt.Sprintf("ws://%s:%d/ws?id=%s", ip, port, id)
+	c := &Client{
+		ip:         ip,
+		port:       port,
+		Connected:  true,
+		sendPong:   make(chan string),
+		send:       make(chan []byte),
+		unregister: make(chan []byte),
+	}
+
+	dialer := websocket.DefaultDialer
+	conn, resp, err := dialer.Dial(url, nil)
+	if err != nil {
+		if c.OnError != nil {
+			c.OnError(err)
+		}
+		return nil, fmt.Errorf("dial error %v (status %v)", err, resp)
+	}
+	c.conn = conn
+
+	// Setup control handlers
+	conn.SetPingHandler(func(appData string) error {
+		if c.OnPing != nil {
+			c.OnPing()
+		}
+		conn.SetWriteDeadline(time.Now().Add(writeWait))
+		conn.SetReadDeadline(time.Now().Add(writeWait))
+		c.sendPong <- appData
+		return nil
+	})
+
+	conn.SetPongHandler(func(string) error {
+		conn.SetReadDeadline(time.Now().Add(pongWait))
+		if c.OnPong != nil {
+			c.OnPong()
+		}
+		return nil
+	})
+
+	conn.SetCloseHandler(func(code int, text string) error {
+		if c.OnClose != nil {
+			c.OnClose(code, text)
+		}
+		return nil
+	})
+
+	if c.OnOpen != nil {
+		c.OnOpen()
+	}
+
+	// Start reading messages from client
+	go c.Read()
+	go c.Write()
+	return c, nil
+}
+
+func (c *Client) Read() {
+	if c.OnOpen != nil {
+		c.OnOpen()
+	}
+
+	c.conn.SetReadDeadline(time.Now().Add(writeWait))
+	for c.Connected {
+		msgType, msg, err := c.conn.ReadMessage()
+		if err != nil {
+			c.handleError(fmt.Errorf("read error (id:%s:%d): %w", c.ip, c.port, err))
+			return
+		}
+		switch msgType {
+		case websocket.CloseMessage:
+			c.Close(websocket.CloseNormalClosure, "Client closed")
+			return
+		case websocket.TextMessage:
+			if c.OnMessage != nil {
+				c.OnMessage(msg)
+			} else {
+				log.Printf("Received message but no handler set (id:%s:%d): %s", c.ip, c.port, string(msg))
+			}
+		default:
+			log.Printf("Unhandled message type %d (id:%s:%d)", msgType, c.ip, c.port)
+		}
+	}
+}
+
+func (c *Client) Write() {
+	ticker := time.NewTicker(pingPeriod)
+	defer func() {
+		ticker.Stop()
+		c.conn.Close()
+	}()
+	for {
+
+		select {
+		case message, ok := <-c.send:
+			c.conn.SetWriteDeadline(time.Now().Add(writeWait))
+			if !ok {
+				// The hub closed the channel.
+				if err := c.conn.WriteMessage(websocket.CloseMessage, []byte{}); err != nil {
+					c.handleError(err)
+					return
+				}
+				c.handleError(fmt.Errorf("server %s:%d closed channel", c.ip, c.port))
+				return
+			} else {
+				if err := c.conn.WriteMessage(websocket.TextMessage, message); err != nil {
+					c.handleError(err)
+					return
+				}
+			}
+		case <-ticker.C:
+			c.conn.SetWriteDeadline(time.Now().Add(writeWait))
+			if err := c.conn.WriteMessage(websocket.PingMessage, nil); err != nil {
+				c.handleError(err)
+				return
+			}
+
+			if c.OnPing != nil {
+				c.OnPing()
+			}
+
+		case message, ok := <-c.sendPong:
+			if ok {
+				c.conn.WriteMessage(websocket.PongMessage, []byte(message))
+			}
+		case message := <-c.unregister:
+			c.conn.WriteMessage(websocket.CloseMessage, message)
+			c.Connected = false
+			close(c.send)
+			close(c.sendPong)
+			close(c.unregister)
+			return
+		}
+
+	}
+}
+
+func (c *Client) SendRequest(req *json_dataModels.Request) error {
+	if !c.Connected {
+		return nil
+	}
+
+	data, err := json.Marshal(*req)
+	if err != nil {
+		return err
+	}
+	c.send <- data
+	return nil
+}
+
+func (c *Client) ReadJsonData(data []byte) (json_dataModels.Response, error) {
+	var resp json_dataModels.Response
+	err := json.Unmarshal(data, &resp)
+	return resp, err
+}
+
+// Close connection to websocket server
+func (c *Client) Close(code int, reason string) error {
+	closeMsg := websocket.FormatCloseMessage(code, reason)
+	select {
+	case c.unregister <- closeMsg: // Attempt to send
+	default: // If the channel is full, this runs
+		return fmt.Errorf("attempt close client socket failed")
+	}
+	if c.OnClose != nil {
+		c.OnClose(code, reason)
+	}
+	return nil
+}
+
+func (c *Client) handleError(err error) {
+	if c.OnError != nil {
+		c.OnError(err)
+	}
+	if err := c.Close(websocket.CloseInternalServerErr, err.Error()); err != nil {
+		if c.OnError != nil {
+			c.OnError(err)
+		} else {
+			fmt.Println("error: ", err)
+		}
+	}
+}