@splitsoftware/splitio-commons 2.1.0-rc.1 → 2.1.0

package/CHANGES.txt

@@ -1,8 +1,7 @@
-2.1.0 (January XX, 2025)
- - Added two new configuration options for the SDK storage in browsers when using storage type `LOCALSTORAGE`:
-    - `storage.expirationDays` to specify the validity period of the rollout cache.
-    - `storage.clearOnInit` to clear the rollout cache on SDK initialization.
- - Updated SDK_READY_FROM_CACHE event when using `LOCALSTORAGE` storage type to be emitted alongside SDK_READY event in case it has not been emitted.
+2.1.0 (January 17, 2025)
+ - Added support for the new impressions tracking toggle available on feature flags, both respecting the setting and including the new field being returned on `SplitView` type objects. Read more in our docs.
+
+2.0.3 (January 9, 2025)
  - Bugfixing - Properly handle rejected promises when using targeting rules with segment matchers in consumer modes (e.g., Redis and Pluggable storages).
 
 2.0.2 (December 3, 2024)

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2024 Split Software, Inc.
+Copyright © 2025 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/cjs/evaluator/index.js

@@ -104,12 +104,14 @@ function getEvaluation(log, splitJSON, key, attributes, storage) {
             return evaluation.then(function (result) {
                 result.changeNumber = split_1.getChangeNumber();
                 result.config = splitJSON.configurations && splitJSON.configurations[result.treatment] || null;
+                result.impressionsDisabled = splitJSON.impressionsDisabled;
                 return result;
             });
         }
         else {
             evaluation.changeNumber = split_1.getChangeNumber(); // Always sync and optional
             evaluation.config = splitJSON.configurations && splitJSON.configurations[evaluation.treatment] || null;
+            evaluation.impressionsDisabled = splitJSON.impressionsDisabled;
         }
     }
     return evaluation;

package/cjs/listeners/browser.js

@@ -3,9 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BrowserSignalListener = void 0;
 var impressionsSubmitter_1 = require("../sync/submitters/impressionsSubmitter");
 var impressionCountsSubmitter_1 = require("../sync/submitters/impressionCountsSubmitter");
-var constants_1 = require("../utils/constants");
 var objectAssign_1 = require("../utils/lang/objectAssign");
-var constants_2 = require("../logger/constants");
+var constants_1 = require("../logger/constants");
 var consent_1 = require("../consent");
 var VISIBILITYCHANGE_EVENT = 'visibilitychange';
 var PAGEHIDE_EVENT = 'pagehide';
