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 #535

Merged
merged 1 commit into from
Oct 25, 2024

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

  • Refactor
    • Simplified chunking logic in FetchTickUnrealizedCancels and FetchTicks methods for improved readability and maintainability.
    • Updated error handling to reflect new variable naming.
  • Chores
    • Added import statement for the slices package.

Cleans up OrderBookClient by reusing slices.Split instead of duplicating
splitting slices into chunks logic in some of the methods.
@deividaspetraitis deividaspetraitis self-assigned this Oct 22, 2024
Copy link

Copy link
Contributor

coderabbitai bot commented Oct 22, 2024

Walkthrough

The changes involve the addition of the slices package import in the orderbook_grpc_client.go file and the refactoring of the FetchTickUnrealizedCancels and FetchTicks methods. Both methods now utilize the slices.Split function for chunking tickIDs, replacing the previous manual for-loop implementation. This modification aims to enhance code readability and maintainability while preserving existing functionality and error handling.

Changes

File Path Change Summary
domain/orderbook/grpcclient/orderbook_grpc_client.go Added import for slices package; refactored FetchTickUnrealizedCancels and FetchTicks methods to use slices.Split for chunking tickIDs. Updated error messages to reflect new variable names.

Possibly related PRs

Suggested reviewers

  • p0mvn

Poem

In the code where rabbits hop,
Slices split, and never stop.
Fetching ticks in a tidy way,
Makes our work a brighter day!
With each chunk, our joy does grow,
Hopping high, we code with flow! 🐇✨


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 (1)
domain/orderbook/grpcclient/orderbook_grpc_client.go (1)

120-121: Approved: Good refactoring, with a minor suggestion

The use of slices.Split here improves code readability and consistency, aligning well with the PR objectives.

Consider updating the error message to use the chunk variable for consistency with the FetchTickUnrealizedCancels method:

- return nil, fmt.Errorf("failed to fetch ticks for pool %s: %w", contractAddress, err)
+ return nil, fmt.Errorf("failed to fetch ticks %v for pool %s: %w", chunk, contractAddress, err)

This change would provide more specific error information and maintain consistency across similar methods.

📜 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 (3)
domain/orderbook/grpcclient/orderbook_grpc_client.go (3)

9-9: LGTM: New import added correctly

The new import for the slices package is correctly placed and necessary for the refactored methods.


92-95: Great refactoring: Improved readability and consistency

The use of slices.Split simplifies the chunking logic, making the code more readable and consistent with the PR objectives. The error handling has been appropriately updated to reflect the new variable name.


Line range hint 1-134: Summary: Successful refactoring with improved code quality

The changes in this file successfully achieve the PR objective of reusing the slices.Split function for pagination. This refactoring has:

  1. Eliminated duplication of chunking logic in FetchTickUnrealizedCancels and FetchTicks methods.
  2. Improved code readability and maintainability.
  3. Maintained existing functionality and error handling.

The use of slices.Split has simplified the code without introducing any apparent issues. Overall, this is a positive change that enhances the quality of the OrderBookClient implementation.

@deividaspetraitis deividaspetraitis merged commit 287add8 into v26.x Oct 25, 2024
15 of 16 checks passed
@deividaspetraitis deividaspetraitis deleted the BE-594/OrderBookClient-cleanup branch October 25, 2024 06:56
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.

2 participants