fix(local pub sub): fix must subscribe to handle context cancelled

[danwt]

PR Standards

Opening a pull request should be able to meet the following requirements

--

PR naming convention: https://hackmd.io/@nZpxHZ0CT7O5ngTp0TP9mg/HJP_jrm7A

---

Close #XXX

<-- Briefly describe the content of this pull request -->

For Author:

• Targeted PR against correct branch
• included the correct type prefix in the PR title
• Linked to Github issue with discussion and accepted design
• Targets only one github issue
• Wrote unit and integration tests
• All CI checks have passed
• Added relevant godoc comments

---

For Reviewer:

• confirmed the correct type prefix in the PR title
• Reviewers assigned
• confirmed all author checklist items have been addressed

---

After reviewer approval:

• In case targets main branch, PR should be squashed and merged.
• In case PR targets a release branch, PR should be rebased.

Summary by CodeRabbit

• New Features

  • Streamlined cache management methods for easier retrieval and deletion of cached blocks.
  • Enhanced error handling in subscription processes for better clarity and robustness.

• Bug Fixes

  • Improved error messaging related to block processing, increasing consistency and clarity.

• Refactor

  • Renamed methods across multiple files for improved readability and maintainability without impacting functionality.

[coderabbitai]

Walkthrough

The recent changes enhance the clarity and maintainability of the codebase by streamlining method names related to block cache management. Key methods have been renamed for brevity, ensuring consistency across the code. Additionally, error handling in the subscription logic has been refined to improve robustness. Overall, these modifications maintain existing functionality while making the code easier to read and work with.

Changes

Files	Change Summary
block/block.go, block/block_cache.go, block/p2p.go, block/retriever.go	Renamed caching methods for clarity: GetBlockFromCache to Get, DeleteBlockFromCache to Delete, etc. Improved consistency and readability.
utils/event/funcs.go	Enhanced error handling in MustSubscribe, adding context to errors and allowing graceful returns for cancellation scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant Manager
    participant BlockCache
    participant Event

    Manager->>BlockCache: Get(blockHeight)
    alt Block exists
        BlockCache-->>Manager: Return cachedBlock
        Manager->>Manager: Process cachedBlock
    else Block does not exist
        BlockCache-->>Manager: Block not found
    end
    Manager->>Event: Subscribe()
    alt Subscription error
        Event-->>Manager: Return error
    end

Loading

🐇 In code we play, with names so bright,
Methods refined, oh what a sight!
Blocks in the cache, we fetch and delete,
With grace we hop, code’s now so neat!
Error logs clear, no panic in sight,
Celebrate change, it feels just 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

• 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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4c9c2c3 and 9dde3e8.

Files selected for processing (6)

• block/block.go (2 hunks)
• block/block_cache.go (1 hunks)
• block/p2p.go (2 hunks)
• block/retriever.go (1 hunks)
• block/submit.go (2 hunks)
• utils/event/funcs.go (1 hunks)

Files skipped from review due to trivial changes (3)

• block/block_cache.go
• block/p2p.go
• block/submit.go

Additional comments not posted (3)

utils/event/funcs.go (1)

27-33: Improved error handling in MustSubscribe.

The changes enhance robustness by wrapping errors for context and handling context cancellation gracefully, avoiding unnecessary panics.

block/retriever.go (1)

139-139: Streamlined cache management in ProcessNextDABatch.

Replacing DeleteBlockFromCache with Delete suggests a more unified approach to cache management, enhancing maintainability.

block/block.go (1)

Line range hint 124-140:
Refactored cache management in attemptApplyCachedBlocks.

The transition to using Get and Delete methods reflects a consistent and streamlined cache management interface, improving code clarity.