@@ -28,7 +27,7 @@ var BrowserSignalListener = /** @class */ (function () {
      * Called when SplitFactory is initialized, it adds event listeners to close streaming and flush impressions and events.
      */
     BrowserSignalListener.prototype.start = function () {
-        this.settings.log.debug(constants_2.CLEANUP_REGISTERING, [EVENT_NAME]);
+        this.settings.log.debug(constants_1.CLEANUP_REGISTERING, [EVENT_NAME]);
         if (typeof document !== 'undefined' && document.addEventListener) {
             // Flush data whenever the page is hidden or unloaded.
             document.addEventListener(VISIBILITYCHANGE_EVENT, this.flushDataIfHidden);
@@ -44,7 +43,7 @@ var BrowserSignalListener = /** @class */ (function () {
      * Called when client is destroyed, it removes event listeners.
      */
     BrowserSignalListener.prototype.stop = function () {
-        this.settings.log.debug(constants_2.CLEANUP_DEREGISTERING, [EVENT_NAME]);
+        this.settings.log.debug(constants_1.CLEANUP_DEREGISTERING, [EVENT_NAME]);
         if (typeof document !== 'undefined' && document.removeEventListener) {
             document.removeEventListener(VISIBILITYCHANGE_EVENT, this.flushDataIfHidden);
         }
@@ -63,10 +62,9 @@ var BrowserSignalListener = /** @class */ (function () {
         var _a = this.settings.urls, events = _a.events, telemetry = _a.telemetry;
         // Flush impressions & events data if there is user consent
         if ((0, consent_1.isConsentGranted)(this.settings)) {
-            var sim = this.settings.sync.impressionsMode;
             var extraMetadata = {
                 // sim stands for Sync/Split Impressions Mode
-                sim: sim === constants_1.OPTIMIZED ? constants_1.OPTIMIZED : sim === constants_1.DEBUG ? constants_1.DEBUG : constants_1.NONE
+                sim: this.settings.sync.impressionsMode
             };
             this._flushData(events + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
             this._flushData(events + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);

package/cjs/readiness/readinessManager.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.readinessManagerFactory = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_1 = require("./constants");
-var constants_2 = require("../utils/constants");
 function splitsEventEmitterFactory(EventEmitter) {
     var splitsEventEmitter = (0, objectAssign_1.objectAssign)(new EventEmitter(), {
         splitsArrived: false,
@@ -84,7 +83,6 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
         }
     }
     function checkIsReadyOrUpdate(diff) {
-        var _a;
         if (isDestroyed)
             return;
         if (isReady) {
@@ -103,10 +101,6 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
                 isReady = true;
                 try {
                     syncLastUpdate();
-                    if (!isReadyFromCache && ((_a = settings.storage) === null || _a === void 0 ? void 0 : _a.type) === constants_2.STORAGE_LOCALSTORAGE) {
-                        isReadyFromCache = true;
-                        gate.emit(constants_1.SDK_READY_FROM_CACHE);
-                    }
                     gate.emit(constants_1.SDK_READY);
                 }
                 catch (e) {

package/cjs/sdkClient/client.js

@@ -33,7 +33,7 @@ function clientFactory(params) {
             var queue = [];
             var treatment = processEvaluation(evaluationResult, featureFlagName, key, attributes, withConfig, methodName, queue);
             impressionsTracker.track(queue, attributes);
-            stopTelemetryTracker(queue[0] && queue[0].label);
+            stopTelemetryTracker(queue[0] && queue[0].imp.label);
             return treatment;
         };
         var evaluation = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
@@ -57,7 +57,7 @@ function clientFactory(params) {
                 treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key, attributes, withConfig, methodName, queue);
             });
             impressionsTracker.track(queue, attributes);
-            stopTelemetryTracker(queue[0] && queue[0].label);
+            stopTelemetryTracker(queue[0] && queue[0].imp.label);
             return treatments;
         };
         var evaluations = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
@@ -83,7 +83,7 @@ function clientFactory(params) {
                 treatments[featureFlagName] = processEvaluation(evaluations[featureFlagName], featureFlagName, key, attributes, withConfig, methodName, queue);
             });
             impressionsTracker.track(queue, attributes);
-            stopTelemetryTracker(queue[0] && queue[0].label);
+            stopTelemetryTracker(queue[0] && queue[0].imp.label);
             return treatments;
         };
         var evaluations = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
@@ -106,18 +106,21 @@ function clientFactory(params) {
     function processEvaluation(evaluation, featureFlagName, key, attributes, withConfig, invokingMethodName, queue) {
         var matchingKey = (0, key_1.getMatching)(key);
         var bucketingKey = (0, key_1.getBucketing)(key);
-        var treatment = evaluation.treatment, label = evaluation.label, changeNumber = evaluation.changeNumber, _a = evaluation.config, config = _a === void 0 ? null : _a;
+        var treatment = evaluation.treatment, label = evaluation.label, changeNumber = evaluation.changeNumber, _a = evaluation.config, config = _a === void 0 ? null : _a, impressionsDisabled = evaluation.impressionsDisabled;
         log.info(constants_2.IMPRESSION, [featureFlagName, matchingKey, treatment, label]);
         if ((0, splitExistence_1.validateSplitExistence)(log, readinessManager, featureFlagName, label, invokingMethodName)) {
             log.info(constants_2.IMPRESSION_QUEUEING);
             queue.push({
-                feature: featureFlagName,
-                keyName: matchingKey,
-                treatment: treatment,
-                time: Date.now(),
-                bucketingKey: bucketingKey,
-                label: label,
-                changeNumber: changeNumber
+                imp: {
+                    feature: featureFlagName,
+                    keyName: matchingKey,
+                    treatment: treatment,
+                    time: Date.now(),
+                    bucketingKey: bucketingKey,
+                    label: label,
+                    changeNumber: changeNumber,
+                },
+                disabled: impressionsDisabled
             });
         }
         if (withConfig) {

package/cjs/sdkClient/sdkClient.js

@@ -50,7 +50,7 @@ function sdkClientFactory(params, isSharedClient) {
                 (0, apiKey_1.releaseApiKey)(settings.core.authorizationKey);
                 telemetryTracker.sessionLength();
                 signalListener && signalListener.stop();
-                uniqueKeysTracker && uniqueKeysTracker.stop();
+                uniqueKeysTracker.stop();
             }
             // Stop background jobs
             syncManager && syncManager.stop();

package/cjs/sdkFactory/index.js

@@ -51,19 +51,14 @@ function sdkFactory(params) {
     var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);
     var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
     var observer = impressionsObserverFactory();
-    var uniqueKeysTracker = impressionsMode === constants_3.NONE ? (0, uniqueKeysTracker_1.uniqueKeysTrackerFactory)(log, storage.uniqueKeys, filterAdapterFactory && filterAdapterFactory()) : undefined;
-    var strategy;
-    switch (impressionsMode) {
-        case constants_3.OPTIMIZED:
-            strategy = (0, strategyOptimized_1.strategyOptimizedFactory)(observer, storage.impressionCounts);
-            break;
-        case constants_3.NONE:
-            strategy = (0, strategyNone_1.strategyNoneFactory)(storage.impressionCounts, uniqueKeysTracker);
-            break;
-        default:
-            strategy = (0, strategyDebug_1.strategyDebugFactory)(observer);
-    }
-    var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, strategy, whenInit, integrationsManager, storage.telemetry);
+    var uniqueKeysTracker = (0, uniqueKeysTracker_1.uniqueKeysTrackerFactory)(log, storage.uniqueKeys, filterAdapterFactory && filterAdapterFactory());
+    var noneStrategy = (0, strategyNone_1.strategyNoneFactory)(storage.impressionCounts, uniqueKeysTracker);
+    var strategy = impressionsMode === constants_3.OPTIMIZED ?
+        (0, strategyOptimized_1.strategyOptimizedFactory)(observer, storage.impressionCounts) :
+        impressionsMode === constants_3.DEBUG ?
+            (0, strategyDebug_1.strategyDebugFactory)(observer) :
+            noneStrategy;
+    var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, noneStrategy, strategy, whenInit, integrationsManager, storage.telemetry);
     var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, whenInit, integrationsManager, storage.telemetry);
     // splitApi is used by SyncManager and Browser signal listener
     var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
@@ -82,7 +77,7 @@ function sdkFactory(params) {
         // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
         (0, apiKey_1.validateAndTrackApiKey)(log, settings.core.authorizationKey);
         readiness.init();
-        uniqueKeysTracker && uniqueKeysTracker.start();
+        uniqueKeysTracker.start();
         syncManager && syncManager.start();
         signalListener && signalListener.start();
         initCallbacks.forEach(function (cb) { return cb(); });

package/cjs/sdkManager/index.js

@@ -28,7 +28,8 @@ function objectToView(splitObject) {
         treatments: collectTreatments(splitObject),
         configs: splitObject.configurations || {},
         sets: splitObject.sets || [],
-        defaultTreatment: splitObject.defaultTreatment
+        defaultTreatment: splitObject.defaultTreatment,
+        impressionsDisabled: splitObject.impressionsDisabled === true
     };
 }
 function objectsToViews(splitObjects) {

package/cjs/storages/AbstractSplitsCacheAsync.js

@@ -14,6 +14,13 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
     AbstractSplitsCacheAsync.prototype.usesSegments = function () {
         return Promise.resolve(true);
     };
+    /**
+     * Check if the splits information is already stored in cache.
+     * Noop, just keeping the interface. This is used by client-side implementations only.
+     */
+    AbstractSplitsCacheAsync.prototype.checkCache = function () {
+        return Promise.resolve(false);
+    };
     /**
      * Kill `name` split and set `defaultTreatment` and `changeNumber`.
      * Used for SPLIT_KILL push notifications.

package/cjs/storages/AbstractSplitsCacheSync.js

@@ -30,6 +30,13 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
         var _this = this;
         return this.getSplitNames().map(function (key) { return _this.getSplit(key); });
     };
+    /**
+     * Check if the splits information is already stored in cache. This data can be preloaded.
+     * It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
+     */
+    AbstractSplitsCacheSync.prototype.checkCache = function () {
+        return false;
+    };
     /**
      * Kill `name` split and set `defaultTreatment` and `changeNumber`.
      * Used for SPLIT_KILL push notifications.

package/cjs/storages/KeyBuilderCS.js

@@ -32,9 +32,6 @@ var KeyBuilderCS = /** @class */ (function (_super) {
     KeyBuilderCS.prototype.buildTillKey = function () {
         return this.prefix + "." + this.matchingKey + ".segments.till";
     };
-    KeyBuilderCS.prototype.buildLastClear = function () {
-        return this.prefix + ".lastClear";
-    };
     return KeyBuilderCS;
 }(KeyBuilder_1.KeyBuilder));
 exports.KeyBuilderCS = KeyBuilderCS;

package/cjs/storages/dataLoader.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dataLoaderFactory = void 0;
-// This value might be eventually set via a config parameter
-var DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days
+var browser_1 = require("../utils/constants/browser");
 /**
  * Factory of client-side storage loader
  *
@@ -26,7 +25,7 @@ function dataLoaderFactory(preloadedData) {
             return;
         var _a = preloadedData.lastUpdated, lastUpdated = _a === void 0 ? -1 : _a, _b = preloadedData.segmentsData, segmentsData = _b === void 0 ? {} : _b, _c = preloadedData.since, since = _c === void 0 ? -1 : _c, _d = preloadedData.splitsData, splitsData = _d === void 0 ? {} : _d;
         var storedSince = storage.splits.getChangeNumber();
-        var expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
+        var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
         // Do not load data if current localStorage data is more recent,
         // or if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
         if (storedSince > since || lastUpdated < expirationTimestamp)

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -5,17 +5,21 @@ var tslib_1 = require("tslib");
 var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
 var lang_1 = require("../../utils/lang");
 var constants_1 = require("./constants");
+var KeyBuilder_1 = require("../KeyBuilder");
 var sets_1 = require("../../utils/lang/sets");
 /**
  * ISplitsCacheSync implementation that stores split definitions in browser LocalStorage.
  */
 var SplitsCacheInLocal = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(SplitsCacheInLocal, _super);
-    function SplitsCacheInLocal(settings, keys) {
+    function SplitsCacheInLocal(settings, keys, expirationTimestamp) {
         var _this = _super.call(this) || this;
         _this.keys = keys;
         _this.log = settings.log;
+        _this.storageHash = (0, KeyBuilder_1.getStorageHash)(settings);
         _this.flagSetsFilter = settings.sync.__splitFiltersValidation.groupedFilters.bySet;
+        _this._checkExpiration(expirationTimestamp);
+        _this._checkFilterQuery();
         return _this;
     }
     SplitsCacheInLocal.prototype._decrementCount = function (key) {
@@ -63,6 +67,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
      * We cannot simply call `localStorage.clear()` since that implies removing user items from the storage.
      */
     SplitsCacheInLocal.prototype.clear = function () {
+        this.log.info(constants_1.LOG_PREFIX + 'Flushing Splits data from localStorage');
         // collect item keys
         var len = localStorage.length;
         var accum = [];
@@ -114,6 +119,18 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         return item && JSON.parse(item);
     };
     SplitsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
+        // when using a new split query, we must update it at the store
+        if (this.updateNewFilter) {
+            this.log.info(constants_1.LOG_PREFIX + 'SDK key, flags filter criteria or flags spec version was modified. Updating cache');
+            var storageHashKey = this.keys.buildHashKey();
+            try {
+                localStorage.setItem(storageHashKey, this.storageHash);
+            }
+            catch (e) {
+                this.log.error(constants_1.LOG_PREFIX + e);
+            }
+            this.updateNewFilter = false;
+        }
         try {
             localStorage.setItem(this.keys.buildSplitsTillKey(), changeNumber + '');
             // update "last updated" timestamp with current time
@@ -164,6 +181,45 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             return true;
         }
     };
+    /**
+     * Check if the splits information is already stored in browser LocalStorage.
+     * In this function we could add more code to check if the data is valid.
+     * @override
+     */
+    SplitsCacheInLocal.prototype.checkCache = function () {
+        return this.getChangeNumber() > -1;
+    };
+    /**
+     * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
+     *
+     * @param expirationTimestamp - if the value is not a number, data will not be cleaned
+     */
+    SplitsCacheInLocal.prototype._checkExpiration = function (expirationTimestamp) {
+        var value = localStorage.getItem(this.keys.buildLastUpdatedKey());
+        if (value !== null) {
+            value = parseInt(value, 10);
+            if (!(0, lang_1.isNaNNumber)(value) && expirationTimestamp && value < expirationTimestamp)
+                this.clear();
+        }
+    };
+    // @TODO eventually remove `_checkFilterQuery`. Cache should be cleared at the storage level, reusing same logic than PluggableStorage
+    SplitsCacheInLocal.prototype._checkFilterQuery = function () {
+        var storageHashKey = this.keys.buildHashKey();
+        var storageHash = localStorage.getItem(storageHashKey);
+        if (storageHash !== this.storageHash) {
+            try {
+                // mark cache to update the new query filter on first successful splits fetch
+                this.updateNewFilter = true;
+                // if there is cache, clear it
+                if (this.checkCache())
+                    this.clear();
+            }
+            catch (e) {
+                this.log.error(constants_1.LOG_PREFIX + e);
+            }
+        }
+        // if the filter didn't change, nothing is done
+    };
     SplitsCacheInLocal.prototype.getNamesByFlagSets = function (flagSets) {
         var _this = this;
         return flagSets.map(function (flagSet) {

package/cjs/storages/inLocalStorage/index.js

@@ -9,13 +9,13 @@ var KeyBuilderCS_1 = require("../KeyBuilderCS");
 var isLocalStorageAvailable_1 = require("../../utils/env/isLocalStorageAvailable");
 var SplitsCacheInLocal_1 = require("./SplitsCacheInLocal");
 var MySegmentsCacheInLocal_1 = require("./MySegmentsCacheInLocal");
+var browser_1 = require("../../utils/constants/browser");
 var InMemoryStorageCS_1 = require("../inMemory/InMemoryStorageCS");
 var constants_1 = require("./constants");
 var constants_2 = require("../../utils/constants");
 var TelemetryCacheInMemory_1 = require("../inMemory/TelemetryCacheInMemory");
 var UniqueKeysCacheInMemoryCS_1 = require("../inMemory/UniqueKeysCacheInMemoryCS");
 var key_1 = require("../../utils/key");
-var validateCache_1 = require("./validateCache");
 /**
  * InLocal storage factory for standalone client-side SplitFactory
  */
@@ -28,10 +28,11 @@ function InLocalStorage(options) {
             params.settings.log.warn(constants_1.LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
             return (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
         }
-        var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, impressionsMode = _a.sync.impressionsMode;
+        var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize;
         var matchingKey = (0, key_1.getMatching)(settings.core.key);
         var keys = new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey);
-        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys);
+        var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
+        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys, expirationTimestamp);
         var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys);
         var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey));
         return {
@@ -39,13 +40,10 @@ function InLocalStorage(options) {
             segments: segments,
             largeSegments: largeSegments,
             impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(impressionsQueueSize),
-            impressionCounts: impressionsMode !== constants_2.DEBUG ? new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() : undefined,
+            impressionCounts: new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory(),
             events: new EventsCacheInMemory_1.EventsCacheInMemory(eventsQueueSize),
             telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
-            uniqueKeys: impressionsMode === constants_2.NONE ? new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS() : undefined,
-            validateCache: function () {
-                return (0, validateCache_1.validateCache)(options, settings, keys, splits, segments, largeSegments);
-            },
+            uniqueKeys: new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS(),
             destroy: function () { },
             // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
             shared: function (matchingKey) {
@@ -57,6 +55,7 @@ function InLocalStorage(options) {
                     impressionCounts: this.impressionCounts,
                     events: this.events,
                     telemetry: this.telemetry,
+                    uniqueKeys: this.uniqueKeys,
                     destroy: function () { }
                 };
             },

package/cjs/storages/inMemory/InMemoryStorage.js

@@ -15,17 +15,17 @@ var UniqueKeysCacheInMemory_1 = require("./UniqueKeysCacheInMemory");
  * @param params - parameters required by EventsCacheSync
  */
 function InMemoryStorageFactory(params) {
-    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
+    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, __splitFiltersValidation = _a.sync.__splitFiltersValidation;
     var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
     var segments = new SegmentsCacheInMemory_1.SegmentsCacheInMemory();
     var storage = {
         splits: splits,
         segments: segments,
         impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(impressionsQueueSize),
-        impressionCounts: impressionsMode !== constants_1.DEBUG ? new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() : undefined,
+        impressionCounts: new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory(),
         events: new EventsCacheInMemory_1.EventsCacheInMemory(eventsQueueSize),
         telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
-        uniqueKeys: impressionsMode === constants_1.NONE ? new UniqueKeysCacheInMemory_1.UniqueKeysCacheInMemory() : undefined,
+        uniqueKeys: new UniqueKeysCacheInMemory_1.UniqueKeysCacheInMemory(),
         destroy: function () { }
     };
     // @TODO revisit storage logic in localhost mode
@@ -34,10 +34,8 @@ function InMemoryStorageFactory(params) {
         var noopTrack = function () { return true; };
         storage.impressions.track = noopTrack;
         storage.events.track = noopTrack;
-        if (storage.impressionCounts)
-            storage.impressionCounts.track = noopTrack;
-        if (storage.uniqueKeys)
-            storage.uniqueKeys.track = noopTrack;
+        storage.impressionCounts.track = noopTrack;
+        storage.uniqueKeys.track = noopTrack;
     }
     return storage;
 }

package/cjs/storages/inMemory/InMemoryStorageCS.js

@@ -15,7 +15,7 @@ var UniqueKeysCacheInMemoryCS_1 = require("./UniqueKeysCacheInMemoryCS");
  * @param params - parameters required by EventsCacheSync
  */
 function InMemoryStorageCSFactory(params) {
-    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
+    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, __splitFiltersValidation = _a.sync.__splitFiltersValidation;
     var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
     var segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
     var largeSegments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
@@ -24,10 +24,10 @@ function InMemoryStorageCSFactory(params) {
         segments: segments,
         largeSegments: largeSegments,
         impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(impressionsQueueSize),
-        impressionCounts: impressionsMode !== constants_1.DEBUG ? new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() : undefined,
+        impressionCounts: new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory(),
         events: new EventsCacheInMemory_1.EventsCacheInMemory(eventsQueueSize),
         telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
-        uniqueKeys: impressionsMode === constants_1.NONE ? new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS() : undefined,
+        uniqueKeys: new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS(),
         destroy: function () { },
         // When using shared instantiation with MEMORY we reuse everything but segments (they are unique per key)
         shared: function () {
@@ -39,6 +39,7 @@ function InMemoryStorageCSFactory(params) {
                 impressionCounts: this.impressionCounts,
                 events: this.events,
                 telemetry: this.telemetry,
+                uniqueKeys: this.uniqueKeys,
                 destroy: function () { }
             };
         },
@@ -49,10 +50,8 @@ function InMemoryStorageCSFactory(params) {
         var noopTrack = function () { return true; };
         storage.impressions.track = noopTrack;
         storage.events.track = noopTrack;
-        if (storage.impressionCounts)
-            storage.impressionCounts.track = noopTrack;
-        if (storage.uniqueKeys)
-            storage.uniqueKeys.track = noopTrack;
+        storage.impressionCounts.track = noopTrack;
+        storage.uniqueKeys.track = noopTrack;
     }
     return storage;
 }

package/cjs/storages/inRedis/constants.js

@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TTL_REFRESH = exports.REFRESH_RATE = exports.DEFAULT_CACHE_SIZE = exports.LOG_PREFIX = void 0;
 exports.LOG_PREFIX = 'storage:redis: ';
 exports.DEFAULT_CACHE_SIZE = 30000;
-exports.REFRESH_RATE = 300000; // 300.000 ms = start after 5 mins
+exports.REFRESH_RATE = 300000; // 300000 ms = start after 5 mins
 exports.TTL_REFRESH = 3600; // 1hr

package/cjs/storages/inRedis/index.js

@@ -23,20 +23,18 @@ function InRedisStorage(options) {
     var RD = require('./RedisAdapter').RedisAdapter;
     var prefix = (0, KeyBuilder_1.validatePrefix)(options.prefix);
     function InRedisStorageFactory(params) {
-        var onReadyCb = params.onReadyCb, settings = params.settings, _a = params.settings, log = _a.log, impressionsMode = _a.sync.impressionsMode;
+        var onReadyCb = params.onReadyCb, settings = params.settings, log = params.settings.log;
         var metadata = (0, utils_1.metadataBuilder)(settings);
         var keys = new KeyBuilderSS_1.KeyBuilderSS(prefix, metadata);
         var redisClient = new RD(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) : undefined;
-        var uniqueKeysCache = impressionsMode === constants_1.NONE ? new UniqueKeysCacheInRedis_1.UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient) : undefined;
+        var impressionCountsCache = new ImpressionCountsCacheInRedis_1.ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient);
+        var uniqueKeysCache = new UniqueKeysCacheInRedis_1.UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient);
         // subscription to Redis connect event in order to emit SDK_READY event on consumer mode
         redisClient.on('connect', function () {
             onReadyCb();
-            if (impressionCountsCache)
-                impressionCountsCache.start();
-            if (uniqueKeysCache)
-                uniqueKeysCache.start();
+            impressionCountsCache.start();
+            uniqueKeysCache.start();
             // Synchronize config
             telemetry.recordConfig();
         });
@@ -51,12 +49,10 @@ function InRedisStorage(options) {
             // When using REDIS we should:
             // 1- Disconnect from the storage
             destroy: function () {
-                var promises = [];
-                if (impressionCountsCache)
-                    promises.push(impressionCountsCache.stop());
-                if (uniqueKeysCache)
-                    promises.push(uniqueKeysCache.stop());
-                return Promise.all(promises).then(function () { redisClient.disconnect(); });
+                return Promise.all([
+                    impressionCountsCache.stop(),
+                    uniqueKeysCache.stop()
+                ]).then(function () { redisClient.disconnect(); });
                 // @TODO check that caches works as expected when redisClient is disconnected
             }
         };

package/cjs/storages/pluggable/index.js

@@ -54,32 +54,27 @@ function PluggableStorage(options) {
     validatePluggableStorageOptions(options);
     var prefix = (0, KeyBuilder_1.validatePrefix)(options.prefix);
     function PluggableStorageFactory(params) {
-        var onReadyCb = params.onReadyCb, settings = params.settings, _a = params.settings, log = _a.log, mode = _a.mode, impressionsMode = _a.sync.impressionsMode, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize;
+        var onReadyCb = params.onReadyCb, settings = params.settings, _a = params.settings, log = _a.log, mode = _a.mode, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize;
         var metadata = (0, utils_1.metadataBuilder)(settings);
         var keys = new KeyBuilderSS_1.KeyBuilderSS(prefix, metadata);
         var wrapper = (0, wrapperAdapter_1.wrapperAdapter)(log, options.wrapper);
-        var isSyncronizer = mode === undefined; // If mode is not defined, the synchronizer is running
+        var isSynchronizer = mode === undefined; // If mode is not defined, the synchronizer is running
         var isPartialConsumer = mode === constants_1.CONSUMER_PARTIAL_MODE;
-        var telemetry = (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) || isSyncronizer ?
+        var telemetry = (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) || isSynchronizer ?
             isPartialConsumer ?
                 new TelemetryCacheInMemory_1.TelemetryCacheInMemory() :
                 new TelemetryCachePluggable_1.TelemetryCachePluggable(log, keys, wrapper) :
             undefined;
-        var impressionCountsCache = impressionsMode !== constants_1.DEBUG || isSyncronizer ?
-            isPartialConsumer ?
-                new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() :
-                new ImpressionCountsCachePluggable_1.ImpressionCountsCachePluggable(log, keys.buildImpressionsCountKey(), wrapper) :
-            undefined;
-        var uniqueKeysCache = impressionsMode === constants_1.NONE || isSyncronizer ?
-            isPartialConsumer ?
-                settings.core.key === undefined ? new UniqueKeysCacheInMemory_1.UniqueKeysCacheInMemory() : new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS() :
-                new UniqueKeysCachePluggable_1.UniqueKeysCachePluggable(log, keys.buildUniqueKeysKey(), wrapper) :
-            undefined;
+        var impressionCountsCache = isPartialConsumer ?
+            new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() :
+            new ImpressionCountsCachePluggable_1.ImpressionCountsCachePluggable(log, keys.buildImpressionsCountKey(), wrapper);
+        var uniqueKeysCache = isPartialConsumer ?
+            settings.core.key === undefined ? new UniqueKeysCacheInMemory_1.UniqueKeysCacheInMemory() : new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS() :
+            new UniqueKeysCachePluggable_1.UniqueKeysCachePluggable(log, keys.buildUniqueKeysKey(), wrapper);
         // Connects to wrapper and emits SDK_READY event on main client
         var connectPromise = wrapper.connect().then(function () {
-            if (isSyncronizer) {
-                // @TODO reuse InLocalStorage::validateCache logic
-                // In standalone or producer mode, clear storage if SDK key, flags filter criteria or flags spec version was modified
+            if (isSynchronizer) {
+                // In standalone or producer mode, clear storage if SDK key or feature flag filter has changed
                 return wrapper.get(keys.buildHashKey()).then(function (hash) {
                     var currentHash = (0, KeyBuilder_1.getStorageHash)(settings);
                     if (hash !== currentHash) {
@@ -94,9 +89,9 @@ function PluggableStorage(options) {
             }
             else {
                 // Start periodic flush of async storages if not running synchronizer (producer mode)
-                if (impressionCountsCache && impressionCountsCache.start)
+                if (impressionCountsCache.start)
                     impressionCountsCache.start();
-                if (uniqueKeysCache && uniqueKeysCache.start)
+                if (uniqueKeysCache.start)
                     uniqueKeysCache.start();
                 if (telemetry && telemetry.recordConfig)
                     telemetry.recordConfig();
@@ -117,9 +112,9 @@ function PluggableStorage(options) {
             uniqueKeys: uniqueKeysCache,
             // Stop periodic flush and disconnect the underlying storage
             destroy: function () {
-                return Promise.all(isSyncronizer ? [] : [
-                    impressionCountsCache && impressionCountsCache.stop && impressionCountsCache.stop(),
-                    uniqueKeysCache && uniqueKeysCache.stop && uniqueKeysCache.stop(),
+                return Promise.all(isSynchronizer ? [] : [
+                    impressionCountsCache.stop && impressionCountsCache.stop(),
+                    uniqueKeysCache.stop && uniqueKeysCache.stop(),
                 ]).then(function () { return wrapper.disconnect(); });
             },
             // emits SDK_READY event on shared clients and returns a reference to the storage