(Node) Timeout for aggregator msg handling

[nick-bisonai]

Description

• Refactoring: encapsulate certain part of the code for readability
• Set minimal timeout in HandlePriceDataMessage , HandleProofMessage so that it doesn't hang forever on delayed price or proof message

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 enhance the Aggregator class by introducing a new constant for message receive timeouts and refactoring the handling of price and proof data messages. New helper methods are created for storing and processing these messages, improving the clarity and maintainability of the code. Additionally, goroutines are implemented to manage timeouts for message processing, with enhanced logging for better debugging.

Changes

Files	Change Summary
node/pkg/aggregator/aggregator.go	Added constants and methods for handling price and proof data messages, including timeout logic and refactoring of existing methods.

Possibly related PRs

• (Node) Add more logs #2291: This PR modifies the HandleTriggerMessage and HandlePriceFixMessage functions in the Aggregator class, which are directly related to the changes made in the main PR that also involves the Aggregator class and its message handling methods.

Suggested reviewers

• Intizar-T

Poem

🐇 In the land of code where bunnies play,
New methods hop in, brightening the day.
With timeouts and helpers, they dance and they twirl,
Making message handling a smoother swirl.
So let’s celebrate this agile delight,
For our Aggregator shines ever so bright! 🌟

Warning

Review ran into problems

🔥 Problems

Error running Gitleaks: Cloning the repository previously failed.

---

Error running golangci-lint: Command failed with exit code 4: jk_cp -o -f -k -j /cache/46/8ac4343e-f571-45ed-8603-4ff80f3ee071 /dev/null /dev/urandom /usr/bin/ast-grep /usr/bin/curl /usr/bin/diff /usr/bin/dirname /usr/bin/env /usr/bin/fd /usr/bin/gawk /usr/bin/gh /usr/bin/jq /usr/bin/patch /usr/bin/rg /usr/bin/shellcheck /usr/bin/tokei /usr/bin/tree /usr/bin/uniq /usr/bin/xargs /etc/ssl/certs /etc/passwd /etc/group /home/jailuser/ast-grep-rules

ERROR: /usr/bin/ast-grep does not exist

Usage: /usr/sbin/jk_cp -j [OPTIONS]

-h --help : this help screen
-j, --jail : the jail to copy to
-v, --verbose : show what is being copied
-f, --force : overwrite existing files
-k, --hardlink : use hardlinks if possible
-o, --owner : retain file ownership and group
-s, --setuid : retain file setuid/setgid bits

Note: if no jail is specified, the first argument is
considered to be the jail

---

Error running semgrep: Cloning the repository previously failed.

---

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review.

---

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>, 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 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 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.

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ce21f43 and 214e0f0.

📒 Files selected for processing (1)

• node/pkg/aggregator/aggregator.go (3 hunks)

🔇 Additional comments (1)

node/pkg/aggregator/aggregator.go (1)

170-181: Verify the correctness of message count conditions

The conditions len(n.roundPrices.prices[priceDataMessage.RoundID]) == n.Raft.SubscribersCount()+1 and len(n.roundProofs.proofs[proofMessage.RoundID]) == n.Raft.SubscribersCount()+1 check if all messages have been received for the round. Verify that adding +1 accurately reflects the total expected number of messages, considering whether SubscribersCount() includes the current node or only the peers.

Run the following script to examine the usage of SubscribersCount and confirm its implementation:

#!/bin/bash
# Description: Verify how SubscribersCount() is used in the codebase.

# Test: Search for all usages of SubscribersCount to understand if it includes the current node.
rg --type go 'SubscribersCount\(\)'

Also applies to: 297-306