d0zingcat/gocryptotrader
1
0
Fork 0
mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-06-02 07:26:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

websocket/gateio: Support multi connection management and integrate with GateIO (#1580)

Browse Source 
* 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

* 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.

* gk: nits

* Leak issue and edge case

* gk: nits

* gk: drain brain

* glorious: nits

* 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

* 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

* defer lock and use functions that don't require locking in SetProxyAddress

* lint: fix

* thrasher: nits

---------

Co-authored-by: shazbert <ryan.oharareid@thrasher.io>
Co-authored-by: Scott <gloriousCode@users.noreply.github.com>
This commit is contained in:
Ryan O'Hara-Reid
2024-10-10 15:09:52 +11:00
committed by GitHub
parent c2dfb37efd
commit ac731ce283
58 changed files with 1996 additions and 1475 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
exchanges/gateio/gateio_websocket.go
View File

@@ -50,6 +50,9 @@ const (
spotFundingBalanceChannel = "spot.funding_balances"
crossMarginBalanceChannel = "spot.cross_balances"
crossMarginLoanChannel = "spot.cross_loan"
subscribeEvent = "subscribe"
unsubscribeEvent = "unsubscribe"
)
var defaultSubscriptions = subscription.List{
@@ -71,16 +74,13 @@ var subscriptionNames = map[string]string{
subscription.AllTradesChannel: spotTradesChannel,
}
// WsConnect initiates a websocket connection
func (g *Gateio) WsConnect() error {
if !g.Websocket.IsEnabled() || !g.IsEnabled() {
return stream.ErrWebsocketNotEnabled
}
// WsConnectSpot initiates a websocket connection
func (g *Gateio) WsConnectSpot(ctx context.Context, conn stream.Connection) error {
err := g.CurrencyPairs.IsAssetEnabled(asset.Spot)
if err != nil {
return err
}
err = g.Websocket.Conn.Dial(&websocket.Dialer{}, http.Header{})
err = conn.DialContext(ctx, &websocket.Dialer{}, http.Header{})
if err != nil {
return err
}
@@ -88,14 +88,12 @@ func (g *Gateio) WsConnect() error {
if err != nil {
return err
}
g.Websocket.Conn.SetupPingHandler(request.Unset, stream.PingHandler{
conn.SetupPingHandler(request.Unset, stream.PingHandler{
Websocket: true,
Delay: time.Second * 15,
Message: pingMessage,
MessageType: websocket.TextMessage,
})
g.Websocket.Wg.Add(1)
go g.wsReadConnData()
return nil
}
@@ -108,29 +106,15 @@ func (g *Gateio) generateWsSignature(secret, event, channel string, t int64) (st
return hex.EncodeToString(mac.Sum(nil)), nil
}
// wsReadConnData receives and passes on websocket messages for processing
func (g *Gateio) wsReadConnData() {
defer g.Websocket.Wg.Done()
for {
resp := g.Websocket.Conn.ReadMessage()
if resp.Raw == nil {
return
}
err := g.wsHandleData(resp.Raw)
if err != nil {
g.Websocket.DataHandler <- err
}
}
}
func (g *Gateio) wsHandleData(respRaw []byte) error {
// WsHandleSpotData handles spot data
func (g *Gateio) WsHandleSpotData(_ context.Context, respRaw []byte) error {
var push WsResponse
err := json.Unmarshal(respRaw, &push)
if err != nil {
return err
}
if push.Event == "subscribe" || push.Event == "unsubscribe" {
if push.Event == subscribeEvent || push.Event == unsubscribeEvent {
if !g.Websocket.Match.IncomingWithData(push.ID, respRaw) {
return fmt.Errorf("couldn't match subscription message with ID: %d", push.ID)
}
@@ -641,22 +625,25 @@ func (g *Gateio) processCrossMarginLoans(data []byte) error {
return nil
}
// generateSubscriptions returns configured subscriptions
func (g *Gateio) generateSubscriptions() (subscription.List, error) {
// generateSubscriptionsSpot returns configured subscriptions
func (g *Gateio) generateSubscriptionsSpot() (subscription.List, error) {
return g.Features.Subscriptions.ExpandTemplates(g)
}
// GetSubscriptionTemplate returns a subscription channel template
func (g *Gateio) GetSubscriptionTemplate(_ *subscription.Subscription) (*template.Template, error) {
return template.New("master.tmpl").Funcs(sprig.FuncMap()).Funcs(template.FuncMap{
"channelName": channelName,
"singleSymbolChannel": singleSymbolChannel,
"interval": g.GetIntervalString,
}).Parse(subTplText)
return template.New("master.tmpl").
Funcs(sprig.FuncMap()).
Funcs(template.FuncMap{
"channelName": channelName,
"singleSymbolChannel": singleSymbolChannel,
"interval": g.GetIntervalString,
}).
Parse(subTplText)
}
// manageSubs sends a websocket message to subscribe or unsubscribe from a list of channel
func (g *Gateio) manageSubs(event string, subs subscription.List) error {
func (g *Gateio) manageSubs(ctx context.Context, event string, conn stream.Connection, subs subscription.List) error {
var errs error
subs, errs = subs.ExpandTemplates(g)
if errs != nil {
@@ -665,11 +652,11 @@ func (g *Gateio) manageSubs(event string, subs subscription.List) error {
for _, s := range subs {
if err := func() error {
msg, err := g.manageSubReq(event, s)
msg, err := g.manageSubReq(ctx, event, conn, s)
if err != nil {
return err
}
result, err := g.Websocket.Conn.SendMessageReturnResponse(context.TODO(), request.Unset, msg.ID, msg)
result, err := conn.SendMessageReturnResponse(ctx, request.Unset, msg.ID, msg)
if err != nil {
return err
}
@@ -681,9 +668,9 @@ func (g *Gateio) manageSubs(event string, subs subscription.List) error {
return fmt.Errorf("(%d) %s", resp.Error.Code, resp.Error.Message)
}
if event == "unsubscribe" {
return g.Websocket.RemoveSubscriptions(s)
return g.Websocket.RemoveSubscriptions(conn, s)
}
return g.Websocket.AddSuccessfulSubscriptions(s)
return g.Websocket.AddSuccessfulSubscriptions(conn, s)
}(); err != nil {
errs = common.AppendError(errs, fmt.Errorf("%s %s %s: %w", s.Channel, s.Asset, s.Pairs, err))
}
@@ -692,16 +679,16 @@ func (g *Gateio) manageSubs(event string, subs subscription.List) error {
}
// manageSubReq constructs the subscription management message for a subscription
func (g *Gateio) manageSubReq(event string, s *subscription.Subscription) (*WsInput, error) {
func (g *Gateio) manageSubReq(ctx context.Context, event string, conn stream.Connection, s *subscription.Subscription) (*WsInput, error) {
req := &WsInput{
ID: g.Websocket.Conn.GenerateMessageID(false),
ID: conn.GenerateMessageID(false),
Event: event,
Channel: channelName(s),
Time: time.Now().Unix(),
Payload: strings.Split(s.QualifiedChannel, ","),
}
if s.Authenticated {
creds, err := g.GetCredentials(context.TODO())
creds, err := g.GetCredentials(ctx)
if err != nil {
return nil, err
}
@@ -719,13 +706,13 @@ func (g *Gateio) manageSubReq(event string, s *subscription.Subscription) (*WsIn
}
// Subscribe sends a websocket message to stop receiving data from the channel
func (g *Gateio) Subscribe(subs subscription.List) error {
return g.manageSubs("subscribe", subs)
func (g *Gateio) Subscribe(ctx context.Context, conn stream.Connection, subs subscription.List) error {
return g.manageSubs(ctx, subscribeEvent, conn, subs)
}
// Unsubscribe sends a websocket message to stop receiving data from the channel
func (g *Gateio) Unsubscribe(subs subscription.List) error {
return g.manageSubs("unsubscribe", subs)
func (g *Gateio) Unsubscribe(ctx context.Context, conn stream.Connection, subs subscription.List) error {
return g.manageSubs(ctx, unsubscribeEvent, conn, subs)
}
func (g *Gateio) listOfAssetsCurrencyPairEnabledFor(cp currency.Pair) map[asset.Item]bool {
@@ -782,3 +769,37 @@ const subTplText = `
{{- end }}
{{- end }}
`
// GeneratePayload returns the payload for a websocket message
type GeneratePayload func(ctx context.Context, conn stream.Connection, event string, channelsToSubscribe subscription.List) ([]WsInput, error)
// handleSubscription sends a websocket message to receive data from the channel
func (g *Gateio) handleSubscription(ctx context.Context, conn stream.Connection, event string, channelsToSubscribe subscription.List, generatePayload GeneratePayload) error {
payloads, err := generatePayload(ctx, conn, event, channelsToSubscribe)
if err != nil {
return err
}
var errs error
for k := range payloads {
result, err := conn.SendMessageReturnResponse(ctx, request.Unset, payloads[k].ID, payloads[k])
if err != nil {
errs = common.AppendError(errs, err)
continue
}
var resp WsEventResponse
if err = json.Unmarshal(result, &resp); err != nil {
errs = common.AppendError(errs, err)
} else {
if resp.Error != nil && resp.Error.Code != 0 {
errs = common.AppendError(errs, fmt.Errorf("error while %s to channel %s error code: %d message: %s", payloads[k].Event, payloads[k].Channel, resp.Error.Code, resp.Error.Message))
continue
}
if event == subscribeEvent {
errs = common.AppendError(errs, g.Websocket.AddSuccessfulSubscriptions(conn, channelsToSubscribe[k]))
} else {
errs = common.AppendError(errs, g.Websocket.RemoveSubscriptions(conn, channelsToSubscribe[k]))
}
}
}
return errs
}