graph: extract cache from CRUD [4] #9551

ellemouton · 2025-02-25T09:39:48Z

** PR 4 ** (note: not dependent on PR 3)

This builds towards this final result by building this side branch incrementally.

In this PR, we move the cache writes for DeleteChannelEdges, DisconnectBlockAtHeight, PruneGraphandPruneGraphNodes` from the KVStore to the ChannelGraph. These each need a bit of refactoring of some
helper methods first, so this PR does this refactoring too.

coderabbitai · 2025-02-25T09:39:57Z

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.

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

bhandras

Looks good, just one comment re pruning.

graph/db/graph.go

bhandras

LGTM 🏄

And update cache outside the method rather. This will make it easier to completely move the cache write out to the ChannelGraph layer.

Here we move the cache writes for DisconnectBlockAtHeight and DeleteChannelEdges to the ChannelGraph.

In preparation for moving the cache write completely out of KVStore, we move the cache write up one layer.

yyforyongyu

Cool I think it's good to go, only have a comment about rebasing, the rest are nits so feel free to ignore.

yyforyongyu · 2025-02-26T10:20:16Z

graph/db/graph.go

+	// cacheMu guards any writes to the graphCache. It should be held
+	// across the DB write call and the graphCache update to make the
+	// two updates as atomic as possible.
+	cacheMu    sync.Mutex


isn't this added here already? I guess it's missing a rebase?

yeah - i made it so that all the PRs dont depend on eachother. They all pointed to the same base. So now that that other one got in first, i can remove that here.

ie, wanted to have all the PRs disjoint

yyforyongyu · 2025-02-26T10:21:26Z

graph/db/graph.go

+		return err
+	}
+
+	if c.graphCache != nil {


think we can use if c.graphCache == nil and exit early to save some indentations

ah ok so for this i think better to keep as is since yes today it exits after, but we will soon expand ChannelGraph to do more than just handle the graphCache. For example when we start moving topology management here and remote graph handling

yyforyongyu · 2025-02-26T10:21:46Z

graph/db/graph.go

+		return nil, err
+	}
+
+	if c.graphCache != nil {


same nit re exiting early.

see above reply

yyforyongyu · 2025-02-26T10:24:51Z

graph/db/kv_store.go

+			return err
+		}
+
+		if c.graphCache != nil {


starting to get a bit lost here...so I guess the goal is to keep KVStore oblivious of the existence of the graph cache, so I guess we need to move the cache into an even higher layer?

yes, this is an intermediary step. the very next commit does this

see commit message "in preparation for moving cache up.."

saw your other comment now :)

yyforyongyu · 2025-02-26T10:26:05Z

graph/db/kv_store.go

@@ -1509,19 +1493,18 @@ func (c *KVStore) PruneGraphNodes() error {
 			return ErrGraphNoEdgesFound
 		}

-		prunedNodes, err := c.pruneGraphNodes(nodes, edgeIndex)
+		var err error
+		prunedNodes, err = c.pruneGraphNodes(nodes, edgeIndex)


ok i see it's done in a different commit.

yyforyongyu · 2025-02-26T11:52:51Z

graph/db/graph.go

+	}
+
+	if c.graphCache != nil {
+		for _, edge := range edges {


This is future stuff, but I just realized all these logic can live in graphCache instead, sth like graphCache.pruneGraph. And same for other places where we have customized logic for the cache.

yeah agreed 👍

This commit moves the cache writes for PruneGraphNodes and PruneGraph from the KVStore to the ChannelGraph.

yyforyongyu

🚢

ellemouton self-assigned this Feb 25, 2025

ellemouton added the graph label Feb 25, 2025

ellemouton force-pushed the graph15 branch from fa250f4 to 415b270 Compare February 25, 2025 09:44

ellemouton requested review from yyforyongyu and bhandras February 25, 2025 11:30

ellemouton force-pushed the graph15 branch from 415b270 to 81a74a6 Compare February 25, 2025 13:46

bhandras reviewed Feb 25, 2025

View reviewed changes

graph/db/graph.go Outdated Show resolved Hide resolved

ellemouton force-pushed the graph15 branch from 81a74a6 to 968e048 Compare February 25, 2025 15:00

bhandras approved these changes Feb 25, 2025

View reviewed changes

ellemouton added 3 commits February 26, 2025 13:50

graph/db: refactor delChannelEdgeUnsafe to return edge info

4b66cf9

And update cache outside the method rather. This will make it easier to completely move the cache write out to the ChannelGraph layer.

graph/db: move some cache writes to ChannelGraph.

a5145b4

Here we move the cache writes for DisconnectBlockAtHeight and DeleteChannelEdges to the ChannelGraph.

graph/db: move cache update out of pruneGraphNodes

16e3ee2

In preparation for moving the cache write completely out of KVStore, we move the cache write up one layer.

yyforyongyu reviewed Feb 26, 2025

View reviewed changes

graph/db: move cache writes for Prune methods

f2f4743

This commit moves the cache writes for PruneGraphNodes and PruneGraph from the KVStore to the ChannelGraph.

ellemouton force-pushed the graph15 branch from 968e048 to f2f4743 Compare February 26, 2025 12:01

ellemouton mentioned this pull request Feb 26, 2025

graph: extract cache from CRUD [6] #9555

Merged

yyforyongyu approved these changes Feb 26, 2025

View reviewed changes

ellemouton merged commit aafbc98 into lightningnetwork:elle-graphCacheBase Feb 26, 2025
29 of 30 checks passed

ellemouton deleted the graph15 branch February 26, 2025 13:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

graph: extract cache from CRUD [4] #9551

graph: extract cache from CRUD [4] #9551

ellemouton commented Feb 25, 2025

coderabbitai bot commented Feb 25, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

bhandras left a comment

bhandras left a comment

yyforyongyu left a comment

yyforyongyu Feb 26, 2025

ellemouton Feb 26, 2025

yyforyongyu Feb 26, 2025

ellemouton Feb 26, 2025

yyforyongyu Feb 26, 2025

ellemouton Feb 26, 2025

yyforyongyu Feb 26, 2025

ellemouton Feb 26, 2025

ellemouton Feb 26, 2025

ellemouton Feb 26, 2025

yyforyongyu Feb 26, 2025

yyforyongyu Feb 26, 2025

ellemouton Feb 26, 2025

yyforyongyu left a comment

graph: extract cache from CRUD [4] #9551

graph: extract cache from CRUD [4] #9551

Conversation

ellemouton commented Feb 25, 2025

coderabbitai bot commented Feb 25, 2025 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

bhandras left a comment

Choose a reason for hiding this comment

bhandras left a comment

Choose a reason for hiding this comment

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

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

yyforyongyu left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Feb 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)