chore: cleaning unused mutex

README.md

@@ -1,2 +1,22 @@
 # safe-web-socket
 
+> A secure, production-ready WebSocket wrapper for Go with built-in validation, rate limiting, authentication, and connection management.
+
+## Overview
+
+`SafeWebSocket` is a Go library designed to simplify the creation of **secure, scalable, and resilient WebSocket servers**. Built on top of `gorilla/websocket`, it adds essential safety layers — including authentication, input validation, connection limits, rate limiting, and graceful shutdown — so you can focus on your application logic, not security pitfalls.
+
+Whether you’re building real-time dashboards, chat apps, or live data feeds, `SafeWebSocket` ensures your WebSocket endpoints are protected against common attacks (e.g., DoS, injection, unauthorized access).
+
+## Features
+- ✅ **Graceful Shutdown & Cleanup**
+- ✅ **Automatic Reconnection Handling (Client-side helpers)**
+- ✅ **WebSocket Ping/Pong Health Checks**
+
+## Installation
+
+```bash
+go get git.neurocipta.com/rogerferdinan/safe-web-socket
+```
+
+> Requires Go 1.24+

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

@@ -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(),
 	}
 }
 
@@ -63,6 +58,7 @@ func (h *Hub) Run() {
 					delete(h.Clients, c)
 					close(c.Send)
 				}
