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

58.33

/htlcswitch/failure_detail.go

package htlcswitch

// FailureDetail is an interface implemented by failures that occur on
// our incoming or outgoing link, or within the switch itself.
type FailureDetail interface {
        // FailureString returns the string representation of a failure
        // detail.
        FailureString() string
}

// OutgoingFailure is an enum which is used to enrich failures which occur in
// the switch or on our outgoing link with additional metadata.
type OutgoingFailure int

const (
        // OutgoingFailureNone is returned when the wire message contains
        // sufficient information.
        OutgoingFailureNone OutgoingFailure = iota

        // OutgoingFailureDecodeError indicates that we could not decode the
        // failure reason provided for a failed payment.
        OutgoingFailureDecodeError

        // OutgoingFailureLinkNotEligible indicates that a routing attempt was
        // made over a link that is not eligible for routing.
        OutgoingFailureLinkNotEligible

        // OutgoingFailureOnChainTimeout indicates that a payment had to be
        // timed out on chain before it got past the first hop by us or the
        // remote party.
        OutgoingFailureOnChainTimeout

        // OutgoingFailureHTLCExceedsMax is returned when a htlc exceeds our
        // policy's maximum htlc amount.
        OutgoingFailureHTLCExceedsMax

        // OutgoingFailureInsufficientBalance is returned when we cannot route a
        // htlc due to insufficient outgoing capacity.
        OutgoingFailureInsufficientBalance

        // OutgoingFailureCircularRoute is returned when an attempt is made
        // to forward a htlc through our node which arrives and leaves on the
        // same channel.
        OutgoingFailureCircularRoute

        // OutgoingFailureIncompleteForward is returned when we cancel an incomplete
        // forward.
        OutgoingFailureIncompleteForward

        // OutgoingFailureDownstreamHtlcAdd is returned when we fail to add a
        // downstream htlc to our outgoing link.
        OutgoingFailureDownstreamHtlcAdd

        // OutgoingFailureForwardsDisabled is returned when the switch is
        // configured to disallow forwards.
        OutgoingFailureForwardsDisabled
)

// FailureString returns the string representation of a failure detail.
//
// Note: it is part of the FailureDetail interface.
func (fd OutgoingFailure) FailureString() string {
        switch fd {
        case OutgoingFailureNone:
                return "no failure detail"

        case OutgoingFailureDecodeError:
                return "could not decode wire failure"

        case OutgoingFailureLinkNotEligible:
                return "link not eligible"

        case OutgoingFailureOnChainTimeout:
                return "payment was resolved on-chain, then canceled back"

        case OutgoingFailureHTLCExceedsMax:
                return "htlc exceeds maximum policy amount"

        case OutgoingFailureInsufficientBalance:
                return "insufficient bandwidth to route htlc"

        case OutgoingFailureCircularRoute:
                return "same incoming and outgoing channel"

        case OutgoingFailureIncompleteForward:
                return "failed after detecting incomplete forward"

        case OutgoingFailureDownstreamHtlcAdd:
                return "could not add downstream htlc"

        case OutgoingFailureForwardsDisabled:
                return "node configured to disallow forwards"

        default:
                return "unknown failure detail"
        }
}

1	package htlcswitch
2
3	// FailureDetail is an interface implemented by failures that occur on
4	// our incoming or outgoing link, or within the switch itself.
5	type FailureDetail interface {
6	// FailureString returns the string representation of a failure
7	// detail.
8	FailureString() string
9	}
10
11	// OutgoingFailure is an enum which is used to enrich failures which occur in
12	// the switch or on our outgoing link with additional metadata.
13	type OutgoingFailure int
14
15	const (
16	// OutgoingFailureNone is returned when the wire message contains
17	// sufficient information.
18	OutgoingFailureNone OutgoingFailure = iota
19
20	// OutgoingFailureDecodeError indicates that we could not decode the
21	// failure reason provided for a failed payment.
22	OutgoingFailureDecodeError
23
24	// OutgoingFailureLinkNotEligible indicates that a routing attempt was
25	// made over a link that is not eligible for routing.
26	OutgoingFailureLinkNotEligible
27
28	// OutgoingFailureOnChainTimeout indicates that a payment had to be
29	// timed out on chain before it got past the first hop by us or the
30	// remote party.
31	OutgoingFailureOnChainTimeout
32
33	// OutgoingFailureHTLCExceedsMax is returned when a htlc exceeds our
34	// policy's maximum htlc amount.
35	OutgoingFailureHTLCExceedsMax
36
37	// OutgoingFailureInsufficientBalance is returned when we cannot route a
38	// htlc due to insufficient outgoing capacity.
39	OutgoingFailureInsufficientBalance
40
41	// OutgoingFailureCircularRoute is returned when an attempt is made
42	// to forward a htlc through our node which arrives and leaves on the
43	// same channel.
44	OutgoingFailureCircularRoute
45
46	// OutgoingFailureIncompleteForward is returned when we cancel an incomplete
47	// forward.
48	OutgoingFailureIncompleteForward
49
50	// OutgoingFailureDownstreamHtlcAdd is returned when we fail to add a
51	// downstream htlc to our outgoing link.
52	OutgoingFailureDownstreamHtlcAdd
53
54	// OutgoingFailureForwardsDisabled is returned when the switch is
55	// configured to disallow forwards.
56	OutgoingFailureForwardsDisabled
57	)
58
59	// FailureString returns the string representation of a failure detail.
60	//
61	// Note: it is part of the FailureDetail interface.
62	func (fd OutgoingFailure) FailureString() string {	9✔
63	switch fd {	9✔
64	case OutgoingFailureNone:	×
65	return "no failure detail"	×
66
67	case OutgoingFailureDecodeError:	×
68	return "could not decode wire failure"	×
69
70	case OutgoingFailureLinkNotEligible:	1✔
71	return "link not eligible"	1✔
72
73	case OutgoingFailureOnChainTimeout:	×
74	return "payment was resolved on-chain, then canceled back"	×
75
76	case OutgoingFailureHTLCExceedsMax:	2✔
77	return "htlc exceeds maximum policy amount"	2✔
78
79	case OutgoingFailureInsufficientBalance:	1✔
80	return "insufficient bandwidth to route htlc"	1✔
81
82	case OutgoingFailureCircularRoute:	1✔
83	return "same incoming and outgoing channel"	1✔
84
85	case OutgoingFailureIncompleteForward:	3✔
86	return "failed after detecting incomplete forward"	3✔
87
88	case OutgoingFailureDownstreamHtlcAdd:	×
89	return "could not add downstream htlc"	×
90
91	case OutgoingFailureForwardsDisabled:	1✔
92	return "node configured to disallow forwards"	1✔
93
94	default:	×
95	return "unknown failure detail"	×
96	}
97	}

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