From 067fae0e00a54e6b3da0d69c113b703f01df3447 Mon Sep 17 00:00:00 2001 From: Bea <103050835+Beadko@users.noreply.github.com> Date: Mon, 7 Aug 2023 13:40:09 +0700 Subject: [PATCH] engine/sync_manager: Rename Update to WebsocketUpdate (#1300) * sync_manager: Update replaced with WebsocketUpdate * sync_manager: replaced TestSyncManagerUpdate with TestSyncManagerWebsocketUpdate * Update engine/sync_manager.go --------- Co-authored-by: Adrian Gallagher --- engine/subsystem_types.go | 2 +- engine/sync_manager.go | 4 ++-- engine/sync_manager_test.go | 24 ++++++++++++------------ engine/websocketroutine_manager.go | 6 +++--- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/engine/subsystem_types.go b/engine/subsystem_types.go index 074b26b8..5b245f75 100644 --- a/engine/subsystem_types.go +++ b/engine/subsystem_types.go @@ -77,7 +77,7 @@ type iCurrencyPairSyncer interface { IsRunning() bool PrintTickerSummary(*ticker.Price, string, error) PrintOrderbookSummary(*orderbook.Base, string, error) - Update(string, currency.Pair, asset.Item, syncItemType, error) error + WebsocketUpdate(string, currency.Pair, asset.Item, syncItemType, error) error } // iDatabaseConnectionManager defines a limited scoped databaseConnectionManager diff --git a/engine/sync_manager.go b/engine/sync_manager.go index ab7eee89..d4b8d2b7 100644 --- a/engine/sync_manager.go +++ b/engine/sync_manager.go @@ -330,9 +330,9 @@ func (m *syncManager) add(k currencyPairKey, s syncBase) *currencyPairSyncAgent return c } -// Update notifies the syncManager to change the last updated time for a exchange asset pair +// WebsocketUpdate notifies the syncManager to change the last updated time for a exchange asset pair // And set IsUsingWebsocket to true. It should be used externally only from websocket updaters -func (m *syncManager) Update(exchangeName string, p currency.Pair, a asset.Item, syncType syncItemType, err error) error { +func (m *syncManager) WebsocketUpdate(exchangeName string, p currency.Pair, a asset.Item, syncType syncItemType, err error) error { if m == nil { return fmt.Errorf("exchange CurrencyPairSyncer %w", ErrNilSubsystem) } diff --git a/engine/sync_manager_test.go b/engine/sync_manager_test.go index 4d900492..2dfe0210 100644 --- a/engine/sync_manager_test.go +++ b/engine/sync_manager_test.go @@ -261,55 +261,55 @@ func TestWaitForInitialSync(t *testing.T) { } } -func TestSyncManagerUpdate(t *testing.T) { +func TestSyncManagerWebsocketUpdate(t *testing.T) { t.Parallel() var m *syncManager - err := m.Update("", currency.EMPTYPAIR, 1, 47, nil) + err := m.WebsocketUpdate("", currency.EMPTYPAIR, 1, 47, nil) if !errors.Is(err, ErrNilSubsystem) { t.Fatalf("received %v, but expected: %v", err, ErrNilSubsystem) } m = &syncManager{} - err = m.Update("", currency.EMPTYPAIR, 1, 47, nil) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, 1, 47, nil) if !errors.Is(err, ErrSubSystemNotStarted) { t.Fatalf("received %v, but expected: %v", err, ErrSubSystemNotStarted) } m.started = 1 // not started initial sync - err = m.Update("", currency.EMPTYPAIR, 1, 47, nil) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, 1, 47, nil) if !errors.Is(err, nil) { t.Fatalf("received %v, but expected: %v", err, nil) } m.initSyncStarted = 1 // orderbook not enabled - err = m.Update("", currency.EMPTYPAIR, asset.Spot, SyncItemOrderbook, nil) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, asset.Spot, SyncItemOrderbook, nil) if !errors.Is(err, nil) { t.Fatalf("received %v, but expected: %v", err, nil) } m.config.SynchronizeOrderbook = true // ticker not enabled - err = m.Update("", currency.EMPTYPAIR, asset.Spot, SyncItemTicker, nil) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, asset.Spot, SyncItemTicker, nil) if !errors.Is(err, nil) { t.Fatalf("received %v, but expected: %v", err, nil) } m.config.SynchronizeTicker = true // trades not enabled - err = m.Update("", currency.EMPTYPAIR, asset.Spot, SyncItemTrade, nil) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, asset.Spot, SyncItemTrade, nil) if !errors.Is(err, nil) { t.Fatalf("received %v, but expected: %v", err, nil) } m.config.SynchronizeTrades = true - err = m.Update("", currency.EMPTYPAIR, asset.Spot, 1336, nil) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, asset.Spot, 1336, nil) if !errors.Is(err, errUnknownSyncItem) { t.Fatalf("received %v, but expected: %v", err, errUnknownSyncItem) } - err = m.Update("", currency.EMPTYPAIR, asset.Spot, SyncItemOrderbook, nil) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, asset.Spot, SyncItemOrderbook, nil) if !errors.Is(err, errCouldNotSyncNewData) { t.Fatalf("received %v, but expected: %v", err, errCouldNotSyncNewData) } @@ -320,19 +320,19 @@ func TestSyncManagerUpdate(t *testing.T) { }, syncBase{}) m.initSyncWG.Add(3) // orderbook match - err = m.Update("", currency.EMPTYPAIR, asset.Spot, SyncItemOrderbook, errors.New("test")) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, asset.Spot, SyncItemOrderbook, errors.New("test")) if !errors.Is(err, nil) { t.Fatalf("received %v, but expected: %v", err, nil) } // ticker match - err = m.Update("", currency.EMPTYPAIR, asset.Spot, SyncItemTicker, errors.New("test")) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, asset.Spot, SyncItemTicker, errors.New("test")) if !errors.Is(err, nil) { t.Fatalf("received %v, but expected: %v", err, nil) } // trades match - err = m.Update("", currency.EMPTYPAIR, asset.Spot, SyncItemTrade, errors.New("test")) + err = m.WebsocketUpdate("", currency.EMPTYPAIR, asset.Spot, SyncItemTrade, errors.New("test")) if !errors.Is(err, nil) { t.Fatalf("received %v, but expected: %v", err, nil) } diff --git a/engine/websocketroutine_manager.go b/engine/websocketroutine_manager.go index 439eb0f3..d92913d2 100644 --- a/engine/websocketroutine_manager.go +++ b/engine/websocketroutine_manager.go @@ -220,7 +220,7 @@ func (m *WebsocketRoutineManager) websocketDataHandler(exchName string, data int } case *ticker.Price: if m.syncer.IsRunning() { - err := m.syncer.Update(exchName, + err := m.syncer.WebsocketUpdate(exchName, d.Pair, d.AssetType, SyncItemTicker, @@ -237,7 +237,7 @@ func (m *WebsocketRoutineManager) websocketDataHandler(exchName string, data int case []ticker.Price: for x := range d { if m.syncer.IsRunning() { - err := m.syncer.Update(exchName, + err := m.syncer.WebsocketUpdate(exchName, d[x].Pair, d[x].AssetType, SyncItemTicker, @@ -276,7 +276,7 @@ func (m *WebsocketRoutineManager) websocketDataHandler(exchName string, data int return err } if m.syncer.IsRunning() { - err := m.syncer.Update(exchName, + err := m.syncer.WebsocketUpdate(exchName, base.Pair, base.Asset, SyncItemOrderbook,