@splitsoftware/splitio-commons 1.6.2-rc.2 → 1.6.2-rc.3

package/src/storages/inMemory/uniqueKeysCacheInMemory.ts

@@ -1,83 +0,0 @@
-import { IUniqueKeysCacheBase } from '../types';
-import { ISet, setToArray, _Set } from '../../utils/lang/sets';
-import { UniqueKeysPayloadSs } from '../../sync/submitters/types';
-
-const DEFAULT_CACHE_SIZE = 30000;
-
-export class UniqueKeysCacheInMemory implements IUniqueKeysCacheBase {
-
-  private onFullQueue?: () => void;
-  private readonly maxStorage: number;
-  private uniqueTrackerSize = 0;
-  private uniqueKeysTracker: { [keys: string]: ISet<string> };
-
-  constructor(uniqueKeysQueueSize: number = DEFAULT_CACHE_SIZE) {
-    this.maxStorage = uniqueKeysQueueSize;
-    this.uniqueKeysTracker = {};
-  }
-
-  setOnFullQueueCb(cb: () => void) {
-    this.onFullQueue = cb;
-  }
-
-  /**
-   * Store unique keys in sequential order
-   * key: string = feature name.
-   * value: Set<string> = set of unique keys. 
-   */
-  track(key: string, featureName: string) {
-    if (!this.uniqueKeysTracker[featureName]) this.uniqueKeysTracker[featureName] = new _Set();
-    const tracker = this.uniqueKeysTracker[featureName];
-    if (!tracker.has(key)) {
-      tracker.add(key);
-      this.uniqueTrackerSize++;
-    }
-    if (this.uniqueTrackerSize >= this.maxStorage && this.onFullQueue) {
-      this.uniqueTrackerSize = 0;
-      this.onFullQueue();
-    }
-  }
-
-  /**
-   * Clear the data stored on the cache.
-   */
-  clear() {
-    this.uniqueKeysTracker = {};
-  }
-
-  /**
-   * Pop the collected data, used as payload for posting.
-   */
-  pop() {
-    const data = this.uniqueKeysTracker;
-    this.uniqueKeysTracker = {};
-    return this.fromUniqueKeysCollector(data);
-  }
-
-  /**
-   * Check if the cache is empty.
-   */
-  isEmpty() {
-    return Object.keys(this.uniqueKeysTracker).length === 0;
-  }
-  
-  /**
-   * Converts `uniqueKeys` data from cache into request payload for SS.
-   */
-  private fromUniqueKeysCollector(uniqueKeys: { [featureName: string]: ISet<string> }): UniqueKeysPayloadSs {
-    const payload = [];
-    const featureNames = Object.keys(uniqueKeys);
-    for (let i = 0; i < featureNames.length; i++) {
-      const featureName = featureNames[i];
-      const featureKeys = setToArray(uniqueKeys[featureName]);
-      const uniqueKeysPayload = {
-        f: featureName,
-        ks: featureKeys
-      };
-
-      payload.push(uniqueKeysPayload);
-    }
-    return { keys: payload };
-  }
-  
-}

package/src/storages/inMemory/uniqueKeysCacheInMemoryCS.ts

