Skip to content

Conversation

Teebor-Choka
Copy link
Contributor

@Teebor-Choka Teebor-Choka commented Nov 26, 2024

The error on dialing for offline peers was expected in the heartbeat protocol and should not be a reason for error log.

This should clean the logs up significantly.

@Teebor-Choka Teebor-Choka added this to the 2.2.0-rc.1 milestone Nov 26, 2024
@Teebor-Choka Teebor-Choka requested a review from a team November 26, 2024 13:48
@Teebor-Choka Teebor-Choka self-assigned this Nov 26, 2024
Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing error handling within the run method of the HoprSwarmWithProcessors struct. Specifically, it refines how outbound failures are logged during the heartbeat protocol. The update introduces a conditional check for libp2p::request_response::OutboundFailure::DialFailure, allowing for specific logging when a peer is offline, while maintaining the existing logging for other outbound failures. This change improves the clarity of logs related to connection issues without altering the overall functionality of the class.

Changes

File Path Change Summary
transport/p2p/src/swarm.rs Modified error handling in run method of HoprSwarmWithProcessors to log specific outbound failures.

Possibly related PRs

Suggested labels

improvement, crate:core-network

Suggested reviewers

  • esterlus
  • NumberFour8
  • tolbrino

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

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.

@Teebor-Choka Teebor-Choka marked this pull request as ready for review November 26, 2024 13:48
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
transport/p2p/src/swarm.rs (2)

484-488: LGTM! Error handling improvement aligns with PR objectives.

The changes correctly implement the desired behavior by:

  1. Distinguishing between dial failures (offline peers) and other outbound failures
  2. Using appropriate log levels (trace for expected offline peers, error for unexpected failures)

However, consider adding a debug log for offline peers instead of trace, as this information might be useful for debugging connection issues:

-trace!(%peer, %request_id, %error, "Peer is offline");
+debug!(%peer, %request_id, %error, "Peer is offline");

482-483: Consider adding error handling for cache invalidation.

The active_pings.invalidate(&request_id).await operation should be checked for errors to ensure proper cleanup of resources.

-active_pings.invalidate(&request_id).await;
+if let Err(e) = active_pings.invalidate(&request_id).await {
+    warn!(%peer, %request_id, error = %e, "Failed to invalidate active ping");
+}
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5fcc893 and d03b42f.

📒 Files selected for processing (1)
  • transport/p2p/src/swarm.rs (1 hunks)

@Teebor-Choka Teebor-Choka merged commit 6ef8549 into master Nov 26, 2024
38 of 43 checks passed
@Teebor-Choka Teebor-Choka deleted the kauki/logs/decrease-the-level-for-expected-heartbeat-failures branch November 26, 2024 14:52
@coderabbitai coderabbitai bot mentioned this pull request Jan 31, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants