12583319996

Committed 02 Jan 2025 01:38PM UTC coverage: 57.522% (-1.1%) from 58.598%

Build # 12583319996

Build Type

Pull #9361

github

Committed by

starius

Commit Message

fn/ContextGuard: use context.AfterFunc to wait

Simplifies context cancellation handling by using context.AfterFunc instead of a
goroutine to wait for context cancellation. This approach avoids the overhead of
a goroutine during the waiting period.

For ctxQuitUnsafe, since g.quit is closed only in the Quit method (which also
cancels all associated contexts), waiting on context cancellation ensures the
same behavior without unnecessary dependency on g.quit.

Added a test to ensure that the Create method does not launch any goroutines.

Pull Request Pull Request #9361: fn: optimize context guard

Run Details

102587 of 178344 relevant lines covered (57.52%)

24734.33 hits per line

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

41.67

/macaroons/auth.go

package macaroons

import (
        "context"
        "encoding/hex"

        macaroon "gopkg.in/macaroon.v2"
)

// MacaroonCredential wraps a macaroon to implement the
// credentials.PerRPCCredentials interface.
type MacaroonCredential struct {
        *macaroon.Macaroon
}

// RequireTransportSecurity implements the PerRPCCredentials interface.
func (m MacaroonCredential) RequireTransportSecurity() bool {
        return true
}

// GetRequestMetadata implements the PerRPCCredentials interface. This method
// is required in order to pass the wrapped macaroon into the gRPC context.
// With this, the macaroon will be available within the request handling scope
// of the ultimate gRPC server implementation.
func (m MacaroonCredential) GetRequestMetadata(ctx context.Context,
        uri ...string) (map[string]string, error) {

        macBytes, err := m.MarshalBinary()
        if err != nil {
                return nil, err
        }

        md := make(map[string]string)
        md["macaroon"] = hex.EncodeToString(macBytes)
        return md, nil
}

// NewMacaroonCredential returns a copy of the passed macaroon wrapped in a
// MacaroonCredential struct which implements PerRPCCredentials.
func NewMacaroonCredential(m *macaroon.Macaroon) (MacaroonCredential, error) {
        ms := MacaroonCredential{}

        // The macaroon library's Clone() method has a subtle bug that doesn't
        // correctly clone all caveats. We need to use our own, safe clone
        // function instead.
        var err error
        ms.Macaroon, err = SafeCopyMacaroon(m)
        if err != nil {
                return ms, err
        }

        return ms, nil
}

1	package macaroons
2
3	import (
4	"context"
5	"encoding/hex"
6
7	macaroon "gopkg.in/macaroon.v2"
8	)
9
10	// MacaroonCredential wraps a macaroon to implement the
11	// credentials.PerRPCCredentials interface.
12	type MacaroonCredential struct {
13	*macaroon.Macaroon
14	}
15
16	// RequireTransportSecurity implements the PerRPCCredentials interface.
17	func (m MacaroonCredential) RequireTransportSecurity() bool {	×
18	return true	×
19	}	×
20
21	// GetRequestMetadata implements the PerRPCCredentials interface. This method
22	// is required in order to pass the wrapped macaroon into the gRPC context.
23	// With this, the macaroon will be available within the request handling scope
24	// of the ultimate gRPC server implementation.
25	func (m MacaroonCredential) GetRequestMetadata(ctx context.Context,
26	uri ...string) (map[string]string, error) {	×
27		×
28	macBytes, err := m.MarshalBinary()	×
29	if err != nil {	×
30	return nil, err	×
31	}	×
32
33	md := make(map[string]string)	×
34	md["macaroon"] = hex.EncodeToString(macBytes)	×
35	return md, nil	×
36	}
37
38	// NewMacaroonCredential returns a copy of the passed macaroon wrapped in a
39	// MacaroonCredential struct which implements PerRPCCredentials.
40	func NewMacaroonCredential(m *macaroon.Macaroon) (MacaroonCredential, error) {	1✔
41	ms := MacaroonCredential{}	1✔
42		1✔
43	// The macaroon library's Clone() method has a subtle bug that doesn't	1✔
44	// correctly clone all caveats. We need to use our own, safe clone	1✔
45	// function instead.	1✔
46	var err error	1✔
47	ms.Macaroon, err = SafeCopyMacaroon(m)	1✔
48	if err != nil {	1✔
49	return ms, err	×
50	}	×
51
52	return ms, nil	1✔
53	}

lightningnetwork / lnd / 12583319996

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