Compare commits

..

49 Commits

Author SHA1 Message Date
632d79dd57 fix: moving writeFunc as culprit of memory leak 2026-02-08 20:50:55 +07:00
b296d73367 fix: discard reconnect channel to prevent memory leak 2026-02-08 11:46:26 +07:00
2200657ba7 fix: fixing memory leak on client 2026-02-05 07:30:49 +07:00
07f7893a26 fix: fixing ping & memory leak 2026-02-04 22:20:19 +07:00
7f21b733ed feat: adding ping & pong handler 2026-02-01 19:05:33 +07:00
9816426780 feat: adding header support for client 2025-11-21 20:01:49 +07:00
4fc0c438c8 feat: adding apiKey for authentication 2025-11-21 16:24:33 +07:00
49a30d3b44 fix: fixing sudden disconnect for multiple connection 2025-10-27 13:09:16 +07:00
b71e8121e2 fix: fixing shut down deadlock 2025-10-16 06:47:51 +07:00
9c6db30550 feat: add data retrieval close function 2025-10-13 08:30:42 +07:00
bc2017e67d fix: fixing client map size 2025-10-13 07:05:18 +07:00
cd4a239f14 feat: adding optional drop channel 2025-10-11 22:17:31 +07:00
0d0de32d21 chore: seperete goroutine into function for readability 2025-10-11 10:16:02 +07:00
88ae539f54 fix: fixing memory leak from unbuffered channel 2025-10-07 09:16:51 +07:00
78a5b21531 fix: fixing websocket error message log 2025-10-03 10:40:46 +07:00
e011931436 fix: messageType typo 2025-10-01 15:09:06 +07:00
70d9a37a4e fix: pong data race 2025-10-01 14:41:23 +07:00
2ab2e07b9b fix: pong not sent 2025-10-01 14:00:22 +07:00
9a9c65c24c fix: ping not sent 2025-10-01 13:45:48 +07:00
8a11ce0103 fix: extend read deadline wait 2025-09-30 13:13:29 +07:00
cf63683c9c fix: fixing panic on pong write message 2025-09-30 10:43:39 +07:00
92bd56aac0 fix: fixing data race 2025-09-30 10:33:30 +07:00
b4e7238b0b fix: fixing data race 2025-09-30 09:59:46 +07:00
b092e36987 fix: adding reconnect when deadline met 2025-09-30 08:16:58 +07:00
4f956b8fe9 fix: read issues 2025-09-30 07:24:54 +07:00
967b8a98b3 fix: write & reader posiiton 2025-09-30 07:12:38 +07:00
d09d389011 fix: initialize write channel 2025-09-30 06:59:01 +07:00
c550701dfa fix: adding lock for cancel function slices 2025-09-29 22:53:29 +07:00
2225391fc3 fix: changing to one concurrent writer & reader 2025-09-29 22:47:33 +07:00
9f8ee49b5c fix: adding SafeWebSocketClient parameter 2025-09-29 18:48:38 +07:00
735f55858e fix: adding nil checker 2025-09-29 17:58:19 +07:00
5e5df9090f fix: adding back read mutex for data race 2025-09-29 17:55:24 +07:00
1537e58444 fix: fixing deadlock caused by read mutex 2025-09-29 16:38:08 +07:00
66b27082b9 feat: adding reconnect channel for authentication purposes 2025-09-29 15:45:02 +07:00
9d74e72ede feat: add writeJSON function 2025-09-29 14:40:07 +07:00
dfbe2f2808 fix: fixing client deadlock condition & reconnection issues 2025-09-29 09:06:31 +07:00
4792d638c1 feat: adding channelSize to safe websocket client 2025-09-27 05:27:57 +07:00
b96e574726 feat: adding client close function 2025-09-27 04:52:47 +07:00
752804cc58 fix: restructuring safe websocket client 2025-09-27 04:48:01 +07:00
e686e69a24 fix: fixing client nil pointer 2025-09-26 16:10:19 +07:00
034e5b68e0 fix: client reconnection data race fix 2025-09-26 16:07:20 +07:00
6fb7cea1fa fix client & server experimental fix 2025-09-26 15:02:54 +07:00
7457604e0f fix: client data race hotfix 2025-09-26 14:18:53 +07:00
f32d97eac4 chore: cleaning unused mutex 2025-09-26 09:16:35 +07:00
4111dd0f25 fix: removing debugger for writePump 2025-09-25 17:33:00 +07:00
f91e24cc02 feat: adding rawQuery to safeWebsocketClient 2025-09-25 14:51:44 +07:00
ef98404caf feat: safe websocket client implementation 2025-09-25 14:14:24 +07:00
eac2ed2bf1 fix: readPump and writePump hotfix 2025-09-25 10:42:40 +07:00
6b58b7f233 fix: data race hotfix 2025-09-25 07:24:57 +07:00
11 changed files with 807 additions and 183 deletions

