(OraklNode) consume channel to fix memory leak

[nick-bisonai]

Description

block channel kept being increased without being consumed leading to memory leak.
this pr fixes the issue

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Checklist before requesting a review

• I have performed a self-review of my code.
• If it is a core feature, I have added thorough tests.

Deployment

• Should publish npm package
• Should publish Docker image

[coderabbitai]

Walkthrough

Walkthrough

The changes to the handleSubscription method in the ChainReader class introduce a new channel, headerSubChan, for subscribing to blockchain headers. This enhancement improves code clarity and reusability. A goroutine is added to monitor this channel, managing the subscription lifecycle and ensuring proper resource cleanup upon context cancellation.

Changes

Files	Change Summary
node/pkg/chain/websocketchainreader/...	Introduced headerSubChan for header subscriptions; added a goroutine for managing subscription lifecycle and context cancellation.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ChainReader
    participant HeaderSubChan

    Client->>ChainReader: Subscribe to headers
    ChainReader->>HeaderSubChan: Create header subscription channel
    ChainReader->>HeaderSubChan: Listen for new headers
    HeaderSubChan-->>ChainReader: New header received
    ChainReader->>Client: Send new header
    Client->>ChainReader: Cancel subscription
    ChainReader->>HeaderSubChan: Stop listening

Loading

Poem

🐇 In the code where headers flow,
A new channel starts to grow.
With a watchful eye, it takes its stand,
To manage subscriptions, oh so grand!
Clean and clear, like a rabbit's hop,
Resources tidy, no need to stop! 🐇

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.
  • @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 as 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.

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

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.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2e61098 and d90c3b5.

Files selected for processing (1)

• node/pkg/chain/websocketchainreader/websocketreader.go (1 hunks)

Additional comments not posted (3)

node/pkg/chain/websocketchainreader/websocketreader.go (3)

120-124: LGTM!

The subscription to new head using headerSubChan is correctly implemented. The defer subNewHead.Unsubscribe() ensures proper cleanup.

The code changes are approved.

---

127-135: LGTM!

The goroutine correctly monitors the headerSubChan channel and handles context cancellation appropriately.

The code changes are approved.

---

118-135: LGTM!

The overall changes in the handleSubscription method improve the control flow by decoupling the subscription handling from the main execution path. This enhances both performance and maintainability.

The code changes are approved.

[Intizar-T]

lgtm! good catch 🔥

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d90c3b5 and f10563a.

Files selected for processing (1)

• node/pkg/chain/websocketchainreader/websocketreader.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• node/pkg/chain/websocketchainreader/websocketreader.go