Compare commits

...

4 Commits

9 changed files with 251 additions and 113 deletions

15
go.mod
View File

@@ -4,6 +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 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 // indirect 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
)

9
go.sum
View File

@@ -2,5 +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/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 h1:4wXSbEuwFd2gycaaGP35bjUkKEEO6WcVfJ6cetEyT5s=
git.neurocipta.com/rogerferdinan/safe-map v0.0.0-20251011004629-ab0b119a7c48/go.mod h1:QtIxG0BYCCq8a5qyklpSHA8qWUvKr+mfl42qF9QxTc0= 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

@@ -1,9 +1,11 @@
package internal package internal
import ( import (
"fmt"
"log" "log"
"time" "time"
"github.com/google/uuid"
"github.com/gorilla/websocket" "github.com/gorilla/websocket"
) )
@@ -14,6 +16,7 @@ const (
) )
type Client struct { type Client struct {
ID string
Conn *websocket.Conn Conn *websocket.Conn
Send chan []byte Send chan []byte
SubscribedPath string SubscribedPath string
@@ -22,8 +25,9 @@ type Client struct {
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, 2), Send: make(chan []byte, 1),
SubscribedPath: subscribedPath, SubscribedPath: subscribedPath,
done: make(chan struct{}, 1), done: make(chan struct{}, 1),
} }
@@ -41,7 +45,7 @@ func NewHub() *Hub {
Broadcast: make(chan []byte, 1), Broadcast: make(chan []byte, 1),
Register: make(chan *Client, 1), Register: make(chan *Client, 1),
Unregister: make(chan *Client, 1), Unregister: make(chan *Client, 1),
Clients: make(map[*Client]bool, 0), Clients: make(map[*Client]bool),
} }
} }
@@ -53,19 +57,21 @@ func (h *Hub) Run() {
h.Clients[client] = true h.Clients[client] = true
log.Println("Client registered") log.Println("Client registered")
case c := <-h.Unregister: 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) delete(h.Clients, c)
close(c.Send) close(c.Send)
} }
log.Println("Client Unregistered") log.Println("Client Unregistered")
case message := <-h.Broadcast: case message := <-h.Broadcast:
for client := range h.Clients { for client := range h.Clients {
select { client.Send <- message
case client.Send <- message: // select {
default: // case client.Send <- message:
close(client.Send) // default:
delete(h.Clients, client) // close(client.Send)
} // delete(h.Clients, client)
// }
} }
} }
} }
@@ -86,15 +92,18 @@ func WritePump(c *Client, h *Hub) {
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{})
fmt.Println(ok)
return return
} }
if err := c.Conn.WriteMessage(websocket.TextMessage, message); err != nil { if err := c.Conn.WriteMessage(websocket.TextMessage, message); err != nil {
fmt.Println(err)
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, []byte{}); err != nil {
fmt.Println(err)
return return
} }
} }
@@ -107,7 +116,7 @@ func ReadPump(c *Client, h *Hub) {
c.Conn.Close() c.Conn.Close()
}() }()
c.Conn.SetReadLimit(512) c.Conn.SetReadLimit(1024)
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))

View File

