fix: fixing memory leak from unbuffered channel

go.mod

@@ -4,4 +4,4 @@ go 1.24.5
 
 require github.com/gorilla/websocket v1.5.3
 
-require git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0 // indirect
+require git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0

internal/hub.go

@@ -1,7 +1,6 @@
 package internal
 
 import (
-	"fmt"
 	"log"
 	"time"
 
@@ -24,9 +23,9 @@ type Client struct {
 func NewClient(conn *websocket.Conn, subscribedPath string) *Client {
 	return &Client{
 		Conn:           conn,
-		Send:           make(chan []byte, 64),
+		Send:           make(chan []byte, 2),
 		SubscribedPath: subscribedPath,
-		done:           make(chan struct{}),
+		done:           make(chan struct{}, 1),
 	}
 }
 
@@ -39,10 +38,10 @@ type Hub struct {
 
 func NewHub() *Hub {
 	return &Hub{
-		Broadcast:  make(chan []byte),
-		Register:   make(chan *Client),
-		Unregister: make(chan *Client),
-		Clients:    make(map[*Client]bool),
+		Broadcast:  make(chan []byte, 1),
+		Register:   make(chan *Client, 1),
+		Unregister: make(chan *Client, 1),
+		Clients:    make(map[*Client]bool, 1),
 	}
 }
 
@@ -118,14 +117,14 @@ func ReadPump(c *Client, h *Hub) {
 	for {
 		messageType, message, err := c.Conn.ReadMessage()
 		if err != nil {
-			if !websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
+			if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
 				log.Printf("WebSocket error: %v", err)
 			}
 			break
 		}
 
 		if messageType == websocket.TextMessage {
-			fmt.Printf("Received: %s\n", message)
+			log.Printf("Received: %s\n", message)
 		}
 	}
 }

v1/client/client.go

@@ -16,6 +16,7 @@ import (
 
 const (
 	pingPeriod   = 10 * time.Second
+	readDeadline = 30 * time.Second
 )
 
 type SafeMap[K comparable, V any] struct {
@@ -64,6 +65,20 @@ func (sm *SafeMap[K, V]) Len() int {
 	return count
 }
 
+type MessageType uint
+
+const (
+	MessageTypeText  MessageType = websocket.TextMessage
+	MessageTypePing  MessageType = websocket.PingMessage
+	MessageTypePong  MessageType = websocket.PongMessage
+	MessageTypeClose MessageType = websocket.CloseMessage
+)
+
+type Message struct {
+	MessageType MessageType
+	Data        []byte
+}
+
 type SafeWebsocketClientBuilder struct {
 	baseHost       *string `nil_checker:"required"`
 	basePort       *uint16 `nil_checker:"required"`
@@ -71,6 +86,7 @@ type SafeWebsocketClientBuilder struct {
 	rawQuery       *string
 	useTLS         *bool
 	channelSize    *int64
+	authenticateFn func(*SafeWebsocketClient) error
 }
 
 func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder {
@@ -92,6 +108,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
@@ -134,6 +155,11 @@ func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketC
 		reconnectCh: make(chan struct{}, 1),
 		isConnected: false,
 		doneMap:     NewSafeMap[string, chan struct{}](),
+		writeChan:   make(chan Message, 1),
+	}
+
+	if b.authenticateFn != nil {
+		wsClient.authenticateFn = b.authenticateFn
 	}
 
 	go wsClient.reconnectHandler()
@@ -151,15 +177,23 @@ type SafeWebsocketClient struct {
 	useTLS   bool
 	path     *string
 	rawQuery *string
+
 	dataChannel chan []byte
 	mu          *custom_rwmutex.CustomRwMutex
 	conn        *websocket.Conn
 	cancelFuncs []context.CancelFunc
-	ctx         context.Context
-	reconnectCh chan struct{}
-	isConnected bool
 
+	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
+	pongChan  chan error
 }
 
 func (wsClient *SafeWebsocketClient) connect() error {
@@ -187,38 +221,126 @@ func (wsClient *SafeWebsocketClient) connect() error {
 		return fmt.Errorf("failed to connect to %s: %w", wsClient.baseHost, err)
 	}
 
-	conn.SetPingHandler(func(pingData string) error {
-		if err := conn.WriteMessage(websocket.PongMessage, []byte(pingData)); err != nil {
-			if err == websocket.ErrCloseSent {
-				return nil
-			}
-			if netErr, ok := err.(interface{ Timeout() bool }); ok && netErr.Timeout() {
-				return nil
-			}
-			return err
-		}
+	pingCtx, pingCancel := context.WithCancel(context.Background())
+	wsClient.mu.WriteHandler(func() error {
+		wsClient.cancelFuncs = append(wsClient.cancelFuncs, pingCancel)
 		return nil
 	})
 
-	wsClient.mu.WriteHandler(func() error {
+	go wsClient.startPingTicker(pingCtx)
+
 	if wsClient.conn != nil {
 		wsClient.conn.Close()
 	}
-
 	wsClient.conn = conn
-
 	wsClient.isConnected = true
 
-		pingCtx, pingCancel := context.WithCancel(context.Background())
-		go wsClient.startPingTicker(pingCtx)
-		wsClient.cancelFuncs = append(wsClient.cancelFuncs, pingCancel)
-
-		receiverCtx, receiverCancel := context.WithCancel(context.Background())
-		go wsClient.startReceiveHandler(receiverCtx)
-		wsClient.cancelFuncs = append(wsClient.cancelFuncs, receiverCancel)
+	if wsClient.authenticateFn != nil {
+		if err := wsClient.authenticateFn(wsClient); err != nil {
+			return err
+		}
+	}
 
+	go func() {
+		ctx, cancel := context.WithCancel(context.Background())
+		wsClient.mu.WriteHandler(func() error {
+			wsClient.cancelFuncs = append(wsClient.cancelFuncs, cancel)
 			return nil
 		})
+
+		var c *websocket.Conn
+		wsClient.mu.ReadHandler(func() error {
+			c = conn
+			return nil
+		})
+
+		for {
+			select {
+			case <-ctx.Done():
+				log.Println("Writer stopped due to client shutdown")
+				return
+			case data := <-wsClient.writeChan:
+				if c == nil {
+					wsClient.triggerReconnect()
+					return
+				}
+
+				if err := c.WriteMessage(int(data.MessageType), data.Data); err != nil {
+					log.Printf("error on write message: %v\n", err)
+					wsClient.triggerReconnect()
+					if data.MessageType == MessageTypePong {
+						wsClient.pongChan <- err
+					}
+					return
+				}
+			}
+		}
+	}()
+
+	go func() {
+		ctx, cancel := context.WithCancel(context.Background())
+		wsClient.mu.WriteHandler(func() error {
+			wsClient.cancelFuncs = append(wsClient.cancelFuncs, cancel)
+			return nil
+		})
+
+		var c *websocket.Conn
+
+		wsClient.mu.ReadHandler(func() error {
+			c = conn
+			return nil
+		})
+		if c == nil {
+			wsClient.triggerReconnect()
+			return
+		}
+		for {
+			select {
+			case <-ctx.Done():
+				log.Println("Reader stopped due to client shutdown")
+				return
+			default:
+				if err := c.SetReadDeadline(time.Now().Add(readDeadline)); err != nil {
+					log.Printf("error on read deadline: %v\n", err)
+					return
+				}
+
+				messageType, data, err := c.ReadMessage()
+				if err != nil {
+					log.Printf("error on read message: %v\n", err)
+					wsClient.triggerReconnect()
+					return
+				}
+
+				if messageType != websocket.TextMessage {
+					continue
+				}
+
+				select {
+				case wsClient.dataChannel <- data:
+				case <-ctx.Done():
+					return
+				default:
+					log.Println("Data channel full, dropping message")
+				}
+			}
+		}
+	}()
+
+	conn.SetPingHandler(func(pingData string) error {
+		wsClient.writeChan <- Message{
+			MessageType: MessageTypePong,
+			Data:        []byte(pingData),
+		}
+
+		select {
+		case err := <-wsClient.pongChan:
+			return err
+		default:
+		}
+		return nil
+	})
+
 	return nil
 }
 
@@ -232,50 +354,9 @@ func (wsClient *SafeWebsocketClient) startPingTicker(ctx context.Context) {
 			log.Println("ping ticker stopped")
 			return
 		case <-ticker.C:
-			wsClient.mu.WriteHandler(func() error {
-				if wsClient.conn == nil {
-					return fmt.Errorf("connection closed")
-				}
-				if err := wsClient.conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
-					log.Printf("Ping failed: %v. Will attempt reconnect.", err)
-					wsClient.triggerReconnect()
-				}
-				return 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")
-					return nil
-				default:
-					log.Println("Data channel full, dropping message")
-				}
-				return nil
-			}); err != nil {
-				return
+			wsClient.writeChan <- Message{
+				MessageType: websocket.PingMessage,
+				Data:        []byte{},
 			}
 		}
 	}
@@ -295,13 +376,17 @@ func (wsClient *SafeWebsocketClient) reconnectHandler() {
 		select {
 		case <-wsClient.reconnectCh:
 			log.Println("Reconnect triggered")
+
+			wsClient.mu.ReadHandler(func() error {
 				if wsClient.cancelFuncs != nil {
 					for _, cancel := range wsClient.cancelFuncs {
 						cancel()
 					}
 				}
-			wsClient.isConnected = false
+				return nil
+			})
 
+			wsClient.isConnected = false
 			time.Sleep(100 * time.Millisecond)
 
 			isInnerLoop := true
@@ -321,10 +406,16 @@ func (wsClient *SafeWebsocketClient) reconnectHandler() {
 					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()
@@ -333,24 +424,48 @@ func (wsClient *SafeWebsocketClient) reconnectHandler() {
 	}
 }
 
+func (wsClient *SafeWebsocketClient) ReconnectChannel() <-chan struct{} {
+	reconnectCh := make(chan struct{}, 1)
+	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 {
-	wsClient.mu.WriteHandler(func() error {
+	wsClient.mu.ReadHandler(func() error {
 		if wsClient.cancelFuncs != nil {
 			for _, cancel := range wsClient.cancelFuncs {
 				cancel()
 			}
 		}
+		return nil
+	})
+
+	if wsClient.reconnectChans != nil {
+		for _, reconnectChan := range wsClient.reconnectChans {
+			close(reconnectChan)
+		}
+	}
 	if wsClient.conn != nil {
 		wsClient.conn.Close()
 	}
 	wsClient.isConnected = false
-		return nil
-	})
-	close(wsClient.dataChannel)
+	// close(wsClient.dataChannel)
 
 	return nil
 }

v1/examples/client/main.go

@@ -29,14 +29,22 @@ func main() {
 		BasePort(8080).
 		Path("/ws/test/data_1").
 		UseTLS(false).
+		ChannelSize(30).
 		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))
 	}
 }