mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-06-05 07:26:47 +00:00
websocket/gateio: Add request functions for websocket multi-connection [SPOT] (#1598)
* gateio: Add multi asset websocket support WIP. * meow * Add tests and shenanigans * integrate flushing and for enabling/disabling pairs from rpc shenanigans * some changes * linter: fixes strikes again. * Change name ConnectionAssociation -> ConnectionCandidate for better clarity on purpose. Change connections map to point to candidate to track subscriptions for future dynamic connections holder and drop struct ConnectionDetails. * Add subscription tests (state functional) * glorious:nits + proxy handling * Spelling * linter: fixerino * instead of nil, dont do nil. * clean up nils * cya nils * don't need to set URL or check if its running * stream match update * update tests * linter: fix * glorious: nits + handle context cancellations * stop ping handler routine leak * * Fix bug where reader routine on error that is not a disconnection error but websocket frame error or anything really makes the reader routine return and then connection never cycles and the buffer gets filled. * Handle reconnection via an errors.Is check which is simpler and in that scope allow for quick disconnect reconnect without waiting for connection cycle. * Dial now uses code from DialContext but just calls context.Background() * Don't allow reader to return on parse binary response error. Just output error and return a non nil response * Allow rollback on connect on any error across all connections * fix shadow jutsu * glorious/gk: nitters - adds in ws mock server * linter: fix * fix deadlock on connection as the previous channel had no reader and would hang connection reader for eternity. * glorious: whooops * gk: nits * Leak issue and edge case * Websocket: Add SendMessageReturnResponses * whooooooopsie * gk: nitssssss * Update exchanges/stream/stream_match.go Co-authored-by: Gareth Kirwan <gbjkirwan@gmail.com> * Update exchanges/stream/stream_match_test.go Co-authored-by: Gareth Kirwan <gbjkirwan@gmail.com> * linter: appease the linter gods * gk: nits * gk: drain brain * started * more changes before merge match pr * gateio: still building out * gateio: finish spot * fix up tests in gateio * Add tests for stream package * rm unused field * glorious: nits * rn files, specifically set function names to asset and offload routing to websocket type. * linter: fix * glorious: nits * add counter and update gateio * fix collision issue * Update exchanges/stream/websocket.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * glorious: nits * add tests * linter: fix * After merge * Add error connection info * upgrade to upstream merge * Fix edge case where it does not reconnect made by an already closed connection * stream coverage * glorious: nits * glorious: nits removed asset error handling in stream package * linter: fix * rm block * Add basic readme * fix asset enabled flush cycle for multi connection * spella: fix * linter: fix * Add glorious suggestions, fix some race thing * reinstate name before any routine gets spawned * stop on error in mock tests * glorious: nits * glorious: nits found in CI build * Add test for drain, bumped wait times as there seems to be something happening on macos CI builds, used context.WithTimeout because its instant. * mutex across shutdown and connect for protection * lint: fix * test time withoffset, reinstate stop * fix whoops * const trafficCheckInterval; rm testmain * y * fix lint * bump time check window * stream: fix intermittant test failures while testing routines and remove code that is not needed. * spells * cant do what I did * protect race due to routine. * update testURL * use mock websocket connection instead of test URL's * linter: fix * remove url because its throwing errors on CI builds * connections drop all the time, don't need to worry about not being able to echo back ws data as it can be easily reviewed _test file side. * remove another superfluous url thats not really set up for this * spawn overwatch routine when there is no errors, inline checker instead of waiting for a time period, add sleep inline with echo handler as this is really quick and wanted to ensure that latency is handing correctly * linter: fixerino uperino * glorious: panix * linter: things * whoops * dont need to make consecutive Unix() calls * websocket: fix potential panic on error and no responses and adding waitForResponses * rm json parser and handle in json package instead * linter: fix * linter: fix again * * change field name OutboundRequestSignature to WrapperDefinedConnectionSignature for agnostic inbound and outbound connections. * change method name GetOutboundConnection to GetConnection for agnostic inbound and outbound connections. * drop outbound field map for improved performance just using a range and field check (less complex as well) * change field name connections to connectionToWrapper for better clarity * spells and magic and wands * glorious: nits * comparable check for signature * mv err var * glorious: nits and stuff * attempt to fix race * glorious: nits * gk: nits; engine log cleanup * gk: nits; OCD * gk: nits; move function change file names * gk: nits; 🚀 * gk: nits; convert variadic function and message inspection to interface and include a specific function for that handling so as to not need nil on every call * gk: nits; continued * gk: engine nits; rm loaded exchange * gk: nits; drop WebsocketLoginResponse * stream: Add match method EnsureMatchWithData * gk: nits; rn Inspect to IsFinal * gk: nits; rn to MessageFilter * linter: fix * gateio: update rate limit definitions (cherry-pick) * Add test and missing * Shared REST rate limit definitions with Websocket service, set lookup item to nil for systems that do not require rate limiting; add glorious nit * integrate rate limits for websocket trading spot * bitstamp: fix issue * glorious: nits * ch name and commentary * fix bug add test * rm a thing * fix test * Update engine/engine.go Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io> * thrasher: nits * Update exchanges/stream/stream_match_test.go Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io> * Update exchanges/stream/stream_match_test.go Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io> * GK: nits rn websocket functions * explicit function names for single to multi outbound orders * linter: fix --------- Co-authored-by: shazbert <ryan.oharareid@thrasher.io> Co-authored-by: Gareth Kirwan <gbjkirwan@gmail.com> Co-authored-by: Scott <gloriousCode@users.noreply.github.com> Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>
This commit is contained in:
Ryan O'Hara-Reid
GitHub
@@ -5,6 +5,7 @@ import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"reflect"
|
||||
"slices"
|
||||
"sync"
|
||||
"time"
|
||||
@@ -27,8 +28,10 @@ var (
|
||||
ErrUnsubscribeFailure = errors.New("unsubscribe failure")
|
||||
ErrAlreadyDisabled = errors.New("websocket already disabled")
|
||||
ErrNotConnected = errors.New("websocket is not connected")
|
||||
ErrNoMessageListener = errors.New("websocket listener not found for message")
|
||||
ErrSignatureTimeout = errors.New("websocket timeout waiting for response with signature")
|
||||
ErrRequestRouteNotFound = errors.New("request route not found")
|
||||
ErrSignatureNotSet = errors.New("signature not set")
|
||||
ErrRequestPayloadNotSet = errors.New("request payload not set")
|
||||
)
|
||||
|
||||
// Private websocket errors
|
||||
@@ -64,6 +67,9 @@ var (
|
||||
errConnectionWrapperDuplication = errors.New("connection wrapper duplication")
|
||||
errCannotChangeConnectionURL = errors.New("cannot change connection URL when using multi connection management")
|
||||
errExchangeConfigEmpty = errors.New("exchange config is empty")
|
||||
errCannotObtainOutboundConnection = errors.New("cannot obtain outbound connection")
|
||||
errMessageFilterNotSet = errors.New("message filter not set")
|
||||
errMessageFilterNotComparable = errors.New("message filter is not comparable")
|
||||
)
|
||||
|
||||
var globalReporter Reporter
|
||||
@@ -259,13 +265,19 @@ func (w *Websocket) SetupNewConnection(c *ConnectionSetup) error {
|
||||
return fmt.Errorf("%w: %w", errConnSetup, errWebsocketDataHandlerUnset)
|
||||
}
|
||||
|
||||
if c.MessageFilter != nil && !reflect.TypeOf(c.MessageFilter).Comparable() {
|
||||
return errMessageFilterNotComparable
|
||||
}
|
||||
|
||||
for x := range w.connectionManager {
|
||||
if w.connectionManager[x].Setup.URL == c.URL {
|
||||
// Below allows for multiple connections to the same URL with different outbound request signatures. This
|
||||
// allows for easier determination of inbound and outbound messages. e.g. Gateio cross_margin, margin on
|
||||
// a spot connection.
|
||||
if w.connectionManager[x].Setup.URL == c.URL && c.MessageFilter == w.connectionManager[x].Setup.MessageFilter {
|
||||
return fmt.Errorf("%w: %w", errConnSetup, errConnectionWrapperDuplication)
|
||||
}
|
||||
}
|
||||
|
||||
w.connectionManager = append(w.connectionManager, ConnectionWrapper{
|
||||
w.connectionManager = append(w.connectionManager, &ConnectionWrapper{
|
||||
Setup: c,
|
||||
Subscriptions: subscription.NewStore(),
|
||||
})
|
||||
@@ -422,12 +434,21 @@ func (w *Websocket) connect() error {
|
||||
break
|
||||
}
|
||||
|
||||
w.connections[conn] = &w.connectionManager[i]
|
||||
w.connections[conn] = w.connectionManager[i]
|
||||
w.connectionManager[i].Connection = conn
|
||||
|
||||
w.Wg.Add(1)
|
||||
go w.Reader(context.TODO(), conn, w.connectionManager[i].Setup.Handler)
|
||||
|
||||
if w.connectionManager[i].Setup.Authenticate != nil && w.CanUseAuthenticatedEndpoints() {
|
||||
err = w.connectionManager[i].Setup.Authenticate(context.TODO(), conn)
|
||||
if err != nil {
|
||||
// Opted to not fail entirely here for POC. This should be
|
||||
// revisited and handled more gracefully.
|
||||
log.Errorf(log.WebsocketMgr, "%s websocket: [conn:%d] [URL:%s] failed to authenticate %v", w.exchangeName, i+1, conn.URL, err)
|
||||
}
|
||||
}
|
||||
|
||||
err = w.connectionManager[i].Setup.Subscriber(context.TODO(), conn, subs)
|
||||
if err != nil {
|
||||
multiConnectFatalError = fmt.Errorf("%v Error subscribing %w", w.exchangeName, err)
|
||||
@@ -633,7 +654,7 @@ func (w *Websocket) FlushChannels() error {
|
||||
}
|
||||
w.Wg.Add(1)
|
||||
go w.Reader(context.TODO(), conn, w.connectionManager[x].Setup.Handler)
|
||||
w.connections[conn] = &w.connectionManager[x]
|
||||
w.connections[conn] = w.connectionManager[x]
|
||||
w.connectionManager[x].Connection = conn
|
||||
}
|
||||
|
||||
@@ -1064,7 +1085,7 @@ func (w *Websocket) checkSubscriptions(conn Connection, subs subscription.List)
|
||||
if s.State() == subscription.ResubscribingState {
|
||||
continue
|
||||
}
|
||||
if found := w.subscriptions.Get(s); found != nil {
|
||||
if found := subscriptionStore.Get(s); found != nil {
|
||||
return fmt.Errorf("%w: %s", subscription.ErrDuplicate, s)
|
||||
}
|
||||
}
|
||||
@@ -1241,3 +1262,37 @@ func signalReceived(ch chan struct{}) bool {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
// GetConnection returns a connection by message filter (defined in exchange package _wrapper.go websocket connection)
|
||||
// for request and response handling in a multi connection context.
|
||||
func (w *Websocket) GetConnection(messageFilter any) (Connection, error) {
|
||||
if w == nil {
|
||||
return nil, fmt.Errorf("%w: %T", common.ErrNilPointer, w)
|
||||
}
|
||||
|
||||
if messageFilter == nil {
|
||||
return nil, errMessageFilterNotSet
|
||||
}
|
||||
|
||||
w.m.Lock()
|
||||
defer w.m.Unlock()
|
||||
|
||||
if !w.useMultiConnectionManagement {
|
||||
return nil, fmt.Errorf("%s: multi connection management not enabled %w please use exported Conn and AuthConn fields", w.exchangeName, errCannotObtainOutboundConnection)
|
||||
}
|
||||
|
||||
if !w.IsConnected() {
|
||||
return nil, ErrNotConnected
|
||||
}
|
||||
|
||||
for _, wrapper := range w.connectionManager {
|
||||
if wrapper.Setup.MessageFilter == messageFilter {
|
||||
if wrapper.Connection == nil {
|
||||
return nil, fmt.Errorf("%s: %s %w associated with message filter: '%v'", w.exchangeName, wrapper.Setup.URL, ErrNotConnected, messageFilter)
|
||||
}
|
||||
return wrapper.Connection, nil
|
||||
}
|
||||
}
|
||||
|
||||
return nil, fmt.Errorf("%s: %w associated with message filter: '%v'", w.exchangeName, ErrRequestRouteNotFound, messageFilter)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user