+				log.Println("Client Unregistered")
 			case message := <-h.Broadcast:
 				for client := range h.Clients {
 					select {
@@ -122,7 +118,7 @@ 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

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

@@ -1,82 +1,220 @@
 package client
 
-// import (
+import (
-// 	"context"
+	"context"
-// 	"fmt"
+	"fmt"
-// 	"time"
+	"log"
+	"net/url"
+	"strings"
+	"time"
 
-// 	"git.neurocipta.com/rogerferdinan/safe-web-socket/internal"
+	custom_rwmutex "git.neurocipta.com/rogerferdinan/custom-rwmutex"
-// 	"github.com/gorilla/websocket"
+	"git.neurocipta.com/rogerferdinan/safe-web-socket/internal"
-// )
+	"github.com/gorilla/websocket"
+)
 
-// const (
+const (
-// 	pingPeriod = 30 * time.Second
+	pingPeriod = 10 * time.Second
-// )
+)
 
-// type SafeWebsocketClientBuilder struct {
+type SafeWebsocketClientBuilder struct {
-// 	baseHost *string `nil_checker:"required"`
+	baseHost *string `nil_checker:"required"`
-// 	basePort *uint16 `nil_checker:"required"`
+	basePort *uint16 `nil_checker:"required"`
-// }
+	path     *string
+	rawQuery *string
+	useTLS   *bool
+}
 
-// func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder {
+func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder {
-// 	return &SafeWebsocketClientBuilder{}
+	return &SafeWebsocketClientBuilder{}
-// }
+}
 
-// func (b *SafeWebsocketClientBuilder) BaseHost(host string) *SafeWebsocketClientBuilder {
+func (b *SafeWebsocketClientBuilder) BaseHost(host string) *SafeWebsocketClientBuilder {
-// 	b.baseHost = &host
+	b.baseHost = &host
-// 	return b
+	return b
-// }
+}
 
-// func (b *SafeWebsocketClientBuilder) BasePort(port uint16) *SafeWebsocketClientBuilder {
+func (b *SafeWebsocketClientBuilder) BasePort(port uint16) *SafeWebsocketClientBuilder {
-// 	b.basePort = &port
+	b.basePort = &port
-// 	return b
+	return b
-// }
+}
 
-// func (b *SafeWebsocketClientBuilder) Build() (*SafeWebsocketClient, error) {
+func (b *SafeWebsocketClientBuilder) UseTLS(useTLS bool) *SafeWebsocketClientBuilder {
-// 	if err := internal.NilChecker(b); err != nil {
+	b.useTLS = &useTLS
-// 		return nil, err
+	return b
-// 	}
+}
 
-// 	ctx, cancel := context.WithCancel(context.Background())
+func (b *SafeWebsocketClientBuilder) Path(path string) *SafeWebsocketClientBuilder {
+	b.path = &path
+	return b
+}
 
-// 	wsClient := SafeWebsocketClient{
+func (b *SafeWebsocketClientBuilder) RawQuery(rawQuery string) *SafeWebsocketClientBuilder {
-// 		baseHost:    b.baseHost,
+	b.rawQuery = &rawQuery
-// 		basePort:    b.basePort,
+	return b
-// 		ctx:         ctx,
+}
-// 		cancel:      cancel,
-// 		reconnectCh: make(chan struct{}, 1),
-// 		isConnected: false,
-// 	}
 
-// 	if err := wsClient.connect(); err != nil {
+func (b *SafeWebsocketClientBuilder) Build() (*SafeWebsocketClient, error) {
-// 		cancel()
+	if err := internal.NilChecker(b); err != nil {
-// 		return nil, fmt.Errorf("failed to establish initial connection: %v", err)
+		return nil, err
-// 	}
+	}
 
-// 	wsClient.startPingTicker()
+	ctx, cancel := context.WithCancel(context.Background())
-// 	wsClient.startReceiveHandler()
 
-// 	return &wsClient, nil
+	var useTLS bool
-// }
+	if b.useTLS != nil {
+		useTLS = *b.useTLS
+	}
 
-// type SafeWebsocketClient struct {
+	wsClient := SafeWebsocketClient{
-// 	baseHost    *string
+		baseHost:    *b.baseHost,
-// 	basePort    *uint16
+		basePort:    *b.basePort,
-// 	mu          *internal.CustomRwMutex
+		useTLS:      useTLS,
-// 	ctx         context.Context
+		path:        b.path,
-// 	cancel      context.CancelFunc
+		rawQuery:    b.rawQuery,
-// 	reconnectCh chan struct{}
+		ctx:         ctx,
-// 	isConnected bool
+		cancel:      cancel,
-// }
+		dataChannel: make(chan []byte, 1),
+		mu:          custom_rwmutex.NewCustomRwMutex(),
+		reconnectCh: make(chan struct{}, 1),
+		isConnected: false,
+	}
 
-// func (wsClient *SafeWebsocketClient) connect() error {
+	if err := wsClient.connect(); err != nil {
-// 	url := fmt.Sprintf("%s:%d", *wsClient.baseHost, *wsClient.basePort)
+		cancel()
-// 	conn, _, err := websocket.DefaultDialer.Dial(url, nil)
+		return nil, fmt.Errorf("failed to establish initial connection: %v", err)
-// 	if err != nil {
+	}
-// 		return fmt.Errorf("failed to connect to %s: %w", *wsClient.baseHost, err)
-// 	}
 
-// 	conn.SetPingHandler(func(pingData string) error {
+	return &wsClient, nil
-// 		conn.WriteMessage(websocket.PongMessage, []byte(pingData))
+}
-// 	})
+
-// }
+type SafeWebsocketClient struct {
+	baseHost    string
+	basePort    uint16
+	useTLS      bool
+	path        *string
+	rawQuery    *string
+	dataChannel chan []byte
+	mu          *custom_rwmutex.CustomRwMutex
+	conn        *websocket.Conn
+	ctx         context.Context
+	cancel      context.CancelFunc
+	reconnectCh chan struct{}
+	isConnected bool
+}
+
+func (wsClient *SafeWebsocketClient) connect() error {
+	var scheme string
+	if wsClient.useTLS {
+		scheme = "wss"
+	} else {
+		scheme = "ws"
+	}
+	newURL := url.URL{
+		Scheme: scheme,
+		Host:   fmt.Sprintf("%s:%d", wsClient.baseHost, wsClient.basePort),
+	}
+
+	if wsClient.path != nil && strings.TrimSpace(*wsClient.path) != "" {
+		newURL.Path = *wsClient.path
+	}
+
+	if wsClient.rawQuery != nil && strings.TrimSpace(*wsClient.rawQuery) != "" {
+		newURL.RawQuery = *wsClient.rawQuery
+	}
+
+	conn, _, err := websocket.DefaultDialer.Dial(newURL.String(), nil)
+	if err != nil {
+		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
+		}
+		return nil
+	})
+
+	wsClient.mu.WriteHandler(func() error {
+		wsClient.conn = conn
+		wsClient.isConnected = true
+		return nil
+	})
+
+	go wsClient.startPingTicker()
+	go wsClient.startReceiveHandler()
+	go wsClient.reconnectHandler()
+
+	return nil
+}
+
+func (wsClient *SafeWebsocketClient) startPingTicker() {
+	ticker := time.NewTicker(pingPeriod)
+	defer ticker.Stop()
+	for {
+		select {
+		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.ReadHandler(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
+			}
+		}
+	}
+}
+
+func (wsClient *SafeWebsocketClient) triggerReconnect() {
+	select {
+	case wsClient.reconnectCh <- struct{}{}:
+	default:
+	}
+}
+
+func (wsClient *SafeWebsocketClient) reconnectHandler() {
+	for range wsClient.reconnectCh {
+		wsClient.connect()
+	}
+}
+
+func (wsClient *SafeWebsocketClient) DataChannel() <-chan []byte {
+	return wsClient.dataChannel
+}

