@splitsoftware/splitio-commons 2.0.3-rc.0 → 2.1.0-rc.0

package/CHANGES.txt

@@ -1,7 +1,3 @@
-2.1.0 (January XX, 2025)
- - Added `trackImpressions` property to SDK Manager's `SplitView` type.
- - Updated implementation of the impressions tracker and strategies to support feature flags with impressions tracking disabled.
-
 2.0.2 (December 3, 2024)
  - Updated the factory `init` and `destroy` methods to support re-initialization after destruction. This update ensures compatibility of the React SDK with React Strict Mode, where the factory's `init` and `destroy` effects are executed an extra time to validate proper resource cleanup.
  - Bugfixing - Sanitize the `SplitSDKMachineName` header value to avoid exceptions on HTTP/S requests when it contains non ISO-8859-1 characters (Related to issue https://github.com/splitio/javascript-client/issues/847).

package/README.md

@@ -14,7 +14,7 @@ This library is compatible with JavaScript ES5 and above.
 Please see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to submit a Pull Request (PR).
 
 ## License
-Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).
+Licensed under the Apache License, Version 2.0. See: [Apache License](https://www.apache.org/licenses/).
 
 ## About Split
 
@@ -46,4 +46,4 @@ For a comprehensive list of open source projects visit our [Github page](https:/
 
 **Learn more about Split:**
 
-Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.
+Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](https://help.split.io) for more detailed information.

package/cjs/evaluator/index.js

@@ -104,14 +104,12 @@ 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.track = splitJSON.trackImpressions;
                 return result;
             });
         }
         else {
             evaluation.changeNumber = split_1.getChangeNumber(); // Always sync and optional
             evaluation.config = splitJSON.configurations && splitJSON.configurations[evaluation.treatment] || null;
-            evaluation.track = splitJSON.trackImpressions;
         }
     }
     return evaluation;

package/cjs/listeners/browser.js

@@ -3,8 +3,9 @@ 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_1 = require("../logger/constants");
+var constants_2 = require("../logger/constants");
 var consent_1 = require("../consent");
 var VISIBILITYCHANGE_EVENT = 'visibilitychange';
 var PAGEHIDE_EVENT = 'pagehide';
