feat: adding ping & pong handler

go.mod

@@ -9,4 +9,12 @@ require (
 	github.com/google/uuid v1.6.0
 )
 
-require git.neurocipta.com/rogerferdinan/safe-map v0.0.0-20251011004629-ab0b119a7c48
+require (
+	git.neurocipta.com/rogerferdinan/safe-map v0.0.0-20251011004629-ab0b119a7c48
+	github.com/gobwas/ws v1.4.0
+)
+
+require (
+	github.com/gobwas/httphead v0.1.0 // indirect
+	github.com/gobwas/pool v0.2.1 // indirect
+)

go.sum

@@ -2,7 +2,14 @@ git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0 h1:KnNc40SrYsg0cksIIcQy/c
 git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0/go.mod h1:9DvvHc2UZhBwEs63NgO4IhiuHnBNtTuBkTJgiMnnCss=
 git.neurocipta.com/rogerferdinan/safe-map v0.0.0-20251011004629-ab0b119a7c48 h1:4wXSbEuwFd2gycaaGP35bjUkKEEO6WcVfJ6cetEyT5s=
 git.neurocipta.com/rogerferdinan/safe-map v0.0.0-20251011004629-ab0b119a7c48/go.mod h1:QtIxG0BYCCq8a5qyklpSHA8qWUvKr+mfl42qF9QxTc0=
+github.com/gobwas/httphead v0.1.0 h1:exrUm0f4YX0L7EBwZHuCF4GDp8aJfVeBrlLQrs6NqWU=
+github.com/gobwas/httphead v0.1.0/go.mod h1:O/RXo79gxV8G+RqlR/otEwx4Q36zl9rqC5u12GKvMCM=
+github.com/gobwas/pool v0.2.1 h1:xfeeEhW7pwmX8nuLVlqbzVc7udMDrwetjEv+TZIz1og=
+github.com/gobwas/pool v0.2.1/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6WezmKEw=
+github.com/gobwas/ws v1.4.0 h1:CTaoG1tojrh4ucGPcoJFiAQUAsEWekEWvLy7GsVNqGs=
+github.com/gobwas/ws v1.4.0/go.mod h1:G3gNqMNtPppf5XUz7O4shetPpcZ1VJ7zt18dlUeakrc=
 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=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

internal/error_response.go

@@ -0,0 +1,56 @@
+package internal
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+type StatusMessageBuilder struct {
+	statusCode *int
+	message    *string
+}
+
+func NewStatusMessage() *StatusMessageBuilder {
+	return &StatusMessageBuilder{}
+}
+
+func (sm *StatusMessageBuilder) StatusCode(statusCode int) *StatusMessageBuilder {
+	sm.statusCode = &statusCode
+	return sm
+}
+
+func (sm *StatusMessageBuilder) Message(message string) *StatusMessageBuilder {
+	sm.message = &message
+	return sm
+}
+
+func (sm *StatusMessageBuilder) Build() *StatusMessage {
+	return &StatusMessage{
+		StatusCode: sm.statusCode,
+		Message:    sm.message,
+	}
+}
+
+type StatusMessage struct {
+	StatusCode *int
+	Message    *string `json:"msg"`
+}
+
+func ErrorResponse(w http.ResponseWriter, statusMessage *StatusMessage) error {
+	if statusMessage.StatusCode == nil {
+		return fmt.Errorf("status code is missing")
+	}
+	if statusMessage.Message == nil {
+		return fmt.Errorf("message is missing")
+	}
+	w.Header().Add("Content-Type", "application/json")
+	w.WriteHeader(*statusMessage.StatusCode)
+
+	b, err := json.Marshal(statusMessage)
+	if err != nil {
+		return fmt.Errorf("failed to marshal JSON")
+	}
+	w.Write(b)
+	return nil
+}

v1/client/client.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"log"
+	"net/http"
 	"net/url"
 	"strings"
 	"time"
