highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-04-07 19:48:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

graph: add contexts to the ReadOnlyGraph interface

Browse Source 
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.
This commit is contained in:
Elle Mouton 2024-11-11 16:31:50 +02:00
parent aa2480464b
commit 9854bad720
No known key found for this signature in database
GPG Key ID: D7D916376026F177
2 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
graph/session/graph_session.go
View File

@ -1,6 +1,7 @@
package session
import (
"context"
"fmt"
graphdb "github.com/lightningnetwork/lnd/graph/db"
@ -30,7 +31,7 @@ func NewGraphSessionFactory(graph ReadOnlyGraph) routing.GraphSessionFactory {
//
// NOTE: This is part of the routing.GraphSessionFactory interface.
func (g *Factory) NewGraphSession() (routing.Graph, func() error, error) {
tx, err := g.graph.NewPathFindTx()
tx, err := g.graph.NewPathFindTx(context.TODO())
if err != nil {
return nil, nil, err
}
@ -85,7 +86,9 @@ func (g *session) close() error {
func (g *session) ForEachNodeChannel(nodePub route.Vertex,
cb func(channel *graphdb.DirectedChannel) error) error {
return g.graph.ForEachNodeDirectedChannel(g.tx, nodePub, cb)
return g.graph.ForEachNodeDirectedChannel(
context.TODO(), g.tx, nodePub, cb,
)
}
// FetchNodeFeatures returns the features of the given node. If the node is
@ -95,7 +98,7 @@ func (g *session) ForEachNodeChannel(nodePub route.Vertex,
func (g *session) FetchNodeFeatures(nodePub route.Vertex) (
*lnwire.FeatureVector, error) {
return g.graph.FetchNodeFeatures(g.tx, nodePub)
return g.graph.FetchNodeFeatures(context.TODO(), g.tx, nodePub)
}
// A compile-time check to ensure that *session implements the
@ -108,7 +111,7 @@ type ReadOnlyGraph interface {
// NewPathFindTx returns a new read transaction that can be used for a
// single path finding session. Will return nil if the graph cache is
// enabled.
NewPathFindTx() (RTx, error)
NewPathFindTx(ctx context.Context) (RTx, error)
graph
}
@ -127,7 +130,8 @@ type graph interface {
//
// NOTE: if a nil tx is provided, then it is expected that the
// implementation create a read only tx.
ForEachNodeDirectedChannel(tx RTx, node route.Vertex,
ForEachNodeDirectedChannel(ctx context.Context, tx RTx,
node route.Vertex,
cb func(channel *graphdb.DirectedChannel) error) error
// FetchNodeFeatures returns the features of a given node. If no
@ -135,6 +139,6 @@ type graph interface {
//
// NOTE: if a nil tx is provided, then it is expected that the
// implementation create a read only tx.
FetchNodeFeatures(tx RTx, node route.Vertex) (*lnwire.FeatureVector,
error)
FetchNodeFeatures(ctx context.Context, tx RTx, node route.Vertex) (
*lnwire.FeatureVector, error)
}

11
graph/sources/chan_graph.go
View File

@ -1,6 +1,7 @@
package sources
import (
"context"
"fmt"
graphdb "github.com/lightningnetwork/lnd/graph/db"
@ -32,8 +33,8 @@ func NewDBGSource(db *graphdb.ChannelGraph) *DBSource {
// path finding session. Will return nil if the graph cache is enabled for the
// underlying graphdb.ChannelGraph.
//
// NOTE: this is part of the graphsession.ReadOnlyGraph interface.
func (s *DBSource) NewPathFindTx() (session.RTx, error) {
// NOTE: this is part of the session.ReadOnlyGraph interface.
func (s *DBSource) NewPathFindTx(_ context.Context) (session.RTx, error) {
tx, err := s.db.NewPathFindTx()
if err != nil {
return nil, err
@ -51,8 +52,8 @@ func (s *DBSource) NewPathFindTx() (session.RTx, error) {
//
// Unknown policies are passed into the callback as nil values.
//
// NOTE: this is part of the graphsession.ReadOnlyGraph interface.
func (s *DBSource) ForEachNodeDirectedChannel(tx session.RTx,
// NOTE: this is part of the session.ReadOnlyGraph interface.
func (s *DBSource) ForEachNodeDirectedChannel(_ context.Context, tx session.RTx,
node route.Vertex,
cb func(channel *graphdb.DirectedChannel) error) error {
@ -70,7 +71,7 @@ func (s *DBSource) ForEachNodeDirectedChannel(tx session.RTx,
// and passed into the callback.
//
// NOTE: this is part of the graphsession.ReadOnlyGraph interface.
func (s *DBSource) FetchNodeFeatures(tx session.RTx,
func (s *DBSource) FetchNodeFeatures(_ context.Context, tx session.RTx,
node route.Vertex) (*lnwire.FeatureVector, error) {
kvdbTx, err := extractKVDBRTx(tx)