@@ -4,6 +4,7 @@ import (
"context" "context"
"fmt" "fmt"
"log" "log"
"net/http"
"net/url" "net/url"
"strings" "strings"
"time" "time"
@@ -34,13 +35,15 @@ type Message struct {
} }
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
isDrop *bool rawQuery *string
useTLS *bool isDrop *bool
channelSize *int64 useTLS *bool
channelSize *int64
writeChannelSize *int64
} }
func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder { func NewSafeWebsocketClientBuilder() *SafeWebsocketClientBuilder {
@@ -57,6 +60,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
@@ -82,6 +90,11 @@ func (b *SafeWebsocketClientBuilder) ChannelSize(channelSize int64) *SafeWebsock
return b return b
} }
func (b *SafeWebsocketClientBuilder) WriteChannelSize(writeChannelSize int64) *SafeWebsocketClientBuilder {
b.writeChannelSize = &writeChannelSize
return b
}
func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketClient, error) { 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
@@ -103,9 +116,15 @@ func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketC
b.channelSize = &channelSize 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,
headers: b.headers,
useTLS: *b.useTLS, useTLS: *b.useTLS,
isDrop: *b.isDrop, isDrop: *b.isDrop,
path: b.path, path: b.path,
@@ -116,7 +135,7 @@ func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketC
reconnectCh: make(chan struct{}, 1), reconnectCh: make(chan struct{}, 1),
isConnected: false, isConnected: false,
doneMap: safemap.NewSafeMap[string, chan struct{}](), doneMap: safemap.NewSafeMap[string, chan struct{}](),
writeChan: make(chan Message, 1), writeChan: make(chan Message, *b.writeChannelSize),
} }
go wsClient.reconnectHandler() go wsClient.reconnectHandler()
@@ -131,6 +150,8 @@ func (b *SafeWebsocketClientBuilder) Build(ctx context.Context) (*SafeWebsocketC
type SafeWebsocketClient struct { type SafeWebsocketClient struct {
baseHost string baseHost string
basePort uint16 basePort uint16
headers *map[string]string
isDrop bool isDrop bool
useTLS bool useTLS bool
path *string path *string
@@ -171,7 +192,16 @@ func (wsClient *SafeWebsocketClient) connect() error {
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 {
fmt.Println(k, v)
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)
} }
@@ -193,19 +223,19 @@ func (wsClient *SafeWebsocketClient) connect() error {
go wsClient.writePump() go wsClient.writePump()
go wsClient.readPump() go wsClient.readPump()
conn.SetPingHandler(func(pingData string) error { // conn.SetPingHandler(func(pingData string) error {
wsClient.writeChan <- Message{ // wsClient.writeChan <- Message{
MessageType: MessageTypePong, // MessageType: MessageTypePong,
Data: []byte(pingData), // Data: []byte(pingData),
} // }
select { // select {
case err := <-wsClient.pongChan: // case err := <-wsClient.pongChan:
return err // return err
default: // default:
} // }
return nil // return nil
}) // })
return nil return nil
} }
@@ -257,78 +287,43 @@ func (wsClient *SafeWebsocketClient) readPump() {
return nil 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 { select {
case wsClient.dataChannel <- data:
case <-ctx.Done(): case <-ctx.Done():
log.Println("Reader canceled by context")
return return
default: 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") 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) { func (wsClient *SafeWebsocketClient) startPingTicker(ctx context.Context) {
@@ -374,7 +369,6 @@ func (wsClient *SafeWebsocketClient) reconnectHandler() {
}) })
wsClient.isConnected = false wsClient.isConnected = false
// time.Sleep(100 * time.Millisecond)
isInnerLoop := true isInnerLoop := true
for isInnerLoop { for isInnerLoop {

View File

@@ -27,9 +27,11 @@ func main() {
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).
ChannelSize(30). ChannelSize(1).
Build(ctx) Build(ctx)
if err != nil { if err != nil {
log.Fatal(err) log.Fatal(err)
@@ -44,7 +46,7 @@ func main() {
dataChannel := wsClient.DataChannel() dataChannel := wsClient.DataChannel()
for data := range dataChannel { for data := range dataChannel {
// _ = data _ = data
fmt.Println(string(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,6 +17,7 @@ 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(10 * time.Millisecond)
for range ticker.C { for range ticker.C {

View File

@@ -5,14 +5,27 @@ import (
"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 +53,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()
@@ -79,22 +93,36 @@ 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) {
if r.Header.Get("X-MBX-APIKEY") != s.apiKey {
internal.ErrorResponse(w, internal.NewStatusMessage().
StatusCode(http.StatusForbidden).
Message("X-MBX-APIKEY is missing").
Build())
}
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