Compare commits

...

24 Commits

Author SHA1 Message Date
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
5 changed files with 283 additions and 186 deletions

7
go.mod
View File

@@ -4,4 +4,9 @@ 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
github.com/google/uuid v1.6.0
)
require git.neurocipta.com/rogerferdinan/safe-map v0.0.0-20251011004629-ab0b119a7c48

4
go.sum
View File

@@ -1,4 +1,8 @@
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/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=

View File

@@ -5,6 +5,7 @@ import (
"log"
"time"
"github.com/google/uuid"
"github.com/gorilla/websocket"
)
@@ -15,6 +16,7 @@ const (
)
type Client struct {
ID string
Conn *websocket.Conn
Send chan []byte
SubscribedPath string
@@ -23,10 +25,11 @@ type Client struct {
func NewClient(conn *websocket.Conn, subscribedPath string) *Client {
return &Client{
ID: uuid.NewString(),
Conn: conn,
Send: make(chan []byte, 64),
Send: make(chan []byte, 1),
SubscribedPath: subscribedPath,
done: make(chan struct{}),
done: make(chan struct{}, 1),
}
}
@@ -39,9 +42,9 @@ type Hub struct {
func NewHub() *Hub {
return &Hub{
Broadcast: make(chan []byte),
Register: make(chan *Client),
Unregister: make(chan *Client),
Broadcast: make(chan []byte, 1),
Register: make(chan *Client, 1),
Unregister: make(chan *Client, 1),
Clients: make(map[*Client]bool),
}
}
@@ -54,19 +57,21 @@ func (h *Hub) Run() {
h.Clients[client] = true
log.Println("Client registered")
case c := <-h.Unregister:
if _, ok := h.Clients[c]; ok {
if v, ok := h.Clients[c]; ok {
fmt.Println(v, c)
delete(h.Clients, c)
close(c.Send)
}
log.Println("Client Unregistered")
case message := <-h.Broadcast:
for client := range h.Clients {
select {
case client.Send <- message:
default:
close(client.Send)
delete(h.Clients, client)
}
client.Send <- message
// select {
// case client.Send <- message:
// default:
// close(client.Send)
// delete(h.Clients, client)
// }
}
}
}
@@ -87,15 +92,18 @@ func WritePump(c *Client, h *Hub) {
c.Conn.SetWriteDeadline(time.Now().Add(writeWait))
if !ok {
c.Conn.WriteMessage(websocket.CloseMessage, []byte{})
fmt.Println(ok)
return
}
if err := c.Conn.WriteMessage(websocket.TextMessage, message); err != nil {
fmt.Println(err)
return
}
case <-pingTicker.C:
c.Conn.SetWriteDeadline(time.Now().Add(writeWait))
if err := c.Conn.WriteMessage(websocket.PingMessage, []byte{}); err != nil {
fmt.Println(err)
return
}
}
@@ -108,7 +116,7 @@ func ReadPump(c *Client, h *Hub) {
c.Conn.Close()
}()
c.Conn.SetReadLimit(512)
c.Conn.SetReadLimit(1024)
c.Conn.SetReadDeadline(time.Now().Add(pongWait))
c.Conn.SetPongHandler(func(string) error {
c.Conn.SetReadDeadline(time.Now().Add(pongWait))
@@ -118,14 +126,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)
}
}
}

View File

@@ -6,72 +6,42 @@ import (
"log"
"net/url"
"strings"
"sync"
"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
pingPeriod = 10 * time.Second
readDeadline = 30 * time.Second
)
type SafeMap[K comparable, V any] struct {
m sync.Map
}
type MessageType uint
func NewSafeMap[K comparable, V any]() *SafeMap[K, V] {
return &SafeMap[K, V]{
m: sync.Map{},
}
}
const (
MessageTypeText MessageType = websocket.TextMessage
MessageTypePing MessageType = websocket.PingMessage
MessageTypePong MessageType = websocket.PongMessage
MessageTypeClose MessageType = websocket.CloseMessage
)
func (sm *SafeMap[K, V]) Store(key K, value V) {
sm.m.Store(key, value)
}
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 Message struct {
MessageType MessageType
Data []byte
}
type SafeWebsocketClientBuilder struct {
baseHost *string `nil_checker:"required"`
basePort *uint16 `nil_checker:"required"`
path *string
rawQuery *string
useTLS *bool
channelSize *int64
authenticateFn func() error
baseHost *string `nil_checker:"required"`
basePort *uint16 `nil_checker:"required"`
path *string
rawQuery *string
isDrop *bool
useTLS *bool
channelSize *int64
writeChannelSize *int64
}
func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder {
@@ -93,11 +63,6 @@ func (b *SafeWebsocketClientBuilder) UseTLS(useTLS bool) *SafeWebsocketClientBui
return b
}
func (b *SafeWebsocketClientBuilder) AuthenticateFn(authenticateFn func() error) *SafeWebsocketClientBuilder {
b.authenticateFn = authenticateFn
return b
}
func (b *SafeWebsocketClientBuilder) Path(path string) *SafeWebsocketClientBuilder {
b.path = &path
return b
@@ -108,19 +73,35 @@ func (b *SafeWebsocketClientBuilder) RawQuery(rawQuery string) *SafeWebsocketCli
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 = *b.useTLS
// 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 {
@@ -128,10 +109,16 @@ func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketC
b.channelSize = &channelSize
}
if b.writeChannelSize == nil {
writeChannelSize := int64(1)
b.writeChannelSize = &writeChannelSize
}
wsClient := SafeWebsocketClient{
baseHost: *b.baseHost,
basePort: *b.basePort,
useTLS: useTLS,
useTLS: *b.useTLS,
isDrop: *b.isDrop,
path: b.path,
rawQuery: b.rawQuery,
dataChannel: make(chan []byte, *b.channelSize),
@@ -139,11 +126,8 @@ func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketC
ctx: ctx,
reconnectCh: make(chan struct{}, 1),
isConnected: false,
doneMap: NewSafeMap[string, chan struct{}](),
}
if b.authenticateFn != nil {
wsClient.authenticateFn = b.authenticateFn
doneMap: safemap.NewSafeMap[string, chan struct{}](),
writeChan: make(chan Message, *b.writeChannelSize),
}
go wsClient.reconnectHandler()
@@ -156,21 +140,26 @@ func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketC
}
type SafeWebsocketClient struct {
baseHost string
basePort uint16
useTLS bool
path *string
rawQuery *string
dataChannel chan []byte
mu *custom_rwmutex.CustomRwMutex
conn *websocket.Conn
cancelFuncs []context.CancelFunc
ctx context.Context
baseHost string
basePort uint16
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[string, chan struct{}]
authenticateFn func() error
doneMap *safemap.SafeMap[string, chan struct{}]
writeChan chan Message
pongChan chan error
}
func (wsClient *SafeWebsocketClient) connect() error {
@@ -198,42 +187,159 @@ 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
})
go wsClient.startPingTicker(pingCtx)
if wsClient.conn != nil {
wsClient.conn.Close()
}
wsClient.conn = conn
wsClient.isConnected = true
if err := wsClient.authenticateFn(); err != nil {
return err
}
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
}
func (wsClient *SafeWebsocketClient) writePump() {
ctx, cancel := context.WithCancel(context.Background())
wsClient.mu.WriteHandler(func() error {
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)
wsClient.cancelFuncs = append(wsClient.cancelFuncs, cancel)
return nil
})
return nil
var c *websocket.Conn
wsClient.mu.ReadHandler(func() error {
c = wsClient.conn
return nil
})
for {
select {
case <-ctx.Done():
log.Println("Writer canceled by context")
return
case data := <-wsClient.writeChan:
if c == nil {
return
}
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
}
}
}
}
func (wsClient *SafeWebsocketClient) readPump() {
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 = wsClient.conn
return nil
})
if wsClient.isDrop {
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
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) {
@@ -243,52 +349,12 @@ func (wsClient *SafeWebsocketClient) startPingTicker(ctx context.Context) {
for {
select {
case <-ctx.Done():
log.Println("ping ticker stopped")
log.Println("ping ticker canceled by context")
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")
default:
log.Println("Data channel full, dropping message")
}
return nil
}); err != nil {
return
wsClient.writeChan <- Message{
MessageType: websocket.PingMessage,
Data: []byte{},
}
}
}
@@ -308,13 +374,17 @@ func (wsClient *SafeWebsocketClient) reconnectHandler() {
select {
case <-wsClient.reconnectCh:
log.Println("Reconnect triggered")
if wsClient.cancelFuncs != nil {
for _, cancel := range wsClient.cancelFuncs {
cancel()
wsClient.mu.ReadHandler(func() error {
if wsClient.cancelFuncs != nil {
for _, cancel := range wsClient.cancelFuncs {
cancel()
}
}
}
return nil
})
wsClient.isConnected = false
time.Sleep(100 * time.Millisecond)
isInnerLoop := true
for isInnerLoop {
@@ -333,6 +403,8 @@ func (wsClient *SafeWebsocketClient) reconnectHandler() {
isInnerLoop = false
continue
case <-wsClient.ctx.Done():
log.Println("reconnect handler stopped due to client shutdown")
wsClient.Close()
return
}
}
@@ -350,7 +422,7 @@ func (wsClient *SafeWebsocketClient) reconnectHandler() {
}
func (wsClient *SafeWebsocketClient) ReconnectChannel() <-chan struct{} {
reconnectCh := make(chan struct{})
reconnectCh := make(chan struct{}, 1)
wsClient.mu.WriteHandler(func() error {
wsClient.reconnectChans = append(wsClient.reconnectChans, reconnectCh)
return nil
@@ -363,31 +435,37 @@ func (wsClient *SafeWebsocketClient) DataChannel() <-chan []byte {
return wsClient.dataChannel
}
func (wsClient *SafeWebsocketClient) WriteJSON(message any) error {
return wsClient.mu.WriteHandler(func() error {
return wsClient.conn.WriteJSON(message)
})
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.WriteHandler(func() error {
wsClient.mu.ReadHandler(func() error {
if wsClient.cancelFuncs != nil {
for _, cancel := range wsClient.cancelFuncs {
cancel()
}
}
if wsClient.reconnectChans != nil {
for _, reconnectChan := range wsClient.reconnectChans {
close(reconnectChan)
}
}
if wsClient.conn != nil {
wsClient.conn.Close()
}
wsClient.isConnected = false
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

@@ -29,20 +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")
}
}()
// go func() {
// for range wsClient.ReconnectChannel() {
// fmt.Println("Reconnection Success")
// }
// }()
dataChannel := wsClient.DataChannel()
for data := range dataChannel {
// _ = data
fmt.Println(string(data))
}
}