Allow configuring heartbeat interval

[sideninja]

Description

This PR allows configuring heartbeat interval

---

For contributor use:

• Targeted PR against master branch
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• Code follows the standards mentioned here.
• Updated relevant documentation
• Re-reviewed Files changed in the Github PR explorer
• Added appropriate labels

Summary by CodeRabbit

• New Features

  • Introduced a customizable heartbeat interval for event subscriptions to improve flexibility and control.

• Improvements

  • Enhanced event subscription reliability with the addition of a heartbeat interval setting.

[coderabbitai]

Walkthrough

The recent changes introduce a new HeartbeatInterval parameter to the Config struct, which is utilized in the NewRPCSubscriber function to set a custom heartbeat interval for event subscriptions. This parameter is configurable via a command-line flag. The modifications span across configuration, initialization, and testing to ensure consistent integration of this new feature.

Changes

File Path	Change Summary
bootstrap/bootstrap.go	Added cfg.HeartbeatInterval to the NewRPCSubscriber call within startIngestion function.
config/config.go	Added HeartbeatInterval field to Config struct and updated FromFlags to parse a new flag.
services/ingestion/subscriber.go	Introduced heartbeatInterval field in RPCSubscriber and updated NewRPCSubscriber function.
services/ingestion/subscriber_test.go	Modified NewRPCSubscriber call to include the new heartbeatInterval parameter in tests.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User as User
    participant CLI as Command-Line Interface
    participant Config as Config
    participant Bootstrap as Bootstrap
    participant Ingestion as Ingestion

    User->>CLI: Start application with --heartbeat-interval
    CLI->>Config: Parse flags
    Config->>Bootstrap: Pass Config including HeartbeatInterval
    Bootstrap->>Ingestion: Call NewRPCSubscriber with HeartbeatInterval
    Ingestion->>Ingestion: Initialize RPCSubscriber with HeartbeatInterval

Loading

In fields of code, where changes bloom,
A heartbeat's rhythm finds its room.
Configs updated, tests align,
Subscribers beat in perfect time.
CodeRabbit cheers, with joy anew,
For intervals that pulse right through.

---

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.

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 full the 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 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.

[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 2153407 and 3452eb6.

Files selected for processing (3)

• bootstrap/bootstrap.go (1 hunks)
• config/config.go (2 hunks)
• services/ingestion/subscriber.go (2 hunks)

Additional comments not posted (4)

services/ingestion/subscriber.go (2)

32-50: The addition of heartbeatInterval to the RPCSubscriber struct and its initialization in NewRPCSubscriber are correctly implemented. This aligns with the PR's objective to allow configurable heartbeat intervals.

---

95-95: Correct usage of heartbeatInterval in the Subscribe method to configure the heartbeat interval dynamically.

bootstrap/bootstrap.go (1)

155-155: The instantiation of RPCSubscriber with the heartbeatInterval parameter in startIngestion is correctly implemented. This ensures that the heartbeat interval is configurable and passed correctly to the ingestion service.

config/config.go (1)

Line range hint 73-100: The addition of the HeartbeatInterval field to the Config struct and its initialization from command-line flags are correctly implemented. This supports the new feature of configurable heartbeat intervals.

[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 3452eb6 and 929c9ba.

Files selected for processing (1)

• services/ingestion/subscriber_test.go (1 hunks)

Additional comments not posted (1)

services/ingestion/subscriber_test.go (1)

100-100: LGTM! The heartbeat interval is correctly passed to the NewRPCSubscriber.

[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 929c9ba and e87304e.

Files selected for processing (2)

• bootstrap/bootstrap.go (1 hunks)
• services/ingestion/subscriber_test.go (1 hunks)

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

• bootstrap/bootstrap.go
• services/ingestion/subscriber_test.go