@@ -27,7 +28,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_1.CLEANUP_REGISTERING, [EVENT_NAME]);
+        this.settings.log.debug(constants_2.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);
@@ -43,7 +44,7 @@ var BrowserSignalListener = /** @class */ (function () {
      * Called when client is destroyed, it removes event listeners.
      */
     BrowserSignalListener.prototype.stop = function () {
-        this.settings.log.debug(constants_1.CLEANUP_DEREGISTERING, [EVENT_NAME]);
+        this.settings.log.debug(constants_2.CLEANUP_DEREGISTERING, [EVENT_NAME]);
         if (typeof document !== 'undefined' && document.removeEventListener) {
             document.removeEventListener(VISIBILITYCHANGE_EVENT, this.flushDataIfHidden);
         }
@@ -62,9 +63,10 @@ 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: this.settings.sync.impressionsMode
+                sim: sim === constants_1.OPTIMIZED ? constants_1.OPTIMIZED : sim === constants_1.DEBUG ? constants_1.DEBUG : constants_1.NONE
             };
             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/listeners/node.js

@@ -43,7 +43,7 @@ var NodeSignalListener = /** @class */ (function () {
         var wrapUp = function () {
             // Cleaned up, remove handlers.
             _this.stop();
-            // This handler prevented the default behaviour, start again.
+            // This handler prevented the default behavior, start again.
             // eslint-disable-next-line no-undef
             process.kill(process.pid, SIGTERM);
         };
@@ -56,7 +56,7 @@ var NodeSignalListener = /** @class */ (function () {
             this.settings.log.error(constants_1.LOG_PREFIX_CLEANUP + "Error with Split SDK graceful shutdown: " + err);
         }
         if ((0, thenable_1.thenable)(handlerResult)) {
-            // Always exit, even with errors. The promise is returned for UT purposses.
+            // Always exit, even with errors. The promise is returned for UT purposes.
             return handlerResult.then(wrapUp).catch(wrapUp);
         }
         else {

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][0].label);
+            stopTelemetryTracker(queue[0] && queue[0].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][0].label);
+            stopTelemetryTracker(queue[0] && queue[0].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][0].label);
+            stopTelemetryTracker(queue[0] && queue[0].label);
             return treatments;
         };
         var evaluations = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
@@ -106,19 +106,19 @@ 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, track = evaluation.track;
+        var treatment = evaluation.treatment, label = evaluation.label, changeNumber = evaluation.changeNumber, _a = evaluation.config, config = _a === void 0 ? null : _a;
         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,
-                }, track]);
+            queue.push({
+                feature: featureFlagName,
+                keyName: matchingKey,
+                treatment: treatment,
+                time: Date.now(),
+                bucketingKey: bucketingKey,
+                label: label,
+                changeNumber: changeNumber
+            });
         }
         if (withConfig) {
             return {

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.stop();
+                uniqueKeysTracker && uniqueKeysTracker.stop();
             }
             // Stop background jobs
             syncManager && syncManager.stop();

package/cjs/sdkFactory/index.js

@@ -51,14 +51,19 @@ 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 = (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 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 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);
@@ -77,7 +82,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.start();
+        uniqueKeysTracker && uniqueKeysTracker.start();
         syncManager && syncManager.start();
         signalListener && signalListener.start();
         initCallbacks.forEach(function (cb) { return cb(); });

package/cjs/sdkManager/index.js

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

package/cjs/storages/AbstractSplitsCacheAsync.js

@@ -14,13 +14,6 @@ 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,13 +30,6 @@ 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,6 +32,9 @@ 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,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dataLoaderFactory = void 0;
-var browser_1 = require("../utils/constants/browser");
+// This value might be eventually set via a config parameter
+var DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days
 /**
  * Factory of client-side storage loader
  *
@@ -25,7 +26,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() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
+        var expirationTimestamp = Date.now() - 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,21 +5,17 @@ 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, expirationTimestamp) {
+    function SplitsCacheInLocal(settings, keys) {
         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) {
@@ -67,7 +63,6 @@ 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 = [];
@@ -119,18 +114,6 @@ 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
@@ -181,45 +164,6 @@ 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,11 +28,10 @@ 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;
+        var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, impressionsMode = _a.sync.impressionsMode;
         var matchingKey = (0, key_1.getMatching)(settings.core.key);
         var keys = new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey);
-        var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
-        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys, expirationTimestamp);
+        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys);
         var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys);
         var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey));
         return {
@@ -40,10 +39,13 @@ function InLocalStorage(options) {
             segments: segments,
             largeSegments: largeSegments,
             impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(impressionsQueueSize),
-            impressionCounts: new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory(),
+            impressionCounts: impressionsMode !== constants_2.DEBUG ? new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() : undefined,
             events: new EventsCacheInMemory_1.EventsCacheInMemory(eventsQueueSize),
             telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
-            uniqueKeys: new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS(),
+            uniqueKeys: impressionsMode === constants_2.NONE ? new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS() : undefined,
+            validateCache: function () {
+                return (0, validateCache_1.validateCache)(options, settings, keys, splits, segments, largeSegments);
+            },
             destroy: function () { },
             // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
             shared: function (matchingKey) {
@@ -55,7 +57,6 @@ function InLocalStorage(options) {
                     impressionCounts: this.impressionCounts,
                     events: this.events,
                     telemetry: this.telemetry,
-                    uniqueKeys: this.uniqueKeys,
                     destroy: function () { }
                 };
             },

package/cjs/storages/inLocalStorage/validateCache.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCache = void 0;
+var lang_1 = require("../../utils/lang");
+var KeyBuilder_1 = require("../KeyBuilder");
+var constants_1 = require("./constants");
+// milliseconds in a day
+var DEFAULT_CACHE_EXPIRATION_IN_DAYS = 10;
+var MILLIS_IN_A_DAY = 86400000;
+/**
+ * Validates if cache should be cleared and sets the cache `hash` if needed.
+ *
+ * @returns `true` if cache should be cleared, `false` otherwise
+ */
+function validateExpiration(options, settings, keys, currentTimestamp, isThereCache) {
+    var log = settings.log;
+    // Check expiration
+    var lastUpdatedTimestamp = parseInt(localStorage.getItem(keys.buildLastUpdatedKey()), 10);
+    if (!(0, lang_1.isNaNNumber)(lastUpdatedTimestamp)) {
+        var cacheExpirationInDays = (0, lang_1.isFiniteNumber)(options.expirationDays) && options.expirationDays >= 1 ? options.expirationDays : DEFAULT_CACHE_EXPIRATION_IN_DAYS;
+        var expirationTimestamp = currentTimestamp - MILLIS_IN_A_DAY * cacheExpirationInDays;
+        if (lastUpdatedTimestamp < expirationTimestamp) {
+            log.info(constants_1.LOG_PREFIX + 'Cache expired more than ' + cacheExpirationInDays + ' days ago. Cleaning up cache');
+            return true;
+        }
+    }
+    // Check hash
+    var storageHashKey = keys.buildHashKey();
+    var storageHash = localStorage.getItem(storageHashKey);
+    var currentStorageHash = (0, KeyBuilder_1.getStorageHash)(settings);
+    if (storageHash !== currentStorageHash) {
+        try {
+            localStorage.setItem(storageHashKey, currentStorageHash);
+        }
+        catch (e) {
+            log.error(constants_1.LOG_PREFIX + e);
+        }
+        if (isThereCache) {
+            log.info(constants_1.LOG_PREFIX + 'SDK key, flags filter criteria or flags spec version has changed. Cleaning up cache');
+            return true;
+        }
+        return false; // No cache to clear
+    }
+    // Clear on init
+    if (options.clearOnInit) {
+        var lastClearTimestamp = parseInt(localStorage.getItem(keys.buildLastClear()), 10);
+        if ((0, lang_1.isNaNNumber)(lastClearTimestamp) || lastClearTimestamp < currentTimestamp - MILLIS_IN_A_DAY) {
+            log.info(constants_1.LOG_PREFIX + 'clearOnInit was set and cache was not cleared in the last 24 hours. Cleaning up cache');
+            return true;
+        }
+    }
+}
+/**
+ * Clean cache if:
+ * - it has expired, i.e., its `lastUpdated` timestamp is older than the given `expirationTimestamp`
+ * - its hash has changed, i.e., the SDK key, flags filter criteria or flags spec version was modified
+ * - `clearOnInit` was set and cache was not cleared in the last 24 hours
+ *
+ * @returns `true` if cache is ready to be used, `false` otherwise (cache was cleared or there is no cache)
+ */
+function validateCache(options, settings, keys, splits, segments, largeSegments) {
+    var currentTimestamp = Date.now();
+    var isThereCache = splits.getChangeNumber() > -1;
+    if (validateExpiration(options, settings, keys, currentTimestamp, isThereCache)) {
+        splits.clear();
+        segments.clear();
+        largeSegments.clear();
+        // Update last clear timestamp
+        try {
+            localStorage.setItem(keys.buildLastClear(), currentTimestamp + '');
+        }
+        catch (e) {
+            settings.log.error(constants_1.LOG_PREFIX + e);
+        }
+        return false;
+    }
+    // Check if ready from cache
+    return isThereCache;
+}
+exports.validateCache = validateCache;

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, __splitFiltersValidation = _a.sync.__splitFiltersValidation;
+    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__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: new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory(),
+        impressionCounts: impressionsMode !== constants_1.DEBUG ? new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() : undefined,
         events: new EventsCacheInMemory_1.EventsCacheInMemory(eventsQueueSize),
         telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
-        uniqueKeys: new UniqueKeysCacheInMemory_1.UniqueKeysCacheInMemory(),
+        uniqueKeys: impressionsMode === constants_1.NONE ? new UniqueKeysCacheInMemory_1.UniqueKeysCacheInMemory() : undefined,
         destroy: function () { }
     };
     // @TODO revisit storage logic in localhost mode

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, __splitFiltersValidation = _a.sync.__splitFiltersValidation;
+    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__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: new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory(),
+        impressionCounts: impressionsMode !== constants_1.DEBUG ? new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() : undefined,
         events: new EventsCacheInMemory_1.EventsCacheInMemory(eventsQueueSize),
         telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
-        uniqueKeys: new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS(),
+        uniqueKeys: impressionsMode === constants_1.NONE ? new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS() : undefined,
         destroy: function () { },
         // When using shared instantiation with MEMORY we reuse everything but segments (they are unique per key)
         shared: function () {
@@ -39,7 +39,6 @@ function InMemoryStorageCSFactory(params) {
                 impressionCounts: this.impressionCounts,
                 events: this.events,
                 telemetry: this.telemetry,
-                uniqueKeys: this.uniqueKeys,
                 destroy: function () { }
             };
         },

package/cjs/storages/inRedis/index.js

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