Skip to content
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.

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

BE-586 | OrderBookClient use slices.Split for pagination #533

Conversation

deividaspetraitis
Copy link
Collaborator

@deividaspetraitis deividaspetraitis commented Oct 22, 2024

Cleans up OrderBookClient by reusing slices.Split instead of duplicating splitting slices into chunks logic in some of the methods.

Summary by CodeRabbit

  • New Features

    • Improved methods for fetching tick data, enhancing performance and reliability.
  • Bug Fixes

    • Updated error messages for better clarity in case of issues during data fetching.
  • Refactor

    • Simplified code by replacing manual chunking logic with a utility function for better readability and maintainability.

Cleans up OrderBookClient by reusing slices.Split instead of duplicating
splitting slices into chunks logic in some of the methods.
Copy link
Contributor

coderabbitai bot commented Oct 22, 2024

Walkthrough

The changes in this pull request focus on the orderbook_grpc_client.go file, specifically enhancing the FetchTickUnrealizedCancels and FetchTicks methods within the orderbookClientImpl struct. The modifications involve replacing manual chunking logic with the slices.Split utility function, simplifying code structure and improving readability while maintaining existing error handling.

Changes

File Path Change Summary
domain/orderbook/grpcclient/orderbook_grpc_client.go Implemented FetchTickUnrealizedCancels and FetchTicks methods using slices.Split for chunking, replacing manual logic. Updated error messages to reflect new variable names. Added import for slices package.

Possibly related PRs

Suggested reviewers

  • p0mvn

Poem

🐇 In the code where ticks do play,
Chunks are split in a simpler way.
Gone are loops that twist and turn,
For clarity, we now discern.
With slices here, our code's a delight,
Hopping forward, all feels right! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
domain/orderbook/grpcclient/orderbook_grpc_client.go (3)

92-95: LGTM: Improved chunking logic using slices.Split

The use of slices.Split simplifies the code and improves readability while maintaining the same functionality. The error message update is consistent with the new variable name.

Consider wrapping the error in a custom error type for better error handling:

if err != nil {
    return nil, fmt.Errorf("failed to fetch unrealized cancels: %w", err)
}

This approach provides more context and allows for easier error checking in the calling code.


120-121: LGTM: Consistent use of slices.Split for chunking

The changes in FetchTicks are consistent with those in FetchTickUnrealizedCancels, improving code clarity and maintainability.

Consider applying the same error wrapping suggestion as in FetchTickUnrealizedCancels:

if err != nil {
    return nil, fmt.Errorf("failed to fetch ticks: %w", err)
}

This would provide more context and allow for consistent error handling across both methods.


Line range hint 1-134: Summary: PR objectives achieved with improved code quality

The changes in this PR successfully achieve the stated objective of cleaning up the OrderBookClient by reusing the slices.Split function. The modifications eliminate duplication of chunking logic in the FetchTickUnrealizedCancels and FetchTicks methods, resulting in more maintainable and efficient code.

Key improvements:

  1. Consistent use of slices.Split for chunking in both methods.
  2. Improved code readability and maintainability.
  3. Preserved existing functionality and error handling.

Consider applying similar refactoring to other methods in the codebase that may benefit from using slices.Split for chunking operations. This would further improve consistency across the project.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9faf2db and 129b583.

📒 Files selected for processing (1)
  • domain/orderbook/grpcclient/orderbook_grpc_client.go (3 hunks)
🧰 Additional context used
🔇 Additional comments (1)
domain/orderbook/grpcclient/orderbook_grpc_client.go (1)

9-9: LGTM: Import added for slices package

The addition of the slices package import is appropriate for the subsequent use of slices.Split in the modified methods.

@deividaspetraitis deividaspetraitis deleted the BE-594/OrderBookClient-cleanup branch October 22, 2024 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant