@splitsoftware/splitio-commons 2.4.2-rc.0 → 2.4.2-rc.2

package/CHANGES.txt

@@ -1,3 +1,6 @@
+2.5.0 (August XX, 2025)
+ - Added `storage.wrapper` configuration option to allow the SDK to use a custom storage wrapper for the storage type `LOCALSTORAGE`. Default value is `window.localStorage`.
+
 2.4.1 (June 3, 2025)
  - Bugfix - Improved the Proxy fallback to flag spec version 1.2 to handle cases where the Proxy does not return an end-of-stream marker in 400 status code responses.
 
@@ -9,7 +12,7 @@
  - Updated the Redis storage to:
     - Avoid lazy require of the `ioredis` dependency when the SDK is initialized, and
     - Flag the SDK as ready from cache immediately to allow queueing feature flag evaluations before SDK_READY event is emitted (Reverted in v1.7.0).
- - Bugfix - Enhanced HTTP client module to implement timeouts for failing requests that might otherwise remain pending indefinitely on some Fetch API implementations.
+ - Bugfix - Enhanced HTTP client module to implement timeouts for failing requests that might otherwise remain pending indefinitely on some Fetch API implementations, pausing the SDK synchronization process.
 
 2.2.0 (March 28, 2025)
  - Added a new optional argument to the client `getTreatment` methods to allow passing additional evaluation options, such as a map of properties to append to the generated impressions sent to Split backend. Read more in our docs.
@@ -47,6 +50,15 @@
    - Removed internal ponyfills for `Map` and `Set` global objects, dropping support for IE and other outdated browsers. The SDK now requires the runtime environment to support these features natively or to provide a polyfill.
    - Removed the `sync.localhostMode` configuration option to plug the LocalhostMode module.
 
+1.17.1 (July 25, 2025)
+ - Updated the Redis storage to avoid lazy require of the `ioredis` dependency when the SDK is initialized.
+ - Updated some transitive dependencies for vulnerability fixes.
+ - Bugfix - Enhanced HTTP client module to implement timeouts for failing requests that might otherwise remain pending indefinitely on some Fetch API implementations, pausing the SDK synchronization process.
+ - Bugfix - Properly handle rejected promises when using targeting rules with segment matchers in consumer modes (e.g., Redis and Pluggable storages).
+ - Bugfix - 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).
+ - Bugfix - 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.
+ - Bugfix - Fixed an issue with the server-side polling manager that caused dangling timers when the SDK was destroyed before it was ready.
+
 1.17.0 (September 6, 2024)
  - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.
  - Added `isTimedout` and `lastUpdate` properties to IStatusInterface to keep track of the timestamp of the last SDK event, used on React and Redux SDKs.

package/cjs/logger/messages/error.js

