Add analytics data name to storages for reusability in logs

Author: EmilianoSanchez

src/storages/inMemory/EventsCacheInMemory.ts

@@ -5,6 +5,7 @@ const MAX_QUEUE_BYTE_SIZE = 5 * 1024 * 1024; // 5M
 
 export class EventsCacheInMemory implements IEventsCacheSync {
 
+  public name = 'events';
   private onFullQueue?: () => void;
   private readonly maxQueue: number;
   private queue: SplitIO.EventData[];

src/storages/inMemory/ImpressionCountsCacheInMemory.ts

@@ -3,6 +3,8 @@ import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
 import { IImpressionCountsCacheSync } from '../types';
 
 export class ImpressionCountsCacheInMemory implements IImpressionCountsCacheSync {
+
+  public name = 'impression counts';
   protected cache: Record<string, number> = {};
   private readonly maxStorage: number;
   protected onFullQueue?: () => void;

src/storages/inMemory/ImpressionsCacheInMemory.ts

@@ -3,6 +3,7 @@ import SplitIO from '../../../types/splitio';
 
 export class ImpressionsCacheInMemory implements IImpressionsCacheSync {
 
+  public name = 'impressions';
   private onFullQueue?: () => void;
   private readonly maxQueue: number;
   private queue: SplitIO.ImpressionDTO[];

src/storages/inMemory/TelemetryCacheInMemory.ts

@@ -25,6 +25,8 @@ export function shouldRecordTelemetry({ settings }: IStorageFactoryParams) {
 
 export class TelemetryCacheInMemory implements ITelemetryCacheSync {
 
+  public name = 'telemetry stats';
+
   constructor(private splits?: ISplitsCacheSync, private segments?: ISegmentsCacheSync, private largeSegments?: ISegmentsCacheSync) { }
 
   // isEmpty flag

src/storages/inMemory/UniqueKeysCacheInMemory.ts

@@ -1,4 +1,4 @@
-import { IUniqueKeysCacheBase } from '../types';
+import { IUniqueKeysCacheSync } from '../types';
 import { UniqueKeysPayloadSs } from '../../sync/submitters/types';
 import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
 import { setToArray } from '../../utils/lang/sets';
@@ -22,8 +22,8 @@ export function fromUniqueKeysCollector(uniqueKeys: { [featureName: string]: Set
   return { keys: payload };
 }
 
-export class UniqueKeysCacheInMemory implements IUniqueKeysCacheBase {
-
+export class UniqueKeysCacheInMemory implements IUniqueKeysCacheSync {
+  public name = 'unique keys';
   protected onFullQueue?: () => void;
   private readonly maxStorage: number;
   private uniqueTrackerSize = 0;

src/storages/inMemory/UniqueKeysCacheInMemoryCS.ts

@@ -1,10 +1,10 @@
-import { IUniqueKeysCacheBase } from '../types';
+import { IUniqueKeysCacheSync } from '../types';
 import { UniqueKeysPayloadCs } from '../../sync/submitters/types';
 import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
 import { setToArray } from '../../utils/lang/sets';
 
-export class UniqueKeysCacheInMemoryCS implements IUniqueKeysCacheBase {
-
+export class UniqueKeysCacheInMemoryCS implements IUniqueKeysCacheSync {
+  public name = 'unique keys';
   private onFullQueue?: () => void;
   private readonly maxStorage: number;
   private uniqueTrackerSize = 0;

src/storages/types.ts

@@ -325,6 +325,7 @@ export interface IUniqueKeysCacheBase {
 
 // API methods for sync recorder storages, used by submitters in standalone mode to pop data and post it to Split BE.
 export interface IRecorderCacheSync<T> {
+  name: string,
   // @TODO names are inconsistent with spec
   /* Checks if cache is empty. Returns true if the cache was just created or cleared */
   isEmpty(): boolean

src/sync/submitters/eventsSubmitter.ts

@@ -2,8 +2,6 @@ import { submitterFactory, firstPushWindowDecorator } from './submitter';
 import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 
-const DATA_NAME = 'events';
-
 /**
  * Submitter that periodically posts tracked events
  */
@@ -16,15 +14,15 @@ export function eventsSubmitterFactory(params: ISdkFactoryContextSync) {
   } = params;
 
   // don't retry events.
-  let submitter = submitterFactory(log, postEventsBulk, events, eventsPushRate, DATA_NAME);
+  let submitter = submitterFactory(log, postEventsBulk, events, eventsPushRate);
 
   // Set a timer for the first push window of events.
   if (eventsFirstPushWindow > 0) submitter = firstPushWindowDecorator(submitter, eventsFirstPushWindow);
 
   // register events submitter to be executed when events cache is full
   events.setOnFullQueueCb(() => {
     if (submitter.isRunning()) {
-      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [events.name]);
       submitter.execute();
     }
     // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.

src/sync/submitters/impressionCountsSubmitter.ts

@@ -40,5 +40,5 @@ export function impressionCountsSubmitterFactory(params: ISdkFactoryContextSync)
   } = params;
 
   // retry impressions counts only once.
-  return submitterFactory(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, 'impression counts', fromImpressionCountsCollector, 1);
+  return submitterFactory(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, fromImpressionCountsCollector, 1);
 }

src/sync/submitters/impressionsSubmitter.ts

@@ -5,16 +5,13 @@ import { ImpressionsPayload } from './types';
 import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 
-const DATA_NAME = 'impressions';
-
 /**
  * Converts `impressions` data from cache into request payload.
  */
 export function fromImpressionsCollector(sendLabels: boolean, data: SplitIO.ImpressionDTO[]): ImpressionsPayload {
   let groupedByFeature = groupBy(data, 'feature');
   let dto: ImpressionsPayload = [];
 
-  // using forOwn instead of for...in since the last also iterates over prototype enumerables
   forOwn(groupedByFeature, (value, name) => {
     dto.push({
       f: name, // Test Name
@@ -50,12 +47,12 @@ export function impressionsSubmitterFactory(params: ISdkFactoryContextSync) {
   } = params;
 
   // retry impressions only once.
-  const syncTask = submitterFactory(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, DATA_NAME, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
+  const syncTask = submitterFactory(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
 
   // register impressions submitter to be executed when impressions cache is full
   impressions.setOnFullQueueCb(() => {
     if (syncTask.isRunning()) {
-      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [impressions.name]);
       syncTask.execute();
     }
     // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.