Refactored loggers to use pointers rather than instances

Author: Djadih

consensus/blake3pow/blake3pow.go

@@ -47,7 +47,7 @@ type Config struct {
 	// be block header JSON objects instead of work package arrays.
 	NotifyFull bool
 
-	Log log.Logger `toml:"-"`
+	Log *log.Logger `toml:"-"`
 }
 
 // Blake3pow is a proof-of-work consensus engine using the blake3 hash algorithm
@@ -75,7 +75,7 @@ type Blake3pow struct {
 // packages.
 func New(config Config, notify []string, noverify bool) *Blake3pow {
 	if config.Log == nil {
-		config.Log = log.Log
+		config.Log = &log.Log
 	}
 	blake3pow := &Blake3pow{
 		config:   config,
@@ -102,7 +102,7 @@ func NewFaker() *Blake3pow {
 	return &Blake3pow{
 		config: Config{
 			PowMode: ModeFake,
-			Log:     log.Log,
+			Log:     &log.Log,
 		},
 	}
 }
@@ -114,7 +114,7 @@ func NewFakeFailer(fail uint64) *Blake3pow {
 	return &Blake3pow{
 		config: Config{
 			PowMode: ModeFake,
-			Log:     log.Log,
+			Log:     &log.Log,
 		},
 		fakeFail: fail,
 	}
@@ -127,7 +127,7 @@ func NewFakeDelayer(delay time.Duration) *Blake3pow {
 	return &Blake3pow{
 		config: Config{
 			PowMode: ModeFake,
-			Log:     log.Log,
+			Log:     &log.Log,
 		},
 		fakeDelay: delay,
 	}
@@ -139,7 +139,7 @@ func NewFullFaker() *Blake3pow {
 	return &Blake3pow{
 		config: Config{
 			PowMode: ModeFullFake,
-			Log:     log.Log,
+			Log:     &log.Log,
 		},
 	}
 }

log/logger.go

@@ -12,9 +12,11 @@ import (
 	"gopkg.in/urfave/cli.v1"
 )
 
-type Logger = *logrus.Logger
+type Logger struct {
+	*logrus.Logger
+}
 
-var Log Logger = logrus.New()
+var Log Logger = Logger{logrus.New()}
 
 func init() {
 
@@ -78,7 +80,7 @@ func New(out_path string) Logger {
 		MaxBackups: 3,
 		MaxAge:     28, //days
 	})
-	return logger
+	return Logger{logger}
 }
 
 func Trace(msg string, args ...interface{}) {

node/config.go

@@ -157,7 +157,7 @@ type Config struct {
 	WSExposeAll bool `toml:",omitempty"`
 
 	// Logger is a custom logger to use with the p2p.Server.
-	Logger log.Logger `toml:",omitempty"`
+	Logger *log.Logger `toml:",omitempty"`
 
 	staticNodesWarning     bool
 	trustedNodesWarning    bool
@@ -371,7 +371,7 @@ func (c *Config) warnOnce(w *bool, format string, args ...interface{}) {
 	}
 	l := c.Logger
 	if l == nil {
-		l = log.Log
+		l = &log.Log
 	}
 	l.Warn(fmt.Sprintf(format, args...))
 	*w = true

node/node.go

@@ -76,7 +76,7 @@ func New(conf *Config) (*Node, error) {
 		conf.DataDir = absdatadir
 	}
 	if conf.Logger == nil {
-		conf.Logger = log.Log
+		conf.Logger = &log.Log
 	}
 
 	// Ensure that the instance name doesn't cause weird conflicts with
@@ -92,7 +92,7 @@ func New(conf *Config) (*Node, error) {
 		config:        conf,
 		inprocHandler: rpc.NewServer(),
 		eventmux:      new(event.TypeMux),
-		log:           conf.Logger,
+		log:           *conf.Logger,
 		stop:          make(chan struct{}),
 		server:        &p2p.Server{Config: conf.P2P},
 		databases:     make(map[*closeTrackingDB]struct{}),
@@ -109,7 +109,7 @@ func New(conf *Config) (*Node, error) {
 	// Initialize the p2p server. This creates the node key and discovery databases.
 	node.server.Config.PrivateKey = node.config.NodeKey()
 	node.server.Config.Name = node.config.NodeName()
-	node.server.Config.Logger = node.log
+	node.server.Config.Logger = &node.log
 	if node.server.Config.StaticNodes == nil {
 		node.server.Config.StaticNodes = node.config.StaticNodes()
 	}

p2p/dial.go

@@ -135,7 +135,7 @@ type dialConfig struct {
 	netRestrict    *netutil.Netlist // IP netrestrict list, disabled if nil
 	resolver       nodeResolver
 	dialer         NodeDialer
-	log            log.Logger
+	log            *log.Logger
 	clock          mclock.Clock
 	rand           *mrand.Rand
 }
@@ -145,7 +145,7 @@ func (cfg dialConfig) withDefaults() dialConfig {
 		cfg.maxActiveDials = defaultMaxPendingPeers
 	}
 	if cfg.log == nil {
-		cfg.log = log.Log
+		cfg.log = &log.Log
 	}
 	if cfg.clock == nil {
 		cfg.clock = mclock.System{}

p2p/discover/common.go

@@ -25,7 +25,6 @@ import (
 	"github.com/dominant-strategies/go-quai/p2p/enode"
 	"github.com/dominant-strategies/go-quai/p2p/enr"
 	"github.com/dominant-strategies/go-quai/p2p/netutil"
-	"github.com/sirupsen/logrus"
 )
 
 // UDPConn is a network connection on which discovery can operate.
@@ -45,14 +44,14 @@ type Config struct {
 	NetRestrict  *netutil.Netlist   // list of allowed IP networks
 	Bootnodes    []*enode.Node      // list of bootstrap nodes
 	Unhandled    chan<- ReadPacket  // unhandled packets are sent on this channel
-	Log          *logrus.Logger     // if set, log messages go here
+	Log          *log.Logger        // if set, log messages go here
 	ValidSchemes enr.IdentityScheme // allowed identity schemes
 	Clock        mclock.Clock
 }
 
 func (cfg Config) withDefaults() Config {
 	if cfg.Log == nil {
-		cfg.Log = log.Log
+		cfg.Log = &log.Log
 	}
 	if cfg.ValidSchemes == nil {
 		cfg.ValidSchemes = enode.ValidSchemes

p2p/discover/v5_udp.go

@@ -35,7 +35,6 @@ import (
 	"github.com/dominant-strategies/go-quai/p2p/enode"
 	"github.com/dominant-strategies/go-quai/p2p/enr"
 	"github.com/dominant-strategies/go-quai/p2p/netutil"
-	"github.com/sirupsen/logrus"
 )
 
 const (
@@ -69,7 +68,7 @@ type UDPv5 struct {
 	priv         *ecdsa.PrivateKey
 	localNode    *enode.LocalNode
 	db           *enode.DB
-	log          *logrus.Logger
+	log          *log.Logger
 	clock        mclock.Clock
 	validSchemes enr.IdentityScheme
 
@@ -146,7 +145,7 @@ func newUDPv5(conn UDPConn, ln *enode.LocalNode, cfg Config) (*UDPv5, error) {
 		db:           ln.Database(),
 		netrestrict:  cfg.NetRestrict,
 		priv:         cfg.PrivateKey,
-		log:          log.Log,
+		log:          &log.Log,
 		validSchemes: cfg.ValidSchemes,
 		clock:        cfg.Clock,
 		trhandlers:   make(map[string]TalkRequestHandler),
@@ -165,7 +164,7 @@ func newUDPv5(conn UDPConn, ln *enode.LocalNode, cfg Config) (*UDPv5, error) {
 		closeCtx:       closeCtx,
 		cancelCloseCtx: cancelCloseCtx,
 	}
-	tab, err := newTable(t, t.db, cfg.Bootnodes, cfg.Log)
+	tab, err := newTable(t, t.db, cfg.Bootnodes, *cfg.Log)
 	if err != nil {
 		return nil, err
 	}

p2p/dnsdisc/client.go

@@ -32,7 +32,6 @@ import (
 	"github.com/dominant-strategies/go-quai/p2p/enode"
 	"github.com/dominant-strategies/go-quai/p2p/enr"
 	lru "github.com/hashicorp/golang-lru"
-	"github.com/sirupsen/logrus"
 	"golang.org/x/sync/singleflight"
 	"golang.org/x/time/rate"
 )
@@ -54,7 +53,7 @@ type Config struct {
 	RateLimit       float64            // maximum DNS requests / second (default 3)
 	ValidSchemes    enr.IdentityScheme // acceptable ENR identity schemes (default enode.ValidSchemes)
 	Resolver        Resolver           // the DNS resolver to use (defaults to system DNS)
-	Logger          *logrus.Logger	   // destination of client log messages (defaults to root logger)
+	Logger          *log.Logger	   // destination of client log messages (defaults to root logger)
 }
 
 // Resolver is a DNS resolver that can query TXT records.
@@ -88,7 +87,7 @@ func (cfg Config) withDefaults() Config {
 		cfg.Resolver = new(net.Resolver)
 	}
 	if cfg.Logger == nil {
-		cfg.Logger = log.Log
+		cfg.Logger = &log.Log
 	}
 	return cfg
 }

p2p/server.go

@@ -153,7 +153,7 @@ type Config struct {
 	EnableMsgEvents bool
 
 	// Logger is a custom logger to use with the p2p.Server.
-	Logger log.Logger `toml:",omitempty"`
+	Logger *log.Logger `toml:",omitempty"`
 
 	clock mclock.Clock
 }
@@ -176,7 +176,7 @@ type Server struct {
 	ourHandshake *protoHandshake
 	loopWG       sync.WaitGroup // loop, listenLoop
 	peerFeed     event.Feed
-	log          log.Logger
+	log          *log.Logger
 
 	nodedb    *enode.DB
 	localnode *enode.LocalNode
@@ -442,7 +442,7 @@ func (srv *Server) Start() (err error) {
 	srv.running = true
 	srv.log = srv.Config.Logger
 	if srv.log == nil {
-		srv.log = log.Log
+		srv.log = &log.Log
 	}
 	if srv.clock == nil {
 		srv.clock = mclock.System{}
@@ -1013,7 +1013,7 @@ func (srv *Server) checkpoint(c *conn, stage chan<- *conn) error {
 }
 
 func (srv *Server) launchPeer(c *conn) *Peer {
-	p := newPeer(srv.log, c, srv.Protocols)
+	p := newPeer(*srv.log, c, srv.Protocols)
 	if srv.EnableMsgEvents {
 		// If message events are enabled, pass the peerFeed
 		// to the peer.