FFM-11660 Move seen targets clear interval to analytics

FFM-11660 Add comment

FFM-11660 Add Bump version

FFM-11660 Add a stop clearing method

Author: erdirowlands

.harness/ffgolangserversdk.yaml

@@ -176,7 +176,7 @@ pipeline:
                                     dockerfile: ff-sdk-testgrid/go/Dockerfile
                                     context: ff-sdk-testgrid/go
                                     buildArgs:
-                                      SDK_VERSION: v0.1.24
+                                      SDK_VERSION: v0.1.25
                                       BUILD_MODE: local
                                     resources:
                                       limits:

analyticsservice/analytics.go

@@ -26,7 +26,7 @@ const (
 	variationValueAttribute      string = "featureValue"
 	targetAttribute              string = "target"
 	sdkVersionAttribute          string = "SDK_VERSION"
-	SdkVersion                   string = "0.1.24"
+	SdkVersion                   string = "0.1.25"
 	sdkTypeAttribute             string = "SDK_TYPE"
 	sdkType                      string = "server"
 	sdkLanguageAttribute         string = "SDK_LANGUAGE"
@@ -62,16 +62,17 @@ type analyticsEvent struct {
 
 // AnalyticsService provides a way to cache and send analytics to the server
 type AnalyticsService struct {
-	analyticsChan             chan analyticsEvent
-	evaluationAnalytics       SafeAnalyticsCache[string, analyticsEvent]
-	targetAnalytics           SafeAnalyticsCache[string, evaluation.Target]
-	seenTargets               SafeSeenTargetsCache[string, bool]
-	logEvaluationLimitReached atomic.Bool
-	logTargetLimitReached     atomic.Bool
-	timeout                   time.Duration
-	logger                    logger.Logger
-	metricsClient             metricsclient.ClientWithResponsesInterface
-	environmentID             string
+	analyticsChan               chan analyticsEvent
+	evaluationAnalytics         SafeAnalyticsCache[string, analyticsEvent]
+	targetAnalytics             SafeAnalyticsCache[string, evaluation.Target]
+	seenTargets                 SafeSeenTargetsCache[string, bool]
+	logEvaluationLimitReached   atomic.Bool
+	logTargetLimitReached       atomic.Bool
+	timeout                     time.Duration
+	logger                      logger.Logger
+	metricsClient               metricsclient.ClientWithResponsesInterface
+	environmentID               string
+	seenTargetsClearingInterval time.Duration
 }
 
 // NewAnalyticsService creates and starts a analytics service to send data to the client
@@ -83,12 +84,13 @@ func NewAnalyticsService(timeout time.Duration, logger logger.Logger, seenTarget
 		serviceTimeout = 1 * time.Hour
 	}
 	as := AnalyticsService{
-		analyticsChan:       make(chan analyticsEvent),
-		evaluationAnalytics: newSafeEvaluationAnalytics(),
-		targetAnalytics:     newSafeTargetAnalytics(),
-		seenTargets:         newSafeSeenTargets(seenTargetsMaxSize, seenTargetsClearingSchedule),
-		timeout:             serviceTimeout,
-		logger:              logger,
+		analyticsChan:               make(chan analyticsEvent),
+		evaluationAnalytics:         newSafeEvaluationAnalytics(),
+		targetAnalytics:             newSafeTargetAnalytics(),
+		seenTargets:                 newSafeSeenTargets(seenTargetsMaxSize),
+		timeout:                     serviceTimeout,
+		logger:                      logger,
+		seenTargetsClearingInterval: seenTargetsClearingSchedule,
 	}
 	go as.listener()
 
@@ -101,6 +103,7 @@ func (as *AnalyticsService) Start(ctx context.Context, client metricsclient.Clie
 	as.metricsClient = client
 	as.environmentID = environmentID
 	go as.startTimer(ctx)
+	go as.startSeenTargetsClearingSchedule(ctx, as.seenTargetsClearingInterval)
 }
 
 func (as *AnalyticsService) startTimer(ctx context.Context) {
@@ -110,6 +113,7 @@ func (as *AnalyticsService) startTimer(ctx context.Context) {
 			timeStamp := time.Now().UnixNano() / (int64(time.Millisecond) / int64(time.Nanosecond))
 			as.sendDataAndResetCache(ctx, timeStamp)
 		case <-ctx.Done():
+			close(as.analyticsChan)
 			as.logger.Infof("%s Metrics stopped", sdk_codes.MetricsStopped)
 			return
 		}
@@ -324,6 +328,22 @@ func (as *AnalyticsService) processTargetMetrics(targetAnalytics SafeAnalyticsCa
 	return targetData
 }
 
+func (as *AnalyticsService) startSeenTargetsClearingSchedule(ctx context.Context, clearingInterval time.Duration) {
+	ticker := time.NewTicker(clearingInterval)
+
+	for {
+		select {
+		case <-ticker.C:
+			as.logger.Infof("Clearing seen targets")
+			as.seenTargets.clear()
+
+		case <-ctx.Done():
+			ticker.Stop()
+			return
+		}
+	}
+}
+
 func getEvaluationAnalyticKey(event analyticsEvent) string {
 	return fmt.Sprintf("%s-%s-%s-%s", event.featureConfig.Feature, event.variation.Identifier, event.variation.Value, globalTarget)
 }

analyticsservice/safe_seen_targets_map.go

@@ -3,36 +3,21 @@ package analyticsservice
 import (
 	"sync"
 	"sync/atomic"
-	"time"
 )
 
 type safeSeenTargets struct {
 	sync.RWMutex
 	data          map[string]bool
 	maxSize       int
 	limitExceeded atomic.Bool
-	clearingTimer *time.Ticker
 }
 
 // Implements SafeSeenTargetsCache
-func newSafeSeenTargets(maxSize int, clearingInterval time.Duration) SafeSeenTargetsCache[string, bool] {
-	st := &safeSeenTargets{
+func newSafeSeenTargets(maxSize int) SafeSeenTargetsCache[string, bool] {
+	return &safeSeenTargets{
 		data:    make(map[string]bool),
 		maxSize: maxSize,
 	}
-
-	if clearingInterval > 0 {
-		st.clearingTimer = time.NewTicker(clearingInterval)
-
-		// Start a goroutine to clear the cache at a set interval
-		go func() {
-			for range st.clearingTimer.C {
-				st.clear()
-			}
-		}()
-	}
-
-	return st
 }
 
 func (s *safeSeenTargets) setWithLimit(key string, seen bool) {

client/options.go

@@ -156,7 +156,8 @@ func WithSeenTargetsMaxSize(maxSize int) ConfigOption {
 	}
 }
 
-// WithSeenTargetsClearInterval sets the clearing interval for the seen targets map.
+// WithSeenTargetsClearInterval sets the clearing interval for the seen targets map. By default, the interval
+// is set to 24 hours.
 func WithSeenTargetsClearInterval(interval time.Duration) ConfigOption {
 	return func(config *config) {
 		config.seenTargetsClearInterval = interval