routing: remove context.TODOs

Author: ellemouton

graph/session/graph_session.go

@@ -30,8 +30,10 @@ func NewGraphSessionFactory(graph ReadOnlyGraph) routing.GraphSessionFactory {
 // was created at Graph construction time.
 //
 // NOTE: This is part of the routing.GraphSessionFactory interface.
-func (g *Factory) NewGraphSession() (routing.Graph, func() error, error) {
-	tx, err := g.graph.NewPathFindTx(context.TODO())
+func (g *Factory) NewGraphSession(ctx context.Context) (routing.Graph,
+	func() error, error) {
+
+	tx, err := g.graph.NewPathFindTx(ctx)
 	if err != nil {
 		return nil, nil, err
 	}
@@ -83,22 +85,20 @@ func (g *session) close() error {
 // ForEachNodeChannel calls the callback for every channel of the given node.
 //
 // NOTE: Part of the routing.Graph interface.
-func (g *session) ForEachNodeChannel(nodePub route.Vertex,
+func (g *session) ForEachNodeChannel(ctx context.Context, nodePub route.Vertex,
 	cb func(channel *graphdb.DirectedChannel) error) error {
 
-	return g.graph.ForEachNodeDirectedChannel(
-		context.TODO(), g.tx, nodePub, cb,
-	)
+	return g.graph.ForEachNodeDirectedChannel(ctx, g.tx, nodePub, cb)
 }
 
 // FetchNodeFeatures returns the features of the given node. If the node is
 // unknown, assume no additional features are supported.
 //
 // NOTE: Part of the routing.Graph interface.
-func (g *session) FetchNodeFeatures(nodePub route.Vertex) (
-	*lnwire.FeatureVector, error) {
+func (g *session) FetchNodeFeatures(ctx context.Context,
+	nodePub route.Vertex) (*lnwire.FeatureVector, error) {
 
-	return g.graph.FetchNodeFeatures(context.TODO(), g.tx, nodePub)
+	return g.graph.FetchNodeFeatures(ctx, g.tx, nodePub)
 }
 
 // A compile-time check to ensure that *session implements the

lnrpc/invoicesrpc/addinvoice.go

@@ -96,7 +96,8 @@ type AddInvoiceConfig struct {
 
 	// QueryBlindedRoutes can be used to generate a few routes to this node
 	// that can then be used in the construction of a blinded payment path.
-	QueryBlindedRoutes func(lnwire.MilliSatoshi) ([]*route.Route, error)
+	QueryBlindedRoutes func(context.Context, lnwire.MilliSatoshi) (
+		[]*route.Route, error)
 }
 
 // AddInvoiceData contains the required data to create a new invoice.

lnrpc/routerrpc/router_backend.go

@@ -50,7 +50,8 @@ type RouterBackend struct {
 
 	// FetchAmountPairCapacity determines the maximal channel capacity
 	// between two nodes given a certain amount.
-	FetchAmountPairCapacity func(nodeFrom, nodeTo route.Vertex,
+	FetchAmountPairCapacity func(ctx context.Context, nodeFrom,
+		nodeTo route.Vertex,
 		amount lnwire.MilliSatoshi) (btcutil.Amount, error)
 
 	// FetchChannelEndpoints returns the pubkeys of both endpoints of the
@@ -60,7 +61,8 @@ type RouterBackend struct {
 
 	// FindRoute is a closure that abstracts away how we locate/query for
 	// routes.
-	FindRoute func(*routing.RouteRequest) (*route.Route, float64, error)
+	FindRoute func(context.Context, *routing.RouteRequest) (*route.Route,
+		float64, error)
 
 	MissionControl MissionControl
 
@@ -165,7 +167,7 @@ func (r *RouterBackend) QueryRoutes(ctx context.Context,
 	// Query the channel router for a possible path to the destination that
 	// can carry `in.Amt` satoshis _including_ the total fee required on
 	// the route
-	route, successProb, err := r.FindRoute(routeReq)
+	route, successProb, err := r.FindRoute(ctx, routeReq)
 	if err != nil {
 		return nil, err
 	}

lnrpc/routerrpc/router_backend_test.go

@@ -120,8 +120,8 @@ func testQueryRoutes(t *testing.T, useMissionControl bool, useMsat bool,
 		}
 	}
 
-	findRoute := func(req *routing.RouteRequest) (*route.Route, float64,
-		error) {
+	findRoute := func(_ context.Context, req *routing.RouteRequest) (
+		*route.Route, float64, error) {
 
 		if int64(req.Amount) != amtSat*1000 {
 			t.Fatal("unexpected amount")
@@ -200,7 +200,8 @@ func testQueryRoutes(t *testing.T, useMissionControl bool, useMsat bool,
 
 			return 1, nil
 		},
-		FetchAmountPairCapacity: func(nodeFrom, nodeTo route.Vertex,
+		FetchAmountPairCapacity: func(_ context.Context, nodeFrom,
+			nodeTo route.Vertex,
 			amount lnwire.MilliSatoshi) (btcutil.Amount, error) {
 
 			return 1, nil

lnrpc/routerrpc/router_server.go

@@ -426,7 +426,7 @@ func (s *Server) EstimateRouteFee(ctx context.Context,
 			return nil, errors.New("amount must be greater than 0")
 
 		default:
-			return s.probeDestination(req.Dest, req.AmtSat)
+			return s.probeDestination(ctx, req.Dest, req.AmtSat)
 		}
 
 	case isProbeInvoice:
@@ -440,8 +440,8 @@ func (s *Server) EstimateRouteFee(ctx context.Context,
 
 // probeDestination estimates fees along a route to a destination based on the
 // contents of the local graph.
-func (s *Server) probeDestination(dest []byte, amtSat int64) (*RouteFeeResponse,
-	error) {
+func (s *Server) probeDestination(ctx context.Context, dest []byte,
+	amtSat int64) (*RouteFeeResponse, error) {
 
 	destNode, err := route.NewVertexFromBytes(dest)
 	if err != nil {
@@ -469,7 +469,7 @@ func (s *Server) probeDestination(dest []byte, amtSat int64) (*RouteFeeResponse,
 		return nil, err
 	}
 
-	route, _, err := s.cfg.Router.FindRoute(routeReq)
+	route, _, err := s.cfg.Router.FindRoute(ctx, routeReq)
 	if err != nil {
 		return nil, err
 	}
@@ -1429,7 +1429,7 @@ func (s *Server) trackPaymentStream(context context.Context,
 }
 
 // BuildRoute builds a route from a list of hop addresses.
-func (s *Server) BuildRoute(_ context.Context,
+func (s *Server) BuildRoute(ctx context.Context,
 	req *BuildRouteRequest) (*BuildRouteResponse, error) {
 
 	if len(req.HopPubkeys) == 0 {
@@ -1490,7 +1490,7 @@ func (s *Server) BuildRoute(_ context.Context,
 
 	// Build the route and return it to the caller.
 	route, err := s.cfg.Router.BuildRoute(
-		amt, hops, outgoingChan, req.FinalCltvDelta, payAddr,
+		ctx, amt, hops, outgoingChan, req.FinalCltvDelta, payAddr,
 		firstHopBlob,
 	)
 	if err != nil {

lnrpc/routerrpc/router_server_deprecated.go

@@ -123,7 +123,7 @@ func (s *Server) SendToRoute(ctx context.Context,
 
 // QueryProbability returns the current success probability estimate for a
 // given node pair and amount.
-func (s *Server) QueryProbability(_ context.Context,
+func (s *Server) QueryProbability(ctx context.Context,
 	req *QueryProbabilityRequest) (*QueryProbabilityResponse, error) {
 
 	fromNode, err := route.NewVertexFromBytes(req.FromNode)
@@ -142,7 +142,7 @@ func (s *Server) QueryProbability(_ context.Context,
 	var prob float64
 	mc := s.cfg.RouterBackend.MissionControl
 	capacity, err := s.cfg.RouterBackend.FetchAmountPairCapacity(
-		fromNode, toNode, amt,
+		ctx, fromNode, toNode, amt,
 	)
 
 	// If we cannot query the capacity this means that either we don't have

routing/bandwidth.go

@@ -1,6 +1,7 @@
 package routing
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/lightningnetwork/lnd/fn"
@@ -82,8 +83,9 @@ type bandwidthManager struct {
 // hints for the edges we directly have open ourselves. Obtaining these hints
 // allows us to reduce the number of extraneous attempts as we can skip channels
 // that are inactive, or just don't have enough bandwidth to carry the payment.
-func newBandwidthManager(graph Graph, sourceNode route.Vertex,
-	linkQuery getLinkQuery, firstHopBlob fn.Option[tlv.Blob],
+func newBandwidthManager(ctx context.Context, graph Graph,
+	sourceNode route.Vertex, linkQuery getLinkQuery,
+	firstHopBlob fn.Option[tlv.Blob],
 	trafficShaper fn.Option[TlvTrafficShaper]) (*bandwidthManager, error) {
 
 	manager := &bandwidthManager{
@@ -95,7 +97,7 @@ func newBandwidthManager(graph Graph, sourceNode route.Vertex,
 
 	// First, we'll collect the set of outbound edges from the target
 	// source node and add them to our bandwidth manager's map of channels.
-	err := graph.ForEachNodeChannel(sourceNode,
+	err := graph.ForEachNodeChannel(ctx, sourceNode,
 		func(channel *graphdb.DirectedChannel) error {
 			shortID := lnwire.NewShortChanIDFromInt(
 				channel.ChannelID,

routing/bandwidth_test.go

@@ -1,6 +1,7 @@
 package routing
 
 import (
+	"context"
 	"testing"
 
 	"github.com/btcsuite/btcd/btcutil"
@@ -116,7 +117,8 @@ func TestBandwidthManager(t *testing.T) {
 			)
 
 			m, err := newBandwidthManager(
-				g, sourceNode.pubkey, testCase.linkQuery,
+				context.Background(), g, sourceNode.pubkey,
+				testCase.linkQuery,
 				fn.None[[]byte](),
 				fn.Some[TlvTrafficShaper](&mockTrafficShaper{}),
 			)

routing/blindedpath/blinded_path.go

@@ -39,7 +39,8 @@ type BuildBlindedPathCfg struct {
 	// various lengths and may even contain only a single hop. Any route
 	// shorter than MinNumHops will be padded with dummy hops during route
 	// construction.
-	FindRoutes func(value lnwire.MilliSatoshi) ([]*route.Route, error)
+	FindRoutes func(ctx context.Context, value lnwire.MilliSatoshi) (
+		[]*route.Route, error)
 
 	// FetchChannelEdgesByID attempts to look up the two directed edges for
 	// the channel identified by the channel ID.
@@ -118,7 +119,7 @@ func BuildBlindedPaymentPaths(ctx context.Context, cfg *BuildBlindedPathCfg) (
 
 	// Find some appropriate routes for the value to be routed. This will
 	// return a set of routes made up of real nodes.
-	routes, err := cfg.FindRoutes(cfg.ValueMsat)
+	routes, err := cfg.FindRoutes(ctx, cfg.ValueMsat)
 	if err != nil {
 		return nil, err
 	}

routing/blindedpath/blinded_path_test.go

@@ -595,8 +595,8 @@ func TestBuildBlindedPath(t *testing.T) {
 	}
 
 	paths, err := BuildBlindedPaymentPaths(ctx, &BuildBlindedPathCfg{
-		FindRoutes: func(_ lnwire.MilliSatoshi) ([]*route.Route,
-			error) {
+		FindRoutes: func(_ context.Context, _ lnwire.MilliSatoshi) (
+			[]*route.Route, error) {
 
 			return []*route.Route{realRoute}, nil
 		},
@@ -765,8 +765,8 @@ func TestBuildBlindedPathWithDummyHops(t *testing.T) {
 	}
 
 	paths, err := BuildBlindedPaymentPaths(ctx, &BuildBlindedPathCfg{
-		FindRoutes: func(_ lnwire.MilliSatoshi) ([]*route.Route,
-			error) {
+		FindRoutes: func(_ context.Context, _ lnwire.MilliSatoshi) (
+			[]*route.Route, error) {
 
 			return []*route.Route{realRoute}, nil
 		},
@@ -935,8 +935,8 @@ func TestBuildBlindedPathWithDummyHops(t *testing.T) {
 	// still get 1 valid path.
 	var errCount int
 	paths, err = BuildBlindedPaymentPaths(ctx, &BuildBlindedPathCfg{
-		FindRoutes: func(_ lnwire.MilliSatoshi) ([]*route.Route,
-			error) {
+		FindRoutes: func(_ context.Context, _ lnwire.MilliSatoshi) (
+			[]*route.Route, error) {
 
 			return []*route.Route{realRoute, realRoute, realRoute},
 				nil
@@ -1016,8 +1016,8 @@ func TestSingleHopBlindedPath(t *testing.T) {
 	}
 
 	paths, err := BuildBlindedPaymentPaths(ctx, &BuildBlindedPathCfg{
-		FindRoutes: func(_ lnwire.MilliSatoshi) ([]*route.Route,
-			error) {
+		FindRoutes: func(_ context.Context, _ lnwire.MilliSatoshi) (
+			[]*route.Route, error) {
 
 			return []*route.Route{realRoute}, nil
 		},