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

feat(eth-pubsub): Implement in-memory EventBus for real-time topic management and event distribution #1855

Merged
merged 3 commits into from
Apr 28, 2024

Conversation

Unique-Divine
Copy link
Member

@Unique-Divine Unique-Divine commented Apr 26, 2024

Purpose / Abstract

feat(eth-pubsub): Implement in-memory EventBus for real-time topic management and event distribution

This commit introduces the memEventBus, an in-memory implementation of the EventBus interface, designed to handle real-time event management and distribution efficiently within the Ethereum module. Key features include:

  • Dynamic topic addition and removal to facilitate organized message distribution.
  • Support for multiple subscribers per topic, enabling robust event handling across different system components.
  • Thread-safe operations using read/write mutexes to ensure reliable performance under concurrent access.
  • Integration of atomic operations for unique subscriber identification, enhancing the traceability and management of individual subscriptions.

Summary by CodeRabbit

  • New Features
    • Introduced an in-memory EventBus for Ethereum, enhancing real-time topic management and event distribution.
  • Tests
    • Added tests to ensure the reliability and efficiency of the new EventBus under concurrent operations.

@Unique-Divine Unique-Divine requested a review from a team as a code owner April 26, 2024 06:13
Copy link
Contributor

coderabbitai bot commented Apr 26, 2024

Walkthrough

The recent changes introduce an innovative feature to the Ethereum framework, enhancing pub/sub capabilities with an in-memory EventBus. This feature enables dynamic topic management and efficient event distribution, ensuring thread-safe operations and real-time data handling across subscribers.

Changes

File Path Change Summary
eth/rpc/pubsub/pubsub.go Introduced an in-memory EventBus for real-time topic management and event distribution in Ethereum.
eth/rpc/pubsub/pubsub_test.go Added test functions for the pubsub package, covering topic addition, subscription, and concurrency testing.

🐇✨
In the realm of code, under the moon's glow,
A rabbit hops, leaving traces in the snow.
With each leap, a new feature springs to life,
Subscriptions weave like threads in a fife.
Cheers to EventBus, threading through the night!
🌟🚌


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

codecov bot commented Apr 27, 2024

Codecov Report

Attention: Patch coverage is 84.93151% with 11 lines in your changes are missing coverage. Please review.

Project coverage is 68.58%. Comparing base (ae20488) to head (70ef06f).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1855      +/-   ##
==========================================
+ Coverage   68.46%   68.58%   +0.11%     
==========================================
  Files         175      176       +1     
  Lines       10014    10087      +73     
==========================================
+ Hits         6856     6918      +62     
- Misses       2738     2747       +9     
- Partials      420      422       +2     
Files Coverage Δ
eth/rpc/pubsub/pubsub.go 84.93% <84.93%> (ø)

@matthiasmatt matthiasmatt merged commit 29e2acd into main Apr 28, 2024
14 checks passed
@matthiasmatt matthiasmatt deleted the ud/evm branch April 28, 2024 15:05
@Unique-Divine Unique-Divine added the x: evm Relates to Nibiru EVM or the EVM Module label May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x: evm Relates to Nibiru EVM or the EVM Module
Projects
Status: ✅ Completed
Development

Successfully merging this pull request may close these issues.

2 participants