@splitsoftware/splitio-commons 1.17.1-rc.3 → 2.0.0-rc.0

package/CHANGES.txt

@@ -1,11 +1,15 @@
-2.0.0 (September XX, 2024)
- - Updated internal storage factory to emit the SDK_READY_FROM_CACHE event when it corresponds, to clean up the initialization flow.
- - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
+2.0.0 (October XX, 2024)
  - Added support for targeting rules based on large segments.
+ - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
+ - Bugfixing - Fixed an issue with the server-side polling manager that caused dangling timers when the SDK was destroyed before it was ready.
  - BREAKING CHANGES:
    - Updated default flag spec version to 1.2.
    - Removed `/mySegments` endpoint from SplitAPI module, as it is replaced by `/memberships` endpoint.
    - Removed support for MY_SEGMENTS_UPDATE and MY_SEGMENTS_UPDATE_V2 notification types, as they are replaced by MEMBERSHIPS_MS_UPDATE and MEMBERSHIPS_LS_UPDATE notification types.
+   - Removed the deprecated `GOOGLE_ANALYTICS_TO_SPLIT` and `SPLIT_TO_GOOGLE_ANALYTICS` integrations.
+   - Removed internal ponyfills for `Map`, `Set` and `Array.from` 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 migration logic for the old format of MySegments keys in LocalStorage introduced in JavaScript SDK v10.17.3.
+   - Removed the `sdkClientMethodCSWithTT` function, which handled the logic to bound an optional traffic type to SDK clients. Client-side SDK implementations must use `sdkClientMethodCS` module, which, unlike the previous function, does not allow passing a traffic type but simplifies the SDK API.
 
 1.17.0 (September 6, 2024)
  - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.

package/cjs/evaluator/index.js