v1/examples/client/main.go

@@ -0,0 +1,25 @@
+package main
+
+import (
+	"fmt"
+	"log"
+
+	"git.neurocipta.com/rogerferdinan/safe-web-socket/v1/client"
+)
+
+func main() {
+	wsClient, err := client.NewSafeWebsocketClientBuilder().
+		BaseHost("localhost").
+		BasePort(8080).
+		Path("/ws/test/data_1").
+		UseTLS(false).
+		Build()
+	if err != nil {
+		log.Fatal(err)
+	}
+	dataChannel := wsClient.DataChannel()
+
+	for data := range dataChannel {
+		fmt.Println(string(data))
+	}
+}

v1/examples/server/main.go

@@ -1,12 +1,18 @@
 package main
 
 import (
+	"encoding/json"
 	"log"
 	"time"
 
 	"git.neurocipta.com/rogerferdinan/safe-web-socket/v1/server"
 )
 
+type ExampleData struct {
+	Time time.Time `json:"time"`
+	Data string    `json:"data"`
+}
+
 func main() {
 	s, err := server.NewSafeWebsocketServerBuilder().
 		BaseHost("localhost").
@@ -14,13 +20,27 @@ func main() {
 		HandleFuncWebsocket("/ws/test/", "data_1", func(c chan []byte) {
 			ticker := time.NewTicker(10 * time.Millisecond)
 			for range ticker.C {
-				c <- []byte(time.Now().Format("2006-01-02 15:04:05") + "_data_1")
+				jsonBytes, err := json.Marshal(ExampleData{
+					Time: time.Now(),
+					Data: "data_1",
+				})
+				if err != nil {
+					continue
+				}
+				c <- jsonBytes
 			}
 		}).
 		HandleFuncWebsocket("/ws/test/", "data_2", func(c chan []byte) {
 			ticker := time.NewTicker(10 * time.Millisecond)
 			for range ticker.C {
-				c <- []byte(time.Now().Format("2006-01-02 15:04:05") + "_data_2")
+				jsonBytes, err := json.Marshal(ExampleData{
+					Time: time.Now(),
+					Data: "data_2",
+				})
+				if err != nil {
+					continue
+				}
+				c <- jsonBytes
 			}
 		}).
 		Build()

v1/server/server.go

@@ -18,9 +18,6 @@ type SafeWebsocketServerBuilder struct {
 }
 
 func NewSafeWebsocketServerBuilder() *SafeWebsocketServerBuilder {
-	h := internal.NewHub()
-	h.Run()
-
 	return &SafeWebsocketServerBuilder{
 		upgrader: &websocket.Upgrader{
 			ReadBufferSize:  1024,