graph: move topology subscription to `ChannelGraph` #9577

ellemouton · 2025-03-05T06:04:46Z

We plan to later on add an option for a remote graph source which will
be managed from the ChannelGraph. In such a set-up, a node would rely on
the remote graph source for graph updates instead of from gossip sync.
In this scenario, however, our topology subscription logic should still
notify clients of all updates and so it makes more sense to have the
logic as part of the ChannelGraph so that we can send updates we receive
from the remote graph.

Part of #9494

We plan to later on add an option for a remote graph source which will be managed from the ChannelGraph. In such a set-up, a node would rely on the remote graph source for graph updates instead of from gossip sync. In this scenario, however, our topology subscription logic should still notify clients of all updates and so it makes more sense to have the logic as part of the ChannelGraph so that we can send updates we receive from the remote graph.

A clean-up commit just to separate out all topology related fields in ChannelGraph into a dedicated struct that then gets mounted to the ChannelGraph.

coderabbitai · 2025-03-05T06:04:53Z

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.

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

yyforyongyu

Beautiful - the overall arch finally starts to look cool now😎

yyforyongyu · 2025-03-06T04:02:18Z

graph/db/graph.go

@@ -234,6 +316,17 @@ func (c *ChannelGraph) AddLightningNode(node *models.LightningNode,
 		)
 	}

+	// No need to send topology updates for shell nodes.


q: what is a shell node?

it's a node that we only know about via a channel announcement that we have not received a channel update for yet

yyforyongyu · 2025-03-06T04:05:08Z

graph/db/graph.go

-	// add a new notification client, or cancel notifications for an
-	// existing client.
-	ntfnClientUpdates chan *topologyClientUpdate
+	*topologyManager


yyforyongyu · 2025-03-06T04:18:06Z

graph/db/graph.go

+		// We'll notify any registered clients.
+		case update := <-c.topologyUpdate:
+			c.wg.Add(1)
+			go c.handleTopologyUpdate(update)


one day we will get there...but goroutine inside goroutine is bad...per-exisiting tho.

Discussed this offline, could you please also add a TODO so we can clean this up?

yyforyongyu · 2025-03-06T04:21:48Z

graph/db/notifications.go

@@ -127,23 +127,22 @@ func (b *Builder) notifyTopologyChange(topologyDiff *TopologyChange) {
 			len(topologyDiff.ChannelEdgeUpdates),
 			len(topologyDiff.ClosedChannels))

-		go func(c *topologyClient) {
-			defer c.wg.Done()
+		go func(t *topologyClient) {


ok i didn't realize we were firing goroutine inside goroutine inside yet anther goroutine😂

yeah it's all very gross 😂

This should be fine though.

bhandras

Awesomeness! LGTM ✨

bhandras · 2025-03-06T08:39:07Z

graph/db/graph.go

+		// We'll notify any registered clients.
+		case update := <-c.topologyUpdate:
+			c.wg.Add(1)
+			go c.handleTopologyUpdate(update)


Discussed this offline, could you please also add a TODO so we can clean this up?

bhandras · 2025-03-06T08:39:43Z

graph/db/notifications.go

@@ -127,23 +127,22 @@ func (b *Builder) notifyTopologyChange(topologyDiff *TopologyChange) {
 			len(topologyDiff.ChannelEdgeUpdates),
 			len(topologyDiff.ClosedChannels))

-		go func(c *topologyClient) {
-			defer c.wg.Done()
+		go func(t *topologyClient) {


This should be fine though.

ellemouton added 2 commits March 5, 2025 07:52

graph/db: refactor to group all topology notification fields

1fafb83

A clean-up commit just to separate out all topology related fields in ChannelGraph into a dedicated struct that then gets mounted to the ChannelGraph.

ellemouton added graph refactoring labels Mar 5, 2025

ellemouton self-assigned this Mar 5, 2025

docs: update release notes

dbb316f

ellemouton force-pushed the graph19 branch from 00c8572 to dbb316f Compare March 5, 2025 06:05

ellemouton requested review from yyforyongyu and bhandras March 5, 2025 07:10

yyforyongyu approved these changes Mar 6, 2025

View reviewed changes

bhandras approved these changes Mar 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

graph: move topology subscription to `ChannelGraph` #9577

graph: move topology subscription to `ChannelGraph` #9577

ellemouton commented Mar 5, 2025

coderabbitai bot commented Mar 5, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

yyforyongyu left a comment

yyforyongyu Mar 6, 2025

ellemouton Mar 6, 2025

yyforyongyu Mar 6, 2025

yyforyongyu Mar 6, 2025

bhandras Mar 6, 2025

yyforyongyu Mar 6, 2025

ellemouton Mar 6, 2025

bhandras Mar 6, 2025

bhandras left a comment

bhandras Mar 6, 2025

bhandras Mar 6, 2025

graph: move topology subscription to ChannelGraph #9577

Are you sure you want to change the base?

graph: move topology subscription to ChannelGraph #9577

Conversation

ellemouton commented Mar 5, 2025

coderabbitai bot commented Mar 5, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

yyforyongyu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bhandras left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

graph: move topology subscription to `ChannelGraph` #9577

graph: move topology subscription to `ChannelGraph` #9577

CodeRabbit Configuration File (`.coderabbit.yaml`)