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

package/esm/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -2,21 +2,17 @@ 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, expirationTimestamp) {
+    function SplitsCacheInLocal(settings, keys) {
         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) {
@@ -64,7 +60,6 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
      * We cannot simply call `localStorage.clear()` since that implies removing user items from the storage.
      */
     SplitsCacheInLocal.prototype.clear = function () {
-        this.log.info(LOG_PREFIX + 'Flushing Splits data from localStorage');
         // collect item keys
         var len = localStorage.length;
         var accum = [];
@@ -116,18 +111,6 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         return item && JSON.parse(item);
     };
     SplitsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
-        // when using a new split query, we must update it at the store
-        if (this.updateNewFilter) {
-            this.log.info(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
@@ -178,45 +161,6 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             return true;
         }
     };
-    /**
-     * Check if the splits information is already stored in browser LocalStorage.
-     * In this function we could add more code to check if the data is valid.
-     * @override
-     */
-    SplitsCacheInLocal.prototype.checkCache = function () {
-        return this.getChangeNumber() > -1;
-    };
-    /**
-     * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
-     *
-     * @param expirationTimestamp - if the value is not a number, data will not be cleaned
-     */
-    SplitsCacheInLocal.prototype._checkExpiration = function (expirationTimestamp) {
-        var value = localStorage.getItem(this.keys.buildLastUpdatedKey());
-        if (value !== null) {
-            value = parseInt(value, 10);
-            if (!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 { DEBUG, NONE, 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,8 +28,7 @@ export function InLocalStorage(options) {
         var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, impressionsMode = _a.sync.impressionsMode;
         var matchingKey = getMatching(settings.core.key);
         var keys = new KeyBuilderCS(prefix, matchingKey);
-        var expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
-        var splits = new SplitsCacheInLocal(settings, keys, expirationTimestamp);
+        var splits = new SplitsCacheInLocal(settings, keys);
         var segments = new MySegmentsCacheInLocal(log, keys);
         var largeSegments = new MySegmentsCacheInLocal(log, myLargeSegmentsKeyBuilder(prefix, matchingKey));
         return {
@@ -41,6 +40,9 @@ export function InLocalStorage(options) {
             events: new EventsCacheInMemory(eventsQueueSize),
             telemetry: shouldRecordTelemetry(params) ? new TelemetryCacheInMemory(splits, segments) : undefined,
             uniqueKeys: impressionsMode === NONE ? new UniqueKeysCacheInMemoryCS() : undefined,
+            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/inLocalStorage/validateCache.js

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

package/esm/storages/pluggable/index.js

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

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

@@ -43,9 +43,10 @@ export function fromObjectUpdaterFactory(splitsParser, storage, readiness, setti
                 readiness.splits.emit(SDK_SPLITS_ARRIVED);
                 if (startingUp) {
                     startingUp = false;
-                    Promise.resolve(splitsCache.checkCache()).then(function (cacheReady) {
+                    var isCacheLoaded_1 = storage.validateCache ? storage.validateCache() : false;
+                    Promise.resolve().then(function () {
                         // Emits SDK_READY_FROM_CACHE
-                        if (cacheReady)
+                        if (isCacheLoaded_1)
                             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, SDK_SPLITS_CACHE_LOADED } from '../../../readiness/constants';
+import { SDK_SPLITS_ARRIVED } 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]);
-            var fetcherPromise = Promise.resolve(splitUpdateNotification ?
+            return Promise.resolve(splitUpdateNotification ?
                 { splits: [splitUpdateNotification.payload], till: splitUpdateNotification.changeNumber } :
                 splitChangesFetcher(since, noCache, till, _promiseDecorator))
                 .then(function (splitChanges) {
@@ -165,15 +165,6 @@ 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);

package/esm/sync/streaming/pushManager.js

@@ -306,12 +306,14 @@ export function pushManagerFactory(params, pollingManager) {
                 // Reconnects in case of a new client.
                 // Run in next event-loop cycle to save authentication calls
                 // in case multiple clients are created in the current cycle.
-                setTimeout(function checkForReconnect() {
-                    if (connectForNewClient) {
-                        connectForNewClient = false;
-                        connectPush();
-                    }
-                }, 0);
+                if (this.isRunning()) {
+                    setTimeout(function checkForReconnect() {
+                        if (connectForNewClient) {
+                            connectForNewClient = false;
+                            connectPush();
+                        }
+                    }, 0);
+                }
             }
         },
         // [Only for client-side]

package/esm/sync/syncManagerOnline.js

@@ -3,6 +3,7 @@ import { PUSH_SUBSYSTEM_UP, PUSH_SUBSYSTEM_DOWN } from './streaming/constants';
 import { SYNC_START_POLLING, SYNC_CONTINUE_POLLING, SYNC_STOP_POLLING } from '../logger/constants';
 import { isConsentGranted } from '../consent';
 import { POLLING, STREAMING, SYNC_MODE_UPDATE } from '../utils/constants';
+import { SDK_SPLITS_CACHE_LOADED } from '../readiness/constants';
 /**
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.
@@ -16,7 +17,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
      * 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;
+        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;
         /** Polling Manager */
         var pollingManager = pollingManagerFactory && pollingManagerFactory(params);
         /** Push Manager */
@@ -64,6 +65,11 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
              */
             start: function () {
                 running = true;
+                if (startFirstTime) {
+                    var isCacheLoaded = storage.validateCache ? storage.validateCache() : false;
+                    if (isCacheLoaded)
+                        Promise.resolve().then(function () { readiness.splits.emit(SDK_SPLITS_CACHE_LOADED); });
+                }
                 // start syncing splits and segments
                 if (pollingManager) {
                     // If synchronization is disabled pushManager and pollingManager should not start
@@ -72,7 +78,6 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                             // Doesn't call `syncAll` when the syncManager is resuming
                             if (startFirstTime) {
                                 pollingManager.syncAll();
-                                startFirstTime = false;
                             }
                             pushManager.start();
                         }
@@ -83,12 +88,12 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                     else {
                         if (startFirstTime) {
                             pollingManager.syncAll();
-                            startFirstTime = false;
                         }
                     }
                 }
                 // start periodic data recording (events, impressions, telemetry).
                 submitterManager.start(!isConsentGranted(settings));
+                startFirstTime = false;
             },
             /**
              * Method used to stop/pause the syncManager.
@@ -115,6 +120,8 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                 if (!pollingManager)
                     return;
                 var mySegmentsSyncTask = pollingManager.add(matchingKey, readinessManager, storage);
+                if (syncEnabled && pushManager)
+                    pushManager.add(matchingKey, mySegmentsSyncTask);
                 if (running) {
                     if (syncEnabled) {
                         if (pushManager) {
@@ -128,7 +135,6 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                                 // of segments since `syncAll` was already executed when starting the main client
                                 mySegmentsSyncTask.execute();
                             }
-                            pushManager.add(matchingKey, mySegmentsSyncTask);
                         }
                         else {
                             if (storage.splits.usesSegments())

package/esm/trackers/eventTracker.js

@@ -22,7 +22,7 @@ export function eventTrackerFactory(settings, eventsCache, whenInit, integration
                 whenInit(function () {
                     // Wrap in a timeout because we don't want it to be blocking.
                     setTimeout(function () {
-                        // copy of event, to avoid unexpected behaviour if modified by integrations
+                        // copy of event, to avoid unexpected behavior if modified by integrations
                         var eventDataCopy = objectAssign({}, eventData);
                         if (properties)
                             eventDataCopy.properties = objectAssign({}, properties);

package/esm/trackers/impressionsTracker.js

@@ -43,7 +43,7 @@ export function impressionsTrackerFactory(settings, impressionsCache, strategy,
             if (impressionListener || integrationsManager) {
                 var _loop_1 = function (i) {
                     var impressionData = {
-                        // copy of impression, to avoid unexpected behaviour if modified by integrations or impressionListener
+                        // copy of impression, to avoid unexpected behavior if modified by integrations or impressionListener
                         impression: objectAssign({}, impressionsToListener[i]),
                         attributes: attributes,
                         ip: ip,

package/esm/utils/settingsValidation/index.js

@@ -136,7 +136,7 @@ export function settingsValidation(config, validationParams) {
             withDefaults.core.key = 'localhost_key';
         }
         else {
-            // Keeping same behaviour than JS SDK: if settings key or TT are invalid,
+            // Keeping same behavior than JS SDK: if settings key or TT are invalid,
             // `false` value is used as bound key/TT of the default client, which leads to some issues.
             // @ts-ignore, @TODO handle invalid keys as a non-recoverable error?
             withDefaults.core.key = validateKey(log, maybeKey, LOG_PREFIX_CLIENT_INSTANTIATION);

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

@@ -3,7 +3,7 @@ import { ERROR_STORAGE_INVALID } from '../../../logger/constants';
 import { LOCALHOST_MODE, STANDALONE_MODE, STORAGE_PLUGGABLE, STORAGE_LOCALSTORAGE, STORAGE_MEMORY } from '../../../utils/constants';
 export function __InLocalStorageMockFactory(params) {
     var result = InMemoryStorageCSFactory(params);
-    result.splits.checkCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
+    result.validateCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
     return result;
 }
 __InLocalStorageMockFactory.type = STORAGE_MEMORY;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "2.0.2",
+  "version": "2.1.0-rc.0",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/listeners/node.ts

@@ -56,7 +56,7 @@ export class NodeSignalListener implements ISignalListener {
       // Cleaned up, remove handlers.
       this.stop();
 
-      // This handler prevented the default behaviour, start again.
+      // This handler prevented the default behavior, start again.
       // eslint-disable-next-line no-undef
       process.kill(process.pid, SIGTERM);
     };
@@ -72,7 +72,7 @@ export class NodeSignalListener implements ISignalListener {
     }
 
     if (thenable(handlerResult)) {
-      // Always exit, even with errors. The promise is returned for UT purposses.
+      // Always exit, even with errors. The promise is returned for UT purposes.
       return handlerResult.then(wrapUp).catch(wrapUp);
     } else {
       wrapUp();

package/src/storages/AbstractSplitsCacheAsync.ts

@@ -27,14 +27,6 @@ export abstract class AbstractSplitsCacheAsync implements ISplitsCacheAsync {
     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.
-   */
-  checkCache(): Promise<boolean> {
-    return Promise.resolve(false);
-  }
-
   /**
    * Kill `name` split and set `defaultTreatment` and `changeNumber`.
    * Used for SPLIT_KILL push notifications.

package/src/storages/AbstractSplitsCacheSync.ts

@@ -47,14 +47,6 @@ export abstract class AbstractSplitsCacheSync implements ISplitsCacheSync {
 
   abstract clear(): void
 
-  /**
-   * 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.
-   */
-  checkCache(): boolean {
-    return false;
-  }
-
   /**
    * Kill `name` split and set `defaultTreatment` and `changeNumber`.
    * Used for SPLIT_KILL push notifications.

package/src/storages/KeyBuilderCS.ts

@@ -43,6 +43,10 @@ export class KeyBuilderCS extends KeyBuilder implements MySegmentsKeyBuilder {
   buildTillKey() {
     return `${this.prefix}.${this.matchingKey}.segments.till`;
   }
+
+  buildLastClear() {
+    return `${this.prefix}.lastClear`;
+  }
 }
 
 export function myLargeSegmentsKeyBuilder(prefix: string, matchingKey: string): MySegmentsKeyBuilder {

package/src/storages/dataLoader.ts

@@ -1,7 +1,9 @@
 import { PreloadedData } from '../types';
-import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../utils/constants/browser';
 import { DataLoader, ISegmentsCacheSync, ISplitsCacheSync } from './types';
 
+// This value might be eventually set via a config parameter
+const DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days
+
 /**
  * Factory of client-side storage loader
  *

package/src/storages/inLocalStorage/SplitsCacheInLocal.ts

@@ -5,7 +5,6 @@ import { KeyBuilderCS } from '../KeyBuilderCS';
 import { ILogger } from '../../logger/types';
 import { LOG_PREFIX } from './constants';
 import { ISettings } from '../../types';
-import { getStorageHash } from '../KeyBuilder';
 import { setToArray } from '../../utils/lang/sets';
 
 /**
@@ -15,21 +14,14 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
 
   private readonly keys: KeyBuilderCS;
   private readonly log: ILogger;
-  private readonly storageHash: string;
   private readonly flagSetsFilter: string[];
   private hasSync?: boolean;
-  private updateNewFilter?: boolean;
 
-  constructor(settings: ISettings, keys: KeyBuilderCS, expirationTimestamp?: number) {
+  constructor(settings: ISettings, keys: KeyBuilderCS) {
     super();
     this.keys = keys;
     this.log = settings.log;
-    this.storageHash = getStorageHash(settings);
     this.flagSetsFilter = settings.sync.__splitFiltersValidation.groupedFilters.bySet;
-
-    this._checkExpiration(expirationTimestamp);
-
-    this._checkFilterQuery();
   }
 
   private _decrementCount(key: string) {
@@ -79,8 +71,6 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
    * We cannot simply call `localStorage.clear()` since that implies removing user items from the storage.
    */
   clear() {
-    this.log.info(LOG_PREFIX + 'Flushing Splits data from localStorage');
-
     // collect item keys
     const len = localStorage.length;
     const accum = [];
@@ -138,19 +128,6 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
   }
 
   setChangeNumber(changeNumber: number): boolean {
-
-    // 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');
-      const 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
@@ -212,48 +189,6 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
     }
   }
 
-  /**
-   * 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
-   */
-  checkCache(): boolean {
-    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
-   */
-  private _checkExpiration(expirationTimestamp?: number) {
-    let value: string | number | null = 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
-  private _checkFilterQuery() {
-    const storageHashKey = this.keys.buildHashKey();
-    const 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
-  }
-
   getNamesByFlagSets(flagSets: string[]): Set<string>[] {
     return flagSets.map(flagSet => {
       const flagSetKey = this.keys.buildFlagSetKey(flagSet);

package/src/storages/inLocalStorage/index.ts

@@ -7,22 +7,19 @@ 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 { DEBUG, NONE, STORAGE_LOCALSTORAGE } from '../../utils/constants';
 import { shouldRecordTelemetry, TelemetryCacheInMemory } from '../inMemory/TelemetryCacheInMemory';
 import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
 import { getMatching } from '../../utils/key';
-
-export interface InLocalStorageOptions {
-  prefix?: string
-}
+import { validateCache } from './validateCache';
+import SplitIO from '../../../types/splitio';
 
 /**
  * InLocal storage factory for standalone client-side SplitFactory
  */
-export function InLocalStorage(options: InLocalStorageOptions = {}): IStorageSyncFactory {
+export function InLocalStorage(options: SplitIO.InLocalStorageOptions = {}): IStorageSyncFactory {
 
   const prefix = validatePrefix(options.prefix);
 
@@ -37,9 +34,8 @@ export function InLocalStorage(options: InLocalStorageOptions = {}): IStorageSyn
     const { settings, settings: { log, scheduler: { impressionsQueueSize, eventsQueueSize, }, sync: { impressionsMode } } } = params;
     const matchingKey = getMatching(settings.core.key);
     const keys = new KeyBuilderCS(prefix, matchingKey);
-    const expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
 
-    const splits = new SplitsCacheInLocal(settings, keys, expirationTimestamp);
+    const splits = new SplitsCacheInLocal(settings, keys);
     const segments = new MySegmentsCacheInLocal(log, keys);
     const largeSegments = new MySegmentsCacheInLocal(log, myLargeSegmentsKeyBuilder(prefix, matchingKey));
 
@@ -53,6 +49,10 @@ export function InLocalStorage(options: InLocalStorageOptions = {}): IStorageSyn
       telemetry: shouldRecordTelemetry(params) ? new TelemetryCacheInMemory(splits, segments) : undefined,
       uniqueKeys: impressionsMode === NONE ? new UniqueKeysCacheInMemoryCS() : undefined,
 
+      validateCache() {
+        return validateCache(options, settings, keys, splits, segments, largeSegments);
+      },
+
       destroy() { },
 
       // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).