Compare commits

...

38 Commits

Author SHA1 Message Date
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
9 changed files with 531 additions and 176 deletions

15
go.mod
View File

@@ -4,4 +4,17 @@ go 1.24.5
require github.com/gorilla/websocket v1.5.3 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
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
)

11
go.sum
View File

@@ -1,4 +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 h1:KnNc40SrYsg0cksIIcQy/ca6bunkGADQOs1u7O/E+iY=
git.neurocipta.com/rogerferdinan/custom-rwmutex v1.0.0/go.mod h1:9DvvHc2UZhBwEs63NgO4IhiuHnBNtTuBkTJgiMnnCss= 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 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= 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,30 +3,35 @@ package internal
import ( import (
"fmt" "fmt"
"log" "log"
"sync"
"time" "time"
"github.com/google/uuid"
"github.com/gorilla/websocket" "github.com/gorilla/websocket"
) )
const ( const (
writeWait = 10 * time.Second writeWait = 10 * time.Second
pongWait = 60 * time.Second pongWait = 60 * time.Second
pingPeriod = 25 * time.Second pingPeriod = (pongWait * 9) / 10
maxMessageSize = 512
) )
type Client struct { type Client struct {
ID string
Conn *websocket.Conn Conn *websocket.Conn
Send chan []byte Send chan []byte
SubscribedPath string SubscribedPath string
done chan struct{} mu sync.Mutex
} }
func NewClient(conn *websocket.Conn, subscribedPath string) *Client { func NewClient(conn *websocket.Conn, subscribedPath string) *Client {
return &Client{ return &Client{
ID: uuid.NewString(),
Conn: conn, Conn: conn,
Send: make(chan []byte, 64), Send: make(chan []byte, 256),
SubscribedPath: subscribedPath, SubscribedPath: subscribedPath,
done: make(chan struct{}), mu: sync.Mutex{},
} }
} }
@@ -39,9 +44,9 @@ type Hub struct {
func NewHub() *Hub { func NewHub() *Hub {
return &Hub{ return &Hub{
Broadcast: make(chan []byte), Broadcast: make(chan []byte, 256),
Register: make(chan *Client), Register: make(chan *Client, 10),
Unregister: make(chan *Client), Unregister: make(chan *Client, 10),
Clients: make(map[*Client]bool), Clients: make(map[*Client]bool),
} }
} }
@@ -52,13 +57,13 @@ func (h *Hub) Run() {
select { select {
case client := <-h.Register: case client := <-h.Register:
h.Clients[client] = true h.Clients[client] = true
log.Println("Client registered") log.Printf("Client registered %s\n", client.ID)
case c := <-h.Unregister: case client := <-h.Unregister:
if _, ok := h.Clients[c]; ok { if _, ok := h.Clients[client]; ok {
delete(h.Clients, c) delete(h.Clients, client)
close(c.Send) close(client.Send)
} }
log.Println("Client Unregistered") log.Printf("Client Unregistered %s\n", client.ID)
case message := <-h.Broadcast: case message := <-h.Broadcast:
for client := range h.Clients { for client := range h.Clients {
select { select {
@@ -66,6 +71,7 @@ func (h *Hub) Run() {
default: default:
close(client.Send) close(client.Send)
delete(h.Clients, client) delete(h.Clients, client)
log.Printf("Client %s removed (slow/disconnected)", client.ID)
} }
} }
} }
@@ -85,20 +91,36 @@ func WritePump(c *Client, h *Hub) {
select { select {
case message, ok := <-c.Send: case message, ok := <-c.Send:
c.Conn.SetWriteDeadline(time.Now().Add(writeWait)) c.Conn.SetWriteDeadline(time.Now().Add(writeWait))
if !ok { if !ok {
c.Conn.WriteMessage(websocket.CloseMessage, []byte{}) c.Conn.WriteMessage(websocket.CloseMessage, []byte{})
return return
} }
if err := c.Conn.WriteMessage(websocket.TextMessage, message); err != nil { w, err := c.Conn.NextWriter(websocket.TextMessage)
if err != nil {
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)
}
if err := w.Close(); err != nil {
return return
} }
case <-pingTicker.C: case <-pingTicker.C:
c.Conn.SetWriteDeadline(time.Now().Add(writeWait)) c.Conn.SetWriteDeadline(time.Now().Add(writeWait))
if err := c.Conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
if err := c.Conn.WriteMessage(websocket.PingMessage, nil); err != nil {
fmt.Println(err)
return return
} }
} }
} }
} }
@@ -108,24 +130,23 @@ func ReadPump(c *Client, h *Hub) {
c.Conn.Close() c.Conn.Close()
}() }()
c.Conn.SetReadLimit(512) c.Conn.SetReadLimit(maxMessageSize)
c.Conn.SetReadDeadline(time.Now().Add(pongWait)) c.Conn.SetReadDeadline(time.Now().Add(pongWait))
c.Conn.SetPongHandler(func(string) error { c.Conn.SetPongHandler(func(string) error {
c.Conn.SetReadDeadline(time.Now().Add(pongWait)) c.Conn.SetReadDeadline(time.Now().Add(pongWait))
return nil return nil
}) })
for { for {
messageType, message, err := c.Conn.ReadMessage() _, message, err := c.Conn.ReadMessage()
if err != nil { 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) log.Printf("WebSocket error: %v", err)
} }
break break
} }
if messageType == websocket.TextMessage { log.Printf("Received: %s\n", message)
fmt.Printf("Received: %s\n", message)
}
} }
} }

View File

@@ -4,72 +4,47 @@ import (
"context" "context"
"fmt" "fmt"
"log" "log"
"net/http"
"net/url" "net/url"
"strings" "strings"
"sync"
"time" "time"
custom_rwmutex "git.neurocipta.com/rogerferdinan/custom-rwmutex" custom_rwmutex "git.neurocipta.com/rogerferdinan/custom-rwmutex"
safemap "git.neurocipta.com/rogerferdinan/safe-map"
"git.neurocipta.com/rogerferdinan/safe-web-socket/internal" "git.neurocipta.com/rogerferdinan/safe-web-socket/internal"
"github.com/gorilla/websocket" "github.com/gorilla/websocket"
) )
const ( const (
pingPeriod = 10 * time.Second pingPeriod = 10 * time.Second
readDeadline = 30 * time.Second
writeDeadline = 10 * time.Second
) )
type SafeMap[K comparable, V any] struct { type MessageType uint
m sync.Map
}
func NewSafeMap[K comparable, V any]() *SafeMap[K, V] { const (
return &SafeMap[K, V]{ MessageTypeText MessageType = websocket.TextMessage
m: sync.Map{}, MessageTypePing MessageType = websocket.PingMessage
} MessageTypePong MessageType = websocket.PongMessage
} MessageTypeClose MessageType = websocket.CloseMessage
)
func (sm *SafeMap[K, V]) Store(key K, value V) { type Message struct {
sm.m.Store(key, value) MessageType MessageType
} Data []byte
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 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 headers *map[string]string
rawQuery *string path *string
useTLS *bool rawQuery *string
isDrop *bool
useTLS *bool
channelSize *int64
writeChannelSize *int64
} }
func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder { func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder {
@@ -86,6 +61,11 @@ func (b *SafeWebsocketClientBuilder) BasePort(port uint16) *SafeWebsocketClientB
return b return b
} }
func (b *SafeWebsocketClientBuilder) Headers(headers map[string]string) *SafeWebsocketClientBuilder {
b.headers = &headers
return b
}
func (b *SafeWebsocketClientBuilder) UseTLS(useTLS bool) *SafeWebsocketClientBuilder { func (b *SafeWebsocketClientBuilder) UseTLS(useTLS bool) *SafeWebsocketClientBuilder {
b.useTLS = &useTLS b.useTLS = &useTLS
return b return b
@@ -101,29 +81,66 @@ func (b *SafeWebsocketClientBuilder) RawQuery(rawQuery string) *SafeWebsocketCli
return b return b
} }
func (b *SafeWebsocketClientBuilder) Build() (*SafeWebsocketClient, error) { 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 { if err := internal.NilChecker(b); err != nil {
return nil, err return nil, err
} }
var useTLS bool // var useTLS bool
if b.useTLS != nil { if b.useTLS == nil {
useTLS = *b.useTLS 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{ wsClient := SafeWebsocketClient{
baseHost: *b.baseHost, baseHost: *b.baseHost,
basePort: *b.basePort, basePort: *b.basePort,
useTLS: useTLS, headers: b.headers,
useTLS: *b.useTLS,
isDrop: *b.isDrop,
path: b.path, path: b.path,
rawQuery: b.rawQuery, rawQuery: b.rawQuery,
dataChannel: make(chan []byte, 1), dataChannel: make(chan []byte, *b.channelSize),
mu: custom_rwmutex.NewCustomRwMutex(), mu: custom_rwmutex.NewCustomRwMutex(),
ctx: ctx,
reconnectCh: make(chan struct{}, 1), reconnectCh: make(chan struct{}, 1),
isConnected: false, isConnected: false,
doneMap: NewSafeMap[string, chan struct{}](), doneMap: safemap.NewSafeMap[string, chan struct{}](),
writeChan: make(chan Message, *b.writeChannelSize),
} }
go wsClient.reconnectHandler()
if err := wsClient.connect(); err != nil { if err := wsClient.connect(); err != nil {
return nil, fmt.Errorf("failed to establish initial connection: %v", err) return nil, fmt.Errorf("failed to establish initial connection: %v", err)
} }
@@ -132,20 +149,27 @@ func (b *SafeWebsocketClientBuilder) Build() (*SafeWebsocketClient, error) {
} }
type SafeWebsocketClient struct { type SafeWebsocketClient struct {
baseHost string baseHost string
basePort uint16 basePort uint16
useTLS bool headers *map[string]string
path *string
rawQuery *string isDrop bool
dataChannel chan []byte useTLS bool
path *string
rawQuery *string
mu *custom_rwmutex.CustomRwMutex mu *custom_rwmutex.CustomRwMutex
conn *websocket.Conn conn *websocket.Conn
ctx context.Context ctx context.Context
cancel context.CancelFunc cancelFuncs []context.CancelFunc
reconnectCh chan struct{} dataChannel chan []byte
isConnected bool
doneMap *SafeMap[string, chan struct{}] reconnectCh chan struct{}
reconnectChans []chan struct{}
isConnected bool
doneMap *safemap.SafeMap[string, chan struct{}]
writeChan chan Message
} }
func (wsClient *SafeWebsocketClient) connect() error { func (wsClient *SafeWebsocketClient) connect() error {
@@ -159,100 +183,205 @@ func (wsClient *SafeWebsocketClient) connect() error {
Scheme: scheme, Scheme: scheme,
Host: fmt.Sprintf("%s:%d", wsClient.baseHost, wsClient.basePort), Host: fmt.Sprintf("%s:%d", wsClient.baseHost, wsClient.basePort),
} }
if wsClient.path != nil && strings.TrimSpace(*wsClient.path) != "" { if wsClient.path != nil && strings.TrimSpace(*wsClient.path) != "" {
newURL.Path = *wsClient.path newURL.Path = *wsClient.path
} }
if wsClient.rawQuery != nil && strings.TrimSpace(*wsClient.rawQuery) != "" { if wsClient.rawQuery != nil && strings.TrimSpace(*wsClient.rawQuery) != "" {
newURL.RawQuery = *wsClient.rawQuery 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 { if err != nil {
return fmt.Errorf("failed to connect to %s: %w", wsClient.baseHost, err) return fmt.Errorf("failed to connect to %s: %w", wsClient.baseHost, err)
} }
conn.SetPingHandler(func(pingData string) error { pingCtx, pingCancel := context.WithCancel(context.Background())
return wsClient.mu.WriteHandler(func() error { pumpCtx, pumpCancel := context.WithCancel(context.Background())
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.mu.WriteHandler(func() error {
wsClient.conn.Close() if wsClient.conn != nil {
ctx, cancel := context.WithCancel(context.Background()) wsClient.conn.Close()
wsClient.ctx = ctx }
wsClient.cancel = cancel
wsClient.conn = conn
wsClient.isConnected = true
wsClient.conn = conn
wsClient.cancelFuncs = append(wsClient.cancelFuncs, pingCancel, pumpCancel)
return nil return nil
}) })
go wsClient.startPingTicker() go wsClient.startPingTicker(pingCtx)
go wsClient.startReceiveHandler() go wsClient.writePump(pumpCtx, conn)
go wsClient.reconnectHandler() 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 return nil
} }
func (wsClient *SafeWebsocketClient) startPingTicker() { func (wsClient *SafeWebsocketClient) reconnectHandler() {
ticker := time.NewTicker(pingPeriod) backoff := 1 * time.Second
defer ticker.Stop() maxBackoff := 15 * time.Second
doneKey := "startPingTicker"
wsClient.doneMap.Store(doneKey, make(chan struct{}))
done, _ := wsClient.doneMap.Load(doneKey)
for { for {
select { select {
case <-ticker.C: case <-wsClient.reconnectCh:
log.Println("Reconnect triggered")
wsClient.mu.WriteHandler(func() error { wsClient.mu.WriteHandler(func() error {
if err := wsClient.conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil { if wsClient.cancelFuncs != nil {
log.Printf("Ping failed: %v. Will attempt reconnect.", err) for _, cancel := range wsClient.cancelFuncs {
wsClient.triggerReconnect() cancel()
}
wsClient.cancelFuncs = nil
} }
return nil return nil
}) })
case <-done:
log.Println("Ping ticker stopped") 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
}
}
}
case <-wsClient.ctx.Done():
log.Println("reconnect handler stopped due to client shutdown")
wsClient.Close()
return return
} }
} }
} }
func (wsClient *SafeWebsocketClient) startReceiveHandler() { func (wsClient *SafeWebsocketClient) writePump(ctx context.Context, c *websocket.Conn) {
doneKey := "startReceiveHandler" defer func() {
wsClient.doneMap.Store(doneKey, make(chan struct{})) c.Close()
done, _ := wsClient.doneMap.Load(doneKey) }()
for { for {
select { select {
case <-done: case <-ctx.Done():
log.Println("Reconnect handler stopped") 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 return
default: default:
conn := wsClient.conn // Set read deadline
if err := c.SetReadDeadline(time.Now().Add(readDeadline)); err != nil {
return
}
if conn == nil { messageType, data, err := c.ReadMessage()
wsClient.triggerReconnect()
return
}
_, message, err := conn.ReadMessage()
if err != nil { if err != nil {
wsClient.triggerReconnect() log.Printf("error on read message: %v\n", err)
return return
} }
wsClient.dataChannel <- message
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{},
}
} }
} }
} }
@@ -264,26 +393,52 @@ func (wsClient *SafeWebsocketClient) triggerReconnect() {
} }
} }
func (wsClient *SafeWebsocketClient) reconnectHandler() { func (wsClient *SafeWebsocketClient) ReconnectChannel() <-chan struct{} {
doneKey := "reconnectHandler" reconnectCh := make(chan struct{}, 1)
wsClient.doneMap.Store(doneKey, make(chan struct{})) wsClient.mu.WriteHandler(func() error {
done, _ := wsClient.doneMap.Load(doneKey) wsClient.reconnectChans = append(wsClient.reconnectChans, reconnectCh)
for { return nil
select { })
case <-wsClient.reconnectCh:
wsClient.cancel()
wsClient.connect()
wsClient.doneMap.Range(func(s string, c chan struct{}) bool { return reconnectCh
c <- struct{}{}
return true
})
case <-done:
return
}
}
} }
func (wsClient *SafeWebsocketClient) DataChannel() <-chan []byte { func (wsClient *SafeWebsocketClient) DataChannel() <-chan []byte {
return wsClient.dataChannel 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

@@ -1,25 +1,60 @@
package main package main
import ( import (
"context"
"fmt" "fmt"
"log" "log"
"os"
"os/signal"
"syscall"
"net/http"
_ "net/http/pprof"
"git.neurocipta.com/rogerferdinan/safe-web-socket/v1/client" "git.neurocipta.com/rogerferdinan/safe-web-socket/v1/client"
) )
func main() { 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(). wsClient, err := client.NewSafeWebsocketClientBuilder().
BaseHost("localhost"). BaseHost("localhost").
BasePort(8080). BasePort(8080).
Path("/ws/test/data_1"). Headers(map[string]string{
"X-MBX-APIKEY": "abcd",
}).Path("/ws/test/data_1").
UseTLS(false). UseTLS(false).
Build() ChannelSize(1).
Build(ctx)
if err != nil { if err != nil {
log.Fatal(err) log.Fatal(err)
} }
go func() {
for range wsClient.ReconnectChannel() {
fmt.Println("Reconnection Success")
}
}()
dataChannel := wsClient.DataChannel() dataChannel := wsClient.DataChannel()
for data := range dataChannel { for data := range dataChannel {
fmt.Println(string(data)) _ = 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

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

View File

@@ -1,18 +1,32 @@
package server package server
import ( import (
"crypto/subtle"
"fmt" "fmt"
"log" "log"
"net/http" "net/http"
"strings" "strings"
"syscall"
"git.neurocipta.com/rogerferdinan/safe-web-socket/internal" "git.neurocipta.com/rogerferdinan/safe-web-socket/internal"
"github.com/gorilla/websocket" "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 { type SafeWebsocketServerBuilder struct {
baseHost *string `nil_checker:"required"` baseHost *string `nil_checker:"required"`
basePort *uint16 `nil_checker:"required"` basePort *uint16 `nil_checker:"required"`
apiKey *string `nil_checker:"required"`
upgrader *websocket.Upgrader `nil_checker:"required"` upgrader *websocket.Upgrader `nil_checker:"required"`
mux *http.ServeMux `nil_checker:"required"` mux *http.ServeMux `nil_checker:"required"`
} }
@@ -40,16 +54,17 @@ func (b *SafeWebsocketServerBuilder) BasePort(basePort uint16) *SafeWebsocketSer
return b 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) b.mux.HandleFunc(pattern, fn)
return b 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 := internal.NewHub()
h.Run() h.Run()
@@ -67,6 +82,7 @@ func (b *SafeWebsocketServerBuilder) HandleFuncWebsocket(
} }
c := internal.NewClient(conn, subscribedPath) c := internal.NewClient(conn, subscribedPath)
h.Register <- c h.Register <- c
go internal.WritePump(c, h) go internal.WritePump(c, h)
go internal.ReadPump(c, h) go internal.ReadPump(c, h)
go writeFunc(h.Broadcast) go writeFunc(h.Broadcast)
@@ -79,22 +95,41 @@ func (b *SafeWebsocketServerBuilder) Build() (*SafeWebsocketServer, error) {
return nil, err return nil, err
} }
setMaxRLimit()
safeServer := SafeWebsocketServer{ 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 return &safeServer, nil
} }
type SafeWebsocketServer struct { 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) {
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 { func (s *SafeWebsocketServer) ListenAndServe() error {
log.Printf("HTTP serve on %s\n", s.url) 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 fmt.Errorf("failed to serve websocket: %w", err)
} }
return nil return nil