@splitsoftware/splitio-commons 1.6.2-rc.1 → 1.6.2-rc.4

package/cjs/trackers/uniqueKeysTracker.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uniqueKeysTrackerFactory = void 0;
-var constants_1 = require("../logger/constants");
-var sets_1 = require("../utils/lang/sets");
-var noopFilterAdapter = {
-    add: function () { return true; },
-    contains: function () { return true; },
-    clear: function () { }
-};
-var DEFAULT_CACHE_SIZE = 30000;
-/**
- * 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 cacheSize optional internal cache size
- * @param maxBulkSize optional max MTKs bulk size
- */
-function uniqueKeysTrackerFactory(log, filterAdapter, cacheSize) {
-    if (filterAdapter === void 0) { filterAdapter = noopFilterAdapter; }
-    if (cacheSize === void 0) { cacheSize = DEFAULT_CACHE_SIZE; }
-    var uniqueKeysTracker = {};
-    var uniqueTrackerSize = 0;
-    return {
-        track: function (featureName, key) {
-            if (!filterAdapter.add(featureName, key)) {
-                log.debug(constants_1.LOG_PREFIX_UNIQUE_KEYS_TRACKER + "The feature " + featureName + " and key " + key + " exist in the filter");
-                return;
-            }
-            if (!uniqueKeysTracker[featureName])
-                uniqueKeysTracker[featureName] = new sets_1._Set();
-            var tracker = uniqueKeysTracker[featureName];
-            if (!tracker.has(key)) {
-                tracker.add(key);
-                log.debug(constants_1.LOG_PREFIX_UNIQUE_KEYS_TRACKER + "Key " + key + " added to feature " + featureName);
-                uniqueTrackerSize++;
-            }
-            if (uniqueTrackerSize >= cacheSize) {
-                log.warn(constants_1.LOG_PREFIX_UNIQUE_KEYS_TRACKER + "The UniqueKeysTracker size reached the maximum limit");
-                // @TODO trigger event to submitter to send mtk
-                uniqueTrackerSize = 0;
-            }
-        },
-        /**
-         * Pop the collected data, used as payload for posting.
-         */
-        pop: function () {
-            var data = uniqueKeysTracker;
-            uniqueKeysTracker = {};
-            return data;
-        },
-        /**
-         * Clear the data stored on the cache.
-         */
-        clear: function () {
-            uniqueKeysTracker = {};
-        },
-        /**
-         * Check if the cache is empty.
-         */
-        isEmpty: function () {
-            return Object.keys(uniqueKeysTracker).length === 0;
-        }
-    };
-}
-exports.uniqueKeysTrackerFactory = uniqueKeysTrackerFactory;

package/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/esm/sync/submitters/uniqueKeysSubmitter.js

@@ -1,64 +0,0 @@
-import { setToArray } from '../../utils/lang/sets';
-import { submitterFactory } from './submitter';
-/**
- * Invert keys for feature to features for key
- */
-function invertUniqueKeys(uniqueKeys) {
-    var featureNames = Object.keys(uniqueKeys);
-    var inverted = {};
-    for (var i = 0; i < featureNames.length; i++) {
-        var featureName = featureNames[i];
-        var featureKeys = setToArray(uniqueKeys[featureName]);
-        for (var j = 0; j < featureKeys.length; j++) {
-            var featureKey = featureKeys[j];
-            if (!inverted[featureKey])
-                inverted[featureKey] = [];
-            inverted[featureKey].push(featureName);
-        }
-    }
-    return inverted;
-}
-/**
- * Converts `uniqueKeys` data from cache into request payload for CS.
- */
-export function fromUniqueKeysCollectorCs(uniqueKeys) {
-    var payload = [];
-    var featuresPerKey = invertUniqueKeys(uniqueKeys);
-    var keys = Object.keys(featuresPerKey);
-    for (var k = 0; k < keys.length; k++) {
-        var key = keys[k];
-        var uniqueKeysPayload = {
-            k: key,
-            fs: featuresPerKey[key]
-        };
-        payload.push(uniqueKeysPayload);
-    }
-    return { keys: payload };
-}
-/**
- * Converts `uniqueKeys` data from cache into request payload for SS.
- */
-export function fromUniqueKeysCollectorSs(uniqueKeys) {
-    var payload = [];
-    var featureNames = Object.keys(uniqueKeys);
-    for (var i = 0; i < featureNames.length; i++) {
-        var featureName = featureNames[i];
-        var featureKeys = setToArray(uniqueKeys[featureName]);
-        var uniqueKeysPayload = {
-            f: featureName,
-            ks: featureKeys
-        };
-        payload.push(uniqueKeysPayload);
-    }
-    return { keys: payload };
-}
-/**
- * Submitter that periodically posts impression counts
- */
-export function uniqueKeysSubmitterFactory(params) {
-    var _a = params.settings, log = _a.log, uniqueKeysRefreshRate = _a.scheduler.uniqueKeysRefreshRate, key = _a.core.key, _b = params.splitApi, postUniqueKeysBulkCs = _b.postUniqueKeysBulkCs, postUniqueKeysBulkSs = _b.postUniqueKeysBulkSs, uniqueKeys = params.storage.uniqueKeys;
-    var isClientSide = key !== undefined;
-    var postUniqueKeysBulk = isClientSide ? postUniqueKeysBulkCs : postUniqueKeysBulkSs;
-    var fromUniqueKeysCollector = isClientSide ? fromUniqueKeysCollectorCs : fromUniqueKeysCollectorSs;
-    return submitterFactory(log, postUniqueKeysBulk, uniqueKeys, uniqueKeysRefreshRate, 'unique keys', fromUniqueKeysCollector);
-}

