Skip to content

Conversation

Roasbeef
Copy link
Member

@Roasbeef Roasbeef commented May 8, 2025

This commit introduces a new "super priority" send queue to the peer's writeHandler. This queue is designed for messages that must bypass the regular send queue to ensure timely delivery, such as ping messages.

Previously, ping messages were sent via the regular sendQueue. If this queue was backed up with other messages (e.g., channel updates, HTLC settlements), pings could be delayed. This delay could lead to the ping-pong mechanism incorrectly determining that the peer is unresponsive, resulting in a premature disconnection.

The new superPrioSendQueue is checked before the regular sendQueue in the writeHandler. If a message is sent from the super priority queue, the writeHandler will immediately loop back to check this queue again, ensuring it is drained before processing messages from the regular queue.

Ping and pongs messages are now sent using this super priority queue via the new SendSuperPriorityMessage method. This helps prevent unnecessary disconnections due to delayed pings when the peer is otherwise busy processing other messages.

The superPrioSendQueue is a buffered channel of size 2 (able to queue a ping and a pong non-blocking).

Copy link
Contributor

coderabbitai bot commented May 8, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

This commit introduces a new "super priority" send queue to the peer's
`writeHandler`. This queue is designed for messages that must bypass
the regular send queue to ensure timely delivery, such as ping messages.

Previously, ping messages were sent via the regular `sendQueue`. If this
queue was backed up with other messages (e.g., channel updates, HTLC
settlements), pings could be delayed. This delay could lead to the
ping-pong mechanism incorrectly determining that the peer is
unresponsive, resulting in a premature disconnection.

The new `superPrioSendQueue` is checked before the regular `sendQueue`
in the `writeHandler`. If a message is sent from the super priority
queue, the `writeHandler` will immediately loop back to check this
queue again, ensuring it is drained before processing messages from the
regular queue.

Ping and pongs messages are now sent using this super priority queue via
the new `SendSuperPriorityMessage` method. This helps prevent
unnecessary disconnections due to delayed pings when the peer is
otherwise busy processing other messages.

The `superPrioSendQueue` is a buffered channel of size 2 (able to queue
a ping and a pong non-blocking).
@ziggie1984
Copy link
Collaborator

ziggie1984 commented May 12, 2025

Given that the culprit was the readHandler rather than the sending of the Ping msg I think we don't need this one.

@Roasbeef
Copy link
Member Author

Given that the culprit was the readHandler rather than the sending of the Ping msg I think we don't need this one.

Yep, may be something we want to look into in the future, re certain messages just bypassing the queue all together.

@Roasbeef Roasbeef closed this May 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants