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

/build/log_shutdown.go

package build

import (
        "context"

        "github.com/btcsuite/btclog/v2"
)

// ShutdownLogger wraps an existing logger with a shutdown function which will
// be called on Critical/Criticalf to prompt shutdown.
type ShutdownLogger struct {
        btclog.Logger
        shutdown func()
}

// NewShutdownLogger creates a shutdown logger for the log provided which will
// use the signal package to request shutdown on critical errors.
func NewShutdownLogger(logger btclog.Logger, shutdown func()) *ShutdownLogger {
        return &ShutdownLogger{
                Logger:   logger,
                shutdown: shutdown,
        }
}

// Criticalf formats message according to format specifier and writes to
// log with LevelCritical. It will then call the shutdown logger's shutdown
// function to prompt safe shutdown.
//
// Note: it is part of the btclog.Logger interface.
func (s *ShutdownLogger) Criticalf(format string, params ...interface{}) {
        s.Logger.Criticalf(format, params...)
        s.Logger.Info("Sending request for shutdown")
        s.shutdown()
}

// Critical formats message using the default formats for its operands
// and writes to log with LevelCritical. It will then call the shutdown
// logger's shutdown function to prompt safe shutdown.
//
// Note: it is part of the btclog.Logger interface.
func (s *ShutdownLogger) Critical(v ...interface{}) {
        s.Logger.Critical(v)
        s.Logger.Info("Sending request for shutdown")
        s.shutdown()
}

// CriticalS writes a structured log with the given message and key-value pair
// attributes with LevelCritical to the log. It will then call the shutdown
// logger's shutdown function to prompt safe shutdown.
//
// Note: it is part of the btclog.Logger interface.
func (s *ShutdownLogger) CriticalS(ctx context.Context, msg string, err error,
        attr ...interface{}) {

        s.Logger.CriticalS(ctx, msg, err, attr...)
        s.Logger.Info("Sending request for shutdown")
        s.shutdown()
}

1	package build
2
3	import (
4	"context"
5
6	"github.com/btcsuite/btclog/v2"
7	)
8
9	// ShutdownLogger wraps an existing logger with a shutdown function which will
10	// be called on Critical/Criticalf to prompt shutdown.
11	type ShutdownLogger struct {
12	btclog.Logger
13	shutdown func()
14	}
15
16	// NewShutdownLogger creates a shutdown logger for the log provided which will
17	// use the signal package to request shutdown on critical errors.
18	func NewShutdownLogger(logger btclog.Logger, shutdown func()) *ShutdownLogger {	×
19	return &ShutdownLogger{	×
20	Logger: logger,	×
21	shutdown: shutdown,	×
22	}	×
23	}	×
24
25	// Criticalf formats message according to format specifier and writes to
26	// log with LevelCritical. It will then call the shutdown logger's shutdown
27	// function to prompt safe shutdown.
28	//
29	// Note: it is part of the btclog.Logger interface.
30	func (s *ShutdownLogger) Criticalf(format string, params ...interface{}) {	×
31	s.Logger.Criticalf(format, params...)	×
32	s.Logger.Info("Sending request for shutdown")	×
33	s.shutdown()	×
34	}	×
35
36	// Critical formats message using the default formats for its operands
37	// and writes to log with LevelCritical. It will then call the shutdown
38	// logger's shutdown function to prompt safe shutdown.
39	//
40	// Note: it is part of the btclog.Logger interface.
41	func (s *ShutdownLogger) Critical(v ...interface{}) {	×
42	s.Logger.Critical(v)	×
43	s.Logger.Info("Sending request for shutdown")	×
44	s.shutdown()	×
45	}	×
46
47	// CriticalS writes a structured log with the given message and key-value pair
48	// attributes with LevelCritical to the log. It will then call the shutdown
49	// logger's shutdown function to prompt safe shutdown.
50	//
51	// Note: it is part of the btclog.Logger interface.
52	func (s *ShutdownLogger) CriticalS(ctx context.Context, msg string, err error,
53	attr ...interface{}) {	×
54		×
55	s.Logger.CriticalS(ctx, msg, err, attr...)	×
56	s.Logger.Info("Sending request for shutdown")	×
57	s.shutdown()	×
58	}	×

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