@@ -36,6 +37,7 @@ type Message struct {
 type SafeWebsocketClientBuilder struct {
 	baseHost         *string `nil_checker:"required"`
 	basePort         *uint16 `nil_checker:"required"`
+	headers          *map[string]string
 	path             *string
 	rawQuery         *string
 	isDrop           *bool
@@ -58,6 +60,11 @@ func (b *SafeWebsocketClientBuilder) BasePort(port uint16) *SafeWebsocketClientB
 	return b
 }
 
+func (b *SafeWebsocketClientBuilder) Headers(headers map[string]string) *SafeWebsocketClientBuilder {
+	b.headers = &headers
+	return b
+}
+
 func (b *SafeWebsocketClientBuilder) UseTLS(useTLS bool) *SafeWebsocketClientBuilder {
 	b.useTLS = &useTLS
 	return b
@@ -117,6 +124,7 @@ func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketC
 	wsClient := SafeWebsocketClient{
 		baseHost:    *b.baseHost,
 		basePort:    *b.basePort,
+		headers:     b.headers,
 		useTLS:      *b.useTLS,
 		isDrop:      *b.isDrop,
 		path:        b.path,
@@ -142,6 +150,8 @@ func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketC
 type SafeWebsocketClient struct {
 	baseHost string
 	basePort uint16
+	headers  *map[string]string
+
 	isDrop   bool
 	useTLS   bool
 	path     *string
@@ -159,7 +169,6 @@ type SafeWebsocketClient struct {
 	doneMap        *safemap.SafeMap[string, chan struct{}]
 
 	writeChan chan Message
-	pongChan  chan error
 }
 
 func (wsClient *SafeWebsocketClient) connect() error {
@@ -182,7 +191,15 @@ func (wsClient *SafeWebsocketClient) connect() error {
 		newURL.RawQuery = *wsClient.rawQuery
 	}
 
-	conn, _, err := websocket.DefaultDialer.Dial(newURL.String(), nil)
+	header := make(http.Header)
+
+	if wsClient.headers != nil {
+		for k, v := range *wsClient.headers {
+			header.Set(k, v)
+		}
+	}
+
+	conn, _, err := websocket.DefaultDialer.Dial(newURL.String(), header)
 	if err != nil {
 		return fmt.Errorf("failed to connect to %s: %w", wsClient.baseHost, err)
 	}
@@ -201,23 +218,30 @@ func (wsClient *SafeWebsocketClient) connect() error {
 	wsClient.conn = conn
 	wsClient.isConnected = true
 
+	conn.SetPingHandler(func(pingData string) error {
+		if err := conn.SetReadDeadline(time.Now().Add(readDeadline)); err != nil {
+			log.Printf("error on read deadline: %v\n", err)
+			return err
+		}
+
+		wsClient.writeChan <- Message{
+			MessageType: MessageTypePong,
+			Data:        []byte(pingData),
+		}
+		return nil
+	})
+
+	conn.SetPongHandler(func(pingData string) error {
+		if err := conn.SetReadDeadline(time.Now().Add(readDeadline)); err != nil {
+			log.Printf("error on read deadline: %v\n", err)
+			return err
+		}
+		return nil
+	})
+
 	go wsClient.writePump()
 	go wsClient.readPump()
 
-	// 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
 }
 
@@ -246,9 +270,6 @@ func (wsClient *SafeWebsocketClient) writePump() {
 
 			if err := c.WriteMessage(int(data.MessageType), data.Data); err != nil {
 				log.Printf("error on write message: %v\n", err)
-				if data.MessageType == MessageTypePong {
-					wsClient.pongChan <- err
-				}
 				return
 			}
 		}
@@ -268,78 +289,43 @@ func (wsClient *SafeWebsocketClient) readPump() {
 		return nil
 	})
 
-	if wsClient.isDrop {
+	for {
-		for {
+		select {
+		case <-ctx.Done():
+			log.Println("Reader canceled by context")
+			return
+		default:
+			if c == nil {
+				return
+			}
+
+			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():
-				log.Println("Reader canceled by context")
 				return
 			default:
-				if c == nil {
+				if wsClient.isDrop {
-					return
-				}
-
-				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")
 				}
 			}
 		}
-	} else {
-		for {
-			select {
-			case <-ctx.Done():
-				log.Println("Reader canceled by context")
-				return
-			default:
-				if c == nil {
-					return
-				}
-
-				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
-				}
-			}
-		}
 	}
-
 }
 
 func (wsClient *SafeWebsocketClient) startPingTicker(ctx context.Context) {

v1/examples/client/main.go

@@ -8,10 +8,18 @@ import (
 	"os/signal"
 	"syscall"
 
+	"net/http"
+	_ "net/http/pprof"
+
 	"git.neurocipta.com/rogerferdinan/safe-web-socket/v1/client"
 )
 
 func main() {
+	go func() {
+		log.Println("Starting pprof server on :6060")
+		log.Println(http.ListenAndServe(":6060", nil))
+	}()
+
 	sigChan := make(chan os.Signal, 1)
 	signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
 
@@ -27,24 +35,26 @@ func main() {
 	wsClient, err := client.NewSafeWebsocketClientBuilder().
 		BaseHost("localhost").
 		BasePort(8080).
-		Path("/ws/test/data_1").
+		Headers(map[string]string{
+			"X-MBX-APIKEY": "abcd",
+		}).Path("/ws/test/data_1").
 		UseTLS(false).
-		ChannelSize(30).
+		ChannelSize(1).
 		Build(ctx)
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	// go func() {
+	go func() {
-	// 	for range wsClient.ReconnectChannel() {
+		for range wsClient.ReconnectChannel() {
-	// 		fmt.Println("Reconnection Success")
+			fmt.Println("Reconnection Success")
-	// 	}
+		}
-	// }()
+	}()
 
 	dataChannel := wsClient.DataChannel()
 
 	for data := range dataChannel {
-		// _ = data
+		_ = data
-		fmt.Println(string(data))
+		// fmt.Println(string(data))
 	}
 }

v1/examples/gobwas-server/main.go

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"syscall"
+)
+
+func setMaxRLimit() {
+	var rLimit syscall.Rlimit
+	if err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit); err != nil {
+		panic(err)
+	}
+	rLimit.Cur = rLimit.Max
+	if err := syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit); err != nil {
+		panic(err)
+	}
+}
+
+func main() {
+	setMaxRLimit()
+	// pooler, err := netpool.New()
+
+	// http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+	// 	if _, _, _, err := ws.UpgradeHTTP(r, w); err != nil {
+	// 		log.Fatal(err)
+	// 	}
+	// })
+	// epoller, err := MkEp
+}

v1/examples/server/main.go

@@ -17,8 +17,9 @@ func main() {
 	s, err := server.NewSafeWebsocketServerBuilder().
 		BaseHost("localhost").
 		BasePort(8080).
+		ApiKey("abcd").
 		HandleFuncWebsocket("/ws/test/", "data_1", func(c chan []byte) {
-			ticker := time.NewTicker(10 * time.Millisecond)
+			ticker := time.NewTicker(100 * time.Millisecond)
 			for range ticker.C {
 				jsonBytes, err := json.Marshal(ExampleData{
 					Time: time.Now(),
@@ -31,7 +32,7 @@ func main() {
 			}
 		}).
 		HandleFuncWebsocket("/ws/test/", "data_2", func(c chan []byte) {
-			ticker := time.NewTicker(10 * time.Millisecond)
+			ticker := time.NewTicker(100 * time.Millisecond)
 			for range ticker.C {
 				jsonBytes, err := json.Marshal(ExampleData{
 					Time: time.Now(),

v1/server/server.go

@@ -5,14 +5,27 @@ import (
 	"log"
 	"net/http"
 	"strings"
+	"syscall"
 
 	"git.neurocipta.com/rogerferdinan/safe-web-socket/internal"
 	"github.com/gorilla/websocket"
 )
 
+func setMaxRLimit() {
+	var rLimit syscall.Rlimit
+	if err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit); err != nil {
+		panic(err)
+	}
+	rLimit.Cur = rLimit.Max
+	if err := syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit); err != nil {
+		panic(err)
+	}
+}
+
 type SafeWebsocketServerBuilder struct {
 	baseHost *string             `nil_checker:"required"`
 	basePort *uint16             `nil_checker:"required"`
+	apiKey   *string             `nil_checker:"required"`
 	upgrader *websocket.Upgrader `nil_checker:"required"`
 	mux      *http.ServeMux      `nil_checker:"required"`
 }
@@ -40,16 +53,17 @@ func (b *SafeWebsocketServerBuilder) BasePort(basePort uint16) *SafeWebsocketSer
 	return b
 }
 
-func (b *SafeWebsocketServerBuilder) HandleFunc(
+func (b *SafeWebsocketServerBuilder) ApiKey(apiKey string) *SafeWebsocketServerBuilder {
-	pattern string, fn func(http.ResponseWriter, *http.Request),
+	b.apiKey = &apiKey
-) *SafeWebsocketServerBuilder {
+	return b
+}
+
+func (b *SafeWebsocketServerBuilder) HandleFunc(pattern string, fn func(http.ResponseWriter, *http.Request)) *SafeWebsocketServerBuilder {
 	b.mux.HandleFunc(pattern, fn)
 	return b
 }
 
-func (b *SafeWebsocketServerBuilder) HandleFuncWebsocket(
+func (b *SafeWebsocketServerBuilder) HandleFuncWebsocket(pattern string, subscribedPath string, writeFunc func(chan []byte)) *SafeWebsocketServerBuilder {
-	pattern string, subscribedPath string, writeFunc func(chan []byte),
-) *SafeWebsocketServerBuilder {
 	h := internal.NewHub()
 	h.Run()
 
@@ -79,22 +93,37 @@ func (b *SafeWebsocketServerBuilder) Build() (*SafeWebsocketServer, error) {
 		return nil, err
 	}
 
+	setMaxRLimit()
 	safeServer := SafeWebsocketServer{
-		url: fmt.Sprintf("%s:%d", *b.baseHost, *b.basePort),
+		mux:    b.mux,
-		mux: b.mux,
+		url:    fmt.Sprintf("%s:%d", *b.baseHost, *b.basePort),
+		apiKey: *b.apiKey,
 	}
 	return &safeServer, nil
 }
 
 type SafeWebsocketServer struct {
-	hub *internal.Hub
+	mux    *http.ServeMux
-	mux *http.ServeMux
+	url    string
-	url string
+	apiKey string
+}
+
+func (s *SafeWebsocketServer) AuthMiddleware(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.Header.Get("X-MBX-APIKEY") != s.apiKey {
+			internal.ErrorResponse(w, internal.NewStatusMessage().
+				StatusCode(http.StatusForbidden).
+				Message("X-MBX-APIKEY is missing").
+				Build())
+			return
+		}
+		next.ServeHTTP(w, r)
+	})
 }
 
 func (s *SafeWebsocketServer) ListenAndServe() error {
 	log.Printf("HTTP serve on %s\n", s.url)
-	if err := http.ListenAndServe(s.url, s.mux); err != nil {
+	if err := http.ListenAndServe(s.url, s.AuthMiddleware(s.mux)); err != nil {
 		return fmt.Errorf("failed to serve websocket: %w", err)
 	}
 	return nil