d0zingcat/gocryptotrader
1
0
Fork 0
mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-06-03 15:10:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Websocket: Restructure files and types (#1859)

Browse Source 
* Websocket: Rename stream package

* Websocket: Rename Websocket to Manager

* Websocket: Replace explicit errs with common.NilGuard

* Websocket: Move websocket_types.go to types.go

* Websocket: Minor field comment and alignment in types

* Webosocket: Rename WebsocketConnection to Connection

* Alphapoint: Make gorilla ws import explicit

Just to avoid confusion with our own packages.

* Websocket: Move stream_match to match

* Websocket: Move websocket_connection to connection

* Websocket: Move websocket.go to manager.go

* Websocket: Break out all subscription methods into subscriptions.go

* Websocket: Move connection type into its file

* Websocket: Remove PositionUpdated

Type is not used anywhere

* Kraken: Use local constant for pong

Was the only use of websocket.Pong and doesn't really feel right to
represent kraken's api resp in one of our packages

* Websocket: Move connection sub-types to connection package

* Websocket: Move manager types into manager

* Websocket: Move ConnectionWrapper into manager

* Websocket: Move websocket_test to manager_test

* Websocket: Privatise connectionWrapper

* Websocket: Remaining types into types.go

These really belong somewhere else mostly, but this will do for now

* Websocket: Tidy up connection method vars

* Gofumpt: Moving package imports around

* Websocket: Rename errDuplicateConnectionSetup

* Websocket: Fix duplicate import of gws

* Websocket: Fix gofumpt -extra

* Websocket: Standardise import of gws across other pkgs

* Kraken: Remove unused sub conf consts

These were replaced by the generic Levels and Depth fields on all subs

* Websocket: Privitise ConnectioWrapper fields

* Websocket: inline single use var WebsocketNotAuthenticatedUsingRest

* Websocket: Move documentation to template

* Bithumb: Assertify TestWsHandleData
This commit is contained in:
Gareth Kirwan
2025-04-10 08:25:02 +02:00
committed by GitHub
parent 676b2e0367
commit b4e45e9a1b
119 changed files with 3169 additions and 3056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
exchanges/binance/binance_test.go
View File

@@ -10,7 +10,7 @@ import (
"testing"
"time"
"github.com/gorilla/websocket"
gws "github.com/gorilla/websocket"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/thrasher-corp/gocryptotrader/common"
@@ -1984,12 +1984,12 @@ func TestSubscribe(t *testing.T) {
require.NoError(t, err, "generateSubscriptions must not error")
if mockTests {
exp := []string{"btcusdt@depth@100ms", "btcusdt@kline_1m", "btcusdt@ticker", "btcusdt@trade", "dogeusdt@depth@100ms", "dogeusdt@kline_1m", "dogeusdt@ticker", "dogeusdt@trade"}
mock := func(tb testing.TB, msg []byte, w *websocket.Conn) error {
mock := func(tb testing.TB, msg []byte, w *gws.Conn) error {
tb.Helper()
var req WsPayload
require.NoError(tb, json.Unmarshal(msg, &req), "Unmarshal should not error")
require.ElementsMatch(tb, req.Params, exp, "Params should have correct channels")
return w.WriteMessage(websocket.TextMessage, fmt.Appendf(nil, `{"result":null,"id":%d}`, req.ID))
return w.WriteMessage(gws.TextMessage, fmt.Appendf(nil, `{"result":null,"id":%d}`, req.ID))
}
b = testexch.MockWsInstance[Binance](t, mockws.CurryWsMockUpgrader(t, mock))
} else {
@@ -2006,12 +2006,12 @@ func TestSubscribeBadResp(t *testing.T) {
channels := subscription.List{
{Channel: "moons@ticker"},
}
mock := func(tb testing.TB, msg []byte, w *websocket.Conn) error {
mock := func(tb testing.TB, msg []byte, w *gws.Conn) error {
tb.Helper()
var req WsPayload
err := json.Unmarshal(msg, &req)
require.NoError(tb, err, "Unmarshal should not error")
return w.WriteMessage(websocket.TextMessage, fmt.Appendf(nil, `{"result":{"error":"carrots"},"id":%d}`, req.ID))
return w.WriteMessage(gws.TextMessage, fmt.Appendf(nil, `{"result":{"error":"carrots"},"id":%d}`, req.ID))
}
b := testexch.MockWsInstance[Binance](t, mockws.CurryWsMockUpgrader(t, mock)) //nolint:govet // Intentional shadow to avoid future copy/paste mistakes
err := b.Subscribe(channels)

22
exchanges/binance/binance_websocket.go
View File

@@ -11,7 +11,7 @@ import (
"time"
"github.com/buger/jsonparser"
"github.com/gorilla/websocket"
gws "github.com/gorilla/websocket"
"github.com/thrasher-corp/gocryptotrader/common"
"github.com/thrasher-corp/gocryptotrader/currency"
"github.com/thrasher-corp/gocryptotrader/encoding/json"
@@ -19,10 +19,10 @@ import (
"github.com/thrasher-corp/gocryptotrader/exchanges/order"
"github.com/thrasher-corp/gocryptotrader/exchanges/orderbook"
"github.com/thrasher-corp/gocryptotrader/exchanges/request"
"github.com/thrasher-corp/gocryptotrader/exchanges/stream"
"github.com/thrasher-corp/gocryptotrader/exchanges/subscription"
"github.com/thrasher-corp/gocryptotrader/exchanges/ticker"
"github.com/thrasher-corp/gocryptotrader/exchanges/trade"
"github.com/thrasher-corp/gocryptotrader/internal/exchange/websocket"
"github.com/thrasher-corp/gocryptotrader/log"
)
@@ -52,10 +52,10 @@ var (
// WsConnect initiates a websocket connection
func (b *Binance) WsConnect() error {
if !b.Websocket.IsEnabled() || !b.IsEnabled() {
return stream.ErrWebsocketNotEnabled
return websocket.ErrWebsocketNotEnabled
}
var dialer websocket.Dialer
var dialer gws.Dialer
dialer.HandshakeTimeout = b.Config.HTTPTimeout
dialer.Proxy = http.ProxyFromEnvironment
var err error
@@ -89,9 +89,9 @@ func (b *Binance) WsConnect() error {
go b.KeepAuthKeyAlive()
}
b.Websocket.Conn.SetupPingHandler(request.Unset, stream.PingHandler{
b.Websocket.Conn.SetupPingHandler(request.Unset, websocket.PingHandler{
UseGorillaHandler: true,
MessageType: websocket.PongMessage,
MessageType: gws.PongMessage,
Delay: pingDelay,
})
@@ -178,7 +178,7 @@ func (b *Binance) wsHandleData(respRaw []byte) error {
}
jsonData, _, _, err := jsonparser.Get(respRaw, "data")
if err != nil {
return fmt.Errorf("%s %s %s", b.Name, stream.UnhandledMessage, string(respRaw))
return fmt.Errorf("%s %s %s", b.Name, websocket.UnhandledMessage, string(respRaw))
}
var event string
event, err = jsonparser.GetUnsafeString(jsonData, "e")
@@ -297,13 +297,13 @@ func (b *Binance) wsHandleData(respRaw []byte) error {
streamStr, err := jsonparser.GetUnsafeString(respRaw, "stream")
if err != nil {
if errors.Is(err, jsonparser.KeyPathNotFoundError) {
return fmt.Errorf("%s %s %s", b.Name, stream.UnhandledMessage, string(respRaw))
return fmt.Errorf("%s %s %s", b.Name, websocket.UnhandledMessage, string(respRaw))
}
return err
}
streamType := strings.Split(streamStr, "@")
if len(streamType) <= 1 {
return fmt.Errorf("%s %s %s", b.Name, stream.UnhandledMessage, string(respRaw))
return fmt.Errorf("%s %s %s", b.Name, websocket.UnhandledMessage, string(respRaw))
}
var (
pair currency.Pair
@@ -386,7 +386,7 @@ func (b *Binance) wsHandleData(respRaw []byte) error {
b.Name,
err)
}
b.Websocket.DataHandler <- stream.KlineData{
b.Websocket.DataHandler <- websocket.KlineData{
Timestamp: kline.EventTime.Time(),
Pair: pair,
AssetType: asset.Spot,
@@ -421,7 +421,7 @@ func (b *Binance) wsHandleData(respRaw []byte) error {
}
return nil
default:
return fmt.Errorf("%s %s %s", b.Name, stream.UnhandledMessage, string(respRaw))
return fmt.Errorf("%s %s %s", b.Name, websocket.UnhandledMessage, string(respRaw))
}
}

10
exchanges/binance/binance_wrapper.go
View File

@@ -27,11 +27,11 @@ import (
"github.com/thrasher-corp/gocryptotrader/exchanges/orderbook"
"github.com/thrasher-corp/gocryptotrader/exchanges/protocol"
"github.com/thrasher-corp/gocryptotrader/exchanges/request"
"github.com/thrasher-corp/gocryptotrader/exchanges/stream"
"github.com/thrasher-corp/gocryptotrader/exchanges/stream/buffer"
"github.com/thrasher-corp/gocryptotrader/exchanges/subscription"
"github.com/thrasher-corp/gocryptotrader/exchanges/ticker"
"github.com/thrasher-corp/gocryptotrader/exchanges/trade"
"github.com/thrasher-corp/gocryptotrader/internal/exchange/websocket"
"github.com/thrasher-corp/gocryptotrader/internal/exchange/websocket/buffer"
"github.com/thrasher-corp/gocryptotrader/log"
"github.com/thrasher-corp/gocryptotrader/portfolio/withdraw"
)
@@ -196,7 +196,7 @@ func (b *Binance) SetDefaults() {
log.Errorln(log.ExchangeSys, err)
}
b.Websocket = stream.NewWebsocket()
b.Websocket = websocket.NewManager()
b.WebsocketResponseMaxLimit = exchange.DefaultWebsocketResponseMaxLimit
b.WebsocketResponseCheckTimeout = exchange.DefaultWebsocketResponseCheckTimeout
}
@@ -217,7 +217,7 @@ func (b *Binance) Setup(exch *config.Exchange) error {
if err != nil {
return err
}
err = b.Websocket.Setup(&stream.WebsocketSetup{
err = b.Websocket.Setup(&websocket.ManagerSetup{
ExchangeConfig: exch,
DefaultURL: binanceDefaultWebsocketURL,
RunningURL: ePoint,
@@ -236,7 +236,7 @@ func (b *Binance) Setup(exch *config.Exchange) error {
return err
}
return b.Websocket.SetupNewConnection(&stream.ConnectionSetup{
return b.Websocket.SetupNewConnection(&websocket.ConnectionSetup{
ResponseCheckTimeout: exch.WebsocketResponseCheckTimeout,
ResponseMaxLimit: exch.WebsocketResponseMaxLimit,
RateLimit: request.NewWeightedRateLimitByDuration(250 * time.Millisecond),