Skip to content

REFACTOR: (coinbase) wrapping connection logics into methods for better maintainability. #2017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
May 7, 2025
Merged

REFACTOR: (coinbase) wrapping connection logics into methods for better maintainability. #2017

merged 2 commits into from
May 7, 2025

Conversation

dboyliao
Copy link
Collaborator

@dboyliao dboyliao commented May 5, 2025 •
edited
Loading

In this PR, I refactor the handleConnect method of the coinbase Stream object as following:

  1. wrapping connection logics of user and market data stream into two separate methods:
    • buildMapForUserDataStream
    • buildMapForMarketStream
  2. writeSubscribeJson: method that write the subscription JSON to the websocket connection
  3. Instead of just logging on subscription error, use panic to abort the process
    • the rationale is that we should prevent the process running since user/market data streams are important data feeds for the trading strategies. If there is any error on subscriptions, the stream is compromised and should be explicitly stopped instead of just logging a message.

@dboyliao dboyliao changed the title 🔧 refactor: wrapping connection logics into methods for better maintainability. REFACTOR: (coinbase) wrapping connection logics into methods for better maintainability. May 5, 2025
@dboyliao dboyliao force-pushed the dboy/coinbase-connect-refactor branch from 0fa3213 to dba8faa Compare May 5, 2025 02:40
@dboyliao dboyliao force-pushed the dboy/coinbase-connect-refactor branch from dba8faa to fe6bfdf Compare May 5, 2025 09:33
gx578007
gx578007 reviewed May 7, 2025
View reviewed changes
pkg/exchange/coinbase/stream_handlers.go Outdated
@@ -77,67 +77,131 @@ func (msg subscribeMsgType2) String() string {
}

func (s *Stream) handleConnect() {
subProductsMap := make(map[types.Channel][]string)
// channel2LocalSymbolsMap is a map from channel to local symbols
channel2LocalSymbolsMap := make(map[types.Channel][]string)

// user data strea, subscribe to user channel for the user order/trade updates
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also help fix the typo in the comment: strea"m".

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opps, thanks.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@dboyliao dboyliao requested a review from gx578007 May 7, 2025 06:20
@dboyliao dboyliao merged commit 3b091ac into main May 7, 2025
2 checks passed
@dboyliao dboyliao deleted the dboy/coinbase-connect-refactor branch May 7, 2025 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kbearXD kbearXD kbearXD approved these changes

@gx578007 gx578007 gx578007 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dboyliao @kbearXD @gx578007