[2/3] Graph RIP: multi: Graph Source Abstraction #9243
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Important Review skippedAuto reviews are limited to specific labels. 🏷️ Labels to auto review (1)
Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
298f526
to
3ce1526
Compare
|
Exciting functionality! |
|
quite a big change/update incoming here soon - so not ready to review yet! 🦖 |
3ce1526
to
2a3db35
Compare
1504b31
to
53d1fab
Compare
2a3db35
to
d04f613
Compare
971cca9
to
2dc2543
Compare
|
Alrighty: updated. See the updated PR description for: 1) PR description 2) PR Flow and 3) how to test this PR. The follow up PR will add the RPC implementation of the |
53d1fab
to
d7d8c39
Compare
Simplify the ChannelGraphSource interface by removing this unused method.
For consistency in the graphsessoin.graph interface, we let the FetchNodeFeatures method take a read transaction just like the ForEachNodeDirectedChannel. This is nice because then all calls in the same pathfinding transaction use the same read transaction.
The package name is kept the same. So this is just for less stuttering at a path level.
This commit adds a new GraphSources interface that LND requires for graph related read-only queries. As of this commit, the interface is empty but it will be populated over the next couple of commits. We add an implementation of this interface backed by a pointer to a graphdb.ChannelGraph. The infrustructure is put into place so that the GraphSoure provided to LND can be overridden by a caller of the lnd.Main function. By default, LND will satisfy the interface itself via the new `graphsource.DBSource` struct.
In this commit, we take the existing graphsession.ReadyOnlyGraph interface and remove its usage of a kvdb.RTx and replace it with a more abstract `RTx` interface type. The new GraphSource interface is expanded to include the graphsession.ReadOnlyGraph interface and the implementation of it, DBSource, is expanded to include the new methods. It converts the given RTx to the underlying kvdb read transaction where needed.
Since the GraphSource interface may be satisfied by an RPC connection, it is best practice to pass a context through to any call in the interface. The ChanGraphSource implementation, which uses a kvdb backend, does not make use of the ctx. Any call-sites are for now given a `context.TODO()` which will all be addressed in follow up commits.
Define a new GraphSource interface required by the invoicerpc server and remove its access to the graphdb.ChannelGraph pointer. Add the new invoicesrpc.GraphSource interface to the GraphSource interface and let DBSource implement it.
And let DBSource implement it.
In this commit, we add a bunch of graph methods to the GraphSource, let DBSource implement it and then we use the graph source for these methods for the GetNodeInfo, VerifyMessage, DescribeGraph, GetNodeMetrics, GetChanInfo and GetNodeInfo RPC calls along with peer alias lookup.
We will later implement this interface with a backing RPC connection and so it makes sense to pass a context through for cancellation.
So that LND can use a different GraphSource for network bootstrapping and does not need to rely on its local graph db.
so that the external graph source can be used to query network information rather than depending on the local graph DB.
So that the calcuation is abstracted behind the interface and not necessarily dependent on LND's local channel graph.
2dc2543
to
06e655f
Compare
06e655f
to
9335ed9
Compare
These should be addressed in a refactor PR.
9335ed9
to
eea9022
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR description
Depends on #9236
This PR adds a new
GraphSourceinterface and passes it around tovarious sub-systems of LND instead of passing around the raw
*graphdb.ChannelGraphpointer. This will allow us to plug in a differentgraph source if we so please. The new
ImplementationCfg.GraphProvidercan be be overridden to provide a different graph source.
This PR by itself is a pure refactor with no logic changes.
PR Flow:
GraphSourceinterface is added and one by one we add tointerface and pass it around to more and more parts of the code base.
Testing this PR:
See/use this demo multinode binary PR to test this PR.
It shows how one LND node can be used as the remote graph source of
another LND node. See that PR description for a more in depth description.