package/esm/trackers/strategy/strategyDebug.js

@@ -1,21 +0,0 @@
-/**
- * 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) {
-    return {
-        process: function (impressions) {
-            impressions.forEach(function (impression) {
-                // Adds previous time if it is enabled
-                impression.pt = impressionsObserver.testAndSet(impression);
-            });
-            return {
-                impressionsToStore: impressions,
-                impressionsToListener: impressions,
-                deduped: 0
-            };
-        }
-    };
-}

package/esm/trackers/strategy/strategyNone.js

@@ -1,25 +0,0 @@
-/**
- * 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, uniqueKeysTracker) {
-    return {
-        process: function (impressions) {
-            impressions.forEach(function (impression) {
-                var now = Date.now();
-                // Increments impression counter per featureName
-                impressionsCounter.track(impression.feature, now, 1);
-                // Keep track by unique key
-                uniqueKeysTracker.track(impression.feature, impression.keyName);
-            });
-            return {
-                impressionsToStore: [],
-                impressionsToListener: impressions,
-                deduped: 0
-            };
-        }
-    };
-}

package/esm/trackers/strategy/strategyOptimized.js

@@ -1,30 +0,0 @@
-import { truncateTimeFrame } from '../../utils/time';
-/**
- * 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, impressionsCounter) {
-    return {
-        process: function (impressions) {
-            var impressionsToStore = [];
-            impressions.forEach(function (impression) {
-                impression.pt = impressionsObserver.testAndSet(impression);
-                var 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/esm/trackers/uniqueKeysTracker.js

@@ -1,65 +0,0 @@
-import { LOG_PREFIX_UNIQUE_KEYS_TRACKER } from '../logger/constants';
-import { _Set } from '../utils/lang/sets';
-var noopFilterAdapter = {
-    add: function () { return true; },
-    contains: function () { return true; },
-    clear: function () { }
-};
-var DEFAULT_CACHE_SIZE = 30000;
-/**
- * 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 cacheSize optional internal cache size
- * @param maxBulkSize optional max MTKs bulk size
- */
-export function uniqueKeysTrackerFactory(log, filterAdapter, cacheSize) {
-    if (filterAdapter === void 0) { filterAdapter = noopFilterAdapter; }
-    if (cacheSize === void 0) { cacheSize = DEFAULT_CACHE_SIZE; }
-    var uniqueKeysTracker = {};
-    var uniqueTrackerSize = 0;
-    return {
-        track: function (featureName, key) {
-            if (!filterAdapter.add(featureName, key)) {
-                log.debug(LOG_PREFIX_UNIQUE_KEYS_TRACKER + "The feature " + featureName + " and key " + key + " exist in the filter");
-                return;
-            }
-            if (!uniqueKeysTracker[featureName])
-                uniqueKeysTracker[featureName] = new _Set();
-            var tracker = uniqueKeysTracker[featureName];
-            if (!tracker.has(key)) {
-                tracker.add(key);
-                log.debug(LOG_PREFIX_UNIQUE_KEYS_TRACKER + "Key " + key + " added to feature " + featureName);
-                uniqueTrackerSize++;
-            }
-            if (uniqueTrackerSize >= cacheSize) {
-                log.warn(LOG_PREFIX_UNIQUE_KEYS_TRACKER + "The UniqueKeysTracker size reached the maximum limit");
-                // @TODO trigger event to submitter to send mtk
-                uniqueTrackerSize = 0;
-            }
-        },
-        /**
-         * Pop the collected data, used as payload for posting.
-         */
-        pop: function () {
-            var data = uniqueKeysTracker;
-            uniqueKeysTracker = {};
-            return data;
-        },
-        /**
-         * Clear the data stored on the cache.
-         */
-        clear: function () {
-            uniqueKeysTracker = {};
-        },
-        /**
-         * Check if the cache is empty.
-         */
-        isEmpty: function () {
-            return Object.keys(uniqueKeysTracker).length === 0;
-        }
-    };
-}

package/esm/types.js

@@ -1 +0,0 @@
-export {};

