feat!: switch from Zap to log/slog (#1115)

* feat!: switch from Zap to log/slog

* add context to the API

* clean using a custom handler

* fix

* lint/fix

Author: dunglas

authorization.go

@@ -3,13 +3,13 @@ package mercure
 import (
 	"errors"
 	"fmt"
+	"log/slog"
 	"net/http"
 	"net/url"
 	"slices"
 	"strings"
 
 	"github.com/golang-jwt/jwt/v5"
-	"go.uber.org/zap"
 )
 
 // claims contains Mercure's JWT claims.
@@ -194,7 +194,5 @@ func canDispatch(s *TopicSelectorStore, topics, topicSelectors []string) bool {
 func (h *Hub) httpAuthorizationError(w http.ResponseWriter, r *http.Request, err error) {
 	http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)
 
-	if c := h.logger.Check(zap.DebugLevel, "Topic selectors not matched, not provided or authorization error"); c != nil {
-		c.Write(zap.String("remote_addr", r.RemoteAddr), zap.Error(err))
-	}
+	h.logger.DebugContext(r.Context(), "Topic selectors not matched, not provided or authorization error", slog.Any("error", err))
 }

bolt.go

@@ -2,15 +2,16 @@ package mercure
 
 import (
 	"bytes"
+	"context"
 	"encoding/binary"
 	"encoding/json"
 	"fmt"
+	"log/slog"
 	"math/rand"
 	"sync"
 	"time"
 
 	bolt "go.etcd.io/bbolt"
-	"go.uber.org/zap"
 )
 
 const BoltDefaultCleanupFrequency = 0.3
@@ -22,7 +23,7 @@ type BoltTransport struct {
 	sync.RWMutex
 
 	subscribers      *SubscriberList
-	logger           Logger
+	logger           *slog.Logger
 	db               *bolt.DB
 	bucketName       string
 	size             uint64
@@ -36,7 +37,7 @@ type BoltTransport struct {
 // NewBoltTransport creates a new BoltTransport.
 func NewBoltTransport(
 	subscriberList *SubscriberList,
-	logger Logger,
+	logger *slog.Logger,
 	path string,
 	bucketName string,
 	size uint64,
@@ -95,7 +96,7 @@ func getDBLastEventID(db *bolt.DB, bucketName string) (string, error) {
 }
 
 // Dispatch dispatches an update to all subscribers and persists it in Bolt DB.
-func (t *BoltTransport) Dispatch(update *Update) error {
+func (t *BoltTransport) Dispatch(ctx context.Context, update *Update) error {
 	select {
 	case <-t.closed:
 		return ErrClosedTransport
@@ -118,14 +119,14 @@ func (t *BoltTransport) Dispatch(update *Update) error {
 	}
 
 	for _, s := range t.subscribers.MatchAny(update) {
-		s.Dispatch(update, false)
+		s.Dispatch(ctx, update, false)
 	}
 
 	return nil
 }
 
 // AddSubscriber adds a new subscriber to the transport.
-func (t *BoltTransport) AddSubscriber(s *LocalSubscriber) error {
+func (t *BoltTransport) AddSubscriber(ctx context.Context, s *LocalSubscriber) error {
 	select {
 	case <-t.closed:
 		return ErrClosedTransport
@@ -138,18 +139,18 @@ func (t *BoltTransport) AddSubscriber(s *LocalSubscriber) error {
 	t.Unlock()
 
 	if s.RequestLastEventID != "" {
-		if err := t.dispatchHistory(s, toSeq); err != nil {
+		if err := t.dispatchHistory(ctx, s, toSeq); err != nil {
 			return err
 		}
 	}
 
-	s.Ready()
+	s.Ready(ctx)
 
 	return nil
 }
 
 // RemoveSubscriber removes a new subscriber from the transport.
-func (t *BoltTransport) RemoveSubscriber(s *LocalSubscriber) error {
+func (t *BoltTransport) RemoveSubscriber(_ context.Context, s *LocalSubscriber) error {
 	select {
 	case <-t.closed:
 		return ErrClosedTransport
@@ -165,15 +166,15 @@ func (t *BoltTransport) RemoveSubscriber(s *LocalSubscriber) error {
 }
 
 // GetSubscribers get the list of active subscribers.
-func (t *BoltTransport) GetSubscribers() (string, []*Subscriber, error) {
+func (t *BoltTransport) GetSubscribers(_ context.Context) (string, []*Subscriber, error) {
 	t.RLock()
 	defer t.RUnlock()
 
 	return t.lastEventID, getSubscribers(t.subscribers), nil
 }
 
 // Close closes the Transport.
-func (t *BoltTransport) Close() (err error) {
+func (t *BoltTransport) Close(_ context.Context) (err error) {
 	t.closedOnce.Do(func() {
 		close(t.closed)
 
@@ -196,7 +197,7 @@ func (t *BoltTransport) Close() (err error) {
 }
 
 //nolint:gocognit
-func (t *BoltTransport) dispatchHistory(s *LocalSubscriber, toSeq uint64) error {
+func (t *BoltTransport) dispatchHistory(ctx context.Context, s *LocalSubscriber, toSeq uint64) error {
 	err := t.db.View(func(tx *bolt.Tx) error {
 		b := tx.Bucket([]byte(t.bucketName))
 		if b == nil {
@@ -223,14 +224,13 @@ func (t *BoltTransport) dispatchHistory(s *LocalSubscriber, toSeq uint64) error
 			if err := json.Unmarshal(v, &update); err != nil {
 				s.HistoryDispatched(responseLastEventID)
 
-				if c := t.logger.Check(zap.ErrorLevel, "Unable to unmarshal update coming from the Bolt DB"); c != nil {
-					c.Write(zap.Error(err))
-				}
+				err := fmt.Errorf("unable to unmarshal update: %w", err)
+				t.logger.ErrorContext(ctx, "Unable to unmarshal update coming from the Bolt DB", slog.Any("update", update), slog.Any("error", err))
 
-				return fmt.Errorf("unable to unmarshal update: %w", err)
+				return err
 			}
 
-			if (s.Match(update) && !s.Dispatch(update, true)) || (toSeq > 0 && binary.BigEndian.Uint64(k[:8]) >= toSeq) {
+			if (s.Match(update) && !s.Dispatch(ctx, update, true)) || (toSeq > 0 && binary.BigEndian.Uint64(k[:8]) >= toSeq) {
 				s.HistoryDispatched(responseLastEventID)
 
 				return nil
@@ -240,9 +240,7 @@ func (t *BoltTransport) dispatchHistory(s *LocalSubscriber, toSeq uint64) error
 		s.HistoryDispatched(responseLastEventID)
 
 		if !afterFromID {
-			if c := t.logger.Check(zap.InfoLevel, "Can't find requested LastEventID"); c != nil {
-				c.Write(zap.String("LastEventID", s.RequestLastEventID))
-			}
+			t.logger.InfoContext(ctx, "Can't find requested LastEventID")
 		}
 
 		return nil

bolt_deprecated_test.go

@@ -9,34 +9,33 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"go.uber.org/zap"
 )
 
 func TestNewBoltTransport(t *testing.T) {
 	t.Parallel()
 
 	u, _ := url.Parse("bolt://test-" + t.Name() + ".db?bucket_name=demo")
-	transport, err := DeprecatedNewBoltTransport(u, zap.NewNop())
+	transport, err := DeprecatedNewBoltTransport(u, nil)
 	require.NoError(t, err)
 	require.NotNil(t, transport)
-	require.NoError(t, transport.Close())
+	require.NoError(t, transport.Close(t.Context()))
 	require.NoError(t, os.Remove("test-"+t.Name()+".db"))
 
 	u, _ = url.Parse("bolt://")
-	_, err = DeprecatedNewBoltTransport(u, zap.NewNop())
+	_, err = DeprecatedNewBoltTransport(u, nil)
 	require.EqualError(t, err, `"bolt:": invalid transport: missing path`)
 
 	u, _ = url.Parse("bolt:///test.db")
-	_, err = DeprecatedNewBoltTransport(u, zap.NewNop())
+	_, err = DeprecatedNewBoltTransport(u, nil)
 
 	// The exact error message depends on the OS
 	assert.Contains(t, err.Error(), "open /test.db:")
 
 	u, _ = url.Parse("bolt://test.db?cleanup_frequency=invalid")
-	_, err = DeprecatedNewBoltTransport(u, zap.NewNop())
+	_, err = DeprecatedNewBoltTransport(u, nil)
 	require.EqualError(t, err, `"bolt://test.db?cleanup_frequency=invalid": invalid "cleanup_frequency" parameter "invalid": invalid transport: strconv.ParseFloat: parsing "invalid": invalid syntax`)
 
 	u, _ = url.Parse("bolt://test.db?size=invalid")
-	_, err = DeprecatedNewBoltTransport(u, zap.NewNop())
+	_, err = DeprecatedNewBoltTransport(u, nil)
 	require.EqualError(t, err, `"bolt://test.db?size=invalid": invalid "size" parameter "invalid": invalid transport: strconv.ParseUint: parsing "invalid": invalid syntax`)
 }