Refactor to use decorator for the cache

api/app.go

@@ -13,6 +13,7 @@ import (
 	"context"
 	"fmt"
 	"github.com/go-redis/redis/v8"
+	enrichercache "github.com/topfreegames/podium/leaderboard/v2/enriching/cache"
 	"net"
 	"net/http"
 	"os"
@@ -231,16 +232,26 @@ func (app *App) configureEnrichment() {
 		Password: app.ParsedConfig.Enrichment.Cache.Password,
 	})
 
-	enrichCache := enriching.NewEnricherCache(app.Logger, redisClient)
+	enrichCache := enrichercache.NewEnricherCache(redisClient)
 	enricher := enriching.NewEnricher(
-		enrichCache,
 		enriching.WithLogger(app.Logger),
 		enriching.WithWebhookUrls(app.ParsedConfig.Enrichment.WebhookUrls),
 		enriching.WithWebhookTimeout(app.ParsedConfig.Enrichment.WebhookTimeout),
 		enriching.WithCloudSaveUrl(app.ParsedConfig.Enrichment.CloudSave.Url),
 		enriching.WithCloudSaveDisabled(app.ParsedConfig.Enrichment.CloudSave.Disabled),
 	)
-	app.Enricher = enriching.NewInstrumentedEnricher(enricher, app.DDStatsD)
+	wrapped := enriching.NewInstrumentedEnricher(enricher, app.DDStatsD)
+
+	if !app.ParsedConfig.Enrichment.Cache.Disabled {
+		wrapped = enrichercache.NewCachedEnricher(
+			enrichCache,
+			enricher,
+			enrichercache.WithLogger(app.Logger),
+			enrichercache.WithTTL(app.ParsedConfig.Enrichment.Cache.TTL),
+		)
+	}
+
+	app.Enricher = wrapped
 }
 
 // OnErrorHandler handles panics

config/default.yaml

@@ -36,6 +36,7 @@ extensions:
 enrichment:
   webhook_urls:
   cache:
+    disabled: false
     ttl: 24h
     addrs: "localhost:6739"
     username: ""

config/local.yaml

@@ -40,6 +40,7 @@ enrichment:
     dummy_tenant_id: "localhost:8080/"
   webhook_timeout: 500ms
   cache:
+    disabled: false
     ttl: 24h
     addrs: "localhost:6739"
     username: ""

leaderboard/enriching/enricher_cache.go → leaderboard/enriching/cache/cache.go

@@ -1,32 +1,29 @@
-package enriching
+package cache
 
 import (
 	"context"
 	"encoding/json"
 	"fmt"
 	"github.com/go-redis/redis/v8"
+	"github.com/topfreegames/podium/leaderboard/v2/enriching"
 	"github.com/topfreegames/podium/leaderboard/v2/model"
-	"go.uber.org/zap"
 	"time"
 )
 
 // cacheKeyFormat is {tenantID}:{leaderboardID}:{memberID}
 const cacheKeyFormat = "leaderboards-enrich-caching:%s:%s:%s"
 
 type enricherCache struct {
-	redis  *redis.Client
-	logger *zap.Logger
+	redis *redis.Client
 }
 
-var _ EnricherCache = &enricherCache{}
+var _ enriching.EnricherCache = &enricherCache{}
 
 func NewEnricherCache(
-	logger *zap.Logger,
 	redis *redis.Client,
-) EnricherCache {
+) enriching.EnricherCache {
 	return &enricherCache{
-		redis:  redis,
-		logger: logger.With(zap.String("source", "enricherCache")),
+		redis: redis,
 	}
 }
 