@@ -1,89 +0,0 @@
-import { IUniqueKeysCacheBase } from '../types';
-import { ISet, setToArray, _Set } from '../../utils/lang/sets';
-import { UniqueKeysPayloadCs } from '../../sync/submitters/types';
-
-const DEFAULT_CACHE_SIZE = 30000;
-
-export class UniqueKeysCacheInMemoryCS implements IUniqueKeysCacheBase {
-
-  private onFullQueue?: () => void;
-  private readonly maxStorage: number;
-  private uniqueTrackerSize = 0;
-  private uniqueKeysTracker: { [keys: string]: ISet<string> };
-
-  /**
-   *
-   * @param impressionsQueueSize number of queued impressions to call onFullQueueCb.
-   * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
-   */
-  constructor(uniqueKeysQueueSize: number = DEFAULT_CACHE_SIZE) {   
-    this.maxStorage = uniqueKeysQueueSize;
-    this.uniqueKeysTracker = {};
-  }
-
-  setOnFullQueueCb(cb: () => void) {
-    this.onFullQueue = cb;
-  }
-
-  /**
-   * Store unique keys in sequential order
-   * key: string = key.
-   * value: HashSet<string> = set of split names. 
-   */
-  track(key: string, featureName: string) {
-    
-    if (!this.uniqueKeysTracker[key]) this.uniqueKeysTracker[key] = new _Set();
-    const tracker = this.uniqueKeysTracker[key];
-    if (!tracker.has(featureName)) {
-      tracker.add(featureName);
-      this.uniqueTrackerSize++;
-    }
-    if (this.uniqueTrackerSize >= this.maxStorage && this.onFullQueue) {
-      this.uniqueTrackerSize = 0;
-      this.onFullQueue();
-    }
-  }
-
-  /**
-   * Clear the data stored on the cache.
-   */
-  clear() {
-    this.uniqueKeysTracker = {};
-  }
-
-  /**
-   * Pop the collected data, used as payload for posting.
-   */
-  pop() {
-    const data = this.uniqueKeysTracker;
-    this.uniqueKeysTracker = {};
-    return this.fromUniqueKeysCollector(data);
-  }
-
-  /**
-   * Check if the cache is empty.
-   */
-  isEmpty() {
-    return Object.keys(this.uniqueKeysTracker).length === 0;
-  }
-  
-  /**
-   * Converts `uniqueKeys` data from cache into request payload.
-   */
-  private fromUniqueKeysCollector(uniqueKeys: { [featureName: string]: ISet<string> }): UniqueKeysPayloadCs {
-    const payload = [];
-    const featureKeys = Object.keys(uniqueKeys);
-    for (let k = 0; k < featureKeys.length; k++) {
-      const featureKey = featureKeys[k];
-      const featureNames = setToArray(uniqueKeys[featureKey]);
-      const uniqueKeysPayload = {
-        k: featureKey,
-        fs: featureNames
-      };
-
-      payload.push(uniqueKeysPayload);
-    }
-    return { keys: payload };
-  }
-  
-}

package/src/sync/submitters/uniqueKeysSubmitter.ts

@@ -1,35 +0,0 @@
-import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-import { submitterFactory } from './submitter';
-
-const DATA_NAME = 'uniqueKeys';
-
-/**
- * Submitter that periodically posts impression counts
- */
-export function uniqueKeysSubmitterFactory(params: ISdkFactoryContextSync) {
-
-  const {
-    settings: { log, scheduler: { uniqueKeysRefreshRate }, core: {key}},
-    splitApi: { postUniqueKeysBulkCs, postUniqueKeysBulkSs },
-    storage: { uniqueKeys }
-  } = params;
-  
-  const isClientSide = key !== undefined;
-  const postUniqueKeysBulk = isClientSide ? postUniqueKeysBulkCs : postUniqueKeysBulkSs;
-
-  const syncTask = submitterFactory(log, postUniqueKeysBulk, uniqueKeys!, uniqueKeysRefreshRate, 'unique keys');
-
-  // register unique keys submitter to be executed when uniqueKeys cache is full
-  uniqueKeys!.setOnFullQueueCb(() => {
-    if (syncTask.isRunning()) {
-      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
-      syncTask.execute();
-    }
-    // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.
-    // Data will be sent when submitter is resumed.
-  });
-  
-  return syncTask;
-}
-

package/src/trackers/strategy/strategyDebug.ts

@@ -1,28 +0,0 @@
-import { ImpressionDTO } from '../../types';
-import { IImpressionObserver } from '../impressionObserver/types';
-import { IStrategy } from '../types';
-
-/**
- * Debug strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
- * 
- * @param impressionsObserver impression observer. Previous time (pt property) is included in impression instances
- * @returns IStrategyResult
- */
-export function strategyDebugFactory(
-  impressionsObserver: IImpressionObserver
-): IStrategy {
-  
-  return {
-    process(impressions: ImpressionDTO[]) {
-      impressions.forEach((impression) => {
-        // Adds previous time if it is enabled
-        impression.pt = impressionsObserver.testAndSet(impression);
-      });
-      return {
-        impressionsToStore: impressions, 
-        impressionsToListener: impressions, 
-        deduped: 0
-      };
-    }
-  };
-}

package/src/trackers/strategy/strategyNone.ts

