fix: changing to one concurrent writer & reader

go.mod

@@ -3,3 +3,5 @@ module git.neurocipta.com/rogerferdinan/safe-web-socket
 go 1.24.5
 
 require github.com/gorilla/websocket v1.5.3
+
+require git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0 // indirect

go.sum

@@ -1,2 +1,4 @@
+git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0 h1:KnNc40SrYsg0cksIIcQy/ca6bunkGADQOs1u7O/E+iY=
+git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0/go.mod h1:9DvvHc2UZhBwEs63NgO4IhiuHnBNtTuBkTJgiMnnCss=
 github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
 github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=

internal/hub.go

@@ -11,7 +11,7 @@ import (
 const (
 	writeWait  = 10 * time.Second
 	pongWait   = 60 * time.Second
-	pingPeriod = 55 * time.Second
+	pingPeriod = 25 * time.Second
 )
 
 type Client struct {
@@ -19,7 +19,6 @@ type Client struct {
 	Send           chan []byte
 	SubscribedPath string
 	done           chan struct{}
-	mu             *CustomRwMutex
 }
 
 func NewClient(conn *websocket.Conn, subscribedPath string) *Client {
@@ -28,7 +27,6 @@ func NewClient(conn *websocket.Conn, subscribedPath string) *Client {
 		Send:           make(chan []byte, 64),
 		SubscribedPath: subscribedPath,
 		done:           make(chan struct{}),
-		mu:             NewCustomRwMutex(),
 	}
 }
 
@@ -37,8 +35,6 @@ type Hub struct {
 	Broadcast  chan []byte
 	Register   chan *Client
 	Unregister chan *Client
-	writeMu    *CustomRwMutex
-	readMu     *CustomRwMutex
 }
 
 func NewHub() *Hub {
@@ -47,7 +43,6 @@ func NewHub() *Hub {
 		Register:   make(chan *Client),
 		Unregister: make(chan *Client),
 		Clients:    make(map[*Client]bool),
-		writeMu:    NewCustomRwMutex(),
 	}
 }
 
@@ -100,7 +95,7 @@ func WritePump(c *Client, h *Hub) {
 			}
 		case <-pingTicker.C:
 			c.Conn.SetWriteDeadline(time.Now().Add(writeWait))
-			if err := c.Conn.WriteMessage(websocket.PingMessage, nil); err != nil {
+			if err := c.Conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
 				return
 			}
 		}

internal/mutex.go

@@ -1,33 +0,0 @@
-package internal
-
-import (
-	"sync"
-)
-
-type CustomRwMutex struct {
-	mu *sync.RWMutex
-}
-
-func NewCustomRwMutex() *CustomRwMutex {
-	return &CustomRwMutex{
-		mu: &sync.RWMutex{},
-	}
-}
-
-func (rwMu *CustomRwMutex) WriteHandler(fn func() error) error {
-	rwMu.mu.Lock()
-	defer rwMu.mu.Unlock()
-	if err := fn(); err != nil {
-		return err
-	}
-	return nil
-}
-
-func (rwMu *CustomRwMutex) ReadHandler(fn func() error) error {
-	rwMu.mu.RLock()
-	defer rwMu.mu.RUnlock()
-	if err := fn(); err != nil {
-		return err
-	}
-	return nil
-}

v1/client/client.go

@@ -3,25 +3,91 @@ package client
 import (
 	"context"
 	"fmt"
+	"io"
 	"log"
 	"net/url"
 	"strings"
+	"sync"
 	"time"
 
+	custom_rwmutex "git.neurocipta.com/rogerferdinan/custom-rwmutex"
 	"git.neurocipta.com/rogerferdinan/safe-web-socket/internal"
 	"github.com/gorilla/websocket"
 )
 
 const (
-	pingPeriod = 10 * time.Second
+	pingPeriod   = 10 * time.Second
+	readDeadline = 10 * time.Second
 )
 
+type SafeMap[K comparable, V any] struct {
+	m sync.Map
+}
+
+func NewSafeMap[K comparable, V any]() *SafeMap[K, V] {
+	return &SafeMap[K, V]{
+		m: sync.Map{},
+	}
+}
+
+func (sm *SafeMap[K, V]) Store(key K, value V) {
+	sm.m.Store(key, value)
+}
+
+func (sm *SafeMap[K, V]) Load(key K) (value V, ok bool) {
+	val, loaded := sm.m.Load(key)
+	if !loaded {
+		return *new(V), false
+	}
+	return val.(V), true
+}
+
+func (sm *SafeMap[K, V]) Delete(key K) {
+	sm.m.Delete(key)
+}
+
+func (sm *SafeMap[K, V]) Range(f func(K, V) bool) {
+	sm.m.Range(func(key, value any) bool {
+		k, ok1 := key.(K)
+		v, ok2 := value.(V)
+		if !ok1 || !ok2 {
+			return true
+		}
+		return f(k, v)
+	})
+}
+
+func (sm *SafeMap[K, V]) Len() int {
+	count := 0
+	sm.Range(func(_ K, _ V) bool {
+		count++
+		return true
+	})
+	return count
+}
+
+type MessageType uint
+
+const (
+	MessageTypeText  MessageType = iota + 1
+	MessageTypePing  MessageType = iota
+	MessageTypePong  MessageType = iota
+	MessageTypeClose MessageType = iota
+)
+
+type Message struct {
+	MessageType MessageType
+	Data        []byte
+}
+
 type SafeWebsocketClientBuilder struct {
-	baseHost *string `nil_checker:"required"`
-	basePort *uint16 `nil_checker:"required"`
-	path     *string
-	rawQuery *string
-	useTLS   *bool
+	baseHost       *string `nil_checker:"required"`
+	basePort       *uint16 `nil_checker:"required"`
+	path           *string
+	rawQuery       *string
+	useTLS         *bool
+	channelSize    *int64
+	authenticateFn func(*SafeWebsocketClient) error
 }
 
 func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder {
@@ -43,6 +109,11 @@ func (b *SafeWebsocketClientBuilder) UseTLS(useTLS bool) *SafeWebsocketClientBui
 	return b
 }
 
+func (b *SafeWebsocketClientBuilder) AuthenticateFn(authenticateFn func(*SafeWebsocketClient) error) *SafeWebsocketClientBuilder {
+	b.authenticateFn = authenticateFn
+	return b
+}
+
 func (b *SafeWebsocketClientBuilder) Path(path string) *SafeWebsocketClientBuilder {
 	b.path = &path
 	return b
@@ -53,34 +124,47 @@ func (b *SafeWebsocketClientBuilder) RawQuery(rawQuery string) *SafeWebsocketCli
 	return b
 }
 
-func (b *SafeWebsocketClientBuilder) Build() (*SafeWebsocketClient, error) {
+func (b *SafeWebsocketClientBuilder) ChannelSize(channelSize int64) *SafeWebsocketClientBuilder {
+	b.channelSize = &channelSize
+	return b
+}
+
+func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketClient, error) {
 	if err := internal.NilChecker(b); err != nil {
 		return nil, err
 	}
 
-	ctx, cancel := context.WithCancel(context.Background())
-
 	var useTLS bool
 	if b.useTLS != nil {
 		useTLS = *b.useTLS
 	}
 
+	if b.channelSize == nil {
+		channelSize := int64(1)
+		b.channelSize = &channelSize
+	}
+
 	wsClient := SafeWebsocketClient{
 		baseHost:    *b.baseHost,
 		basePort:    *b.basePort,
 		useTLS:      useTLS,
 		path:        b.path,
 		rawQuery:    b.rawQuery,
+		dataChannel: make(chan []byte, *b.channelSize),
+		mu:          custom_rwmutex.NewCustomRwMutex(),
 		ctx:         ctx,
-		cancel:      cancel,
-		dataChannel: make(chan []byte, 1),
-		mu:          internal.NewCustomRwMutex(),
 		reconnectCh: make(chan struct{}, 1),
 		isConnected: false,
+		doneMap:     NewSafeMap[string, chan struct{}](),
 	}
 
+	if b.authenticateFn != nil {
+		wsClient.authenticateFn = b.authenticateFn
+	}
+
+	go wsClient.reconnectHandler()
+
 	if err := wsClient.connect(); err != nil {
-		cancel()
 		return nil, fmt.Errorf("failed to establish initial connection: %v", err)
 	}
 
@@ -88,18 +172,27 @@ func (b *SafeWebsocketClientBuilder) Build() (*SafeWebsocketClient, error) {
 }
 
 type SafeWebsocketClient struct {
-	baseHost    string
-	basePort    uint16
-	useTLS      bool
-	path        *string
-	rawQuery    *string
+	baseHost string
+	basePort uint16
+	useTLS   bool
+	path     *string
+	rawQuery *string
+
 	dataChannel chan []byte
-	mu          *internal.CustomRwMutex
+	mu          *custom_rwmutex.CustomRwMutex
 	conn        *websocket.Conn
-	ctx         context.Context
-	cancel      context.CancelFunc
-	reconnectCh chan struct{}
-	isConnected bool
+	cancelFuncs []context.CancelFunc
+
+	ctx    context.Context
+	Cancel context.CancelFunc
+
+	reconnectCh    chan struct{}
+	reconnectChans []chan struct{}
+	isConnected    bool
+	doneMap        *SafeMap[string, chan struct{}]
+	authenticateFn func(*SafeWebsocketClient) error
+
+	writeChan chan Message
 }
 
 func (wsClient *SafeWebsocketClient) connect() error {
@@ -140,67 +233,153 @@ func (wsClient *SafeWebsocketClient) connect() error {
 		return nil
 	})
 
-	wsClient.mu.WriteHandler(func() error {
-		wsClient.conn = conn
-		wsClient.isConnected = true
-		return nil
-	})
+	pingCtx, pingCancel := context.WithCancel(context.Background())
+	go wsClient.startPingTicker(pingCtx)
+	wsClient.cancelFuncs = append(wsClient.cancelFuncs, pingCancel)
 
-	go wsClient.startPingTicker()
-	go wsClient.startReceiveHandler()
-	go wsClient.reconnectHandler()
+	if wsClient.conn != nil {
+		wsClient.conn.Close()
+	}
+	wsClient.conn = conn
+	wsClient.isConnected = true
+
+	if wsClient.authenticateFn != nil {
+		if err := wsClient.authenticateFn(wsClient); err != nil {
+			return err
+		}
+	}
+
+	go func() {
+		ctx, cancel := context.WithCancel(context.Background())
+		wsClient.cancelFuncs = append(wsClient.cancelFuncs, cancel)
+		for {
+			select {
+			case <-ctx.Done():
+				fmt.Println("Writer stopped due to client shutdown")
+				return
+			case data := <-wsClient.writeChan:
+				if conn == nil {
+					wsClient.triggerReconnect()
+					return
+				}
+				messageType := websocket.TextMessage
+				switch data.MessageType {
+				case MessageTypePing:
+					messageType = websocket.PingMessage
+				case MessageTypePong:
+					messageType = websocket.PongMessage
+				case MessageTypeClose:
+					messageType = websocket.CloseMessage
+				}
+				writer, err := conn.NextWriter(messageType)
+				if err != nil {
+					return
+				}
+
+				if _, err := writer.Write(data.Data); err != nil {
+					return
+				}
+			}
+		}
+	}()
+
+	go func() {
+		ctx, cancel := context.WithCancel(context.Background())
+		wsClient.cancelFuncs = append(wsClient.cancelFuncs, cancel)
+		for {
+			select {
+			case <-ctx.Done():
+				fmt.Println("Reader stopped due to client shutdown")
+				return
+			default:
+				if conn == nil {
+					return
+				}
+				if err := conn.SetReadDeadline(time.Now().Add(readDeadline)); err != nil {
+					fmt.Printf("error on read deadline: %v\n", err)
+					return
+				}
+				_, reader, err := conn.NextReader()
+				if err != nil {
+					fmt.Printf("Next Reader Closed: %v\n", err)
+					wsClient.triggerReconnect()
+					return
+				}
+
+				readerBytes, err := io.ReadAll(reader)
+				if err != nil {
+					fmt.Printf("io reader failed: %v\n", err)
+					wsClient.triggerReconnect()
+					return
+				}
+				select {
+				case wsClient.dataChannel <- readerBytes:
+				case <-ctx.Done():
+					return
+				default:
+					fmt.Println("Data channel full, dropping message")
+				}
+
+			}
+
+		}
+	}()
 
 	return nil
 }
 
-func (wsClient *SafeWebsocketClient) startPingTicker() {
+func (wsClient *SafeWebsocketClient) startPingTicker(ctx context.Context) {
 	ticker := time.NewTicker(pingPeriod)
 	defer ticker.Stop()
+
 	for {
 		select {
+		case <-ctx.Done():
+			log.Println("ping ticker stopped")
+			return
 		case <-ticker.C:
-			wsClient.mu.WriteHandler(func() error {
-				if err := wsClient.conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
-					log.Printf("Ping failed: %v. Will attempt reconnect.", err)
-					wsClient.triggerReconnect()
-				}
-				return nil
-			})
-		case <-wsClient.ctx.Done():
-			log.Println("Ping ticker stopped")
-			return
-		}
-	}
-}
-
-func (wsClient *SafeWebsocketClient) startReceiveHandler() {
-	for {
-		select {
-		case <-wsClient.reconnectCh:
-		case <-wsClient.ctx.Done():
-			log.Println("Reconnect handler stopped")
-			return
-		default:
-			if err := wsClient.mu.WriteHandler(func() error {
-				conn := wsClient.conn
-
-				if conn == nil {
-					return fmt.Errorf("no active connection, waiting for reconnect")
-				}
-				_, message, err := conn.ReadMessage()
-				if err != nil {
-					return err
-				}
-				wsClient.dataChannel <- message
-				return nil
-			}); err != nil {
-				wsClient.triggerReconnect()
-				return
+			wsClient.writeChan <- Message{
+				MessageType: websocket.PingMessage,
+				Data:        nil,
 			}
 		}
 	}
 }
 
+// func (wsClient *SafeWebsocketClient) startReceiveHandler(ctx context.Context) {
+// 	for {
+// 		select {
+// 		case <-ctx.Done():
+// 			log.Println("receive handler stopped")
+// 			return
+// 		default:
+// 			if err := wsClient.mu.ReadHandler(func() error {
+// 				conn := wsClient.conn
+
+// 				if conn == nil {
+// 					wsClient.triggerReconnect()
+// 					return fmt.Errorf("connection closed")
+// 				}
+// 				_, message, err := conn.ReadMessage()
+// 				if err != nil {
+// 					wsClient.triggerReconnect()
+// 					return fmt.Errorf("failed to read message: %v", err)
+// 				}
+// 				select {
+// 				case wsClient.dataChannel <- message:
+// 				case <-ctx.Done():
+// 					log.Println("Reconnect handler stopped")
+// 				default:
+// 					log.Println("")
+// 				}
+// 				return nil
+// 			}); err != nil {
+// 				return
+// 			}
+// 		}
+// 	}
+// }
+
 func (wsClient *SafeWebsocketClient) triggerReconnect() {
 	select {
 	case wsClient.reconnectCh <- struct{}{}:
@@ -209,11 +388,95 @@ func (wsClient *SafeWebsocketClient) triggerReconnect() {
 }
 
 func (wsClient *SafeWebsocketClient) reconnectHandler() {
-	for range wsClient.reconnectCh {
-		wsClient.connect()
+	backoff := 1 * time.Second
+	maxBackoff := 30 * time.Second
+	for {
+		select {
+		case <-wsClient.reconnectCh:
+			log.Println("Reconnect triggered")
+
+			if wsClient.cancelFuncs != nil {
+				for _, cancel := range wsClient.cancelFuncs {
+					cancel()
+				}
+			}
+			wsClient.isConnected = false
+			time.Sleep(100 * time.Millisecond)
+
+			isInnerLoop := true
+			for isInnerLoop {
+				log.Printf("Attempting reconnect in %v...", backoff)
+				select {
+				case <-time.After(backoff):
+					if err := wsClient.connect(); err != nil {
+						log.Printf("Reconnect failed: %v", err)
+						if backoff < maxBackoff {
+							backoff *= 2
+						}
+						continue
+					}
+					log.Println("Reconnected successfully")
+					backoff = 1 * time.Second
+					isInnerLoop = false
+					continue
+				case <-wsClient.ctx.Done():
+					log.Println("reconnect handler stopped due to client shutdown")
+					wsClient.Close()
+					return
+				}
+			}
+			if wsClient.reconnectChans != nil {
+				for _, reconnectCh := range wsClient.reconnectChans {
+					reconnectCh <- struct{}{}
+				}
+			}
+		case <-wsClient.ctx.Done():
+			log.Println("reconnect handler stopped due to client shutdown")
+			wsClient.Close()
+			return
+		}
 	}
 }
 
+func (wsClient *SafeWebsocketClient) ReconnectChannel() <-chan struct{} {
+	reconnectCh := make(chan struct{})
+	wsClient.mu.WriteHandler(func() error {
+		wsClient.reconnectChans = append(wsClient.reconnectChans, reconnectCh)
+		return nil
+	})
+
+	return reconnectCh
+}
+
 func (wsClient *SafeWebsocketClient) DataChannel() <-chan []byte {
 	return wsClient.dataChannel
 }
+
+func (wsClient *SafeWebsocketClient) Write(data []byte) error {
+	wsClient.writeChan <- Message{
+		MessageType: MessageTypeText,
+		Data:        data,
+	}
+	return nil
+}
+
+func (wsClient *SafeWebsocketClient) Close() error {
+	if wsClient.cancelFuncs != nil {
+		for _, cancel := range wsClient.cancelFuncs {
+			cancel()
+		}
+	}
+
+	if wsClient.reconnectChans != nil {
+		for _, reconnectChan := range wsClient.reconnectChans {
+			close(reconnectChan)
+		}
+	}
+	if wsClient.conn != nil {
+		wsClient.conn.Close()
+	}
+	wsClient.isConnected = false
+	close(wsClient.dataChannel)
+
+	return nil
+}

v1/examples/client/main.go

@@ -1,25 +1,49 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"log"
+	"os"
+	"os/signal"
+	"syscall"
 
 	"git.neurocipta.com/rogerferdinan/safe-web-socket/v1/client"
 )
 
 func main() {
+	sigChan := make(chan os.Signal, 1)
+	signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
+
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	go func() {
+		<-sigChan
+		fmt.Println("\nReceived interrupt signal. Shutting down gracefully...")
+		cancel()
+	}()
+
 	wsClient, err := client.NewSafeWebsocketClientBuilder().
 		BaseHost("localhost").
 		BasePort(8080).
 		Path("/ws/test/data_1").
 		UseTLS(false).
-		Build()
+		Build(ctx)
 	if err != nil {
 		log.Fatal(err)
 	}
+
+	go func() {
+		for range wsClient.ReconnectChannel() {
+			fmt.Println("Reconnection Success")
+		}
+	}()
+
 	dataChannel := wsClient.DataChannel()
 
 	for data := range dataChannel {
+		// _ = data
 		fmt.Println(string(data))
 	}
 }