refactor: Use zerolog.Logger instead of log.Logger

2026-05-14 03:04:16 -04:00 · 2025-01-09 10:10:57 +01:00
parent 5f1b193792
commit 7697e6d9e5
5 changed files with 42 additions and 42 deletions
--- a/services/notifications/pkg/service/job.go
+++ b/services/notifications/pkg/service/job.go
@@ -4,19 +4,19 @@ import (
 	"context"
 	"github.com/cs3org/reva/v2/pkg/events"
 	"github.com/owncloud/ocis/v2/ocis-pkg/l10n"
-	"github.com/owncloud/ocis/v2/ocis-pkg/log"
 	ehmsg "github.com/owncloud/ocis/v2/protogen/gen/ocis/messages/eventhistory/v0"
 	"github.com/owncloud/ocis/v2/services/notifications/pkg/channels"
 	"github.com/owncloud/ocis/v2/services/notifications/pkg/email"
+	"github.com/rs/zerolog"
 )

 func (s eventsNotifier) sendGroupedEmailsJob(sendEmailsEvent events.SendEmailsEvent, eventId string) {
-	logger := log.Logger{Logger: s.logger.With().
+	logger := s.logger.With().
 		Str("event", "SendEmailsEvent").
 		Str("eventId", eventId).
-		Logger()}
+		Logger()

-	if sendEmailsEvent.Interval != intervalDaily && sendEmailsEvent.Interval != intervalWeekly {
+	if sendEmailsEvent.Interval != _intervalDaily && sendEmailsEvent.Interval != _intervalWeekly {
 		logger.Error().Str("interval", sendEmailsEvent.Interval).Msg("unsupported email sending interval")
 		return
 	}
@@ -42,7 +42,7 @@ func (s eventsNotifier) sendGroupedEmailsJob(sendEmailsEvent events.SendEmailsEv
 	}
 }

-func (s eventsNotifier) createGroupedMail(ctx context.Context, logger log.Logger, key string) {
+func (s eventsNotifier) createGroupedMail(ctx context.Context, logger zerolog.Logger, key string) {
 	userEvents, err := s.userEventStore.pop(ctx, key)
 	if err != nil {
 		logger.Error().Err(err).Str("key", key).Msg("could not pop user events")
@@ -56,10 +56,10 @@ func (s eventsNotifier) createGroupedMail(ctx context.Context, logger log.Logger
 	for _, e := range userEvents.Events {
 		switch te := s.unwrapEvent(logger, e).(type) {
 		case events.SpaceShared:
-			logger := log.Logger{Logger: logger.With().
+			logger := logger.With().
 				Str("event", "SpaceShared").
 				Str("eventId", te.ID.OpaqueId).
-				Logger()}
+				Logger()

 			executant, spaceName, shareLink, _, err := s.prepareSpaceShared(logger, te)
 			if err != nil {
@@ -74,10 +74,10 @@ func (s eventsNotifier) createGroupedMail(ctx context.Context, logger log.Logger
 				"ShareLink":   shareLink,
 			})
 		case events.SpaceUnshared:
-			logger := log.Logger{Logger: logger.With().
+			logger := logger.With().
 				Str("event", "SpaceUnshared").
 				Str("eventId", te.ID.OpaqueId).
-				Logger()}
+				Logger()

 			executant, spaceName, shareLink, _, err := s.prepareSpaceUnshared(logger, te)
 			if err != nil {
@@ -97,10 +97,10 @@ func (s eventsNotifier) createGroupedMail(ctx context.Context, logger log.Logger
 				"ExpiredAt": te.ExpiredAt.Format("2006-01-02 15:04:05"),
 			})
 		case events.ShareCreated:
-			logger := log.Logger{Logger: logger.With().
+			logger := logger.With().
 				Str("event", "ShareCreated").
 				Str("eventId", te.ItemID.OpaqueId).
-				Logger()}
+				Logger()

 			owner, shareFolder, shareLink, _, err := s.prepareShareCreated(logger, te)
 			if err != nil {
@@ -114,10 +114,10 @@ func (s eventsNotifier) createGroupedMail(ctx context.Context, logger log.Logger
 				"ShareLink":   shareLink,
 			})
 		case events.ShareExpired:
-			logger := log.Logger{Logger: logger.With().
+			logger := logger.With().
 				Str("event", "ShareCreated").
 				Str("eventId", te.ItemID.OpaqueId).
-				Logger()}
+				Logger()

 			shareFolder, _, err := s.prepareShareExpired(logger, te)
 			if err != nil {
@@ -144,7 +144,7 @@ func (s eventsNotifier) createGroupedMail(ctx context.Context, logger log.Logger
 	s.send(ctx, []*channels.Message{rendered})
 }

-func (s eventsNotifier) unwrapEvent(logger log.Logger, e *ehmsg.Event) any {
+func (s eventsNotifier) unwrapEvent(logger zerolog.Logger, e *ehmsg.Event) any {
 	etype, ok := s.registeredEvents[e.GetType()]
 	if !ok {
 		logger.Error().Str("eventId", e.GetId()).Str("eventType", e.GetType()).Msg("event not registered")
--- a/services/notifications/pkg/service/persistence.go
+++ b/services/notifications/pkg/service/persistence.go
@@ -28,8 +28,8 @@ type userEvents struct {
 }

 const (
-	intervalDaily  = "daily"
-	intervalWeekly = "weekly"
+	_intervalDaily  = "daily"
+	_intervalWeekly = "weekly"
 )

 func newUserEventStore(l log.Logger, s store.Store, hc ehsvc.EventHistoryService) *userEventStore {
--- a/services/notifications/pkg/service/shares.go
+++ b/services/notifications/pkg/service/shares.go
@@ -5,17 +5,17 @@ import (
 	user "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
 	"github.com/cs3org/reva/v2/pkg/events"
 	"github.com/cs3org/reva/v2/pkg/utils"
-	"github.com/owncloud/ocis/v2/ocis-pkg/log"
 	"github.com/owncloud/ocis/v2/services/notifications/pkg/email"
 	"github.com/owncloud/ocis/v2/services/settings/pkg/store/defaults"
+	"github.com/rs/zerolog"
 	"google.golang.org/protobuf/types/known/fieldmaskpb"
 )

 func (s eventsNotifier) handleShareCreated(e events.ShareCreated, eventId string) {
-	logger := log.Logger{Logger: s.logger.With().
+	logger := s.logger.With().
 		Str("event", "ShareCreated").
 		Str("itemid", e.ItemID.OpaqueId).
-		Logger()}
+		Logger()

 	owner, shareFolder, shareLink, ctx, err := s.prepareShareCreated(logger, e)
 	if err != nil {
@@ -27,8 +27,8 @@ func (s eventsNotifier) handleShareCreated(e events.ShareCreated, eventId string
 	filteredGrantees := s.filter.execute(ctx, granteeList, defaults.SettingUUIDProfileEventShareCreated)

 	recipientsInstant, recipientsDaily, recipientsInstantWeekly := s.splitter.execute(ctx, filteredGrantees)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalDaily, eventId, recipientsDaily)...)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalWeekly, eventId, recipientsInstantWeekly)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalDaily, eventId, recipientsDaily)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalWeekly, eventId, recipientsInstantWeekly)...)
 	if recipientsInstant == nil {
 		return
 	}
@@ -48,7 +48,7 @@ func (s eventsNotifier) handleShareCreated(e events.ShareCreated, eventId string
 	s.send(ctx, emails)
 }

-func (s eventsNotifier) prepareShareCreated(logger log.Logger, e events.ShareCreated) (owner *user.User, shareFolder, shareLink string, ctx context.Context, err error) {
+func (s eventsNotifier) prepareShareCreated(logger zerolog.Logger, e events.ShareCreated) (owner *user.User, shareFolder, shareLink string, ctx context.Context, err error) {
 	gatewayClient, err := s.gatewaySelector.Next()
 	if err != nil {
 		logger.Error().Err(err).Msg("could not select next gateway client")
@@ -89,10 +89,10 @@ func (s eventsNotifier) prepareShareCreated(logger log.Logger, e events.ShareCre
 }

 func (s eventsNotifier) handleShareExpired(e events.ShareExpired, eventId string) {
-	logger := log.Logger{Logger: s.logger.With().
+	logger := s.logger.With().
 		Str("event", "ShareExpired").
 		Str("itemid", e.ItemID.GetOpaqueId()).
-		Logger()}
+		Logger()

 	gatewayClient, err := s.gatewaySelector.Next()
 	if err != nil {
@@ -116,8 +116,8 @@ func (s eventsNotifier) handleShareExpired(e events.ShareExpired, eventId string
 	filteredGrantees := s.filter.execute(ctx, granteeList, defaults.SettingUUIDProfileEventShareExpired)

 	recipientsInstant, recipientsDaily, recipientsInstantWeekly := s.splitter.execute(ctx, filteredGrantees)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalDaily, eventId, recipientsDaily)...)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalWeekly, eventId, recipientsInstantWeekly)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalDaily, eventId, recipientsDaily)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalWeekly, eventId, recipientsInstantWeekly)...)
 	if recipientsInstant == nil {
 		return
 	}
@@ -135,7 +135,7 @@ func (s eventsNotifier) handleShareExpired(e events.ShareExpired, eventId string
 	s.send(ctx, emails)
 }

-func (s eventsNotifier) prepareShareExpired(logger log.Logger, e events.ShareExpired) (shareFolder string, ctx context.Context, err error) {
+func (s eventsNotifier) prepareShareExpired(logger zerolog.Logger, e events.ShareExpired) (shareFolder string, ctx context.Context, err error) {
 	gatewayClient, err := s.gatewaySelector.Next()
 	if err != nil {
 		logger.Error().Err(err).Msg("could not select next gateway client")
--- a/services/notifications/pkg/service/spaces.go
+++ b/services/notifications/pkg/service/spaces.go
@@ -6,16 +6,16 @@ import (
 	"github.com/cs3org/reva/v2/pkg/events"
 	"github.com/cs3org/reva/v2/pkg/storagespace"
 	"github.com/cs3org/reva/v2/pkg/utils"
-	"github.com/owncloud/ocis/v2/ocis-pkg/log"
 	"github.com/owncloud/ocis/v2/services/notifications/pkg/email"
 	"github.com/owncloud/ocis/v2/services/settings/pkg/store/defaults"
+	"github.com/rs/zerolog"
 )

 func (s eventsNotifier) handleSpaceShared(e events.SpaceShared, eventId string) {
-	logger := log.Logger{Logger: s.logger.With().
+	logger := s.logger.With().
 		Str("event", "SpaceShared").
 		Str("itemid", e.ID.OpaqueId).
-		Logger()}
+		Logger()
 	executant, spaceName, shareLink, ctx, err := s.prepareSpaceShared(logger, e)
 	if err != nil {
 		logger.Error().Err(err).Msg("could not prepare vars for email")
@@ -26,8 +26,8 @@ func (s eventsNotifier) handleSpaceShared(e events.SpaceShared, eventId string)
 	filteredGrantees := s.filter.execute(ctx, granteeList, defaults.SettingUUIDProfileEventSpaceShared)

 	recipientsInstant, recipientsDaily, recipientsInstantWeekly := s.splitter.execute(ctx, filteredGrantees)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalDaily, eventId, recipientsDaily)...)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalWeekly, eventId, recipientsInstantWeekly)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalDaily, eventId, recipientsDaily)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalWeekly, eventId, recipientsInstantWeekly)...)
 	if recipientsInstant == nil {
 		return
 	}
@@ -47,7 +47,7 @@ func (s eventsNotifier) handleSpaceShared(e events.SpaceShared, eventId string)
 	s.send(ctx, emails)
 }

-func (s eventsNotifier) prepareSpaceShared(logger log.Logger, e events.SpaceShared) (executant *user.User, spaceName, shareLink string, ctx context.Context, err error) {
+func (s eventsNotifier) prepareSpaceShared(logger zerolog.Logger, e events.SpaceShared) (executant *user.User, spaceName, shareLink string, ctx context.Context, err error) {
 	gatewayClient, err := s.gatewaySelector.Next()
 	if err != nil {
 		logger.Error().Err(err).Msg("could not select next gateway client")
@@ -95,10 +95,10 @@ func (s eventsNotifier) prepareSpaceShared(logger log.Logger, e events.SpaceShar
 }

 func (s eventsNotifier) handleSpaceUnshared(e events.SpaceUnshared, eventId string) {
-	logger := log.Logger{Logger: s.logger.With().
+	logger := s.logger.With().
 		Str("event", "SpaceUnshared").
 		Str("itemid", e.ID.OpaqueId).
-		Logger()}
+		Logger()

 	executant, spaceName, shareLink, ctx, err := s.prepareSpaceUnshared(logger, e)
 	if err != nil {
@@ -110,8 +110,8 @@ func (s eventsNotifier) handleSpaceUnshared(e events.SpaceUnshared, eventId stri
 	filteredGrantees := s.filter.execute(ctx, granteeList, defaults.SettingUUIDProfileEventSpaceUnshared)

 	recipientsInstant, recipientsDaily, recipientsInstantWeekly := s.splitter.execute(ctx, filteredGrantees)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalDaily, eventId, recipientsDaily)...)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalWeekly, eventId, recipientsInstantWeekly)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalDaily, eventId, recipientsDaily)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalWeekly, eventId, recipientsInstantWeekly)...)
 	if recipientsInstant == nil {
 		return
 	}
@@ -131,7 +131,7 @@ func (s eventsNotifier) handleSpaceUnshared(e events.SpaceUnshared, eventId stri
 	s.send(ctx, emails)
 }

-func (s eventsNotifier) prepareSpaceUnshared(logger log.Logger, e events.SpaceUnshared) (executant *user.User, spaceName, shareLink string, ctx context.Context, err error) {
+func (s eventsNotifier) prepareSpaceUnshared(logger zerolog.Logger, e events.SpaceUnshared) (executant *user.User, spaceName, shareLink string, ctx context.Context, err error) {
 	gatewayClient, err := s.gatewaySelector.Next()
 	if err != nil {
 		logger.Error().Err(err).Msg("could not select next gateway client")
@@ -211,8 +211,8 @@ func (s eventsNotifier) handleSpaceMembershipExpired(e events.SpaceMembershipExp
 	filteredGrantees := s.filter.execute(ctx, granteeList, defaults.SettingUUIDProfileEventSpaceMembershipExpired)

 	recipientsInstant, recipientsDaily, recipientsInstantWeekly := s.splitter.execute(ctx, filteredGrantees)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalDaily, eventId, recipientsDaily)...)
-	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(intervalWeekly, eventId, recipientsInstantWeekly)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalDaily, eventId, recipientsDaily)...)
+	recipientsInstant = append(recipientsInstant, s.userEventStore.persist(_intervalWeekly, eventId, recipientsInstantWeekly)...)
 	if recipientsInstant == nil {
 		return
 	}
--- a/services/notifications/pkg/service/splitter.go
+++ b/services/notifications/pkg/service/splitter.go
@@ -31,9 +31,9 @@ func (s intervalSplitter) execute(ctx context.Context, users []*user.User) (inst
 			instant = append(instant, u)
 		} else if interval == "instant" {
 			instant = append(instant, u)
-		} else if interval == intervalDaily {
+		} else if interval == _intervalDaily {
 			daily = append(daily, u)
-		} else if interval == intervalWeekly {
+		} else if interval == _intervalWeekly {
 			weekly = append(weekly, u)
 		}
 	}