@@ -1,34 +0,0 @@
-import { IImpressionCountsCacheSync } from '../../storages/types';
-import { ImpressionDTO } from '../../types';
-import { IStrategy, IUniqueKeysTracker } from '../types';
-
-/**
- * None strategy for impressions tracker.
- * 
- * @param impressionsCounter cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
- * @param uniqueKeysTracker unique keys tracker in charge of tracking the unique keys per split. 
- * @returns IStrategyResult
- */
-export function strategyNoneFactory(
-  impressionsCounter: IImpressionCountsCacheSync,
-  uniqueKeysTracker: IUniqueKeysTracker
-): IStrategy {
-  
-  return {
-    process(impressions: ImpressionDTO[]) {
-      impressions.forEach((impression) => {        
-        const now = Date.now();
-        // Increments impression counter per featureName
-        impressionsCounter.track(impression.feature, now, 1);
-        // Keep track by unique key
-        uniqueKeysTracker.track(impression.keyName, impression.feature);
-      });
-      
-      return {
-        impressionsToStore: [], 
-        impressionsToListener: impressions, 
-        deduped: 0
-      };
-    }
-  };
-}

package/src/trackers/strategy/strategyOptimized.ts

@@ -1,42 +0,0 @@
-import { IImpressionCountsCacheSync } from '../../storages/types';
-import { ImpressionDTO } from '../../types';
-import { truncateTimeFrame } from '../../utils/time';
-import { IImpressionObserver } from '../impressionObserver/types';
-import { IStrategy } from '../types';
-
-/**
- * Optimized strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
- * 
- * @param impressionsObserver impression observer. previous time (pt property) is included in impression instances
- * @param impressionsCounter cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
- * @returns IStrategyResult
- */
-export function strategyOptimizedFactory(
-  impressionsObserver: IImpressionObserver,
-  impressionsCounter: IImpressionCountsCacheSync,
-): IStrategy {
-  
-  return {
-    process(impressions: ImpressionDTO[]) {
-      const impressionsToStore: ImpressionDTO[] = [];
-      impressions.forEach((impression) => {
-        impression.pt = impressionsObserver.testAndSet(impression);
-        
-        const now = Date.now();
-        
-        // Increments impression counter per featureName
-        impressionsCounter.track(impression.feature, now, 1);
-  
-        // Checks if the impression should be added in queue to be sent
-        if (!impression.pt || impression.pt < truncateTimeFrame(now)) {
-          impressionsToStore.push(impression);
-        }
-      });
-      return {
-        impressionsToStore: impressionsToStore, 
-        impressionsToListener: impressions, 
-        deduped: impressions.length - impressionsToStore.length
-      };
-    }
-  };
-}

package/src/trackers/uniqueKeysTracker.ts

@@ -1,37 +0,0 @@
-import { LOG_PREFIX_UNIQUE_KEYS_TRACKER } from '../logger/constants';
-import { ILogger } from '../logger/types';
-import { IUniqueKeysCacheBase } from '../storages/types';
-import { IFilterAdapter, IUniqueKeysTracker } from './types';
-
-const noopFilterAdapter = {
-  add() {return true;},
-  contains() {return true;},
-  clear() {}
-};
-
-/**
- * Trackes uniques keys
- * Unique Keys Tracker will be in charge of checking if the MTK was already sent to the BE in the last period
- *  or schedule to be sent; if not it will be added in an internal cache and sent in the next post. 
- * 
- * @param log Logger instance
- * @param filterAdapter filter adapter
- * @param uniqueKeysCache cache to save unique keys
- */
-export function uniqueKeysTrackerFactory(
-  log: ILogger,
-  uniqueKeysCache: IUniqueKeysCacheBase,
-  filterAdapter: IFilterAdapter = noopFilterAdapter,
-): IUniqueKeysTracker {
-  
-  return {
-    track(key: string, featureName: string): void {
-      if (!filterAdapter.add(key, featureName)) {
-        log.debug(`${LOG_PREFIX_UNIQUE_KEYS_TRACKER}The feature ${featureName} and key ${key} exist in the filter`);
-        return;
-      }
-      uniqueKeysCache.track(key, featureName);
-    }
-  };
-
-}