View File

@@ -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 youre 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+

15
go.mod
View File

@@ -3,3 +3,18 @@ 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
github.com/google/uuid v1.6.0
)
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
)

13
go.sum
View File

@@ -1,2 +1,15 @@
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=
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=

View File

@@ -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
}

View File

@@ -3,26 +3,35 @@ package internal
import (
"fmt"
"log"
"sync"
"time"
"github.com/google/uuid"
"github.com/gorilla/websocket"
)
const (
writeWait = 10 * time.Second
pongWait = 60 * time.Second
pingPeriod = (pongWait * 9) / 10
maxMessageSize = 512
)
type Client struct {
ID string
Conn *websocket.Conn
Send chan []byte
SubscribedPath string
done chan struct{}
mu *CustomRwMutex
mu sync.Mutex
}
func NewClient(conn *websocket.Conn, subscribedPath string) *Client {
return &Client{
ID: uuid.NewString(),
Conn: conn,
Send: make(chan []byte, 1024),
Send: make(chan []byte, 256),
SubscribedPath: subscribedPath,
done: make(chan struct{}),
mu: NewCustomRwMutex(),
mu: sync.Mutex{},
}
}
@@ -31,83 +40,38 @@ type Hub struct {
Broadcast chan []byte
Register chan *Client
Unregister chan *Client
ClientData map[string]chan []byte
writeMu *CustomRwMutex
readMu *CustomRwMutex
}
func NewHub() *Hub {
return &Hub{
Broadcast: make(chan []byte),
Register: make(chan *Client),
Unregister: make(chan *Client),
Broadcast: make(chan []byte, 256),
Register: make(chan *Client, 10),
Unregister: make(chan *Client, 10),
Clients: make(map[*Client]bool),
ClientData: make(map[string]chan []byte),
writeMu: NewCustomRwMutex(),
}
}
func (h *Hub) AddDataChannel(dataID string) chan []byte {
ch := make(chan []byte, 256)
h.writeMu.WriteHandler(func() error {
if innerCh, ok := h.ClientData[dataID]; ok {
ch = innerCh
return nil
}
h.ClientData[dataID] = ch
log.Printf("Created data channel for: %s\n", dataID)
return nil
})
return ch
}
func (h *Hub) GetDataChannel(dataID string) (chan []byte, bool) {
var ch chan []byte
var ok bool
h.writeMu.ReadHandler(func() error {
innerCh, innerOk := h.ClientData[dataID]
ch = innerCh
ok = innerOk
return nil
})
return ch, ok
}
func (h *Hub) RemoveDataChannel(dataID string) {
h.writeMu.WriteHandler(func() error {
if ch, ok := h.ClientData[dataID]; ok {
close(ch)
delete(h.ClientData, dataID)
log.Printf("Removed data channel for: %s\n", dataID)
}
return nil
})
}
func (h *Hub) Run() {
go func() {
for {
select {
case c := <-h.Register:
h.Clients[c] = true
log.Println("Client registered")
case c := <-h.Unregister:
if _, ok := h.Clients[c]; ok {
delete(h.Clients, c)
close(c.Send)
c.Conn.Close()
log.Println("Client unregistered")
case client := <-h.Register:
h.Clients[client] = true
log.Printf("Client registered %s\n", client.ID)
case client := <-h.Unregister:
if _, ok := h.Clients[client]; ok {
delete(h.Clients, client)
close(client.Send)
}
log.Printf("Client Unregistered %s\n", client.ID)
case message := <-h.Broadcast:
for c := range h.Clients {
for client := range h.Clients {
select {
case c.Send <- message:
case client.Send <- message:
default:
close(c.Send)
delete(h.Clients, c)
close(client.Send)
delete(h.Clients, client)
log.Printf("Client %s removed (slow/disconnected)", client.ID)
}
}
}
@@ -116,73 +80,73 @@ func (h *Hub) Run() {
}
func WritePump(c *Client, h *Hub) {
go func() {
defer func() {
h.Unregister <- c
c.Conn.Close()
}()
c.Conn.SetReadLimit(1024)
c.Conn.SetPongHandler(func(string) error {
if err := c.Conn.WriteMessage(websocket.PongMessage, []byte{}); err != nil {
return fmt.Errorf("failed to send pong: %v", err)
}
return nil
})
ticker := time.NewTicker(30 * time.Second)
defer ticker.Stop()
for {
select {
case message, ok := <-c.Send:
if err := c.mu.WriteHandler(func() error {
if !ok {
c.Conn.WriteMessage(websocket.CloseMessage, []byte{})
return fmt.Errorf("message not ok")
}
w, err := c.Conn.NextWriter(websocket.TextMessage)
if err != nil {
return fmt.Errorf("failed to get writer: %q", err)
}
w.Write(message)
if err := w.Close(); err != nil {
return err
}
return nil
}); err == nil {
continue
}
case <-ticker.C:
if err := c.mu.WriteHandler(func() error {
if err := c.Conn.WriteMessage(websocket.PingMessage, nil); err != nil {
return err
}
return nil
}); err != nil {
return
}
}
}
pingTicker := time.NewTicker(pingPeriod)
defer func() {
h.Unregister <- c
pingTicker.Stop()
c.Conn.Close()
}()
}
func ReadPump(c *Client) {
go func() {
for {
_, message, err := c.Conn.ReadMessage()
for {
select {
case message, ok := <-c.Send:
c.Conn.SetWriteDeadline(time.Now().Add(writeWait))
if !ok {
c.Conn.WriteMessage(websocket.CloseMessage, []byte{})
return
}
w, err := c.Conn.NextWriter(websocket.TextMessage)
if err != nil {
if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
log.Printf("WebSocket error: %v", err)
}
break
return
}
w.Write(message)
// Queue queued messages in the same buffer (optional optimization)
n := len(c.Send)
for i := 0; i < n; i++ {
w.Write(<-c.Send)
}
fmt.Println(string(message))
if err := w.Close(); err != nil {
return
}
case <-pingTicker.C:
c.Conn.SetWriteDeadline(time.Now().Add(writeWait))
if err := c.Conn.WriteMessage(websocket.PingMessage, nil); err != nil {
fmt.Println(err)
return
}
}
}
}
func ReadPump(c *Client, h *Hub) {
defer func() {
h.Unregister <- c
c.Conn.Close()
}()
c.Conn.SetReadLimit(maxMessageSize)
c.Conn.SetReadDeadline(time.Now().Add(pongWait))
c.Conn.SetPongHandler(func(string) error {
c.Conn.SetReadDeadline(time.Now().Add(pongWait))
return nil
})
for {
_, message, err := c.Conn.ReadMessage()
if err != nil {
if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
log.Printf("WebSocket error: %v", err)
}
break
}
log.Printf("Received: %s\n", message)
}
}

View File

@@ -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
}

449
v1/client/client.go Normal file
View File

@@ -0,0 +1,449 @@
package client
import (
"context"
"fmt"
"log"
"net/http"
"net/url"
"strings"
"time"
custom_rwmutex "git.neurocipta.com/rogerferdinan/custom-rwmutex"
safemap "git.neurocipta.com/rogerferdinan/safe-map"
"git.neurocipta.com/rogerferdinan/safe-web-socket/internal"
"github.com/gorilla/websocket"
)
const (
pingPeriod = 10 * time.Second
readDeadline = 30 * time.Second
writeDeadline = 10 * time.Second
)
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"`
headers *map[string]string
path *string
rawQuery *string
isDrop *bool
useTLS *bool
channelSize *int64
writeChannelSize *int64
}
func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder {
return &SafeWebsocketClientBuilder{}
}
func (b *SafeWebsocketClientBuilder) BaseHost(host string) *SafeWebsocketClientBuilder {
b.baseHost = &host
return b
}
func (b *SafeWebsocketClientBuilder) BasePort(port uint16) *SafeWebsocketClientBuilder {
b.basePort = &port
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
}
func (b *SafeWebsocketClientBuilder) Path(path string) *SafeWebsocketClientBuilder {
b.path = &path
return b
}
func (b *SafeWebsocketClientBuilder) RawQuery(rawQuery string) *SafeWebsocketClientBuilder {
b.rawQuery = &rawQuery
return b
}
func (b *SafeWebsocketClientBuilder) IsDrop(isDrop bool) *SafeWebsocketClientBuilder {
b.isDrop = &isDrop
return b
}
func (b *SafeWebsocketClientBuilder) ChannelSize(channelSize int64) *SafeWebsocketClientBuilder {
b.channelSize = &channelSize
return b
}
func (b *SafeWebsocketClientBuilder) WriteChannelSize(writeChannelSize int64) *SafeWebsocketClientBuilder {
b.writeChannelSize = &writeChannelSize
return b
}
func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketClient, error) {
if err := internal.NilChecker(b); err != nil {
return nil, err
}
// var useTLS bool
if b.useTLS == nil {
useTLS := true
b.useTLS = &useTLS
}
if b.isDrop == nil {
isDrop := true
b.isDrop = &isDrop
}
if b.channelSize == nil {
channelSize := int64(1)
b.channelSize = &channelSize
}
if b.writeChannelSize == nil {
writeChannelSize := int64(1)
b.writeChannelSize = &writeChannelSize
}
wsClient := SafeWebsocketClient{
baseHost: *b.baseHost,
basePort: *b.basePort,
headers: b.headers,
useTLS: *b.useTLS,
isDrop: *b.isDrop,
path: b.path,
rawQuery: b.rawQuery,
dataChannel: make(chan []byte, *b.channelSize),
mu: custom_rwmutex.NewCustomRwMutex(),
ctx: ctx,
reconnectCh: make(chan struct{}, 1),
isConnected: false,
doneMap: safemap.NewSafeMap[string, chan struct{}](),
writeChan: make(chan Message, *b.writeChannelSize),
}
go wsClient.reconnectHandler()
if err := wsClient.connect(); err != nil {
return nil, fmt.Errorf("failed to establish initial connection: %v", err)
}
return &wsClient, nil
}
type SafeWebsocketClient struct {
baseHost string
basePort uint16
headers *map[string]string
isDrop bool
useTLS bool
path *string
rawQuery *string
mu *custom_rwmutex.CustomRwMutex
conn *websocket.Conn
ctx context.Context
cancelFuncs []context.CancelFunc
dataChannel chan []byte
reconnectCh chan struct{}
reconnectChans []chan struct{}
isConnected bool
doneMap *safemap.SafeMap[string, chan struct{}]
writeChan chan Message
}
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
}
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)
}
pingCtx, pingCancel := context.WithCancel(context.Background())
pumpCtx, pumpCancel := context.WithCancel(context.Background())
wsClient.mu.WriteHandler(func() error {
if wsClient.conn != nil {
wsClient.conn.Close()
}
wsClient.conn = conn
wsClient.cancelFuncs = append(wsClient.cancelFuncs, pingCancel, pumpCancel)
return nil
})
go wsClient.startPingTicker(pingCtx)
go wsClient.writePump(pumpCtx, conn)
go wsClient.readPump(pumpCtx, conn)
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
})
wsClient.isConnected = true
return nil
}
func (wsClient *SafeWebsocketClient) reconnectHandler() {
backoff := 1 * time.Second
maxBackoff := 15 * time.Second
for {
select {
case <-wsClient.reconnectCh:
log.Println("Reconnect triggered")
wsClient.mu.WriteHandler(func() error {
if wsClient.cancelFuncs != nil {
for _, cancel := range wsClient.cancelFuncs {
cancel()
}
wsClient.cancelFuncs = nil
}
return nil
})
wsClient.isConnected = false
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 {
select {
case reconnectCh <- struct{}{}:
default: // prevent blocking if chan is full
}
}
if len(wsClient.reconnectChans) > 1 {
wsClient.reconnectChans = wsClient.reconnectChans[1:]
} else {
wsClient.reconnectChans = nil
}
}
case <-wsClient.ctx.Done():
log.Println("reconnect handler stopped due to client shutdown")
wsClient.Close()
return
}
}
}
func (wsClient *SafeWebsocketClient) writePump(ctx context.Context, c *websocket.Conn) {
defer func() {
c.Close()
}()
for {
select {
case <-ctx.Done():
log.Println("Writer canceled by context")
return
case data := <-wsClient.writeChan:
if err := c.SetWriteDeadline(time.Now().Add(writeDeadline)); err != nil {
log.Printf("error setting write deadline: %v", err)
return
}
if err := c.WriteMessage(int(data.MessageType), data.Data); err != nil {
log.Printf("error on write message: %v\n", err)
wsClient.triggerReconnect() // Trigger reconnect on write failure
return
}
}
}
}
func (wsClient *SafeWebsocketClient) readPump(ctx context.Context, c *websocket.Conn) {
defer func() {
wsClient.triggerReconnect()
c.Close()
}()
for {
select {
case <-ctx.Done():
log.Println("Reader canceled by context")
return
default:
// Set read deadline
if err := c.SetReadDeadline(time.Now().Add(readDeadline)); err != nil {
return
}
messageType, data, err := c.ReadMessage()
if err != nil {
log.Printf("error on read message: %v\n", err)
return
}
if messageType != websocket.TextMessage {
continue
}
select {
case wsClient.dataChannel <- data:
case <-ctx.Done():
return
default:
if wsClient.isDrop {
log.Println("Data channel full, dropping message")
}
}
}
}
}
func (wsClient *SafeWebsocketClient) startPingTicker(ctx context.Context) {
ticker := time.NewTicker(pingPeriod)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
log.Println("ping ticker canceled by context")
return
case <-ticker.C:
wsClient.writeChan <- Message{
MessageType: websocket.PingMessage,
Data: []byte{},
}
}
}
}
func (wsClient *SafeWebsocketClient) triggerReconnect() {
select {
case wsClient.reconnectCh <- struct{}{}:
default:
}
}
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) CloseDataChannel() {
close(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.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
close(wsClient.dataChannel)
return nil
}

View File

@@ -0,0 +1,60 @@
package main
import (
"context"
"fmt"
"log"
"os"
"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)
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).
Headers(map[string]string{
"X-MBX-APIKEY": "abcd",
}).Path("/ws/test/data_1").
UseTLS(false).
ChannelSize(1).
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))
}
}