@@ -36,17 +33,10 @@ func (e *enricherCache) Get(
 	leaderboardID string,
 	members []*model.Member,
 ) (map[string]map[string]string, bool, error) {
-	l := e.logger.With(
-		zap.String("method", "Get"),
-		zap.String("tenantID", tenantID),
-		zap.String("leaderboardID", leaderboardID),
-	)
-
 	keys := getKeysFromMemberArray(tenantID, leaderboardID, members)
 	dataArray, err := e.redis.MGet(ctx, keys...).Result()
 	if err != nil {
-		l.With(zap.Error(err)).Error("failed to get members from cache")
-		return nil, false, fmt.Errorf("failed to get data from cache: %w", err)
+		return nil, false, fmt.Errorf("failed to get data from cacheConfig: %w", err)
 	}
 
 	dataMap := make(map[string]map[string]string)
@@ -58,7 +48,6 @@ func (e *enricherCache) Get(
 		unmarshaled := map[string]string{}
 		err := json.Unmarshal([]byte(data.(string)), &unmarshaled)
 		if err != nil {
-			l.With(zap.Error(err)).Error("failed to unmarshal data")
 			return nil, false, fmt.Errorf("failed to unmarshal data: %w", err)
 		}
 
@@ -76,27 +65,21 @@ func (e *enricherCache) Set(
 	members []*model.Member,
 	ttl time.Duration,
 ) error {
-	l := e.logger.With(
-		zap.String("method", "Set"),
-		zap.String("tenantID", tenantID),
-		zap.String("leaderboardID", leaderboardID),
-	)
-
 	keys := getKeysFromMemberArray(tenantID, leaderboardID, members)
 	pipe := e.redis.TxPipeline()
 	for i, member := range members {
-		marshaled, err := json.Marshal(member.Metadata)
-		if err != nil {
-			l.With(zap.Error(err)).Error("failed to marshal metadata")
-			return fmt.Errorf("failed to marshal metadata: %w", err)
+		if member.Metadata != nil {
+			marshaled, err := json.Marshal(member.Metadata)
+			if err != nil {
+				return fmt.Errorf("failed to marshal metadata: %w", err)
+			}
+			pipe.Set(ctx, keys[i], marshaled, ttl)
 		}
-		pipe.Set(ctx, keys[i], marshaled, ttl)
 	}
 
 	_, err := pipe.Exec(ctx)
 	if err != nil {
-		l.With(zap.Error(err)).Error("failed to set members in cache")
-		return fmt.Errorf("failed to set members in cache: %w", err)
+		return fmt.Errorf("failed to set members in cacheConfig: %w", err)
 	}
 
 	return nil

leaderboard/enriching/cache/cache_suite_test.go

@@ -0,0 +1,12 @@
+package cache
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"testing"
+)
+
+func TestEnrichingCache(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Enriching Cache Suite")
+}

leaderboard/enriching/enricher_cache_test.go → leaderboard/enriching/cache/cache_test.go

@@ -1,4 +1,4 @@
-package enriching
+package cache
 
 import (
 	"context"
@@ -9,7 +9,6 @@ import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 	"github.com/topfreegames/podium/leaderboard/v2/model"
-	"go.uber.org/zap"
 )
 
 var _ = Describe("Members array to keys array test", func() {
@@ -34,7 +33,7 @@ var _ = Describe("Members array to keys array test", func() {
 	})
 })
 
-var _ = Describe("Enricher cache Get tests", func() {
+var _ = Describe("Enricher cacheConfig Get tests", func() {
 	tenantID := "tenantID"
 	leaderboardID := "leaderboardID"
 
@@ -51,7 +50,7 @@ var _ = Describe("Enricher cache Get tests", func() {
 			getKeysFromMemberArray(tenantID, leaderboardID, members)...,
 		).SetErr(errors.New("some error"))
 
-		cache := NewEnricherCache(zap.NewNop(), redis)
+		cache := NewEnricherCache(redis)
 		res, hit, err := cache.Get(context.Background(), tenantID, leaderboardID, members)
 
 		Expect(res).To(BeNil())
@@ -76,7 +75,7 @@ var _ = Describe("Enricher cache Get tests", func() {
 			getKeysFromMemberArray(tenantID, leaderboardID, members)...,
 		).SetVal([]interface{}{nil, nil})
 
-		cache := NewEnricherCache(zap.NewNop(), redis)
+		cache := NewEnricherCache(redis)
 		res, hit, err := cache.Get(context.Background(), tenantID, leaderboardID, members)
 
 		Expect(res).To(BeNil())
@@ -105,7 +104,7 @@ var _ = Describe("Enricher cache Get tests", func() {
 			getKeysFromMemberArray(tenantID, leaderboardID, members)...,
 		).SetVal(mgetExpectedResult)
 
-		cache := NewEnricherCache(zap.NewNop(), redis)
+		cache := NewEnricherCache(redis)
 		res, hit, err := cache.Get(context.Background(), tenantID, leaderboardID, members)
 
 		Expect(res).To(BeNil())
@@ -134,7 +133,7 @@ var _ = Describe("Enricher cache Get tests", func() {
 			getKeysFromMemberArray(tenantID, leaderboardID, members)...,
 		).SetVal(mgetExpectedResult)
 
-		cache := NewEnricherCache(zap.NewNop(), redis)
+		cache := NewEnricherCache(redis)
 		res, hit, err := cache.Get(context.Background(), tenantID, leaderboardID, members)
 
 		expectedResult := map[string]map[string]string{
@@ -152,14 +151,14 @@ var _ = Describe("Enricher cache Get tests", func() {
 	})
 })
 
-var _ = Describe("Ericher cache Set tests", func() {
+var _ = Describe("Ericher cacheConfig Set tests", func() {
 	tenantID := "tenantID"
 	leaderboardID := "leaderboardID"
 
 	It("should set the data in redis", func() {
 		redis := redis.NewClient(&redis.Options{Addr: "localhost:6379"})
 
-		cache := NewEnricherCache(zap.NewNop(), redis)
+		cache := NewEnricherCache(redis)
 		members := []*model.Member{
 			{
 				PublicID: "member1",

leaderboard/enriching/cache/cached_enricher.go

@@ -0,0 +1,81 @@
+package cache
+
+import (
+	"context"
+	"github.com/topfreegames/podium/leaderboard/v2/enriching"
+	"github.com/topfreegames/podium/leaderboard/v2/model"
+	"go.uber.org/zap"
+)
+
+type cachedEnricher struct {
+	cache  enriching.EnricherCache
+	config cacheConfig
+	impl   enriching.Enricher
+	logger *zap.Logger
+}
+
+func NewCachedEnricher(
+	cache enriching.EnricherCache,
+	enricher enriching.Enricher,
+	options ...CachedEnricherOptions,
+) enriching.Enricher {
+	e := &cachedEnricher{
+		cache:  cache,
+		impl:   enricher,
+		config: newDefaultCacheConfig(),
+		logger: zap.NewNop(),
+	}
+
+	for _, opt := range options {
+		opt(e)
+	}
+
+	return e
+}
+
+var _ enriching.Enricher = &cachedEnricher{}
+
+func (e *cachedEnricher) Enrich(
+	ctx context.Context,
+	tenantID,
+	leaderboardID string,
+	members []*model.Member,
+) ([]*model.Member, error) {
+	if len(members) == 0 {
+		return members, nil
+	}
+
+	l := e.logger.With(
+		zap.String("tenantID", tenantID),
+		zap.String("leaderboardID", leaderboardID),
+	)
+
+	cached, hit, err := e.cache.Get(ctx, tenantID, leaderboardID, members)
+	if err != nil {
+		l.Error("could not get cached enrichment data", zap.Error(err))
+	}
+
+	if hit {
+		l.Debug("returning cached enrich data")
+		for _, m := range members {
+			if metadata, exists := cached[m.PublicID]; exists {
+				m.Metadata = metadata
+			}
+		}
+
+		return members, nil
+	}
+
+	members, err = e.impl.Enrich(ctx, tenantID, leaderboardID, members)
+
+	if err != nil {
+		return nil, err
+	}
+
+	err = e.cache.Set(ctx, tenantID, leaderboardID, members, e.config.ttl)
+	if err != nil {
+		l.Error("could not set cached enrichment data", zap.Error(err))
+	}
+
+	return members, nil
+}