@@ -59,7 +59,7 @@ exports.evaluateFeatures = evaluateFeatures;
 function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, method) {
     var storedFlagNames;
     function evaluate(featureFlagsByFlagSets) {
-        var featureFlags = new sets_1._Set();
+        var featureFlags = new Set();
         for (var i = 0; i < flagSets.length; i++) {
             var featureFlagByFlagSet = featureFlagsByFlagSets[i];
             if (featureFlagByFlagSet.size) {
@@ -70,7 +70,7 @@ function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, met
             }
         }
         return featureFlags.size ?
-            evaluateFeatures(log, key, (0, sets_1.setToArray)(featureFlags), attributes, storage) :
+            evaluateFeatures(log, key, Array.from(featureFlags), attributes, storage) :
             {};
     }
     // get features by flag sets

package/cjs/evaluator/matchers/semver_inlist.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.inListSemverMatcherContext = void 0;
-var sets_1 = require("../../utils/lang/sets");
 var Semver_1 = require("../../utils/Semver");
 function inListSemverMatcherContext(ruleAttr) {
     // @TODO ruleAttr validation should be done at the `parser` or `matchersTransform` level to reuse for all matchers
     if (!ruleAttr || ruleAttr.length === 0)
         throw new Error('whitelistMatcherData is required for IN_LIST_SEMVER matcher type');
-    var listOfSemvers = new sets_1._Set(ruleAttr.map(function (version) { return new Semver_1.Semver(version).version; }));
+    var listOfSemvers = new Set(ruleAttr.map(function (version) { return new Semver_1.Semver(version).version; }));
     return function inListSemverMatcher(runtimeAttr) {
         var runtimeSemver = new Semver_1.Semver(runtimeAttr).version;
         var isInList = listOfSemvers.has(runtimeSemver);

package/cjs/evaluator/matchers/whitelist.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.whitelistMatcherContext = void 0;
-var sets_1 = require("../../utils/lang/sets");
 function whitelistMatcherContext(ruleAttr) {
-    var whitelistSet = new sets_1._Set(ruleAttr);
+    var whitelistSet = new Set(ruleAttr);
     return function whitelistMatcher(runtimeAttr) {
         var isInWhitelist = whitelistSet.has(runtimeAttr);
         return isInWhitelist;

package/cjs/listeners/browser.js

@@ -100,7 +100,6 @@ var BrowserSignalListener = /** @class */ (function () {
      * Returns true if beacon API was used successfully, false otherwise.
      */
     BrowserSignalListener.prototype._sendBeacon = function (url, data, extraMetadata) {
-        // eslint-disable-next-line compat/compat
         if (typeof navigator !== 'undefined' && navigator.sendBeacon) {
             var json = {
                 entries: data,
@@ -113,7 +112,7 @@ var BrowserSignalListener = /** @class */ (function () {
             // Stringify the payload
             var payload = JSON.stringify(json);
             // https://xgwang.me/posts/you-may-not-know-beacon/#it-may-throw-error%2C-be-sure-to-catch
-            try { // eslint-disable-next-line compat/compat
+            try {
                 return navigator.sendBeacon(url, payload);
             }
             catch (e) {

package/cjs/logger/browser/DebugLogger.js

@@ -3,8 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DebugLogger = void 0;
 var index_1 = require("../index");
 var debug_1 = require("../messages/debug");
-var maps_1 = require("../../utils/lang/maps");
 function DebugLogger() {
-    return new index_1.Logger({ logLevel: 'DEBUG' }, new maps_1._Map(debug_1.codesDebug));
+    return new index_1.Logger({ logLevel: 'DEBUG' }, new Map(debug_1.codesDebug));
 }
 exports.DebugLogger = DebugLogger;

package/cjs/logger/browser/ErrorLogger.js

@@ -3,8 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorLogger = void 0;
 var index_1 = require("../index");
 var error_1 = require("../messages/error");
-var maps_1 = require("../../utils/lang/maps");
 function ErrorLogger() {
-    return new index_1.Logger({ logLevel: 'ERROR' }, new maps_1._Map(error_1.codesError));
+    return new index_1.Logger({ logLevel: 'ERROR' }, new Map(error_1.codesError));
 }
 exports.ErrorLogger = ErrorLogger;

package/cjs/logger/browser/InfoLogger.js

@@ -3,8 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoLogger = void 0;
 var index_1 = require("../index");
 var info_1 = require("../messages/info");
-var maps_1 = require("../../utils/lang/maps");
 function InfoLogger() {
-    return new index_1.Logger({ logLevel: 'INFO' }, new maps_1._Map(info_1.codesInfo));
+    return new index_1.Logger({ logLevel: 'INFO' }, new Map(info_1.codesInfo));
 }
 exports.InfoLogger = InfoLogger;

package/cjs/logger/browser/WarnLogger.js

@@ -3,8 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WarnLogger = void 0;
 var index_1 = require("../index");
 var warn_1 = require("../messages/warn");
-var maps_1 = require("../../utils/lang/maps");
 function WarnLogger() {
-    return new index_1.Logger({ logLevel: 'WARN' }, new maps_1._Map(warn_1.codesWarn));
+    return new index_1.Logger({ logLevel: 'WARN' }, new Map(warn_1.codesWarn));
 }
 exports.WarnLogger = WarnLogger;

package/cjs/logger/index.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = exports._sprintf = exports.isLogLevelString = exports.LogLevels = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var lang_1 = require("../utils/lang");
-var maps_1 = require("../utils/lang/maps");
 exports.LogLevels = {
     DEBUG: 'DEBUG',
     INFO: 'INFO',
@@ -47,7 +46,7 @@ var defaultOptions = {
 var Logger = /** @class */ (function () {
     function Logger(options, codes) {
         this.options = (0, objectAssign_1.objectAssign)({}, defaultOptions, options);
-        this.codes = codes || new maps_1._Map();
+        this.codes = codes || new Map();
         this.logLevel = LogLevelIndexes[this.options.logLevel];
     }
     Logger.prototype.setLogLevel = function (logLevel) {

package/cjs/readiness/readinessManager.js

@@ -45,14 +45,17 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
         splits.once(constants_1.SDK_SPLITS_CACHE_LOADED, checkIsReadyFromCache);
     // emit SDK_READY_TIMED_OUT
     var hasTimedout = false;
-    var readyTimeoutId;
     function timeout() {
-        if (hasTimedout || isReady)
+        if (hasTimedout)
             return;
         hasTimedout = true;
         syncLastUpdate();
         gate.emit(constants_1.SDK_READY_TIMED_OUT, 'Split SDK emitted SDK_READY_TIMED_OUT event.');
     }
+    var readyTimeoutId;
+    if (readyTimeout > 0) {
+        readyTimeoutId = setTimeout(timeout, readyTimeout);
+    }
     // emit SDK_READY and SDK_UPDATE
     var isReady = false;
     splits.on(constants_1.SDK_SPLITS_ARRIVED, checkIsReadyOrUpdate);
@@ -113,11 +116,6 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
         // Called on 403 error (client-side SDK key on server-side), to set the SDK as destroyed for
         // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
         setDestroyed: function () { isDestroyed = true; },
-        init: function () {
-            if (readyTimeout > 0) {
-                readyTimeoutId = setTimeout(timeout, readyTimeout);
-            }
-        },
         destroy: function () {
             isDestroyed = true;
             syncLastUpdate();

package/cjs/sdkClient/clientCS.js

@@ -4,16 +4,15 @@ exports.clientCSDecorator = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var clientAttributesDecoration_1 = require("./clientAttributesDecoration");
 /**
- * Decorator that binds a key and (optionally) a traffic type to client methods
+ * Decorator that binds a key to client methods
  *
  * @param client sync client instance
  * @param key validated split key
- * @param trafficType validated traffic type
  */
-function clientCSDecorator(log, client, key, trafficType) {
+function clientCSDecorator(log, client, key) {
     var clientCS = (0, clientAttributesDecoration_1.clientAttributesDecoration)(log, client);
     return (0, objectAssign_1.objectAssign)(clientCS, {
-        // In the client-side API, we bind a key to the client `getTreatment*` methods
+        // In the client-side API, we bind a key to the client `getTreatment*` and `track` methods
         getTreatment: clientCS.getTreatment.bind(clientCS, key),
         getTreatmentWithConfig: clientCS.getTreatmentWithConfig.bind(clientCS, key),
         getTreatments: clientCS.getTreatments.bind(clientCS, key),
@@ -22,12 +21,10 @@ function clientCSDecorator(log, client, key, trafficType) {
         getTreatmentsWithConfigByFlagSets: clientCS.getTreatmentsWithConfigByFlagSets.bind(clientCS, key),
         getTreatmentsByFlagSet: clientCS.getTreatmentsByFlagSet.bind(clientCS, key),
         getTreatmentsWithConfigByFlagSet: clientCS.getTreatmentsWithConfigByFlagSet.bind(clientCS, key),
-        // Key is bound to the `track` method. Same thing happens with trafficType but only if provided
-        track: trafficType ? clientCS.track.bind(clientCS, key, trafficType) : clientCS.track.bind(clientCS, key),
+        track: clientCS.track.bind(clientCS, key),
         // Not part of the public API. These properties are used to support other modules (e.g., Split Suite)
         isClientSide: true,
-        key: key,
-        trafficType: trafficType
+        key: key
     });
 }
 exports.clientCSDecorator = clientCSDecorator;

package/cjs/sdkClient/sdkClientMethodCS.js

@@ -14,7 +14,7 @@ var identity_1 = require("./identity");
  * Therefore, clients don't have a bound TT for the track method.
  */
 function sdkClientMethodCSFactory(params) {
-    var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log, whenInit = params.whenInit;
+    var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log;
     var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key);
     var parsedDefaultKey = (0, key_2.keyParser)(key);
     var defaultInstanceId = (0, identity_1.buildInstanceId)(parsedDefaultKey);
@@ -25,7 +25,7 @@ function sdkClientMethodCSFactory(params) {
             log.debug(constants_1.RETRIEVE_CLIENT_DEFAULT);
             return mainClientInstance;
         }
-        // Validate the key value. The trafficType (2nd argument) is ignored
+        // Validate the key value
         var validKey = (0, key_1.validateKey)(log, key, constants_1.LOG_PREFIX_CLIENT_INSTANTIATION);
         if (validKey === false) {
             throw new Error('Shared Client needs a valid key.');
@@ -47,18 +47,15 @@ function sdkClientMethodCSFactory(params) {
             // - Consumer mode: both syncManager and sharedSyncManager are undefined
             // - Consumer partial mode: syncManager is defined (only for submitters) but sharedSyncManager is undefined
             // @ts-ignore
-            var sharedSyncManager_1 = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
+            var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
             // As shared clients reuse all the storage information, we don't need to check here if we
             // will use offline or online mode. We should stick with the original decision.
             clients[instanceId] = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)((0, objectAssign_1.objectAssign)({}, params, {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
-                syncManager: sharedSyncManager_1,
+                syncManager: sharedSyncManager,
             }), true), validKey);
-            whenInit(function () {
-                sharedSdkReadiness_1.readinessManager.init();
-                sharedSyncManager_1 && sharedSyncManager_1.start();
-            });
+            sharedSyncManager && sharedSyncManager.start();
             log.info(constants_1.NEW_SHARED_CLIENT);
         }
         else {

package/cjs/sdkFactory/index.js

@@ -19,19 +19,12 @@ var constants_3 = require("../utils/constants");
  * Modular SDK factory
  */
 function sdkFactory(params) {
-    var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory, filterAdapterFactory = params.filterAdapterFactory, isPure = params.isPure;
+    var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory, filterAdapterFactory = params.filterAdapterFactory;
     var log = settings.log, impressionsMode = settings.sync.impressionsMode;
     // @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid SDK Key, etc.
     // On non-recoverable errors, we should mark the SDK as destroyed and not start synchronization.
-    // initialization
-    var isInit = false;
-    var initCallbacks = [];
-    function whenInit(cb) {
-        if (isInit)
-            cb();
-        else
-            initCallbacks.push(cb);
-    }
+    // 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);
     var sdkReadinessManager = (0, sdkReadinessManager_1.sdkReadinessManagerFactory)(platform.EventEmitter, settings);
     var readiness = sdkReadinessManager.readinessManager;
     var storage = storageFactory({
@@ -45,10 +38,8 @@ function sdkFactory(params) {
             readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
             readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
         },
-        onReadyFromCacheCb: function () {
-            readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED);
-        }
     });
+    // @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
     var clients = {};
     var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);
     var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
@@ -65,11 +56,11 @@ function sdkFactory(params) {
         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);
+    var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
+    var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager, storage.telemetry);
     // splitApi is used by SyncManager and Browser signal listener
     var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
-    var ctx = { clients: clients, splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform, whenInit: whenInit };
+    var ctx = { clients: clients, splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
     var syncManager = syncManagerFactory && syncManagerFactory(ctx);
     ctx.syncManager = syncManager;
     var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
@@ -77,22 +68,8 @@ function sdkFactory(params) {
     // SDK client and manager
     var clientMethod = sdkClientMethodFactory(ctx);
     var managerInstance = sdkManagerFactory(settings, storage.splits, sdkReadinessManager);
-    function init() {
-        if (isInit)
-            return;
-        isInit = true;
-        // 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();
-        storage.init && storage.init();
-        uniqueKeysTracker && uniqueKeysTracker.start();
-        syncManager && syncManager.start();
-        signalListener && signalListener.start();
-        initCallbacks.forEach(function (cb) { return cb(); });
-        initCallbacks.length = 0;
-    }
-    if (!isPure)
-        init();
+    syncManager && syncManager.start();
+    signalListener && signalListener.start();
     log.info(constants_1.NEW_FACTORY);
     // @ts-ignore
     return (0, objectAssign_1.objectAssign)({
@@ -109,6 +86,6 @@ function sdkFactory(params) {
         destroy: function () {
             return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
         }
-    }, extraProps && extraProps(ctx), isPure && { init: init });
+    }, extraProps && extraProps(ctx));
 }
 exports.sdkFactory = sdkFactory;

package/cjs/services/decorateHeaders.js

@@ -2,8 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.decorateHeaders = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
-var sets_1 = require("../utils/lang/sets");
-var FORBIDDEN_HEADERS = new sets_1._Set([
+var FORBIDDEN_HEADERS = new Set([
     'splitsdkclientkey',
     'splitsdkversion',
     'splitsdkmachineip',

package/cjs/storages/AbstractSplitsCacheAsync.js

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

package/cjs/storages/AbstractSplitsCacheSync.js

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

package/cjs/storages/KeyBuilderCS.js

@@ -23,12 +23,6 @@ var KeyBuilderCS = /** @class */ (function (_super) {
         if ((0, lang_1.startsWith)(builtSegmentKeyName, prefix))
             return builtSegmentKeyName.substr(prefix.length);
     };
-    // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
-    KeyBuilderCS.prototype.extractOldSegmentKey = function (builtSegmentKeyName) {
-        var prefix = this.matchingKey + "." + this.prefix + ".segment.";
-        if ((0, lang_1.startsWith)(builtSegmentKeyName, prefix))
-            return builtSegmentKeyName.substr(prefix.length);
-    };
     KeyBuilderCS.prototype.buildLastUpdatedKey = function () {
         return this.prefix + ".splits.lastUpdated";
     };
@@ -51,9 +45,6 @@ function myLargeSegmentsKeyBuilder(prefix, matchingKey) {
             if ((0, lang_1.startsWith)(builtSegmentKeyName, p))
                 return builtSegmentKeyName.substr(p.length);
         },
-        extractOldSegmentKey: function () {
-            return undefined;
-        },
         buildTillKey: function () {
             return prefix + "." + matchingKey + ".largeSegments.till";
         }

package/cjs/storages/dataLoader.js

@@ -1,83 +1,51 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSnapshot = exports.loadData = void 0;
-var sets_1 = require("../utils/lang/sets");
-var key_1 = require("../utils/key");
+exports.dataLoaderFactory = void 0;
+var browser_1 = require("../utils/constants/browser");
 /**
- * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
- * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
+ * Factory of client-side storage loader
  *
- * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader and extended with a `mySegmentsData` property.
- * @param storage object containing `splits` and `segments` cache (client-side variant)
- * @param userKey user key (matching key) of the provided MySegmentsCache
- *
- * @TODO extend to load largeSegments
- * @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
- * @TODO add logs, and input validation in this module, in favor of size reduction.
- * @TODO unit tests
+ * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
+ * and extended with a `mySegmentsData` property.
+ * @returns function to preload the storage
  */
-function loadData(preloadedData, storage, matchingKey) {
-    // Do not load data if current preloadedData is empty
-    if (Object.keys(preloadedData).length === 0)
-        return;
-    var _a = preloadedData.segmentsData, segmentsData = _a === void 0 ? {} : _a, _b = preloadedData.since, since = _b === void 0 ? -1 : _b, _c = preloadedData.splitsData, splitsData = _c === void 0 ? [] : _c;
-    if (storage.splits) {
+function dataLoaderFactory(preloadedData) {
+    /**
+     * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
+     * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
+     *
+     * @param storage object containing `splits` and `segments` cache (client-side variant)
+     * @param userId user key string of the provided MySegmentsCache
+     *
+     * @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
+     * @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
+     */
+    return function loadData(storage, userId) {
+        // Do not load data if current preloadedData is empty
+        if (Object.keys(preloadedData).length === 0)
+            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();
-        // Do not load data if current data is more recent
-        if (storedSince > since)
+        var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
+        // Do not load data if current localStorage data is more recent,
+        // or if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
+        if (storedSince > since || lastUpdated < expirationTimestamp)
             return;
         // cleaning up the localStorage data, since some cached splits might need be part of the preloaded data
         storage.splits.clear();
         storage.splits.setChangeNumber(since);
         // splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
-        storage.splits.addSplits(splitsData.map(function (split) { return ([split.name, split]); }));
-    }
-    if (matchingKey) { // add mySegments data (client-side)
-        var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[matchingKey];
+        storage.splits.addSplits(Object.keys(splitsData).map(function (splitName) { return JSON.parse(splitsData[splitName]); }));
+        // add mySegments data
+        var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userId];
         if (!mySegmentsData) {
             // segmentsData in an object where the property is the segment name and the pertaining value is a stringified object that contains the `added` array of userIds
             mySegmentsData = Object.keys(segmentsData).filter(function (segmentName) {
-                var matchingKeys = segmentsData[segmentName];
-                return matchingKeys.indexOf(matchingKey) > -1;
+                var userIds = JSON.parse(segmentsData[segmentName]).added;
+                return Array.isArray(userIds) && userIds.indexOf(userId) > -1;
             });
         }
         storage.segments.resetSegments({ k: mySegmentsData.map(function (s) { return ({ n: s }); }) });
-    }
-    else { // add segments data (server-side)
-        Object.keys(segmentsData).filter(function (segmentName) {
-            var matchingKeys = segmentsData[segmentName];
-            storage.segments.addToSegment(segmentName, matchingKeys);
-        });
-    }
-}
-exports.loadData = loadData;
-function getSnapshot(storage, userKeys) {
-    return {
-        // lastUpdated: Date.now(),
-        since: storage.splits.getChangeNumber(),
-        splitsData: storage.splits.getAll(),
-        segmentsData: userKeys ?
-            undefined : // @ts-ignore accessing private prop
-            Object.keys(storage.segments.segmentCache).reduce(function (prev, cur) {
-                prev[cur] = (0, sets_1.setToArray)(storage.segments.segmentCache[cur]);
-                return prev;
-            }, {}),
-        mySegmentsData: userKeys ?
-            userKeys.reduce(function (prev, userKey) {
-                prev[(0, key_1.getMatching)(userKey)] = storage.shared ?
-                    // Client-side segments
-                    // @ts-ignore accessing private prop
-                    Object.keys(storage.shared(userKey).segments.segmentCache) :
-                    // Server-side segments
-                    // @ts-ignore accessing private prop
-                    Object.keys(storage.segments.segmentCache).reduce(function (prev, segmentName) {
-                        return storage.segments.segmentCache[segmentName].has(userKey) ?
-                            prev.concat(segmentName) :
-                            prev;
-                    }, []);
-                return prev;
-            }, {}) :
-            undefined
     };
 }
-exports.getSnapshot = getSnapshot;
+exports.dataLoaderFactory = dataLoaderFactory;

package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js

@@ -48,28 +48,8 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
         // Scan current values from localStorage
         return Object.keys(localStorage).reduce(function (accum, key) {
             var segmentName = _this.keys.extractSegmentName(key);
-            if (segmentName) {
+            if (segmentName)
                 accum.push(segmentName);
-            }
-            else {
-                // @TODO @BREAKING: This is only to clean up "old" keys. Remove this whole else code block
-                segmentName = _this.keys.extractOldSegmentKey(key);
-                if (segmentName) { // this was an old segment key, let's clean up.
-                    var newSegmentKey = _this.keys.buildSegmentNameKey(segmentName);
-                    try {
-                        // If the new format key is not there, create it.
-                        if (!localStorage.getItem(newSegmentKey)) {
-                            localStorage.setItem(newSegmentKey, constants_1.DEFINED);
-                            // we are migrating a segment, let's track it.
-                            accum.push(segmentName);
-                        }
-                        localStorage.removeItem(key); // we migrated the current key, let's delete it.
-                    }
-                    catch (e) {
-                        _this.log.error(e);
-                    }
-                }
-            }
             return accum;
         }, []);
     };

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -5,7 +5,6 @@ var tslib_1 = require("tslib");
 var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
 var lang_1 = require("../../utils/lang");
 var constants_1 = require("./constants");
-var sets_1 = require("../../utils/lang/sets");
 var KeyBuilder_1 = require("../KeyBuilder");
 /**
  * ISplitsCacheSync implementation that stores split definitions in browser LocalStorage.
@@ -186,6 +185,14 @@ 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`,
      *
@@ -208,7 +215,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
                 // mark cache to update the new query filter on first successful splits fetch
                 this.updateNewFilter = true;
                 // if there is cache, clear it
-                if (this.getChangeNumber() > -1)
+                if (this.checkCache())
                     this.clear();
             }
             catch (e) {
@@ -222,7 +229,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         return flagSets.map(function (flagSet) {
             var flagSetKey = _this.keys.buildFlagSetKey(flagSet);
             var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
-            return new sets_1._Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
+            return new Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
         });
     };
     SplitsCacheInLocal.prototype.addToFlagSets = function (featureFlag) {
@@ -234,9 +241,9 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
                 return;
             var flagSetKey = _this.keys.buildFlagSetKey(featureFlagSet);
             var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
-            var flagSetCache = new sets_1._Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
+            var flagSetCache = new Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
             flagSetCache.add(featureFlag.name);
-            localStorage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
+            localStorage.setItem(flagSetKey, JSON.stringify(Array.from(flagSetCache)));
         });
     };
     SplitsCacheInLocal.prototype.removeFromFlagSets = function (featureFlagName, flagSets) {
@@ -252,13 +259,13 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
         if (!flagSetFromLocalStorage)
             return;
-        var flagSetCache = new sets_1._Set(JSON.parse(flagSetFromLocalStorage));
+        var flagSetCache = new Set(JSON.parse(flagSetFromLocalStorage));
         flagSetCache.delete(featureFlagName);
         if (flagSetCache.size === 0) {
             localStorage.removeItem(flagSetKey);
             return;
         }
-        localStorage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
+        localStorage.setItem(flagSetKey, JSON.stringify(Array.from(flagSetCache)));
     };
     return SplitsCacheInLocal;
 }(AbstractSplitsCacheSync_1.AbstractSplitsCacheSync));