Merge pull request #25 from danl5/refine_logger

using the slog
danl5 · Jun 17, 2024 · 15f136c · 15f136c
2 parents d317199 + 6e2d2c1
commit 15f136c
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 56 deletions.
diff --git a/elect.go b/elect.go
@@ -2,11 +2,12 @@ package goelect
 
 import (
 	"context"
+	"log/slog"
+	"os"
 	"time"
 
 	"github.com/danl5/goelect/pkg/config"
 	"github.com/danl5/goelect/pkg/consensus"
-	"github.com/danl5/goelect/pkg/log"
 	"github.com/danl5/goelect/pkg/model"
 )
 
@@ -26,7 +27,10 @@ func NewElect(
 	trans model.Transport,
 	transConfig model.TransportConfig,
 	cfg *ElectConfig,
-	logger log.Logger) (*Elect, error) {
+	logger *slog.Logger) (*Elect, error) {
+	if logger == nil {
+		logger = slog.New(slog.NewJSONHandler(os.Stdout, nil))
+	}
 	var peers []config.NodeConfig
 	for _, n := range cfg.Peers {
 		peers = append(peers, config.NodeConfig{
@@ -73,7 +77,7 @@ func NewElect(
 	}
 	return &Elect{
 		cfg:             cfg,
-		logger:          logger,
+		logger:          logger.With("component", "elect"),
 		callBackTimeout: cfg.CallBackTimeout,
 		consensus:       c,
 		callBacks:       cfg.CallBacks,
@@ -95,7 +99,7 @@ type Elect struct {
 	// cfg is the configuration for the election
 	cfg *ElectConfig
 	// logger is used for logging
-	logger log.Logger
+	logger *slog.Logger
 }
 
 // Run is the main function of the Elect struct

diff --git a/examples/onenode/node.go b/examples/onenode/node.go
@@ -15,6 +15,7 @@ import (
 	"flag"
 	"fmt"
 	"log/slog"
+	"os"
 	"strings"
 	"time"
 
@@ -42,7 +43,7 @@ func newElect() (*goelect.Elect, error) {
 		peerNodes = append(peerNodes, goelect.Node{Address: pa, ID: pa})
 	}
 
-	logger := slog.Default()
+	logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
 
 	// rpc transport
 	rpcTransport, err := rpc.NewRPC(logger)

diff --git a/pkg/consensus/consensus.go b/pkg/consensus/consensus.go
@@ -3,6 +3,7 @@ package consensus
 import (
 	"context"
 	"fmt"
+	"log/slog"
 	"math/rand"
 	"sync"
 	"time"
@@ -12,7 +13,6 @@ import (
 
 	"github.com/danl5/goelect/pkg/common"
 	"github.com/danl5/goelect/pkg/config"
-	"github.com/danl5/goelect/pkg/log"
 	"github.com/danl5/goelect/pkg/model"
 )
 
@@ -21,14 +21,18 @@ func NewConsensus(
 	trans model.Transport,
 	transConfig model.TransportConfig,
 	cfg *config.Config,
-	logger log.Logger) (*Consensus, error) {
+	logger *slog.Logger) (*Consensus, error) {
 	if err := node.Validate(); err != nil {
 		return nil, err
 	}
 
+	if logger == nil {
+		return nil, fmt.Errorf("new consensus, logger is nil")
+	}
+
 	c := &Consensus{
 		cfg:             cfg,
-		logger:          logger,
+		logger:          logger.With("component", "consensus"),
 		node:            node,
 		termCache:       &termCache{},
 		transport:       trans,
@@ -52,7 +56,7 @@ type Consensus struct {
 	// cfg is the configuration for the consensus
 	cfg *config.Config
 	// logger
-	logger log.Logger
+	logger *slog.Logger
 
 	// node is the elect node of the model
 	node model.ElectNode

diff --git a/pkg/consensus/consensus_test.go b/pkg/consensus/consensus_test.go
@@ -8,14 +8,13 @@ import (
 	"github.com/stretchr/testify/assert"
 
 	"github.com/danl5/goelect/pkg/common"
-	"github.com/danl5/goelect/pkg/log"
 	"github.com/danl5/goelect/pkg/model"
 )
 
 func TestConsensus_HeartBeat(t *testing.T) {
 	type fields struct {
 		termCache *termCache
-		logger    log.Logger
+		logger    *slog.Logger
 		eventChan chan model.NodeEvent
 	}
 	type args struct {
@@ -93,7 +92,7 @@ func TestConsensus_HeartBeat(t *testing.T) {
 func TestConsensus_RequestVote(t *testing.T) {
 	type fields struct {
 		termCache *termCache
-		logger    log.Logger
+		logger    *slog.Logger
 		fsm       *fsm.FSM
 		eventChan chan model.NodeEvent
 	}

diff --git a/pkg/log/log.go b/pkg/log/log.go
diff --git a/pkg/model/command.go b/pkg/model/command.go
@@ -1,6 +1,8 @@
 package model
 
-import "errors"
+import (
+	"errors"
+)
 
 var (
 	ErrorBadCommand = errors.New("bad command")

diff --git a/pkg/transport/rpc/rpc.go b/pkg/transport/rpc/rpc.go
@@ -5,14 +5,14 @@ import (
 	"crypto/x509"
 	"errors"
 	"fmt"
+	"log/slog"
 	"net"
 	"net/rpc"
 	"os"
 	"reflect"
 	"sync"
 	"time"
 
-	"github.com/danl5/goelect/pkg/log"
 	"github.com/danl5/goelect/pkg/model"
 	"github.com/mitchellh/mapstructure"
 	"github.com/silenceper/pool"
@@ -30,13 +30,17 @@ const (
 	poolMaxCap = 20
 )
 
-func NewRPC(logger log.Logger) (*RPC, error) {
+func NewRPC(logger *slog.Logger) (*RPC, error) {
+	if logger == nil {
+		return nil, fmt.Errorf("new rpc, logger is nil")
+	}
+
 	rpc := &RPC{
 		Server: Server{
-			logger: logger,
+			logger: logger.With("component", "rpc server"),
 		},
 		Client: Client{
-			logger: logger,
+			logger: logger.With("component", "rpc client"),
 		},
 	}
 
@@ -102,7 +106,7 @@ func (r *RPC) Decode(raw any, target any) error {
 
 type Server struct {
 	rpcHandler *RPCHandler
-	logger     log.Logger
+	logger     *slog.Logger
 }
 
 // Start initiates the server to begin listening on the specified address.
@@ -209,7 +213,7 @@ type Client struct {
 	// string -> pool.Pool
 	clients sync.Map
 
-	logger log.Logger
+	logger *slog.Logger
 }
 
 // InitConnections initializes a set of connections to the given nodes.