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

package/CHANGES.txt

@@ -1,3 +1,11 @@
+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).
+
 2.0.1 (November 25, 2024)
  - Bugfixing - Fixed an issue with the SDK_UPDATE event on server-side, where it was not being emitted if there was an empty segment and the SDK received a feature flag update notification.
 

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.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,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

@@ -28,7 +28,7 @@ function segmentsEventEmitterFactory(EventEmitter) {
 /**
  * Factory of readiness manager, which handles the ready / update event propagation.
  */
-function readinessManagerFactory(EventEmitter, settings, splits) {
+function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
     if (splits === void 0) { splits = splitsEventEmitterFactory(EventEmitter); }
     var readyTimeout = settings.startup.readyTimeout;
     var segments = segmentsEventEmitterFactory(EventEmitter);
@@ -54,22 +54,24 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
         syncLastUpdate();
         gate.emit(constants_1.SDK_READY_TIMED_OUT, 'Split SDK emitted SDK_READY_TIMED_OUT event.');
     }
-    var readyTimeoutId;
-    if (readyTimeout > 0) {
-        if (splits.hasInit)
-            readyTimeoutId = setTimeout(timeout, readyTimeout);
-        else
-            splits.initCallbacks.push(function () { readyTimeoutId = setTimeout(timeout, readyTimeout); });
-    }
     // emit SDK_READY and SDK_UPDATE
     var isReady = false;
     splits.on(constants_1.SDK_SPLITS_ARRIVED, checkIsReadyOrUpdate);
     segments.on(constants_1.SDK_SEGMENTS_ARRIVED, checkIsReadyOrUpdate);
     var isDestroyed = false;
+    var readyTimeoutId;
+    function __init() {
+        isDestroyed = false;
+        if (readyTimeout > 0 && !isReady)
+            readyTimeoutId = setTimeout(timeout, readyTimeout);
+    }
+    splits.initCallbacks.push(__init);
+    if (splits.hasInit)
+        __init();
     function checkIsReadyFromCache() {
         isReadyFromCache = true;
         // Don't emit SDK_READY_FROM_CACHE if SDK_READY has been emitted
-        if (!isReady) {
+        if (!isReady && !isDestroyed) {
             try {
                 syncLastUpdate();
                 gate.emit(constants_1.SDK_READY_FROM_CACHE);
@@ -81,6 +83,8 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
         }
     }
     function checkIsReadyOrUpdate(diff) {
+        if (isDestroyed)
+            return;
         if (isReady) {
             try {
                 syncLastUpdate();
@@ -106,14 +110,12 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
             }
         }
     }
-    var refCount = 1;
     return {
         splits: splits,
         segments: segments,
         gate: gate,
         shared: function () {
-            refCount++;
-            return readinessManagerFactory(EventEmitter, settings, splits);
+            return readinessManagerFactory(EventEmitter, settings, splits, true);
         },
         // @TODO review/remove next methods when non-recoverable errors are reworked
         // Called on consumer mode, when storage fails to connect
@@ -130,13 +132,9 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
         destroy: function () {
             isDestroyed = true;
             syncLastUpdate();
-            segments.removeAllListeners();
-            gate.removeAllListeners();
             clearTimeout(readyTimeoutId);
-            if (refCount > 0)
-                refCount--;
-            if (refCount === 0)
-                splits.removeAllListeners();
+            if (!isShared)
+                splits.hasInit = false;
         },
         isReady: function () { return isReady; },
         isReadyFromCache: function () { return isReadyFromCache; },

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][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].label);
+            stopTelemetryTracker(queue[0] && queue[0][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].label);
+            stopTelemetryTracker(queue[0] && queue[0][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;
+        var treatment = evaluation.treatment, label = evaluation.label, changeNumber = evaluation.changeNumber, _a = evaluation.config, config = _a === void 0 ? null : _a, track = evaluation.track;
         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
-            });
+            queue.push([{
+                    feature: featureFlagName,
+                    keyName: matchingKey,
+                    treatment: treatment,
+                    time: Date.now(),
+                    bucketingKey: bucketingKey,
+                    label: label,
+                    changeNumber: changeNumber,
+                }, track]);
         }
         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 && 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(); });
@@ -102,6 +97,7 @@ function sdkFactory(params) {
         Logger: (0, sdkLogger_1.createLoggerAPI)(log),
         settings: settings,
         destroy: function () {
+            hasInit = false;
             return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
         }
     }, extraProps && extraProps(ctx), lazyInit ? { init: init } : init());

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,
+        trackImpressions: splitObject.trackImpressions !== false
     };
 }
 function objectsToViews(splitObjects) {

package/cjs/services/decorateHeaders.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.decorateHeaders = void 0;
+exports.removeNonISO88591 = exports.decorateHeaders = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var FORBIDDEN_HEADERS = new Set([
     'splitsdkclientkey',
@@ -33,3 +33,8 @@ function decorateHeaders(settings, headers) {
     return headers;
 }
 exports.decorateHeaders = decorateHeaders;
+function removeNonISO88591(input) {
+    // eslint-disable-next-line no-control-regex
+    return input.replace(/[^\x00-\xFF]/g, '');
+}
+exports.removeNonISO88591 = removeNonISO88591;

package/cjs/services/splitHttpClient.js

@@ -28,7 +28,7 @@ function splitHttpClientFactory(settings, _a) {
     if (ip)
         commonHeaders['SplitSDKMachineIP'] = ip;
     if (hostname)
-        commonHeaders['SplitSDKMachineName'] = hostname;
+        commonHeaders['SplitSDKMachineName'] = (0, decorateHeaders_1.removeNonISO88591)(hostname);
     return function httpClient(url, reqOpts, latencyTracker, logErrorsAsInfo) {
         if (reqOpts === void 0) { reqOpts = {}; }
         if (latencyTracker === void 0) { latencyTracker = function () { }; }

package/cjs/storages/inLocalStorage/index.js

@@ -9,8 +9,6 @@ var KeyBuilderCS_1 = require("../KeyBuilderCS");
 var isLocalStorageAvailable_1 = require("../../utils/env/isLocalStorageAvailable");
 var SplitsCacheInLocal_1 = require("./SplitsCacheInLocal");
 var MySegmentsCacheInLocal_1 = require("./MySegmentsCacheInLocal");
-var MySegmentsCacheInMemory_1 = require("../inMemory/MySegmentsCacheInMemory");
-var SplitsCacheInMemory_1 = require("../inMemory/SplitsCacheInMemory");
 var browser_1 = require("../../utils/constants/browser");
 var InMemoryStorageCS_1 = require("../inMemory/InMemoryStorageCS");
 var constants_1 = require("./constants");
@@ -30,7 +28,7 @@ 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, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
+        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 expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
@@ -42,20 +40,11 @@ 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,
-            destroy: function () {
-                var _a;
-                this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
-                this.segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
-                this.largeSegments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
-                this.impressions.clear();
-                this.impressionCounts && this.impressionCounts.clear();
-                this.events.clear();
-                (_a = this.uniqueKeys) === null || _a === void 0 ? void 0 : _a.clear();
-            },
+            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) {
                 return {
@@ -66,11 +55,8 @@ function InLocalStorage(options) {
                     impressionCounts: this.impressionCounts,
                     events: this.events,
                     telemetry: this.telemetry,
-                    destroy: function () {
-                        this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
-                        this.segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
-                        this.largeSegments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
-                    }
+                    uniqueKeys: this.uniqueKeys,
+                    destroy: function () { }
                 };
             },
         };

package/cjs/storages/inMemory/InMemoryStorage.js

@@ -15,26 +15,18 @@ 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,
-        // When using MEMORY we should clean all the caches to leave them empty
-        destroy: function () {
-            this.splits.clear();
-            this.segments.clear();
-            this.impressions.clear();
-            this.impressionCounts && this.impressionCounts.clear();
-            this.events.clear();
-            this.uniqueKeys && this.uniqueKeys.clear();
-        }
+        uniqueKeys: new UniqueKeysCacheInMemory_1.UniqueKeysCacheInMemory(),
+        destroy: function () { }
     };
     // @TODO revisit storage logic in localhost mode
     // No tracking data in localhost mode to avoid memory leaks

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,20 +24,11 @@ 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,
-        // When using MEMORY we should clean all the caches to leave them empty
-        destroy: function () {
-            this.splits.clear();
-            this.segments.clear();
-            this.largeSegments.clear();
-            this.impressions.clear();
-            this.impressionCounts && this.impressionCounts.clear();
-            this.events.clear();
-            this.uniqueKeys && this.uniqueKeys.clear();
-        },
+        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 () {
             return {
@@ -48,12 +39,8 @@ function InMemoryStorageCSFactory(params) {
                 impressionCounts: this.impressionCounts,
                 events: this.events,
                 telemetry: this.telemetry,
-                // Set a new splits cache to clean it for the client without affecting other clients
-                destroy: function () {
-                    this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
-                    this.segments.clear();
-                    this.largeSegments.clear();
-                }
+                uniqueKeys: this.uniqueKeys,
+                destroy: function () { }
             };
         },
     };

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,30 +54,26 @@ 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) {
+            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);
@@ -93,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();
@@ -116,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

package/cjs/sync/submitters/impressionCountsSubmitter.js

@@ -30,9 +30,7 @@ var IMPRESSIONS_COUNT_RATE = 1800000; // 30 minutes
  */
 function impressionCountsSubmitterFactory(params) {
     var log = params.settings.log, postTestImpressionsCount = params.splitApi.postTestImpressionsCount, impressionCounts = params.storage.impressionCounts;
-    if (impressionCounts) {
-        // retry impressions counts only once.
-        return (0, submitter_1.submitterFactory)(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, 'impression counts', fromImpressionCountsCollector, 1);
-    }
+    // retry impressions counts only once.
+    return (0, submitter_1.submitterFactory)(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, 'impression counts', fromImpressionCountsCollector, 1);
 }
 exports.impressionCountsSubmitterFactory = impressionCountsSubmitterFactory;

package/cjs/sync/submitters/submitterManager.js

@@ -9,14 +9,11 @@ var uniqueKeysSubmitter_1 = require("./uniqueKeysSubmitter");
 function submitterManagerFactory(params) {
     var submitters = [
         (0, impressionsSubmitter_1.impressionsSubmitterFactory)(params),
-        (0, eventsSubmitter_1.eventsSubmitterFactory)(params)
+        (0, eventsSubmitter_1.eventsSubmitterFactory)(params),
+        (0, impressionCountsSubmitter_1.impressionCountsSubmitterFactory)(params),
+        (0, uniqueKeysSubmitter_1.uniqueKeysSubmitterFactory)(params)
     ];
-    var impressionCountsSubmitter = (0, impressionCountsSubmitter_1.impressionCountsSubmitterFactory)(params);
-    if (impressionCountsSubmitter)
-        submitters.push(impressionCountsSubmitter);
     var telemetrySubmitter = (0, telemetrySubmitter_1.telemetrySubmitterFactory)(params);
-    if (params.storage.uniqueKeys)
-        submitters.push((0, uniqueKeysSubmitter_1.uniqueKeysSubmitterFactory)(params));
     return {
         // `onlyTelemetry` true if SDK is created with userConsent not GRANTED
         start: function (onlyTelemetry) {