Adjust ping parameters to improve tor stability #8762

ProofOfKeags · 2024-05-15T19:18:10Z

Change Description

Here we do the following things to increase stability with tor peers:

Reduce maximum pong payload size to ease bandwidth consumption
Make PingManager.Stop infallible so that it doesn't pollute the logs with false errors in the case where we fail to send or receive the init message.
If we detect that the connection with our peer is over tor (heuristic), then we will triple the timeout parameters to give them more time to respond.

Steps to Test

Run this patch with a bunch of tor peers and see if it improves the long term stability of those peers.

Pull Request Checklist

Testing

Your PR passes all CI checks.
Tests covering the positive and negative (error paths) are included.
Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
Commits follow the Ideal Git Commit Structure.
Any new logging statements use an appropriate subsystem and logging level.
Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

coderabbitai · 2024-05-15T19:18:16Z

Important

Review Skipped

Auto reviews are disabled on this repository.

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.

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>.
- 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 a review. This is useful when automatic reviews are disabled for the repository.
@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.

Liongrass · 2024-05-16T04:33:33Z

I ran this and it does indeed fix the problem I was seeing. Thank you!

ellemouton

lgtm! 🚢

peer/brontide.go

Liongrass · 2024-05-17T05:11:13Z

I'm running this now, and so far so good! Will report back in the morning!

Roasbeef

LGTM 🐠

peer/brontide.go

bitromortac

LGTM ⚡, with a nit (+ the helper function)

peer/ping_manager.go

Chinwendu20 · 2024-05-21T10:40:22Z

peer/ping_manager.go

-// when the PingManager is running.
-func (m *PingManager) Stop() error {
+// Stop interrupts the goroutines that the PingManager owns.
+func (m *PingManager) Stop() {
 	if m.pingTicker == nil {


q: Do we still need ths conditional here? Would it ever be hit?

It turns out, yes. Testing this code reveals that if there is a timeout during the init process of the Brontide, then we call Disconnect before the ping manager is ever started. Since Start is what initializes the Timer this will be nil at that point.

Chinwendu20

Nice work. left some nits and qs

Chinwendu20 · 2024-05-21T11:01:53Z

peer/brontide.go

@@ -1258,15 +1258,13 @@ func (p *Brontide) Disconnect(reason error) {

 	p.log.Infof(err.Error())

+	// Stop ping manager before closing TCP connection


nit: missing full stop

Fwiw, as far as I can tell, the full-stop rule is only important for godocs since it affects the godoc rendering semantics. In-line comments like this aren't rendered and so I don't think it matters, but others may know things that I don't.

CC @ellemouton @yyforyongyu

peer/brontide.go

ProofOfKeags · 2024-05-21T23:32:25Z

Not sure what to make of the unit-race CI check failing here.

Roasbeef · 2024-05-22T02:34:26Z

Not sure what to make of the unit-race CI check failing here.

Appears to be a known flake.

saubyk added this to the v0.18.0 milestone May 15, 2024

saubyk assigned ProofOfKeags May 15, 2024

saubyk requested review from bitromortac and ellemouton May 16, 2024 15:20

ProofOfKeags marked this pull request as ready for review May 16, 2024 15:23

ellemouton approved these changes May 16, 2024

View reviewed changes

peer/brontide.go Outdated Show resolved Hide resolved

ProofOfKeags force-pushed the bugfix/ping-stability branch from 1f74bd1 to a766f91 Compare May 16, 2024 18:22

Roasbeef requested changes May 16, 2024

View reviewed changes

peer/brontide.go Outdated Show resolved Hide resolved

ProofOfKeags force-pushed the bugfix/ping-stability branch 3 times, most recently from 14c58b8 to fc6b65f Compare May 18, 2024 01:29

ProofOfKeags added the no-changelog label May 18, 2024

ProofOfKeags requested a review from Roasbeef May 18, 2024 01:32

ProofOfKeags force-pushed the bugfix/ping-stability branch from fc6b65f to 5d82b6a Compare May 18, 2024 01:34

Roasbeef approved these changes May 21, 2024

View reviewed changes

peer/brontide.go Outdated Show resolved Hide resolved

bitromortac approved these changes May 21, 2024

View reviewed changes

peer/ping_manager.go Outdated Show resolved Hide resolved

Chinwendu20 reviewed May 21, 2024

View reviewed changes

ProofOfKeags added 3 commits May 21, 2024 13:27

peer: reduce upper bound of pong bytes to ease bandwidth load

94a9bae

peer: make PingManager.Stop infallible

61191a5

peer: triple timeout parameters to give tor more grace

1148e57

ProofOfKeags force-pushed the bugfix/ping-stability branch from 5d82b6a to 1148e57 Compare May 21, 2024 20:39

Roasbeef merged commit 64639fb into lightningnetwork:master May 22, 2024
25 of 34 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adjust ping parameters to improve tor stability #8762

Adjust ping parameters to improve tor stability #8762

ProofOfKeags commented May 15, 2024 •

edited

coderabbitai bot commented May 15, 2024 •

edited

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Liongrass commented May 16, 2024

ellemouton left a comment

Liongrass commented May 17, 2024

Roasbeef left a comment

bitromortac left a comment •

edited

Chinwendu20 May 21, 2024

ProofOfKeags May 21, 2024

Chinwendu20 left a comment

Chinwendu20 May 21, 2024

ProofOfKeags May 21, 2024

ProofOfKeags commented May 21, 2024

Roasbeef commented May 22, 2024

		@@ -1258,15 +1258,13 @@ func (p *Brontide) Disconnect(reason error) {

		p.log.Infof(err.Error())

		// Stop ping manager before closing TCP connection

Adjust ping parameters to improve tor stability #8762

Adjust ping parameters to improve tor stability #8762

Conversation

ProofOfKeags commented May 15, 2024 • edited

Change Description

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

coderabbitai bot commented May 15, 2024 • edited

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Liongrass commented May 16, 2024

ellemouton left a comment

Choose a reason for hiding this comment

Liongrass commented May 17, 2024

Roasbeef left a comment

Choose a reason for hiding this comment

bitromortac left a comment • edited

Choose a reason for hiding this comment

Chinwendu20 May 21, 2024

Choose a reason for hiding this comment

ProofOfKeags May 21, 2024

Choose a reason for hiding this comment

Chinwendu20 left a comment

Choose a reason for hiding this comment

Chinwendu20 May 21, 2024

Choose a reason for hiding this comment

ProofOfKeags May 21, 2024

Choose a reason for hiding this comment

ProofOfKeags commented May 21, 2024

Roasbeef commented May 22, 2024

ProofOfKeags commented May 15, 2024 •

edited

coderabbitai bot commented May 15, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

bitromortac left a comment •

edited