Refactoring of websocket package

ocpp1.6/v16.go

@@ -158,8 +158,8 @@ type ChargePoint interface {
 //	})
 //
 // For more advanced options, or if a customer networking/occpj layer is required,
-// please refer to ocppj.Client and ws.WsClient.
-func NewChargePoint(id string, endpoint *ocppj.Client, client ws.WsClient) ChargePoint {
+// please refer to ocppj.Client and ws.Client.
+func NewChargePoint(id string, endpoint *ocppj.Client, client ws.Client) ChargePoint {
 	if client == nil {
 		client = ws.NewClient()
 	}
@@ -339,7 +339,7 @@ type CentralSystem interface {
 // If you need a TLS server, you may use the following:
 //
 //	cs := NewServer(nil, ws.NewTLSServer("certificatePath", "privateKeyPath"))
-func NewCentralSystem(endpoint *ocppj.Server, server ws.WsServer) CentralSystem {
+func NewCentralSystem(endpoint *ocppj.Server, server ws.Server) CentralSystem {
 	if server == nil {
 		server = ws.NewServer()
 	}

ocpp1.6_test/ocpp16_test.go

@@ -4,7 +4,6 @@ import (
 	"crypto/tls"
 	"fmt"
 	"net"
-	"net/http"
 	"reflect"
 	"testing"
 	"time"
@@ -50,14 +49,18 @@ func (websocket MockWebSocket) TLSConnectionState() *tls.ConnectionState {
 	return nil
 }
 
+func (websocket MockWebSocket) IsConnected() bool {
+	return true
+}
+
 func NewMockWebSocket(id string) MockWebSocket {
 	return MockWebSocket{id: id}
 }
 
 // ---------------------- MOCK WEBSOCKET SERVER ----------------------
 type MockWebsocketServer struct {
 	mock.Mock
-	ws.WsServer
+	ws.Server
 	MessageHandler            func(ws ws.Channel, data []byte) error
 	NewClientHandler          func(ws ws.Channel)
 	CheckClientHandler        ws.CheckClientHandler
@@ -77,11 +80,11 @@ func (websocketServer *MockWebsocketServer) Write(webSocketId string, data []byt
 	return args.Error(0)
 }
 
-func (websocketServer *MockWebsocketServer) SetMessageHandler(handler func(ws ws.Channel, data []byte) error) {
+func (websocketServer *MockWebsocketServer) SetMessageHandler(handler ws.MessageHandler) {
 	websocketServer.MessageHandler = handler
 }
 
-func (websocketServer *MockWebsocketServer) SetNewClientHandler(handler func(ws ws.Channel)) {
+func (websocketServer *MockWebsocketServer) SetNewClientHandler(handler ws.ConnectedHandler) {
 	websocketServer.NewClientHandler = handler
 }
 
@@ -96,14 +99,14 @@ func (websocketServer *MockWebsocketServer) NewClient(websocketId string, client
 	websocketServer.MethodCalled("NewClient", websocketId, client)
 }
 
-func (websocketServer *MockWebsocketServer) SetCheckClientHandler(handler func(id string, r *http.Request) bool) {
+func (websocketServer *MockWebsocketServer) SetCheckClientHandler(handler ws.CheckClientHandler) {
 	websocketServer.CheckClientHandler = handler
 }
 
 // ---------------------- MOCK WEBSOCKET CLIENT ----------------------
 type MockWebsocketClient struct {
 	mock.Mock
-	ws.WsClient
+	ws.Client
 	MessageHandler      func(data []byte) error
 	ReconnectedHandler  func()
 	DisconnectedHandler func(err error)
@@ -445,41 +448,6 @@ func (smartChargingListener *MockChargePointSmartChargingListener) OnGetComposit
 }
 
 // ---------------------- COMMON UTILITY METHODS ----------------------
-func NewWebsocketServer(t *testing.T, onMessage func(data []byte) ([]byte, error)) *ws.Server {
-	wsServer := ws.Server{}
-	wsServer.SetMessageHandler(func(ws ws.Channel, data []byte) error {
-		assert.NotNil(t, ws)
-		assert.NotNil(t, data)
-		if onMessage != nil {
-			response, err := onMessage(data)
-			assert.Nil(t, err)
-			if response != nil {
-				err = wsServer.Write(ws.ID(), data)
-				assert.Nil(t, err)
-			}
-		}
-		return nil
-	})
-	return &wsServer
-}
-
-func NewWebsocketClient(t *testing.T, onMessage func(data []byte) ([]byte, error)) *ws.Client {
-	wsClient := ws.Client{}
-	wsClient.SetMessageHandler(func(data []byte) error {
-		assert.NotNil(t, data)
-		if onMessage != nil {
-			response, err := onMessage(data)
-			assert.Nil(t, err)
-			if response != nil {
-				err = wsClient.Write(data)
-				assert.Nil(t, err)
-			}
-		}
-		return nil
-	})
-	return &wsClient
-}
-
 type expectedCentralSystemOptions struct {
 	clientId              string
 	rawWrittenMessage     []byte

ocpp2.0.1/v2.go

@@ -207,8 +207,8 @@ type ChargingStation interface {
 //	})
 //
 // For more advanced options, or if a custom networking/occpj layer is required,
-// please refer to ocppj.Client and ws.WsClient.
-func NewChargingStation(id string, endpoint *ocppj.Client, client ws.WsClient) ChargingStation {
+// please refer to ocppj.Client and ws.Client.
+func NewChargingStation(id string, endpoint *ocppj.Client, client ws.Client) ChargingStation {
 	if client == nil {
 		client = ws.NewClient()
 	}
@@ -415,7 +415,7 @@ type CSMS interface {
 // If you need a TLS server, you may use the following:
 //
 //	csms := NewCSMS(nil, ws.NewTLSServer("certificatePath", "privateKeyPath"))
-func NewCSMS(endpoint *ocppj.Server, server ws.WsServer) CSMS {
+func NewCSMS(endpoint *ocppj.Server, server ws.Server) CSMS {
 	if server == nil {
 		server = ws.NewServer()
 	}

ocpp2.0.1_test/ocpp2_test.go

@@ -4,7 +4,6 @@ import (
 	"crypto/tls"
 	"fmt"
 	"net"
-	"net/http"
 	"reflect"
 	"testing"
 	"time"
@@ -59,6 +58,10 @@ func (websocket MockWebSocket) TLSConnectionState() *tls.ConnectionState {
 	return nil
 }
 
+func (websocket MockWebSocket) IsConnected() bool {
+	return true
+}
+
 func NewMockWebSocket(id string) MockWebSocket {
 	return MockWebSocket{id: id}
 }
@@ -67,7 +70,7 @@ func NewMockWebSocket(id string) MockWebSocket {
 
 type MockWebsocketServer struct {
 	mock.Mock
-	ws.WsServer
+	ws.Server
 	MessageHandler            func(ws ws.Channel, data []byte) error
 	NewClientHandler          func(ws ws.Channel)
 	CheckClientHandler        ws.CheckClientHandler
@@ -87,11 +90,11 @@ func (websocketServer *MockWebsocketServer) Write(webSocketId string, data []byt
 	return args.Error(0)
 }
 
-func (websocketServer *MockWebsocketServer) SetMessageHandler(handler func(ws ws.Channel, data []byte) error) {
+func (websocketServer *MockWebsocketServer) SetMessageHandler(handler ws.MessageHandler) {
 	websocketServer.MessageHandler = handler
 }
 
-func (websocketServer *MockWebsocketServer) SetNewClientHandler(handler func(ws ws.Channel)) {
+func (websocketServer *MockWebsocketServer) SetNewClientHandler(handler ws.ConnectedHandler) {
 	websocketServer.NewClientHandler = handler
 }
 
@@ -106,15 +109,15 @@ func (websocketServer *MockWebsocketServer) NewClient(websocketId string, client
 	websocketServer.MethodCalled("NewClient", websocketId, client)
 }
 
-func (websocketServer *MockWebsocketServer) SetCheckClientHandler(handler func(id string, r *http.Request) bool) {
+func (websocketServer *MockWebsocketServer) SetCheckClientHandler(handler ws.CheckClientHandler) {
 	websocketServer.CheckClientHandler = handler
 }
 
 // ---------------------- MOCK WEBSOCKET CLIENT ----------------------
 
 type MockWebsocketClient struct {
 	mock.Mock
-	ws.WsClient
+	ws.Client
 	MessageHandler      func(data []byte) error
 	ReconnectedHandler  func()
 	DisconnectedHandler func(err error)
@@ -812,42 +815,6 @@ func (handler *MockCSMSTransactionsHandler) OnTransactionEvent(chargingStationID
 }
 
 // ---------------------- COMMON UTILITY METHODS ----------------------
-
-func NewWebsocketServer(t *testing.T, onMessage func(data []byte) ([]byte, error)) *ws.Server {
-	wsServer := ws.Server{}
-	wsServer.SetMessageHandler(func(ws ws.Channel, data []byte) error {
-		assert.NotNil(t, ws)
-		assert.NotNil(t, data)
-		if onMessage != nil {
-			response, err := onMessage(data)
-			assert.Nil(t, err)
-			if response != nil {
-				err = wsServer.Write(ws.ID(), data)
-				assert.Nil(t, err)
-			}
-		}
-		return nil
-	})
-	return &wsServer
-}
-
-func NewWebsocketClient(t *testing.T, onMessage func(data []byte) ([]byte, error)) *ws.Client {
-	wsClient := ws.Client{}
-	wsClient.SetMessageHandler(func(data []byte) error {
-		assert.NotNil(t, data)
-		if onMessage != nil {
-			response, err := onMessage(data)
-			assert.Nil(t, err)
-			if response != nil {
-				err = wsClient.Write(data)
-				assert.Nil(t, err)
-			}
-		}
-		return nil
-	})
-	return &wsClient
-}
-
 type expectedCSMSOptions struct {
 	clientId              string
 	rawWrittenMessage     []byte

ocppj/central_system_test.go

@@ -400,7 +400,7 @@ func (suite *OcppJTestSuite) TestCentralSystemNewClientHandler() {
 	suite.mockServer.NewClientHandler(channel)
 	ok := <-connectedC
 	assert.True(t, ok)
-	// Client state was created
+	// client state was created
 	_, ok = suite.serverRequestMap.Get(mockClientID)
 	assert.True(t, ok)
 }

ocppj/client.go

@@ -13,7 +13,7 @@ import (
 // During message exchange, the two roles may be reversed (depending on the message direction), but a client struct remains associated to a charge point/charging station.
 type Client struct {
 	Endpoint
-	client                ws.WsClient
+	client                ws.Client
 	Id                    string
 	requestHandler        func(request ocpp.Request, requestId string, action string)
 	responseHandler       func(response ocpp.Response, requestId string)
@@ -35,7 +35,7 @@ type Client struct {
 //
 // The wsClient parameter cannot be nil. Refer to the ws package for information on how to create and
 // customize a websocket client.
-func NewClient(id string, wsClient ws.WsClient, dispatcher ClientDispatcher, stateHandler ClientState, profiles ...*ocpp.Profile) *Client {
+func NewClient(id string, wsClient ws.Client, dispatcher ClientDispatcher, stateHandler ClientState, profiles ...*ocpp.Profile) *Client {
 	endpoint := Endpoint{}
 	if wsClient == nil {
 		panic("wsClient parameter cannot be nil")

ocppj/dispatcher.go

@@ -54,7 +54,7 @@ type ClientDispatcher interface {
 	// Sets the network client, so the dispatcher may send requests using the networking layer directly.
 	//
 	// This needs to be set before calling the Start method. If not, sending requests will fail.
-	SetNetworkClient(client ws.WsClient)
+	SetNetworkClient(client ws.Client)
 	// Sets the state manager for pending requests in the dispatcher.
 	//
 	// The state should only be accessed by the dispatcher while running.
@@ -90,7 +90,7 @@ type DefaultClientDispatcher struct {
 	requestChannel      chan bool
 	readyForDispatch    chan bool
 	pendingRequestState ClientState
-	network             ws.WsClient
+	network             ws.Client
 	mutex               sync.RWMutex
 	onRequestCancel     func(requestID string, request ocpp.Request, err *ocpp.Error)
 	timer               *time.Timer
@@ -149,7 +149,7 @@ func (d *DefaultClientDispatcher) Stop() {
 	// TODO: clear pending requests?
 }
 
-func (d *DefaultClientDispatcher) SetNetworkClient(client ws.WsClient) {
+func (d *DefaultClientDispatcher) SetNetworkClient(client ws.Client) {
 	d.network = client
 }
 
@@ -335,7 +335,7 @@ type ServerDispatcher interface {
 	// Sets the network server, so the dispatcher may send requests using the networking layer directly.
 	//
 	// This needs to be set before calling the Start method. If not, sending requests will fail.
-	SetNetworkServer(server ws.WsServer)
+	SetNetworkServer(server ws.Server)
 	// Sets the state manager for pending requests in the dispatcher.
 	//
 	// The state should only be accessed by the dispatcher while running.
@@ -371,7 +371,7 @@ type DefaultServerDispatcher struct {
 	running             bool
 	stoppedC            chan struct{}
 	onRequestCancel     CanceledRequestHandler
-	network             ws.WsServer
+	network             ws.Server
 	mutex               sync.RWMutex
 }
 
@@ -442,7 +442,7 @@ func (d *DefaultServerDispatcher) DeleteClient(clientID string) {
 	}
 }
 
-func (d *DefaultServerDispatcher) SetNetworkServer(server ws.WsServer) {
+func (d *DefaultServerDispatcher) SetNetworkServer(server ws.Server) {
 	d.network = server
 }
 
@@ -491,7 +491,7 @@ func (d *DefaultServerDispatcher) messagePump() {
 	for {
 		select {
 		case <-d.stoppedC:
-			// Server was stopped
+			// server was stopped
 			d.queueMap.Init()
 			log.Info("stopped processing requests")
 			return
@@ -547,7 +547,7 @@ func (d *DefaultServerDispatcher) messagePump() {
 				clientCtx.cancel()
 				clientContextMap[clientID] = clientTimeoutContext{}
 			}
-			// Client can now transmit again
+			// client can now transmit again
 			clientQueue, ok = d.queueMap.Get(clientID)
 			if ok {
 				// Ready to transmit
@@ -620,7 +620,7 @@ func (d *DefaultServerDispatcher) waitForTimeout(clientID string, clientCtx clie
 			log.Debugf("timeout canceled for %s", clientID)
 		}
 	case <-d.stoppedC:
-		// Server was stopped, every pending timeout gets canceled
+		// server was stopped, every pending timeout gets canceled
 	}
 }