Skip to content

itest: test automatic peer bootstrapping#9967

Merged
guggero merged 4 commits intolightningnetwork:masterfrom
ellemouton:peerBootstrapItest
Jun 24, 2025
Merged

itest: test automatic peer bootstrapping#9967
guggero merged 4 commits intolightningnetwork:masterfrom
ellemouton:peerBootstrapItest

Conversation

@ellemouton
Copy link
Collaborator

@ellemouton ellemouton commented Jun 20, 2025

Description

In this PR, we add an itest to test the automatic peer bootstrapping logic. In other words, we test
that a node is able to use the graph data (specifically, node_announcements) to create some peer
connections.

Possible breaking change for regtest/simnet/signet users

We used to explicitly disallow bootstrapping for any simnet/signet/regtest nodes but this has now
been removed so that we can properly test this in an itest.

This does, however, mean that any users who have a simnet/signet/regtest network that depends on
this no-bootstrapping functionality will need to now explicitly add the --nobootstrap config option.
The release notes have been updated to inform users of this.

Why?

  1. This removes an old TODO & allows us to test this previously untested logic
  2. For the upcoming "Remote Graph" project, we will want to be able to switch on bootstrapping in an itest to show that a node that is purely relying on a remote graph (instead of syncing its own graph data) is able to bootstrap using the remote graph data.

@ellemouton ellemouton self-assigned this Jun 20, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 20, 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

@ellemouton ellemouton added networking itests Issues related to integration tests. labels Jun 20, 2025
@ellemouton ellemouton force-pushed the peerBootstrapItest branch from 2bda297 to fd1e84f Compare June 20, 2025 08:42
@ellemouton ellemouton requested a review from yyforyongyu June 20, 2025 13:09
Copy link
Member

@yyforyongyu yyforyongyu left a comment

Choose a reason for hiding this comment

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

LGTM🦾


// Dave still has bootstrapping disabled and so it should not connect
// to any peers.
err := wait.Invariant(func() bool {
Copy link
Member

Choose a reason for hiding this comment

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

nit: can use

ht.AssertNotConnected(dave, alice)
ht.AssertNotConnected(dave, bob)
ht.AssertNotConnected(dave, carol)

so we don't need to wait for 5s

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

the bootstrapping happens after start up though, so i think it is good to use an invariant here for this specific case cause there will be a time between restart and potential bootstrapping where no nodes will be connected. So we want to test here that the bootstrapping doesnt happen after restart

@yyforyongyu yyforyongyu requested a review from ziggie1984 June 23, 2025 09:28
Copy link
Collaborator

@ziggie1984 ziggie1984 left a comment

Choose a reason for hiding this comment

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

LGTM

We already set `nobootstrap` in the default node flags for itest nodes,
so we can remove this check now. This will allow us to later test
bootstrapping in an itest. NOTE that with this change, any
signet/simnet/regtest network users will now need to explicitly add the
`--nobootstrap` flag if they want to prevent automatic bootstrapping.
This warning is added to the release notes later on.
This will allow us to test bootstrapping in an itest.
Test the automatic peer bootstrapping logic via an itest.
Warn users of simnet/signet/regtest scripts that they will now need to
explicitly specify the `--nobootstrap` flag to turn bootstrapping off.
@ellemouton ellemouton force-pushed the peerBootstrapItest branch from fd1e84f to 75a3531 Compare June 24, 2025 10:57
Copy link
Collaborator Author

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

Thanks for the swift review yall! updated 🫡


// Dave still has bootstrapping disabled and so it should not connect
// to any peers.
err := wait.Invariant(func() bool {
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

the bootstrapping happens after start up though, so i think it is good to use an invariant here for this specific case cause there will be a time between restart and potential bootstrapping where no nodes will be connected. So we want to test here that the bootstrapping doesnt happen after restart

@ellemouton
Copy link
Collaborator Author

cc @guggero for override merge 🙏

@guggero guggero merged commit 715cae9 into lightningnetwork:master Jun 24, 2025
35 of 37 checks passed
@ellemouton ellemouton deleted the peerBootstrapItest branch June 24, 2025 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

itests Issues related to integration tests. networking

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants