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

perf: send multiple txs on the same height concurrently #16

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

leonz789
Copy link
Collaborator

@leonz789 leonz789 commented Jan 1, 2025

Notable changes

  1. sign tx when received instead of on the height expected to send that tx.
  2. send multiple txs on the same height concurrently.

Note:when sending multiple transactions on the same height, the execution order of those transactions is not guaranteed.

Summary by CodeRabbit

  • New Features

    • Enhanced transaction debugging capabilities
    • Added methods for retrieving and sending signed transaction bytes
    • Improved asynchronous processing of transaction requests
  • Refactor

    • Updated request management structure to support more flexible transaction handling
    • Modified error handling and processing methods for debug transactions

Copy link

coderabbitai bot commented Jan 1, 2025

Walkthrough

The pull request introduces modifications to the transaction handling process in the cmd/feeder_debug.go and exoclient/tx.go files. The changes focus on enhancing the debugging capabilities of the transaction sending mechanism by introducing a new sendBytesReq type and adding methods to work with signed transaction bytes. The modifications enable more flexible and asynchronous processing of transaction requests, with improved error handling and support for direct byte-level transaction management.

Changes

File Change Summary
cmd/feeder_debug.go - Replaced sendReq with sendBytesReq type
- Updated pendingRequestManager to use sendBytesReq
- Modified add and process methods to work with new type
- Introduced concurrent processing with sync.WaitGroup
exoclient/tx.go - Reintroduced SendTxDebug method
- Added GetSignedTxBytesDebug method
- Added SendSignedTxBytesDebug method for broadcasting transaction bytes

Sequence Diagram

sequenceDiagram
    participant DebugPriceFeeder
    participant PendingRequestManager
    participant ExoClient
    
    DebugPriceFeeder->>ExoClient: GetSignedTxBytesDebug()
    ExoClient-->>DebugPriceFeeder: Return tx bytes
    
    DebugPriceFeeder->>PendingRequestManager: Add sendBytesReq
    
    PendingRequestManager->>ExoClient: SendSignedTxBytesDebug()
    ExoClient-->>PendingRequestManager: Broadcast result
Loading

Poem

🐰 Bytes of wisdom, requests so bright,
Dancing through channels with async might
Transactions flow, no longer constrained
Debug magic, elegantly unchained!
Hop, hop, hooray for code so clean! 🚀


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

@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

🧹 Nitpick comments (6)
cmd/feeder_debug.go (4)

27-30: Clarify responsibility of the new sendBytesReq struct
The sendBytesReq struct now encapsulates transaction bytes and a results channel. Consider including metadata (e.g., block height or a correlation ID) to facilitate logging, diagnostics, or correlation.


45-56: Concurrent request processing aligns with PR objective
The process method correctly uses goroutines and a WaitGroup to handle multiple transactions concurrently at or below a given height. Consider capturing partial failures or logging them to track concurrency issues.


164-171: No guaranteed ordering in concurrent execution
Calling SendSignedTxBytesDebug concurrently fulfills the PR’s goal of sending multiple transactions at once, but there is no inherent ordering guarantee. Ensure this behavior is acceptable and well-documented.


184-195: Error handling strategy with switch break
If an error occurs while signing the transaction (GetSignedTxBytesDebug), the code breaks from the select case but continues the outer loop. Verify that this is intentional and won’t omit further processing inadvertently. Also consider whether the user should be notified of partial failures.

exoclient/tx.go (2)

132-143: Typographical fix and improved broadcasting logs
The reintroduced SendTxDebug method works as intended. However, there is a minor typo in the error message “braodcast.” Recommend correcting it to “broadcast.”

- return nil, fmt.Errorf("failed to braodcast transaction, msg:%v, ...
+ return nil, fmt.Errorf("failed to broadcast transaction, msg:%v, ...

149-156: Duplicate logic and minor typo
SendSignedTxBytesDebug mirrors SendTxDebug’s broadcast logic with signed bytes. Consider refactoring to avoid duplication. Also fix the “braodcast” typo.

- return nil, fmt.Errorf("failed to braodcast transaction, txBytes:%v, ...
+ return nil, fmt.Errorf("failed to broadcast transaction, txBytes:%v, ...
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c42dc8 and 9a872d9.

📒 Files selected for processing (2)
  • cmd/feeder_debug.go (4 hunks)
  • exoclient/tx.go (1 hunks)
🔇 Additional comments (5)
cmd/feeder_debug.go (4)

8-8: Confirm concurrency usage with the sync package
The import of the sync package indicates concurrency usage such as WaitGroup. Ensure that any shared data structures are handled in a concurrency-safe manner or accessed from a single goroutine.


31-31: Map-based manager might need synchronization
pendingRequestManager is defined as a shared map of block heights to slice pointers. If accessed concurrently from multiple goroutines, consider appropriate locking or guaranteeing single-threaded access.


34-34: Straightforward map initialization
The constructor function returning an empty map of int64 to *sendBytesReq slices is correct and clear.


37-41: Ensure atomic addition of pending requests
The add method appends to a slice stored in a map. If multiple goroutines call add at the same time, a race might occur. Confirm that only one goroutine writes to this map or add a locking mechanism.

exoclient/tx.go (1)

145-147: Simple wrapper method
GetSignedTxBytesDebug delegates directly to getSignedTxBytes, keeping code DRY and readable. No issues found.

@leonz789 leonz789 merged commit 4998fd7 into develop Jan 2, 2025
1 check passed
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