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

package/CHANGES.txt

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

package/cjs/readiness/readinessManager.js

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

package/cjs/storages/AbstractSplitsCacheAsync.js

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

package/cjs/storages/AbstractSplitsCacheSync.js

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

package/cjs/storages/KeyBuilderCS.js

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

package/cjs/storages/dataLoader.js

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

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

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

package/cjs/storages/inLocalStorage/index.js

@@ -9,13 +9,13 @@ var KeyBuilderCS_1 = require("../KeyBuilderCS");
 var isLocalStorageAvailable_1 = require("../../utils/env/isLocalStorageAvailable");
 var SplitsCacheInLocal_1 = require("./SplitsCacheInLocal");
 var MySegmentsCacheInLocal_1 = require("./MySegmentsCacheInLocal");
+var browser_1 = require("../../utils/constants/browser");
 var InMemoryStorageCS_1 = require("../inMemory/InMemoryStorageCS");
 var constants_1 = require("./constants");
 var constants_2 = require("../../utils/constants");
 var TelemetryCacheInMemory_1 = require("../inMemory/TelemetryCacheInMemory");
 var UniqueKeysCacheInMemoryCS_1 = require("../inMemory/UniqueKeysCacheInMemoryCS");
 var key_1 = require("../../utils/key");
-var validateCache_1 = require("./validateCache");
 /**
  * InLocal storage factory for standalone client-side SplitFactory
  */
@@ -31,7 +31,8 @@ function InLocalStorage(options) {
         var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize;
         var matchingKey = (0, key_1.getMatching)(settings.core.key);
         var keys = new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey);