package/src/sync/submitters/uniqueKeysSubmitter.ts

@@ -1,79 +0,0 @@
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-import { ISet, setToArray } from '../../utils/lang/sets';
-import { submitterFactory } from './submitter';
-import { UniqueKeysPayloadCs, UniqueKeysPayloadSs } from './types';
-
-/** 
- * Invert keys for feature to features for key
- */
-function invertUniqueKeys(uniqueKeys: { [featureName: string]: ISet<string> }): { [key: string]: string[] } {
-  const featureNames = Object.keys(uniqueKeys);
-  const inverted: { [key: string]: string[] } = {};
-  for (let i = 0; i < featureNames.length; i++) {
-    const featureName = featureNames[i];
-    const featureKeys = setToArray(uniqueKeys[featureName]);
-    for (let j = 0; j< featureKeys.length; j++) {
-      const featureKey = featureKeys[j];
-      if (!inverted[featureKey]) inverted[featureKey] = []; 
-      inverted[featureKey].push(featureName);
-    }
-  }
-  return inverted;
-}
-
-/**
- * Converts `uniqueKeys` data from cache into request payload for CS.
- */
-export function fromUniqueKeysCollectorCs(uniqueKeys: { [featureName: string]: ISet<string> }): UniqueKeysPayloadCs {
-  const payload = [];
-  const featuresPerKey = invertUniqueKeys(uniqueKeys);
-  const keys = Object.keys(featuresPerKey);
-  for (let k = 0; k < keys.length; k++) {
-    const key = keys[k];
-    const uniqueKeysPayload = {
-      k: key,
-      fs: featuresPerKey[key]
-    };
-
-    payload.push(uniqueKeysPayload);
-  }
-  return { keys: payload };
-}
-
-/**
- * Converts `uniqueKeys` data from cache into request payload for SS.
- */
-export function fromUniqueKeysCollectorSs(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 };
-}
-
-/**
- * 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 fromUniqueKeysCollector = isClientSide ? fromUniqueKeysCollectorCs : fromUniqueKeysCollectorSs;
-
-  return submitterFactory(log, postUniqueKeysBulk, uniqueKeys!, uniqueKeysRefreshRate, 'unique keys', fromUniqueKeysCollector);
-}
-

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.feature, impression.keyName);
-      });
-      
-      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,80 +0,0 @@
-import { LOG_PREFIX_UNIQUE_KEYS_TRACKER } from '../logger/constants';
-import { ILogger } from '../logger/types';
-import { ISet, _Set } from '../utils/lang/sets';
-import { IFilterAdapter, IUniqueKeysTracker } from './types';
-
-const noopFilterAdapter = {
-  add() {return true;},
-  contains() {return true;},
-  clear() {}
-};
-
-const DEFAULT_CACHE_SIZE = 30000;
-/**
- * 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 cacheSize optional internal cache size
- * @param maxBulkSize optional max MTKs bulk size
- */
-export function uniqueKeysTrackerFactory(
-  log: ILogger,
-  filterAdapter: IFilterAdapter = noopFilterAdapter,
-  cacheSize = DEFAULT_CACHE_SIZE,
-  // @TODO
-  // maxBulkSize: number = 5000,
-): IUniqueKeysTracker {
-  
-  let uniqueKeysTracker: { [featureName: string]: ISet<string> } = {};
-  let uniqueTrackerSize = 0;
-  
-  return {
-    track(featureName: string, key: string): void {
-      if (!filterAdapter.add(featureName, key)) {
-        log.debug(`${LOG_PREFIX_UNIQUE_KEYS_TRACKER}The feature ${featureName} and key ${key} exist in the filter`);
-        return;
-      }
-      if (!uniqueKeysTracker[featureName]) uniqueKeysTracker[featureName] = new _Set();
-      const tracker = uniqueKeysTracker[featureName];
-      if (!tracker.has(key)) {
-        tracker.add(key);
-        log.debug(`${LOG_PREFIX_UNIQUE_KEYS_TRACKER}Key ${key} added to feature ${featureName}`);
-        uniqueTrackerSize++;
-      }
-      
-      if (uniqueTrackerSize >= cacheSize) {
-        log.warn(`${LOG_PREFIX_UNIQUE_KEYS_TRACKER}The UniqueKeysTracker size reached the maximum limit`);
-        // @TODO trigger event to submitter to send mtk
-        uniqueTrackerSize = 0;
-      }
-    },
-    
-    /**
-     * Pop the collected data, used as payload for posting.
-     */
-    pop() {
-      const data = uniqueKeysTracker;
-      uniqueKeysTracker = {};
-      return data;
-    },
-
-    /**
-     * Clear the data stored on the cache.
-     */
-    clear() {
-      uniqueKeysTracker = {};
-    },
-
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty() {
-      return Object.keys(uniqueKeysTracker).length === 0;
-    }
-    
-  };
-
-}