@@ -17,7 +17,7 @@ exports.codesError = [
     [c.ERROR_SYNC_OFFLINE_LOADING, c.LOG_PREFIX_SYNC_OFFLINE + 'There was an issue loading the mock feature flags data. No changes will be applied to the current cache. %s'],
     [c.ERROR_STREAMING_SSE, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to connect or error on streaming connection, with error message: %s'],
     [c.ERROR_STREAMING_AUTH, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to authenticate for streaming. Error: %s.'],
-    [c.ERROR_HTTP, 'Response status is not OK. Status: %s. URL: %s. Message: %s'],
+    [c.ERROR_HTTP, 'HTTP request failed with %s. URL: %s. Message: %s'],
     // client status
     [c.ERROR_CLIENT_LISTENER, 'A listener was added for %s on the SDK, which has already fired and won\'t be emitted again. The callback won\'t be executed.'],
     [c.ERROR_CLIENT_DESTROYED, '%s: Client has already been destroyed - no calls possible.'],

package/cjs/sdkClient/sdkClient.js

@@ -38,7 +38,6 @@ function sdkClientFactory(params, isSharedClient) {
     (0, clientInputValidation_1.clientInputValidationDecorator)(settings, (0, client_1.clientFactory)(params), sdkReadinessManager.readinessManager), 
     // Sdk destroy
     {
-        __ctx: params,
         flush: function () {
             // @TODO define cooldown time
             return __cooldown(__flush, COOLDOWN_TIME_IN_MILLIS);

package/cjs/sdkFactory/index.js

@@ -87,7 +87,8 @@ function sdkFactory(params) {
         initCallbacks.length = 0;
     }
     log.info(constants_1.NEW_FACTORY);
-    var factory = (0, objectAssign_1.objectAssign)({
+    // @ts-ignore
+    return (0, objectAssign_1.objectAssign)({
         // Split evaluation and event tracking engine
         client: clientMethod,
         // Manager API to explore available information
@@ -101,15 +102,7 @@ function sdkFactory(params) {
         destroy: function () {
             hasInit = false;
             return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
-        },
-        __ctx: ctx
+        }
     }, extraProps && extraProps(ctx), lazyInit ? { init: init } : init());
-    // append factory to global
-    if (typeof window === 'object') { // @ts-ignore
-        // eslint-disable-next-line no-undef
-        (window.__HARNESS_FME__ = window.__HARNESS_FME__ || []).push(factory);
-    }
-    // @ts-ignore
-    return factory;
 }
 exports.sdkFactory = sdkFactory;

package/cjs/services/splitHttpClient.js

@@ -69,7 +69,7 @@ function splitHttpClientFactory(settings, _a) {
                 msg = error.message || 'Network Error';
             }
             if (!resp || resp.status !== 403) { // 403's log we'll be handled somewhere else.
-                log[logErrorsAsInfo ? 'info' : 'error'](constants_1.ERROR_HTTP, [resp ? resp.status : 'NO_STATUS', url, msg]);
+                log[logErrorsAsInfo ? 'info' : 'error'](constants_1.ERROR_HTTP, [resp ? 'status code ' + resp.status : 'no status code', url, msg]);
             }
             var networkError = new Error(msg);
             // passes `undefined` as statusCode if not an HTTP error (resp === undefined)

package/cjs/storages/AbstractMySegmentsCacheSync.js

@@ -23,37 +23,45 @@ var AbstractMySegmentsCacheSync = /** @class */ (function () {
      */
     AbstractMySegmentsCacheSync.prototype.resetSegments = function (segmentsData) {
         var _this = this;
-        this.setChangeNumber(segmentsData.cn);
         var _a = segmentsData, added = _a.added, removed = _a.removed;
+        var isDiff = false;
         if (added && removed) {
-            var isDiff_1 = false;
             added.forEach(function (segment) {
-                isDiff_1 = _this.addSegment(segment) || isDiff_1;
+                isDiff = _this.addSegment(segment) || isDiff;
             });
             removed.forEach(function (segment) {
-                isDiff_1 = _this.removeSegment(segment) || isDiff_1;
+                isDiff = _this.removeSegment(segment) || isDiff;
             });
-            return isDiff_1;
-        }
-        var names = (segmentsData.k || []).map(function (s) { return s.n; }).sort();
-        var storedSegmentKeys = this.getRegisteredSegments().sort();
-        // Extreme fast => everything is empty
-        if (!names.length && !storedSegmentKeys.length)
-            return false;
-        var index = 0;
-        while (index < names.length && index < storedSegmentKeys.length && names[index] === storedSegmentKeys[index])
-            index++;
-        // Quick path => no changes
-        if (index === names.length && index === storedSegmentKeys.length)
-            return false;
-        // Slowest path => add and/or remove segments
-        for (var removeIndex = index; removeIndex < storedSegmentKeys.length; removeIndex++) {
-            this.removeSegment(storedSegmentKeys[removeIndex]);
         }
-        for (var addIndex = index; addIndex < names.length; addIndex++) {
-            this.addSegment(names[addIndex]);
+        else {
+            var names = (segmentsData.k || []).map(function (s) { return s.n; }).sort();
+            var storedSegmentKeys = this.getRegisteredSegments().sort();
+            // Extreme fast => everything is empty
+            if (!names.length && !storedSegmentKeys.length) {
+                isDiff = false;
+            }
+            else {
+                var index = 0;
+                while (index < names.length && index < storedSegmentKeys.length && names[index] === storedSegmentKeys[index])
+                    index++;
+                // Quick path => no changes
+                if (index === names.length && index === storedSegmentKeys.length) {
+                    isDiff = false;
+                }
+                else {
+                    // Slowest path => add and/or remove segments
+                    for (var removeIndex = index; removeIndex < storedSegmentKeys.length; removeIndex++) {
+                        this.removeSegment(storedSegmentKeys[removeIndex]);
+                    }
+                    for (var addIndex = index; addIndex < names.length; addIndex++) {
+                        this.addSegment(names[addIndex]);
+                    }
+                    isDiff = true;
+                }
+            }
         }
-        return true;
+        this.setChangeNumber(segmentsData.cn);
+        return isDiff;
     };
     return AbstractMySegmentsCacheSync;
 }());

package/cjs/storages/AbstractSplitsCacheSync.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.usesSegments = exports.AbstractSplitsCacheSync = void 0;
+exports.usesSegmentsSync = exports.usesSegments = exports.AbstractSplitsCacheSync = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_1 = require("../utils/constants");
 /**
@@ -12,9 +12,10 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
     }
     AbstractSplitsCacheSync.prototype.update = function (toAdd, toRemove, changeNumber) {
         var _this = this;
-        this.setChangeNumber(changeNumber);
         var updated = toAdd.map(function (addedFF) { return _this.addSplit(addedFF); }).some(function (result) { return result; });
-        return toRemove.map(function (removedFF) { return _this.removeSplit(removedFF.name); }).some(function (result) { return result; }) || updated;
+        updated = toRemove.map(function (removedFF) { return _this.removeSplit(removedFF.name); }).some(function (result) { return result; }) || updated;
+        this.setChangeNumber(changeNumber);
+        return updated;
     };
     AbstractSplitsCacheSync.prototype.getSplits = function (names) {
         var _this = this;
@@ -69,3 +70,7 @@ function usesSegments(ruleEntity) {
     return false;
 }
 exports.usesSegments = usesSegments;
+function usesSegmentsSync(storage) {
+    return storage.splits.usesSegments() || storage.rbSegments.usesSegments();
+}
+exports.usesSegmentsSync = usesSegmentsSync;

package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js

@@ -7,19 +7,20 @@ var AbstractMySegmentsCacheSync_1 = require("../AbstractMySegmentsCacheSync");
 var constants_1 = require("./constants");
 var MySegmentsCacheInLocal = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(MySegmentsCacheInLocal, _super);
-    function MySegmentsCacheInLocal(log, keys) {
+    function MySegmentsCacheInLocal(log, keys, storage) {
         var _this = _super.call(this) || this;
         _this.log = log;
         _this.keys = keys;
+        _this.storage = storage;
         return _this;
         // There is not need to flush segments cache like splits cache, since resetSegments receives the up-to-date list of active segments
     }
     MySegmentsCacheInLocal.prototype.addSegment = function (name) {
         var segmentKey = this.keys.buildSegmentNameKey(name);
         try {
-            if (localStorage.getItem(segmentKey) === constants_1.DEFINED)
+            if (this.storage.getItem(segmentKey) === constants_1.DEFINED)
                 return false;
-            localStorage.setItem(segmentKey, constants_1.DEFINED);
+            this.storage.setItem(segmentKey, constants_1.DEFINED);
             return true;
         }
         catch (e) {
@@ -30,9 +31,9 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
     MySegmentsCacheInLocal.prototype.removeSegment = function (name) {
         var segmentKey = this.keys.buildSegmentNameKey(name);
         try {
-            if (localStorage.getItem(segmentKey) !== constants_1.DEFINED)
+            if (this.storage.getItem(segmentKey) !== constants_1.DEFINED)
                 return false;
-            localStorage.removeItem(segmentKey);
+            this.storage.removeItem(segmentKey);
             return true;
         }
         catch (e) {
@@ -41,17 +42,16 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
         }
     };
     MySegmentsCacheInLocal.prototype.isInSegment = function (name) {
-        return localStorage.getItem(this.keys.buildSegmentNameKey(name)) === constants_1.DEFINED;
+        return this.storage.getItem(this.keys.buildSegmentNameKey(name)) === constants_1.DEFINED;
     };
     MySegmentsCacheInLocal.prototype.getRegisteredSegments = function () {
-        var _this = this;
-        // Scan current values from localStorage
-        return Object.keys(localStorage).reduce(function (accum, key) {
-            var segmentName = _this.keys.extractSegmentName(key);
+        var registeredSegments = [];
+        for (var i = 0; i < this.storage.length; i++) {
+            var segmentName = this.keys.extractSegmentName(this.storage.key(i));
             if (segmentName)
-                accum.push(segmentName);
-            return accum;
-        }, []);
+                registeredSegments.push(segmentName);
+        }
+        return registeredSegments;
     };
     MySegmentsCacheInLocal.prototype.getKeysCount = function () {
         return 1;
@@ -59,9 +59,9 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
     MySegmentsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
         try {
             if (changeNumber)
-                localStorage.setItem(this.keys.buildTillKey(), changeNumber + '');
+                this.storage.setItem(this.keys.buildTillKey(), changeNumber + '');
             else
-                localStorage.removeItem(this.keys.buildTillKey());
+                this.storage.removeItem(this.keys.buildTillKey());
         }
         catch (e) {
             this.log.error(e);
@@ -69,7 +69,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
     };
     MySegmentsCacheInLocal.prototype.getChangeNumber = function () {
         var n = -1;
-        var value = localStorage.getItem(this.keys.buildTillKey());
+        var value = this.storage.getItem(this.keys.buildTillKey());
         if (value !== null) {
             value = parseInt(value, 10);
             return (0, lang_1.isNaNNumber)(value) ? n : value;

package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js

@@ -6,25 +6,27 @@ var sets_1 = require("../../utils/lang/sets");
 var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
 var constants_1 = require("./constants");
 var RBSegmentsCacheInLocal = /** @class */ (function () {
-    function RBSegmentsCacheInLocal(settings, keys) {
+    function RBSegmentsCacheInLocal(settings, keys, storage) {
         this.keys = keys;
         this.log = settings.log;
+        this.storage = storage;
     }
     RBSegmentsCacheInLocal.prototype.clear = function () {
         var _this = this;
         this.getNames().forEach(function (name) { return _this.remove(name); });
-        localStorage.removeItem(this.keys.buildRBSegmentsTillKey());
+        this.storage.removeItem(this.keys.buildRBSegmentsTillKey());
     };
     RBSegmentsCacheInLocal.prototype.update = function (toAdd, toRemove, changeNumber) {
         var _this = this;
-        this.setChangeNumber(changeNumber);
         var updated = toAdd.map(function (toAdd) { return _this.add(toAdd); }).some(function (result) { return result; });
-        return toRemove.map(function (toRemove) { return _this.remove(toRemove.name); }).some(function (result) { return result; }) || updated;
+        updated = toRemove.map(function (toRemove) { return _this.remove(toRemove.name); }).some(function (result) { return result; }) || updated;
+        this.setChangeNumber(changeNumber);
+        return updated;
     };
     RBSegmentsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
         try {
-            localStorage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
-            localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
+            this.storage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
+            this.storage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
         }
         catch (e) {
             this.log.error(constants_1.LOG_PREFIX + e);
@@ -32,20 +34,19 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
     };
     RBSegmentsCacheInLocal.prototype.updateSegmentCount = function (diff) {
         var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-        var count = (0, lang_1.toNumber)(localStorage.getItem(segmentsCountKey)) + diff;
-        // @ts-expect-error
+        var count = (0, lang_1.toNumber)(this.storage.getItem(segmentsCountKey)) + diff;
         if (count > 0)
-            localStorage.setItem(segmentsCountKey, count);
+            this.storage.setItem(segmentsCountKey, count + '');
         else
-            localStorage.removeItem(segmentsCountKey);
+            this.storage.removeItem(segmentsCountKey);
     };
     RBSegmentsCacheInLocal.prototype.add = function (rbSegment) {
         try {
             var name_1 = rbSegment.name;
             var rbSegmentKey = this.keys.buildRBSegmentKey(name_1);
-            var rbSegmentFromLocalStorage = localStorage.getItem(rbSegmentKey);
-            var previous = rbSegmentFromLocalStorage ? JSON.parse(rbSegmentFromLocalStorage) : null;
-            localStorage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
+            var rbSegmentFromStorage = this.storage.getItem(rbSegmentKey);
+            var previous = rbSegmentFromStorage ? JSON.parse(rbSegmentFromStorage) : null;
+            this.storage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
             var usesSegmentsDiff = 0;
             if (previous && (0, AbstractSplitsCacheSync_1.usesSegments)(previous))
                 usesSegmentsDiff--;
@@ -65,7 +66,7 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
             var rbSegment = this.get(name);
             if (!rbSegment)
                 return false;
-            localStorage.removeItem(this.keys.buildRBSegmentKey(name));
+            this.storage.removeItem(this.keys.buildRBSegmentKey(name));
             if ((0, AbstractSplitsCacheSync_1.usesSegments)(rbSegment))
                 this.updateSegmentCount(-1);
             return true;
@@ -76,11 +77,11 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
         }
     };
     RBSegmentsCacheInLocal.prototype.getNames = function () {
-        var len = localStorage.length;
+        var len = this.storage.length;
         var accum = [];
         var cur = 0;
         while (cur < len) {
-            var key = localStorage.key(cur);
+            var key = this.storage.key(cur);
             if (key != null && this.keys.isRBSegmentKey(key))
                 accum.push(this.keys.extractKey(key));
             cur++;
@@ -88,7 +89,7 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
         return accum;
     };
     RBSegmentsCacheInLocal.prototype.get = function (name) {
-        var item = localStorage.getItem(this.keys.buildRBSegmentKey(name));
+        var item = this.storage.getItem(this.keys.buildRBSegmentKey(name));
         return item && JSON.parse(item);
     };
     RBSegmentsCacheInLocal.prototype.contains = function (names) {
@@ -98,7 +99,7 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
     };
     RBSegmentsCacheInLocal.prototype.getChangeNumber = function () {
         var n = -1;
-        var value = localStorage.getItem(this.keys.buildRBSegmentsTillKey());
+        var value = this.storage.getItem(this.keys.buildRBSegmentsTillKey());
         if (value !== null) {
             value = parseInt(value, 10);
             return (0, lang_1.isNaNNumber)(value) ? n : value;
@@ -106,7 +107,7 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
         return n;
     };
     RBSegmentsCacheInLocal.prototype.usesSegments = function () {
-        var storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
+        var storedCount = this.storage.getItem(this.keys.buildSplitsWithSegmentCountKey());
         var splitsWithSegmentsCount = storedCount === null ? 0 : (0, lang_1.toNumber)(storedCount);
         return (0, lang_1.isFiniteNumber)(splitsWithSegmentsCount) ?
             splitsWithSegmentsCount > 0 :

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -6,25 +6,22 @@ var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
 var lang_1 = require("../../utils/lang");
 var constants_1 = require("./constants");
 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, storage) {
         var _this = _super.call(this) || this;
         _this.keys = keys;
         _this.log = settings.log;
         _this.flagSetsFilter = settings.sync.__splitFiltersValidation.groupedFilters.bySet;
+        _this.storage = storage;
         return _this;
     }
     SplitsCacheInLocal.prototype._decrementCount = function (key) {
-        var count = (0, lang_1.toNumber)(localStorage.getItem(key)) - 1;
-        // @ts-expect-error
+        var count = (0, lang_1.toNumber)(this.storage.getItem(key)) - 1;
         if (count > 0)
-            localStorage.setItem(key, count);
+            this.storage.setItem(key, count + '');
         else
-            localStorage.removeItem(key);
+            this.storage.removeItem(key);
     };
     SplitsCacheInLocal.prototype._decrementCounts = function (split) {
         try {
@@ -42,12 +39,10 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     SplitsCacheInLocal.prototype._incrementCounts = function (split) {
         try {
             var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-            // @ts-expect-error
-            localStorage.setItem(ttKey, (0, lang_1.toNumber)(localStorage.getItem(ttKey)) + 1);
+            this.storage.setItem(ttKey, ((0, lang_1.toNumber)(this.storage.getItem(ttKey)) + 1) + '');
             if ((0, AbstractSplitsCacheSync_1.usesSegments)(split)) {
                 var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-                // @ts-expect-error
-                localStorage.setItem(segmentsCountKey, (0, lang_1.toNumber)(localStorage.getItem(segmentsCountKey)) + 1);
+                this.storage.setItem(segmentsCountKey, ((0, lang_1.toNumber)(this.storage.getItem(segmentsCountKey)) + 1) + '');
             }
         }
         catch (e) {
@@ -59,17 +54,18 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
      * We cannot simply call `localStorage.clear()` since that implies removing user items from the storage.
      */
     SplitsCacheInLocal.prototype.clear = function () {
+        var _this = this;
         // collect item keys
-        var len = localStorage.length;
+        var len = this.storage.length;
         var accum = [];
         for (var cur = 0; cur < len; cur++) {
-            var key = localStorage.key(cur);
+            var key = this.storage.key(cur);
             if (key != null && this.keys.isSplitsCacheKey(key))
                 accum.push(key);
         }
         // remove items
         accum.forEach(function (key) {
-            localStorage.removeItem(key);
+            _this.storage.removeItem(key);
         });
         this.hasSync = false;
     };
@@ -77,13 +73,13 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         try {
             var name_1 = split.name;
             var splitKey = this.keys.buildSplitKey(name_1);
-            var splitFromLocalStorage = localStorage.getItem(splitKey);
-            var previousSplit = splitFromLocalStorage ? JSON.parse(splitFromLocalStorage) : null;
+            var splitFromStorage = this.storage.getItem(splitKey);
+            var previousSplit = splitFromStorage ? JSON.parse(splitFromStorage) : null;
             if (previousSplit) {
                 this._decrementCounts(previousSplit);
                 this.removeFromFlagSets(previousSplit.name, previousSplit.sets);
             }
-            localStorage.setItem(splitKey, JSON.stringify(split));
+            this.storage.setItem(splitKey, JSON.stringify(split));
             this._incrementCounts(split);
             this.addToFlagSets(split);
             return true;
@@ -98,7 +94,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             var split = this.getSplit(name);
             if (!split)
                 return false;
-            localStorage.removeItem(this.keys.buildSplitKey(name));
+            this.storage.removeItem(this.keys.buildSplitKey(name));
             this._decrementCounts(split);
             this.removeFromFlagSets(split.name, split.sets);
             return true;
@@ -109,14 +105,14 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         }
     };
     SplitsCacheInLocal.prototype.getSplit = function (name) {
-        var item = localStorage.getItem(this.keys.buildSplitKey(name));
+        var item = this.storage.getItem(this.keys.buildSplitKey(name));
         return item && JSON.parse(item);
     };
     SplitsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
         try {
-            localStorage.setItem(this.keys.buildSplitsTillKey(), changeNumber + '');
+            this.storage.setItem(this.keys.buildSplitsTillKey(), changeNumber + '');
             // update "last updated" timestamp with current time
-            localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
+            this.storage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
             this.hasSync = true;
             return true;
         }
@@ -127,7 +123,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     };
     SplitsCacheInLocal.prototype.getChangeNumber = function () {
         var n = -1;
-        var value = localStorage.getItem(this.keys.buildSplitsTillKey());
+        var value = this.storage.getItem(this.keys.buildSplitsTillKey());
         if (value !== null) {
             value = parseInt(value, 10);
             return (0, lang_1.isNaNNumber)(value) ? n : value;
@@ -135,11 +131,11 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         return n;
     };
     SplitsCacheInLocal.prototype.getSplitNames = function () {
-        var len = localStorage.length;
+        var len = this.storage.length;
         var accum = [];
         var cur = 0;
         while (cur < len) {
-            var key = localStorage.key(cur);
+            var key = this.storage.key(cur);
             if (key != null && this.keys.isSplitKey(key))
                 accum.push(this.keys.extractKey(key));
             cur++;
@@ -147,14 +143,14 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         return accum;
     };
     SplitsCacheInLocal.prototype.trafficTypeExists = function (trafficType) {
-        var ttCount = (0, lang_1.toNumber)(localStorage.getItem(this.keys.buildTrafficTypeKey(trafficType)));
+        var ttCount = (0, lang_1.toNumber)(this.storage.getItem(this.keys.buildTrafficTypeKey(trafficType)));
         return (0, lang_1.isFiniteNumber)(ttCount) && ttCount > 0;
     };
     SplitsCacheInLocal.prototype.usesSegments = function () {
         // If cache hasn't been synchronized with the cloud, assume we need them.
         if (!this.hasSync)
             return true;
-        var storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
+        var storedCount = this.storage.getItem(this.keys.buildSplitsWithSegmentCountKey());
         var splitsWithSegmentsCount = storedCount === null ? 0 : (0, lang_1.toNumber)(storedCount);
         return (0, lang_1.isFiniteNumber)(splitsWithSegmentsCount) ?
             splitsWithSegmentsCount > 0 :
@@ -164,8 +160,8 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         var _this = this;
         return flagSets.map(function (flagSet) {
             var flagSetKey = _this.keys.buildFlagSetKey(flagSet);
-            var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
-            return new Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
+            var flagSetFromStorage = _this.storage.getItem(flagSetKey);
+            return new Set(flagSetFromStorage ? JSON.parse(flagSetFromStorage) : []);
         });
     };
     SplitsCacheInLocal.prototype.addToFlagSets = function (featureFlag) {
@@ -176,10 +172,10 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             if (_this.flagSetsFilter.length > 0 && !_this.flagSetsFilter.some(function (filterFlagSet) { return filterFlagSet === featureFlagSet; }))
                 return;
             var flagSetKey = _this.keys.buildFlagSetKey(featureFlagSet);
-            var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
-            var flagSetCache = new Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
+            var flagSetFromStorage = _this.storage.getItem(flagSetKey);
+            var flagSetCache = new Set(flagSetFromStorage ? JSON.parse(flagSetFromStorage) : []);
             flagSetCache.add(featureFlag.name);
-            localStorage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
+            _this.storage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
         });
     };
     SplitsCacheInLocal.prototype.removeFromFlagSets = function (featureFlagName, flagSets) {
@@ -192,16 +188,16 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     };
     SplitsCacheInLocal.prototype.removeNames = function (flagSetName, featureFlagName) {
         var flagSetKey = this.keys.buildFlagSetKey(flagSetName);
-        var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
-        if (!flagSetFromLocalStorage)
+        var flagSetFromStorage = this.storage.getItem(flagSetKey);
+        if (!flagSetFromStorage)
             return;
-        var flagSetCache = new Set(JSON.parse(flagSetFromLocalStorage));
+        var flagSetCache = new Set(JSON.parse(flagSetFromStorage));
         flagSetCache.delete(featureFlagName);
         if (flagSetCache.size === 0) {
-            localStorage.removeItem(flagSetKey);
+            this.storage.removeItem(flagSetKey);
             return;
         }
-        localStorage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
+        this.storage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
     };
     return SplitsCacheInLocal;
 }(AbstractSplitsCacheSync_1.AbstractSplitsCacheSync));

package/cjs/storages/inLocalStorage/index.js

@@ -17,6 +17,20 @@ var TelemetryCacheInMemory_1 = require("../inMemory/TelemetryCacheInMemory");
 var UniqueKeysCacheInMemoryCS_1 = require("../inMemory/UniqueKeysCacheInMemoryCS");
 var key_1 = require("../../utils/key");
 var validateCache_1 = require("./validateCache");
+var storageAdapter_1 = require("./storageAdapter");
+function validateStorage(log, prefix, wrapper) {
+    if (wrapper) {
+        if ((0, isLocalStorageAvailable_1.isValidStorageWrapper)(wrapper)) {
+            return (0, isLocalStorageAvailable_1.isWebStorage)(wrapper) ?
+                wrapper : // localStorage and sessionStorage don't need adapter
+                (0, storageAdapter_1.storageAdapter)(log, prefix, wrapper);
+        }
+        log.warn(constants_1.LOG_PREFIX + 'Invalid storage provided. Falling back to LocalStorage API');
+    }
+    if ((0, isLocalStorageAvailable_1.isLocalStorageAvailable)())
+        return localStorage;
+    log.warn(constants_1.LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
+}
 /**
  * InLocal storage factory for standalone client-side SplitFactory
  */
@@ -24,18 +38,17 @@ function InLocalStorage(options) {
     if (options === void 0) { options = {}; }
     var prefix = (0, KeyBuilder_1.validatePrefix)(options.prefix);
     function InLocalStorageCSFactory(params) {
-        // Fallback to InMemoryStorage if LocalStorage API is not available
-        if (!(0, isLocalStorageAvailable_1.isLocalStorageAvailable)()) {
-            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 storage = validateStorage(log, prefix, options.wrapper);
+        if (!storage)
+            return (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
         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 rbSegments = new RBSegmentsCacheInLocal_1.RBSegmentsCacheInLocal(settings, keys);
-        var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys);
-        var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey));
+        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys, storage);
+        var rbSegments = new RBSegmentsCacheInLocal_1.RBSegmentsCacheInLocal(settings, keys, storage);
+        var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys, storage);
+        var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey), storage);
+        var validateCachePromise;
         return {
             splits: splits,
             rbSegments: rbSegments,
@@ -47,16 +60,18 @@ function InLocalStorage(options) {
             telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
             uniqueKeys: new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS(),
             validateCache: function () {
-                return (0, validateCache_1.validateCache)(options, settings, keys, splits, rbSegments, segments, largeSegments);
+                return validateCachePromise || (validateCachePromise = (0, validateCache_1.validateCache)(options, storage, settings, keys, splits, rbSegments, segments, largeSegments));
+            },
+            destroy: function () {
+                return storage.save && storage.save();
             },
-            destroy: function () { },
             // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
             shared: function (matchingKey) {
                 return {
                     splits: this.splits,
                     rbSegments: this.rbSegments,
-                    segments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey)),
-                    largeSegments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey)),
+                    segments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey), storage),
+                    largeSegments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey), storage),
                     impressions: this.impressions,
                     impressionCounts: this.impressionCounts,
                     events: this.events,