-        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys);
+        var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
+        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys, expirationTimestamp);
         var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys);
         var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey));
         return {
@@ -43,9 +44,6 @@ function InLocalStorage(options) {
             events: new EventsCacheInMemory_1.EventsCacheInMemory(eventsQueueSize),
             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, segments, largeSegments);
-            },
             destroy: function () { },
             // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
             shared: function (matchingKey) {

package/cjs/storages/inRedis/constants.js

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

package/cjs/storages/pluggable/index.js

@@ -74,8 +74,7 @@ function PluggableStorage(options) {
         // Connects to wrapper and emits SDK_READY event on main client
         var connectPromise = wrapper.connect().then(function () {
             if (isSynchronizer) {
-                // @TODO reuse InLocalStorage::validateCache logic
-                // In standalone or producer mode, clear storage if SDK key, flags filter criteria or flags spec version was modified
+                // In standalone or producer mode, clear storage if SDK key or feature flag filter has changed
                 return wrapper.get(keys.buildHashKey()).then(function (hash) {
                     var currentHash = (0, KeyBuilder_1.getStorageHash)(settings);
                     if (hash !== currentHash) {

package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js

@@ -46,10 +46,9 @@ function fromObjectUpdaterFactory(splitsParser, storage, readiness, settings) {
                 readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
                 if (startingUp) {
                     startingUp = false;
-                    var isCacheLoaded_1 = storage.validateCache ? storage.validateCache() : false;
-                    Promise.resolve().then(function () {
+                    Promise.resolve(splitsCache.checkCache()).then(function (cacheReady) {
                         // Emits SDK_READY_FROM_CACHE
-                        if (isCacheLoaded_1)
+                        if (cacheReady)
                             readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED);
                         // Emits SDK_READY
                         readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);

package/cjs/sync/polling/updaters/splitChangesUpdater.js

@@ -126,7 +126,7 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments,
         function _splitChangesUpdater(since, retry) {
             if (retry === void 0) { retry = 0; }
             log.debug(constants_2.SYNC_SPLITS_FETCH, [since]);
-            return Promise.resolve(splitUpdateNotification ?
+            var fetcherPromise = Promise.resolve(splitUpdateNotification ?
                 { splits: [splitUpdateNotification.payload], till: splitUpdateNotification.changeNumber } :
                 splitChangesFetcher(since, noCache, till, _promiseDecorator))
                 .then(function (splitChanges) {
@@ -170,6 +170,15 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, segments,
                 }
                 return false;
             });
+            // After triggering the requests, if we have cached splits information let's notify that to emit SDK_READY_FROM_CACHE.
+            // Wrapping in a promise since checkCache can be async.
+            if (splitsEventEmitter && startingUp) {
+                Promise.resolve(splits.checkCache()).then(function (isCacheReady) {
+                    if (isCacheReady)
+                        splitsEventEmitter.emit(constants_1.SDK_SPLITS_CACHE_LOADED);
+                });
+            }
+            return fetcherPromise;
         }
         var sincePromise = Promise.resolve(splits.getChangeNumber()); // `getChangeNumber` never rejects or throws error
         return sincePromise.then(_splitChangesUpdater);

package/cjs/sync/syncManagerOnline.js

@@ -6,7 +6,6 @@ var constants_1 = require("./streaming/constants");
 var constants_2 = require("../logger/constants");
 var consent_1 = require("../consent");
 var constants_3 = require("../utils/constants");
-var constants_4 = require("../readiness/constants");
 /**
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.
@@ -20,7 +19,7 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
      * SyncManager factory for modular SDK
      */
     return function (params) {
-        var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled, syncEnabled = _a.sync.enabled, telemetryTracker = params.telemetryTracker, storage = params.storage, readiness = params.readiness;
+        var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled, syncEnabled = _a.sync.enabled, telemetryTracker = params.telemetryTracker;
         /** Polling Manager */
         var pollingManager = pollingManagerFactory && pollingManagerFactory(params);
         /** Push Manager */
@@ -68,11 +67,6 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
              */
             start: function () {
                 running = true;
-                if (startFirstTime) {
-                    var isCacheLoaded = storage.validateCache ? storage.validateCache() : false;
-                    if (isCacheLoaded)
-                        Promise.resolve().then(function () { readiness.splits.emit(constants_4.SDK_SPLITS_CACHE_LOADED); });
-                }
                 // start syncing splits and segments
                 if (pollingManager) {
                     // If synchronization is disabled pushManager and pollingManager should not start
@@ -81,6 +75,7 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                             // Doesn't call `syncAll` when the syncManager is resuming
                             if (startFirstTime) {
                                 pollingManager.syncAll();
+                                startFirstTime = false;
                             }
                             pushManager.start();
                         }
@@ -91,12 +86,12 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                     else {
                         if (startFirstTime) {
                             pollingManager.syncAll();
+                            startFirstTime = false;
                         }
                     }
                 }
                 // start periodic data recording (events, impressions, telemetry).
                 submitterManager.start(!(0, consent_1.isConsentGranted)(settings));
-                startFirstTime = false;
             },
             /**
              * Method used to stop/pause the syncManager.

package/cjs/trackers/uniqueKeysTracker.js

@@ -8,7 +8,7 @@ var noopFilterAdapter = {
     clear: function () { }
 };
 /**
- * Trackes uniques keys
+ * Tracks uniques keys
  * Unique Keys Tracker will be in charge of checking if the MTK was already sent to the BE in the last period
  * or schedule to be sent; if not it will be added in an internal cache and sent in the next post.
  *

package/cjs/utils/constants/browser.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_CACHE_EXPIRATION_IN_MILLIS = void 0;
+// This value might be eventually set via a config parameter
+exports.DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days

package/cjs/utils/settingsValidation/storage/storageCS.js

@@ -6,7 +6,7 @@ var constants_1 = require("../../../logger/constants");
 var constants_2 = require("../../../utils/constants");
 function __InLocalStorageMockFactory(params) {
     var result = (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
-    result.validateCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
+    result.splits.checkCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
     return result;
 }
 exports.__InLocalStorageMockFactory = __InLocalStorageMockFactory;

package/esm/readiness/readinessManager.js

@@ -1,6 +1,5 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED, SDK_SEGMENTS_ARRIVED, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE, SDK_READY } from './constants';
-import { STORAGE_LOCALSTORAGE } from '../utils/constants';
 function splitsEventEmitterFactory(EventEmitter) {
     var splitsEventEmitter = objectAssign(new EventEmitter(), {
         splitsArrived: false,
@@ -81,7 +80,6 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
         }
     }
     function checkIsReadyOrUpdate(diff) {
-        var _a;
         if (isDestroyed)
             return;
         if (isReady) {
@@ -100,10 +98,6 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
                 isReady = true;
                 try {
                     syncLastUpdate();
-                    if (!isReadyFromCache && ((_a = settings.storage) === null || _a === void 0 ? void 0 : _a.type) === STORAGE_LOCALSTORAGE) {
-                        isReadyFromCache = true;
-                        gate.emit(SDK_READY_FROM_CACHE);
-                    }
                     gate.emit(SDK_READY);
                 }
                 catch (e) {

package/esm/storages/AbstractSplitsCacheAsync.js

@@ -11,6 +11,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/esm/storages/AbstractSplitsCacheSync.js

@@ -27,6 +27,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/esm/storages/KeyBuilderCS.js

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

package/esm/storages/dataLoader.js

@@ -1,5 +1,4 @@
-// This value might be eventually set via a config parameter
-var DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days
+import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../utils/constants/browser';
 /**
  * Factory of client-side storage loader
  *

package/esm/storages/inLocalStorage/SplitsCacheInLocal.js

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

package/esm/storages/inLocalStorage/index.js

@@ -6,13 +6,13 @@ import { KeyBuilderCS, myLargeSegmentsKeyBuilder } from '../KeyBuilderCS';
 import { isLocalStorageAvailable } from '../../utils/env/isLocalStorageAvailable';
 import { SplitsCacheInLocal } from './SplitsCacheInLocal';
 import { MySegmentsCacheInLocal } from './MySegmentsCacheInLocal';
+import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../../utils/constants/browser';
 import { InMemoryStorageCSFactory } from '../inMemory/InMemoryStorageCS';
 import { LOG_PREFIX } from './constants';
 import { STORAGE_LOCALSTORAGE } from '../../utils/constants';
 import { shouldRecordTelemetry, TelemetryCacheInMemory } from '../inMemory/TelemetryCacheInMemory';
 import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
 import { getMatching } from '../../utils/key';
-import { validateCache } from './validateCache';
 /**
  * InLocal storage factory for standalone client-side SplitFactory
  */
@@ -28,7 +28,8 @@ export function InLocalStorage(options) {
         var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize;
         var matchingKey = getMatching(settings.core.key);
         var keys = new KeyBuilderCS(prefix, matchingKey);
-        var splits = new SplitsCacheInLocal(settings, keys);
+        var expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
+        var splits = new SplitsCacheInLocal(settings, keys, expirationTimestamp);
         var segments = new MySegmentsCacheInLocal(log, keys);
         var largeSegments = new MySegmentsCacheInLocal(log, myLargeSegmentsKeyBuilder(prefix, matchingKey));
         return {
@@ -40,9 +41,6 @@ export function InLocalStorage(options) {
             events: new EventsCacheInMemory(eventsQueueSize),
             telemetry: shouldRecordTelemetry(params) ? new TelemetryCacheInMemory(splits, segments) : undefined,
             uniqueKeys: new UniqueKeysCacheInMemoryCS(),
-            validateCache: function () {
-                return validateCache(options, settings, keys, splits, segments, largeSegments);
-            },
             destroy: function () { },
             // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
             shared: function (matchingKey) {

package/esm/storages/inRedis/constants.js

@@ -1,4 +1,4 @@
 export var LOG_PREFIX = 'storage:redis: ';
 export var DEFAULT_CACHE_SIZE = 30000;
-export var REFRESH_RATE = 300000; // 300.000 ms = start after 5 mins
+export var REFRESH_RATE = 300000; // 300000 ms = start after 5 mins
 export var TTL_REFRESH = 3600; // 1hr

package/esm/storages/pluggable/index.js

@@ -71,8 +71,7 @@ export function PluggableStorage(options) {
         // Connects to wrapper and emits SDK_READY event on main client
         var connectPromise = wrapper.connect().then(function () {
             if (isSynchronizer) {
-                // @TODO reuse InLocalStorage::validateCache logic
-                // In standalone or producer mode, clear storage if SDK key, flags filter criteria or flags spec version was modified
+                // 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 = getStorageHash(settings);
                     if (hash !== currentHash) {

package/esm/sync/offline/syncTasks/fromObjectSyncTask.js

@@ -43,10 +43,9 @@ export function fromObjectUpdaterFactory(splitsParser, storage, readiness, setti
                 readiness.splits.emit(SDK_SPLITS_ARRIVED);
                 if (startingUp) {
                     startingUp = false;
-                    var isCacheLoaded_1 = storage.validateCache ? storage.validateCache() : false;
-                    Promise.resolve().then(function () {
+                    Promise.resolve(splitsCache.checkCache()).then(function (cacheReady) {
                         // Emits SDK_READY_FROM_CACHE
-                        if (isCacheLoaded_1)
+                        if (cacheReady)
                             readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
                         // Emits SDK_READY
                         readiness.segments.emit(SDK_SEGMENTS_ARRIVED);

package/esm/sync/polling/updaters/splitChangesUpdater.js

@@ -1,5 +1,5 @@
 import { timeout } from '../../../utils/promise/timeout';
-import { SDK_SPLITS_ARRIVED } from '../../../readiness/constants';
+import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED } from '../../../readiness/constants';
 import { SYNC_SPLITS_FETCH, SYNC_SPLITS_NEW, SYNC_SPLITS_REMOVED, SYNC_SPLITS_SEGMENTS, SYNC_SPLITS_FETCH_FAILS, SYNC_SPLITS_FETCH_RETRY } from '../../../logger/constants';
 import { startsWith } from '../../../utils/lang';
 import { IN_SEGMENT } from '../../../utils/constants';
@@ -121,7 +121,7 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, seg
         function _splitChangesUpdater(since, retry) {
             if (retry === void 0) { retry = 0; }
             log.debug(SYNC_SPLITS_FETCH, [since]);
-            return Promise.resolve(splitUpdateNotification ?
+            var fetcherPromise = Promise.resolve(splitUpdateNotification ?
                 { splits: [splitUpdateNotification.payload], till: splitUpdateNotification.changeNumber } :
                 splitChangesFetcher(since, noCache, till, _promiseDecorator))
                 .then(function (splitChanges) {
@@ -165,6 +165,15 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, splits, seg
                 }
                 return false;
             });
+            // After triggering the requests, if we have cached splits information let's notify that to emit SDK_READY_FROM_CACHE.
+            // Wrapping in a promise since checkCache can be async.
+            if (splitsEventEmitter && startingUp) {
+                Promise.resolve(splits.checkCache()).then(function (isCacheReady) {
+                    if (isCacheReady)
+                        splitsEventEmitter.emit(SDK_SPLITS_CACHE_LOADED);
+                });
+            }
+            return fetcherPromise;
         }
         var sincePromise = Promise.resolve(splits.getChangeNumber()); // `getChangeNumber` never rejects or throws error
         return sincePromise.then(_splitChangesUpdater);