View File

@@ -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
}

View File

@@ -1,26 +1,47 @@
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").
BasePort(8080).
ApiKey("abcd").
HandleFuncWebsocket("/ws/test/", "data_1", func(c chan []byte) {
ticker := time.NewTicker(100 * 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(100 * 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()

View File

@@ -1,26 +1,37 @@
package server
import (
"crypto/subtle"
"fmt"
"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"`
}
func NewSafeWebsocketServerBuilder() *SafeWebsocketServerBuilder {
h := internal.NewHub()
h.Run()
return &SafeWebsocketServerBuilder{
upgrader: &websocket.Upgrader{
ReadBufferSize: 1024,
@@ -43,19 +54,22 @@ func (b *SafeWebsocketServerBuilder) BasePort(basePort uint16) *SafeWebsocketSer
return b
}
func (b *SafeWebsocketServerBuilder) HandleFunc(
pattern string, fn func(http.ResponseWriter, *http.Request),
) *SafeWebsocketServerBuilder {
func (b *SafeWebsocketServerBuilder) ApiKey(apiKey string) *SafeWebsocketServerBuilder {
b.apiKey = &apiKey
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(
pattern string, subscribedPath string, writeFunc func(chan []byte),
) *SafeWebsocketServerBuilder {
func (b *SafeWebsocketServerBuilder) HandleFuncWebsocket(pattern string, subscribedPath string, writeFunc func(writeChannel chan []byte)) *SafeWebsocketServerBuilder {
h := internal.NewHub()
h.Run()
go writeFunc(h.Broadcast)
b.mux.HandleFunc(pattern+subscribedPath, func(w http.ResponseWriter, r *http.Request) {
conn, err := b.upgrader.Upgrade(w, r, nil)
if err != nil {
@@ -64,16 +78,16 @@ func (b *SafeWebsocketServerBuilder) HandleFuncWebsocket(
}
subscribedPath := strings.TrimPrefix(r.URL.Path, pattern)
fmt.Println(subscribedPath)
if subscribedPath == "" {
http.Error(w, "invalid path", http.StatusBadRequest)
return
}
c := internal.NewClient(conn, subscribedPath)
h.Register <- c
internal.WritePump(c, h)
internal.ReadPump(c)
writeFunc(h.Broadcast)
go internal.WritePump(c, h)
go internal.ReadPump(c, h)
})
return b
}
@@ -83,24 +97,41 @@ func (b *SafeWebsocketServerBuilder) Build() (*SafeWebsocketServer, error) {
return nil, err
}
setMaxRLimit()
safeServer := SafeWebsocketServer{
url: fmt.Sprintf("%s:%d", *b.baseHost, *b.basePort),
mux: b.mux,
mu: internal.NewCustomRwMutex(),
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
url string
mu *internal.CustomRwMutex
mux *http.ServeMux
url string
apiKey string
}
func (s *SafeWebsocketServer) AuthMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
providedKey := r.Header.Get("X-MBX-APIKEY")
expectedKey := s.apiKey
if subtle.ConstantTimeCompare([]byte(providedKey), []byte(expectedKey)) != 1 {
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