@splitsoftware/splitio-commons 1.6.2-rc.7 → 1.6.2-rc.8

package/cjs/sdkFactory/index.js

@@ -35,9 +35,6 @@ function sdkFactory(params) {
         impressionsQueueSize: settings.scheduler.impressionsQueueSize,
         eventsQueueSize: settings.scheduler.eventsQueueSize,
         uniqueKeysCacheSize: settings.scheduler.uniqueKeysCacheSize,
-        impressionCountsQueueSize: settings.scheduler.impressionCountsQueueSize,
-        impressionCountsRefreshRate: settings.scheduler.impressionCountsRefreshRate,
-        uniqueKeysRefreshRate: settings.scheduler.uniqueKeysRefreshRate,
         optimize: (0, utils_1.shouldBeOptimized)(settings),
         // ATM, only used by InLocalStorage
         matchingKey: (0, key_1.getMatching)(settings.core.key),

package/cjs/storages/inRedis/ImpressionCountsCacheInRedis.js

@@ -19,9 +19,9 @@ var ImpressionCountsCacheInRedis = /** @class */ (function (_super) {
     ImpressionCountsCacheInRedis.prototype.postImpressionCountsInRedis = function () {
         var _this = this;
         var counts = this.pop();
-        if (!counts)
-            return false;
         var keys = Object.keys(counts);
+        if (!keys)
+            return Promise.resolve(false);
         var pipeline = this.redis.pipeline();
         keys.forEach(function (key) {
             pipeline.hincrby(_this.key, key, counts[key]);
@@ -35,7 +35,7 @@ var ImpressionCountsCacheInRedis = /** @class */ (function (_super) {
         })
             .catch(function (err) {
             _this.log.error(constants_1.LOG_PREFIX + "Error in impression counts pipeline: " + err + ".");
-            return false;
+            return Promise.resolve(false);
         });
     };
     ImpressionCountsCacheInRedis.prototype.start = function () {
@@ -43,6 +43,7 @@ var ImpressionCountsCacheInRedis = /** @class */ (function (_super) {
     };
     ImpressionCountsCacheInRedis.prototype.stop = function () {
         clearInterval(this.intervalId);
+        return this.postImpressionCountsInRedis();
     };
     return ImpressionCountsCacheInRedis;
 }(ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory));

package/cjs/storages/inRedis/index.js

@@ -20,12 +20,12 @@ function InRedisStorage(options) {
     if (options === void 0) { options = {}; }
     var prefix = (0, KeyBuilder_1.validatePrefix)(options.prefix);
     function InRedisStorageFactory(_a) {
-        var log = _a.log, metadata = _a.metadata, onReadyCb = _a.onReadyCb, impressionsMode = _a.impressionsMode, impressionCountsQueueSize = _a.impressionCountsQueueSize, impressionCountsRefreshRate = _a.impressionCountsRefreshRate, uniqueKeysCacheSize = _a.uniqueKeysCacheSize, uniqueKeysRefreshRate = _a.uniqueKeysRefreshRate;
+        var log = _a.log, metadata = _a.metadata, onReadyCb = _a.onReadyCb, impressionsMode = _a.impressionsMode;
         var keys = new KeyBuilderSS_1.KeyBuilderSS(prefix, metadata);
         var redisClient = new RedisAdapter_1.RedisAdapter(log, options.options || {});
         var telemetry = new TelemetryCacheInRedis_1.TelemetryCacheInRedis(log, keys, redisClient);
-        var impressionCountsCache = impressionsMode !== constants_1.DEBUG ? new ImpressionCountsCacheInRedis_1.ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient, impressionCountsQueueSize, impressionCountsRefreshRate) : undefined;
-        var uniqueKeysCache = impressionsMode === constants_1.NONE ? new uniqueKeysCacheInRedis_1.UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient, uniqueKeysCacheSize, uniqueKeysRefreshRate) : undefined;
+        var impressionCountsCache = impressionsMode !== constants_1.DEBUG ? new ImpressionCountsCacheInRedis_1.ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient) : undefined;
+        var uniqueKeysCache = impressionsMode === constants_1.NONE ? new uniqueKeysCacheInRedis_1.UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient) : undefined;
         // subscription to Redis connect event in order to emit SDK_READY event on consumer mode
         redisClient.on('connect', function () {
             onReadyCb();
@@ -47,11 +47,12 @@ function InRedisStorage(options) {
             // When using REDIS we should:
             // 1- Disconnect from the storage
             destroy: function () {
-                redisClient.disconnect();
+                var promises = [];
                 if (impressionCountsCache)
-                    impressionCountsCache.stop();
+                    promises.push(impressionCountsCache.stop());
                 if (uniqueKeysCache)
-                    uniqueKeysCache.stop();
+                    promises.push(uniqueKeysCache.stop());
+                return Promise.all(promises).then(function () { redisClient.disconnect(); });
                 // @TODO check that caches works as expected when redisClient is disconnected
             }
         };

package/cjs/storages/inRedis/uniqueKeysCacheInRedis.js

@@ -21,8 +21,10 @@ var UniqueKeysCacheInRedis = /** @class */ (function (_super) {
     }
     UniqueKeysCacheInRedis.prototype.postUniqueKeysInRedis = function () {
         var _this = this;
-        var pipeline = this.redis.pipeline();
         var featureNames = Object.keys(this.uniqueKeysTracker);
+        if (!featureNames)
+            return Promise.resolve(false);
+        var pipeline = this.redis.pipeline();
         for (var i = 0; i < featureNames.length; i++) {
             var featureName = featureNames[i];
             var featureKeys = (0, sets_1.setToArray)(this.uniqueKeysTracker[featureName]);
@@ -42,7 +44,7 @@ var UniqueKeysCacheInRedis = /** @class */ (function (_super) {
         })
             .catch(function (err) {
             _this.log.error(constants_2.LOG_PREFIX + "Error in uniqueKeys pipeline: " + err + ".");
-            return false;
+            return Promise.resolve(false);
         });
     };
     UniqueKeysCacheInRedis.prototype.start = function () {
@@ -50,6 +52,7 @@ var UniqueKeysCacheInRedis = /** @class */ (function (_super) {
     };
     UniqueKeysCacheInRedis.prototype.stop = function () {
         clearInterval(this.intervalId);
+        return this.postUniqueKeysInRedis();
     };
     return UniqueKeysCacheInRedis;
 }(uniqueKeysCacheInMemory_1.UniqueKeysCacheInMemory));

package/cjs/utils/settingsValidation/index.js

@@ -115,7 +115,6 @@ function settingsValidation(config, validationParams) {
     scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
     scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
     scheduler.uniqueKeysRefreshRate = fromSecondsToMillis(scheduler.uniqueKeysRefreshRate);
-    scheduler.impressionCountsRefreshRate = fromSecondsToMillis(scheduler.impressionCountsRefreshRate);
     scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
     // Default impressionsRefreshRate for DEBUG mode is 60 secs
     if ((0, lang_1.get)(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === constants_1.DEBUG)

package/esm/sdkFactory/index.js

@@ -32,9 +32,6 @@ export function sdkFactory(params) {
         impressionsQueueSize: settings.scheduler.impressionsQueueSize,
         eventsQueueSize: settings.scheduler.eventsQueueSize,
         uniqueKeysCacheSize: settings.scheduler.uniqueKeysCacheSize,
-        impressionCountsQueueSize: settings.scheduler.impressionCountsQueueSize,
-        impressionCountsRefreshRate: settings.scheduler.impressionCountsRefreshRate,
-        uniqueKeysRefreshRate: settings.scheduler.uniqueKeysRefreshRate,
         optimize: shouldBeOptimized(settings),
         // ATM, only used by InLocalStorage
         matchingKey: getMatching(settings.core.key),

package/esm/storages/inRedis/ImpressionCountsCacheInRedis.js

@@ -16,9 +16,9 @@ var ImpressionCountsCacheInRedis = /** @class */ (function (_super) {
     ImpressionCountsCacheInRedis.prototype.postImpressionCountsInRedis = function () {
         var _this = this;
         var counts = this.pop();
-        if (!counts)
-            return false;
         var keys = Object.keys(counts);
+        if (!keys)
+            return Promise.resolve(false);
         var pipeline = this.redis.pipeline();
         keys.forEach(function (key) {
             pipeline.hincrby(_this.key, key, counts[key]);
@@ -32,7 +32,7 @@ var ImpressionCountsCacheInRedis = /** @class */ (function (_super) {
         })
             .catch(function (err) {
             _this.log.error(LOG_PREFIX + "Error in impression counts pipeline: " + err + ".");
-            return false;
+            return Promise.resolve(false);
         });
     };
     ImpressionCountsCacheInRedis.prototype.start = function () {
@@ -40,6 +40,7 @@ var ImpressionCountsCacheInRedis = /** @class */ (function (_super) {
     };
     ImpressionCountsCacheInRedis.prototype.stop = function () {
         clearInterval(this.intervalId);
+        return this.postImpressionCountsInRedis();
     };
     return ImpressionCountsCacheInRedis;
 }(ImpressionCountsCacheInMemory));

package/esm/storages/inRedis/index.js

@@ -17,12 +17,12 @@ export function InRedisStorage(options) {
     if (options === void 0) { options = {}; }
     var prefix = validatePrefix(options.prefix);
     function InRedisStorageFactory(_a) {
-        var log = _a.log, metadata = _a.metadata, onReadyCb = _a.onReadyCb, impressionsMode = _a.impressionsMode, impressionCountsQueueSize = _a.impressionCountsQueueSize, impressionCountsRefreshRate = _a.impressionCountsRefreshRate, uniqueKeysCacheSize = _a.uniqueKeysCacheSize, uniqueKeysRefreshRate = _a.uniqueKeysRefreshRate;
+        var log = _a.log, metadata = _a.metadata, onReadyCb = _a.onReadyCb, impressionsMode = _a.impressionsMode;
         var keys = new KeyBuilderSS(prefix, metadata);
         var redisClient = new RedisAdapter(log, options.options || {});
         var telemetry = new TelemetryCacheInRedis(log, keys, redisClient);
-        var impressionCountsCache = impressionsMode !== DEBUG ? new ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient, impressionCountsQueueSize, impressionCountsRefreshRate) : undefined;
-        var uniqueKeysCache = impressionsMode === NONE ? new UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient, uniqueKeysCacheSize, uniqueKeysRefreshRate) : undefined;
+        var impressionCountsCache = impressionsMode !== DEBUG ? new ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient) : undefined;
+        var uniqueKeysCache = impressionsMode === NONE ? new UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient) : undefined;
         // subscription to Redis connect event in order to emit SDK_READY event on consumer mode
         redisClient.on('connect', function () {
             onReadyCb();
@@ -44,11 +44,12 @@ export function InRedisStorage(options) {
             // When using REDIS we should:
             // 1- Disconnect from the storage
             destroy: function () {
-                redisClient.disconnect();
+                var promises = [];
                 if (impressionCountsCache)
-                    impressionCountsCache.stop();
+                    promises.push(impressionCountsCache.stop());
                 if (uniqueKeysCache)
-                    uniqueKeysCache.stop();
+                    promises.push(uniqueKeysCache.stop());
+                return Promise.all(promises).then(function () { redisClient.disconnect(); });
                 // @TODO check that caches works as expected when redisClient is disconnected
             }
         };

package/esm/storages/inRedis/uniqueKeysCacheInRedis.js

@@ -18,8 +18,10 @@ var UniqueKeysCacheInRedis = /** @class */ (function (_super) {
     }
     UniqueKeysCacheInRedis.prototype.postUniqueKeysInRedis = function () {
         var _this = this;
-        var pipeline = this.redis.pipeline();
         var featureNames = Object.keys(this.uniqueKeysTracker);
+        if (!featureNames)
+            return Promise.resolve(false);
+        var pipeline = this.redis.pipeline();
         for (var i = 0; i < featureNames.length; i++) {
             var featureName = featureNames[i];
             var featureKeys = setToArray(this.uniqueKeysTracker[featureName]);
@@ -39,7 +41,7 @@ var UniqueKeysCacheInRedis = /** @class */ (function (_super) {
         })
             .catch(function (err) {
             _this.log.error(LOG_PREFIX + "Error in uniqueKeys pipeline: " + err + ".");
-            return false;
+            return Promise.resolve(false);
         });
     };
     UniqueKeysCacheInRedis.prototype.start = function () {
@@ -47,6 +49,7 @@ var UniqueKeysCacheInRedis = /** @class */ (function (_super) {
     };
     UniqueKeysCacheInRedis.prototype.stop = function () {
         clearInterval(this.intervalId);
+        return this.postUniqueKeysInRedis();
     };
     return UniqueKeysCacheInRedis;
 }(UniqueKeysCacheInMemory));

package/esm/utils/settingsValidation/index.js

@@ -112,7 +112,6 @@ export function settingsValidation(config, validationParams) {
     scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
     scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
     scheduler.uniqueKeysRefreshRate = fromSecondsToMillis(scheduler.uniqueKeysRefreshRate);
-    scheduler.impressionCountsRefreshRate = fromSecondsToMillis(scheduler.impressionCountsRefreshRate);
     scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
     // Default impressionsRefreshRate for DEBUG mode is 60 secs
     if (get(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === DEBUG)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.6.2-rc.7",
+  "version": "1.6.2-rc.8",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/sdkFactory/index.ts

@@ -44,9 +44,6 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.
     impressionsQueueSize: settings.scheduler.impressionsQueueSize,
     eventsQueueSize: settings.scheduler.eventsQueueSize,
     uniqueKeysCacheSize: settings.scheduler.uniqueKeysCacheSize,
-    impressionCountsQueueSize: settings.scheduler.impressionCountsQueueSize,
-    impressionCountsRefreshRate: settings.scheduler.impressionCountsRefreshRate,
-    uniqueKeysRefreshRate: settings.scheduler.uniqueKeysRefreshRate,
     optimize: shouldBeOptimized(settings),
 
     // ATM, only used by InLocalStorage

package/src/storages/inRedis/ImpressionCountsCacheInRedis.ts

@@ -22,8 +22,8 @@ export class ImpressionCountsCacheInRedis extends ImpressionCountsCacheInMemory
   
   postImpressionCountsInRedis(){
     const counts = this.pop();
-    if (!counts) return false;
     const keys = Object.keys(counts);
+    if (!keys) return Promise.resolve(false);
     const pipeline = this.redis.pipeline();
     keys.forEach(key => {
       pipeline.hincrby(this.key, key, counts[key]);
@@ -37,7 +37,7 @@ export class ImpressionCountsCacheInRedis extends ImpressionCountsCacheInMemory
       })
       .catch(err => {
         this.log.error(`${LOG_PREFIX}Error in impression counts pipeline: ${err}.`);
-        return false;
+        return Promise.resolve(false);
       });
   }
   
@@ -47,5 +47,6 @@ export class ImpressionCountsCacheInRedis extends ImpressionCountsCacheInMemory
   
   stop() {
     clearInterval(this.intervalId);
+    return this.postImpressionCountsInRedis();
   }
 }

package/src/storages/inRedis/index.ts

@@ -24,12 +24,12 @@ export function InRedisStorage(options: InRedisStorageOptions = {}): IStorageAsy
 
   const prefix = validatePrefix(options.prefix);
 
-  function InRedisStorageFactory({ log, metadata, onReadyCb, impressionsMode, impressionCountsQueueSize, impressionCountsRefreshRate, uniqueKeysCacheSize, uniqueKeysRefreshRate }: IStorageFactoryParams): IStorageAsync {
+  function InRedisStorageFactory({ log, metadata, onReadyCb, impressionsMode }: IStorageFactoryParams): IStorageAsync {
     const keys = new KeyBuilderSS(prefix, metadata);
     const redisClient = new RedisAdapter(log, options.options || {});
     const telemetry = new TelemetryCacheInRedis(log, keys, redisClient);
-    const impressionCountsCache = impressionsMode !== DEBUG ? new ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient, impressionCountsQueueSize, impressionCountsRefreshRate) : undefined;
-    const uniqueKeysCache = impressionsMode === NONE ? new UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient, uniqueKeysCacheSize, uniqueKeysRefreshRate) : undefined;
+    const impressionCountsCache = impressionsMode !== DEBUG ? new ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient) : undefined;
+    const uniqueKeysCache = impressionsMode === NONE ? new UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient) : undefined;
 
     // subscription to Redis connect event in order to emit SDK_READY event on consumer mode
     redisClient.on('connect', () => {
@@ -52,10 +52,11 @@ export function InRedisStorage(options: InRedisStorageOptions = {}): IStorageAsy
 
       // When using REDIS we should:
       // 1- Disconnect from the storage
-      destroy() {
-        redisClient.disconnect();
-        if (impressionCountsCache) impressionCountsCache.stop();
-        if (uniqueKeysCache) uniqueKeysCache.stop();
+      destroy(): Promise<void>{
+        let promises = [];
+        if (impressionCountsCache) promises.push(impressionCountsCache.stop());
+        if (uniqueKeysCache) promises.push(uniqueKeysCache.stop());
+        return Promise.all(promises).then(() => { redisClient.disconnect(); });
         // @TODO check that caches works as expected when redisClient is disconnected
       }
     };

package/src/storages/inRedis/uniqueKeysCacheInRedis.ts

@@ -24,9 +24,9 @@ export class UniqueKeysCacheInRedis extends UniqueKeysCacheInMemory implements I
   }
   
   postUniqueKeysInRedis() {
-    const pipeline = this.redis.pipeline();
-    
     const featureNames = Object.keys(this.uniqueKeysTracker);
+    if (!featureNames) return Promise.resolve(false);
+    const pipeline = this.redis.pipeline();
     for (let i = 0; i < featureNames.length; i++) {
       const featureName = featureNames[i];
       const featureKeys = setToArray(this.uniqueKeysTracker[featureName]);
@@ -47,7 +47,7 @@ export class UniqueKeysCacheInRedis extends UniqueKeysCacheInMemory implements I
       })
       .catch(err => {
         this.log.error(`${LOG_PREFIX}Error in uniqueKeys pipeline: ${err}.`);
-        return false;
+        return Promise.resolve(false);
       });
   }
   
@@ -58,6 +58,7 @@ export class UniqueKeysCacheInRedis extends UniqueKeysCacheInMemory implements I
   
   stop() {
     clearInterval(this.intervalId);
+    return this.postUniqueKeysInRedis();
   }
   
 }

package/src/storages/types.ts

@@ -498,10 +498,7 @@ export type DataLoader = (storage: IStorageSync, matchingKey: string) => void
 export interface IStorageFactoryParams {
   log: ILogger,
   impressionsQueueSize?: number,
-  impressionCountsQueueSize?: number,
-  impressionCountsRefreshRate?: number,
-  uniqueKeysRefreshRate?: number,
-  uniqueKeysCacheSize?: number,
+  uniqueKeysCacheSize?: number;
   eventsQueueSize?: number,
   optimize?: boolean /* whether create the `impressionCounts` cache (OPTIMIZED impression mode) or not (DEBUG impression mode) */,
   mode: SDKMode,

package/src/types.ts

@@ -80,8 +80,6 @@ export interface ISettings {
     featuresRefreshRate: number,
     impressionsRefreshRate: number,
     impressionsQueueSize: number,
-    impressionCountsRefreshRate: number,
-    impressionCountsQueueSize: number,
     uniqueKeysRefreshRate: number,
     uniqueKeysCacheSize: number,
     /**

package/src/utils/settingsValidation/index.ts

@@ -133,7 +133,6 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
   scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
   scheduler.uniqueKeysRefreshRate = fromSecondsToMillis(scheduler.uniqueKeysRefreshRate);
-  scheduler.impressionCountsRefreshRate = fromSecondsToMillis(scheduler.impressionCountsRefreshRate);
   scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
 
   // Default impressionsRefreshRate for DEBUG mode is 60 secs

package/types/storages/inRedis/ImpressionCountsCacheInRedis.d.ts

@@ -8,7 +8,7 @@ export declare class ImpressionCountsCacheInRedis extends ImpressionCountsCacheI
     private readonly refreshRate;
     private intervalId;
     constructor(log: ILogger, key: string, redis: Redis, impressionCountsCacheSize?: number, refreshRate?: number);
-    postImpressionCountsInRedis(): false | Promise<boolean | import("ioredis").BooleanResponse | undefined>;
+    postImpressionCountsInRedis(): Promise<boolean | import("ioredis").BooleanResponse | undefined>;
     start(): void;
-    stop(): void;
+    stop(): Promise<boolean | import("ioredis").BooleanResponse | undefined>;
 }

package/types/storages/inRedis/uniqueKeysCacheInRedis.d.ts

@@ -11,5 +11,5 @@ export declare class UniqueKeysCacheInRedis extends UniqueKeysCacheInMemory impl
     constructor(log: ILogger, key: string, redis: Redis, uniqueKeysQueueSize?: number, refreshRate?: number);
     postUniqueKeysInRedis(): Promise<boolean | import("ioredis").BooleanResponse | undefined>;
     start(): void;
-    stop(): void;
+    stop(): Promise<boolean | import("ioredis").BooleanResponse | undefined>;
 }

package/types/storages/types.d.ts

@@ -393,9 +393,6 @@ export declare type DataLoader = (storage: IStorageSync, matchingKey: string) =>
 export interface IStorageFactoryParams {
     log: ILogger;
     impressionsQueueSize?: number;
-    impressionCountsQueueSize?: number;
-    impressionCountsRefreshRate?: number;
-    uniqueKeysRefreshRate?: number;
     uniqueKeysCacheSize?: number;
     eventsQueueSize?: number;
     optimize?: boolean;

package/types/types.d.ts

@@ -74,8 +74,6 @@ export interface ISettings {
         featuresRefreshRate: number;
         impressionsRefreshRate: number;
         impressionsQueueSize: number;
-        impressionCountsRefreshRate: number;
-        impressionCountsQueueSize: number;
         uniqueKeysRefreshRate: number;
         uniqueKeysCacheSize: number;
         /**