12312390362

Committed 13 Dec 2024 08:44AM UTC coverage: 57.458% (+8.5%) from 48.92%

Build # 12312390362

Build Type

Pull #9343

github

Committed by

ellemouton

Commit Message

fn: rework the ContextGuard and add tests

In this commit, the ContextGuard struct is re-worked such that the
context that its new main WithCtx method provides is cancelled in sync
with a parent context being cancelled or with it's quit channel being
cancelled. Tests are added to assert the behaviour. In order for the
close of the quit channel to be consistent with the cancelling of the
derived context, the quit channel _must_ be contained internal to the
ContextGuard so that callers are only able to close the channel via the
exposed Quit method which will then take care to first cancel any
derived context that depend on the quit channel before returning.

Pull Request Pull Request #9343: fn: expand the ContextGuard and add tests

Run Details

101853 of 177264 relevant lines covered (57.46%)

24972.93 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/routing/graph.go

package routing

import (
        "fmt"

        "github.com/btcsuite/btcd/btcutil"
        graphdb "github.com/lightningnetwork/lnd/graph/db"
        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/routing/route"
)

// Graph is an abstract interface that provides information about nodes and
// edges to pathfinding.
type Graph interface {
        // ForEachNodeChannel calls the callback for every channel of the given
        // node.
        ForEachNodeChannel(nodePub route.Vertex,
                cb func(channel *graphdb.DirectedChannel) error) error

        // FetchNodeFeatures returns the features of the given node.
        FetchNodeFeatures(nodePub route.Vertex) (*lnwire.FeatureVector, error)
}

// GraphSessionFactory can be used to produce a new Graph instance which can
// then be used for a path-finding session. Depending on the implementation,
// the Graph session will represent a DB connection where a read-lock is being
// held across calls to the backing Graph.
type GraphSessionFactory interface {
        // NewGraphSession will produce a new Graph to use for a path-finding
        // session. It returns the Graph along with a call-back that must be
        // called once Graph access is complete. This call-back will close any
        // read-only transaction that was created at Graph construction time.
        NewGraphSession() (Graph, func() error, error)
}

// FetchAmountPairCapacity determines the maximal public capacity between two
// nodes depending on the amount we try to send.
func FetchAmountPairCapacity(graph Graph, source, nodeFrom, nodeTo route.Vertex,
        amount lnwire.MilliSatoshi) (btcutil.Amount, error) {

        // Create unified edges for all incoming connections.
        //
        // Note: Inbound fees are not used here because this method is only used
        // by a deprecated router rpc.
        u := newNodeEdgeUnifier(source, nodeTo, false, nil)

        err := u.addGraphPolicies(graph)
        if err != nil {
                return 0, err
        }

        edgeUnifier, ok := u.edgeUnifiers[nodeFrom]
        if !ok {
                return 0, fmt.Errorf("no edge info for node pair %v -> %v",
                        nodeFrom, nodeTo)
        }

        edge := edgeUnifier.getEdgeNetwork(amount, 0)
        if edge == nil {
                return 0, fmt.Errorf("no edge for node pair %v -> %v "+
                        "(amount %v)", nodeFrom, nodeTo, amount)
        }

        return edge.capacity, nil
}

1	package routing
2
3	import (
4	"fmt"
5
6	"github.com/btcsuite/btcd/btcutil"
7	graphdb "github.com/lightningnetwork/lnd/graph/db"
8	"github.com/lightningnetwork/lnd/lnwire"
9	"github.com/lightningnetwork/lnd/routing/route"
10	)
11
12	// Graph is an abstract interface that provides information about nodes and
13	// edges to pathfinding.
14	type Graph interface {
15	// ForEachNodeChannel calls the callback for every channel of the given
16	// node.
17	ForEachNodeChannel(nodePub route.Vertex,
18	cb func(channel *graphdb.DirectedChannel) error) error
19
20	// FetchNodeFeatures returns the features of the given node.
21	FetchNodeFeatures(nodePub route.Vertex) (*lnwire.FeatureVector, error)
22	}
23
24	// GraphSessionFactory can be used to produce a new Graph instance which can
25	// then be used for a path-finding session. Depending on the implementation,
26	// the Graph session will represent a DB connection where a read-lock is being
27	// held across calls to the backing Graph.
28	type GraphSessionFactory interface {
29	// NewGraphSession will produce a new Graph to use for a path-finding
30	// session. It returns the Graph along with a call-back that must be
31	// called once Graph access is complete. This call-back will close any
32	// read-only transaction that was created at Graph construction time.
33	NewGraphSession() (Graph, func() error, error)
34	}
35
36	// FetchAmountPairCapacity determines the maximal public capacity between two
37	// nodes depending on the amount we try to send.
38	func FetchAmountPairCapacity(graph Graph, source, nodeFrom, nodeTo route.Vertex,
39	amount lnwire.MilliSatoshi) (btcutil.Amount, error) {	×
40		×
41	// Create unified edges for all incoming connections.	×
42	//	×
43	// Note: Inbound fees are not used here because this method is only used	×
44	// by a deprecated router rpc.	×
45	u := newNodeEdgeUnifier(source, nodeTo, false, nil)	×
46		×
47	err := u.addGraphPolicies(graph)	×
48	if err != nil {	×
49	return 0, err	×
50	}	×
51
52	edgeUnifier, ok := u.edgeUnifiers[nodeFrom]	×
53	if !ok {	×
54	return 0, fmt.Errorf("no edge info for node pair %v -> %v",	×
55	nodeFrom, nodeTo)	×
56	}	×
57
58	edge := edgeUnifier.getEdgeNetwork(amount, 0)	×
59	if edge == nil {	×
60	return 0, fmt.Errorf("no edge for node pair %v -> %v "+	×
61	"(amount %v)", nodeFrom, nodeTo, amount)	×
62	}	×
63
64	return edge.capacity, nil	×
65	}

lightningnetwork / lnd / 12312390362

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous