@splitsoftware/splitio-commons 1.12.1-rc.4 → 1.12.1-rc.6

package/CHANGES.txt

@@ -1,4 +1,4 @@
-1.12.0 (December XX, 2023)
+1.12.0 (December 4, 2023)
  - Added support for Flag Sets in "consumer" and "partial consumer" modes for Pluggable and Redis storages.
  - Updated evaluation flow to log a warning when using flag sets that don't contain cached feature flags.
  - Updated Redis adapter to handle timeouts and queueing of some missing commands: 'hincrby', 'popNRaw', and 'pipeline.exec'.

package/cjs/logger/constants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_SPLITS_SEGMENTS = exports.SYNC_SPLITS_REMOVED = exports.SYNC_SPLITS_NEW = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_WHITELIST = exports.ENGINE_MATCHER_STARTS_WITH = exports.ENGINE_MATCHER_STRING_INVALID = exports.ENGINE_MATCHER_STRING = exports.ENGINE_MATCHER_SEGMENT = exports.ENGINE_MATCHER_PART_OF = exports.ENGINE_MATCHER_LESS = exports.ENGINE_MATCHER_GREATER = exports.ENGINE_MATCHER_ENDS_WITH = exports.ENGINE_MATCHER_EQUAL_TO_SET = exports.ENGINE_MATCHER_EQUAL = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_MATCHER_CONTAINS_STRING = exports.ENGINE_MATCHER_CONTAINS_ANY = exports.ENGINE_MATCHER_CONTAINS_ALL = exports.ENGINE_MATCHER_BOOLEAN = exports.ENGINE_MATCHER_BETWEEN = exports.ENGINE_MATCHER_ALL = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
-exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.WARN_FLAGSET_WITHOUT_FLAGS = exports.WARN_FLAGSET_NOT_CONFIGURED = exports.WARN_SPLITS_FILTER_LOWERCASE_SET = exports.WARN_SPLITS_FILTER_INVALID_SET = exports.STREAMING_PARSING_SPLIT_UPDATE = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_SDK_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = void 0;
+exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.WARN_FLAGSET_WITHOUT_FLAGS = exports.WARN_FLAGSET_NOT_CONFIGURED = exports.WARN_LOWERCASE_FLAGSET = exports.WARN_INVALID_FLAGSET = exports.STREAMING_PARSING_SPLIT_UPDATE = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_SDK_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = void 0;
 exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_SETS_FILTER_EXCLUSIVE = exports.ERROR_TOO_MANY_SETS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = void 0;
 /**
  * Message codes used to trim string log messages from commons and client-side API modules,
@@ -100,8 +100,8 @@ exports.WARN_SPLITS_FILTER_EMPTY = 221;
 exports.WARN_SDK_KEY = 222;
 exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
 exports.STREAMING_PARSING_SPLIT_UPDATE = 224;
-exports.WARN_SPLITS_FILTER_INVALID_SET = 225;
-exports.WARN_SPLITS_FILTER_LOWERCASE_SET = 226;
+exports.WARN_INVALID_FLAGSET = 225;
+exports.WARN_LOWERCASE_FLAGSET = 226;
 exports.WARN_FLAGSET_NOT_CONFIGURED = 227;
 exports.WARN_FLAGSET_WITHOUT_FLAGS = 228;
 exports.ERROR_ENGINE_COMBINER_IFELSEIF = 300;

package/cjs/logger/messages/warn.js

@@ -36,7 +36,7 @@ exports.codesWarn = error_1.codesError.concat([
     [c.WARN_SDK_KEY, c.LOG_PREFIX_SETTINGS + ': You already have %s. We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'],
     [c.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching MySegments due to an error processing %s notification: %s'],
     [c.STREAMING_PARSING_SPLIT_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching SplitChanges due to an error processing SPLIT_UPDATE notification: %s'],
-    [c.WARN_SPLITS_FILTER_INVALID_SET, c.LOG_PREFIX_SETTINGS + ': you passed %s, flag set must adhere to the regular expressions %s. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. %s was discarded.'],
-    [c.WARN_SPLITS_FILTER_LOWERCASE_SET, c.LOG_PREFIX_SETTINGS + ': flag set %s should be all lowercase - converting string to lowercase.'],
+    [c.WARN_INVALID_FLAGSET, '%s: you passed %s, flag set must adhere to the regular expressions %s. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. %s was discarded.'],
+    [c.WARN_LOWERCASE_FLAGSET, '%s: flag set %s should be all lowercase - converting string to lowercase.'],
     [c.WARN_FLAGSET_WITHOUT_FLAGS, '%s: you passed %s flag set that does not contain cached feature flag names. Please double check what flag sets are in use in the Split user interface.'],
 ]);

package/cjs/sdkClient/client.js

@@ -9,7 +9,7 @@ var trafficTypeExistence_1 = require("../utils/inputValidation/trafficTypeExiste
 var labels_1 = require("../utils/labels");
 var constants_1 = require("../utils/constants");
 var constants_2 = require("../logger/constants");
-var utils_1 = require("../trackers/impressionObserver/utils");
+var mode_1 = require("../utils/settingsValidation/mode");
 var treatmentNotReady = { treatment: constants_1.CONTROL, label: labels_1.SDK_NOT_READY };
 function treatmentsNotReady(featureFlagNames) {
     var evaluations = {};
@@ -24,6 +24,7 @@ function treatmentsNotReady(featureFlagNames) {
 function clientFactory(params) {
     var readinessManager = params.sdkReadinessManager.readinessManager, storage = params.storage, settings = params.settings, impressionsTracker = params.impressionsTracker, eventTracker = params.eventTracker, telemetryTracker = params.telemetryTracker;
     var log = settings.log, mode = settings.mode;
+    var isAsync = (0, mode_1.isConsumerMode)(mode);
     function getTreatment(key, featureFlagName, attributes, withConfig, methodName) {
         if (withConfig === void 0) { withConfig = false; }
         if (methodName === void 0) { methodName = constants_1.GET_TREATMENT; }
@@ -37,9 +38,9 @@ function clientFactory(params) {
         };
         var evaluation = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
             (0, evaluator_1.evaluateFeature)(log, key, featureFlagName, attributes, storage) :
-            (0, utils_1.isStorageSync)(settings) ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
-                treatmentNotReady :
-                Promise.resolve(treatmentNotReady); // Promisify if async
+            isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
+                Promise.resolve(treatmentNotReady) :
+                treatmentNotReady;
         return (0, thenable_1.thenable)(evaluation) ? evaluation.then(function (res) { return wrapUp(res); }) : wrapUp(evaluation);
     }
     function getTreatmentWithConfig(key, featureFlagName, attributes) {
@@ -61,9 +62,9 @@ function clientFactory(params) {
         };
         var evaluations = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
             (0, evaluator_1.evaluateFeatures)(log, key, featureFlagNames, attributes, storage) :
-            (0, utils_1.isStorageSync)(settings) ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
-                treatmentsNotReady(featureFlagNames) :
-                Promise.resolve(treatmentsNotReady(featureFlagNames)); // Promisify if async
+            isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
+                Promise.resolve(treatmentsNotReady(featureFlagNames)) :
+                treatmentsNotReady(featureFlagNames);
         return (0, thenable_1.thenable)(evaluations) ? evaluations.then(function (res) { return wrapUp(res); }) : wrapUp(evaluations);
     }
     function getTreatmentsWithConfig(key, featureFlagNames, attributes) {
@@ -87,7 +88,9 @@ function clientFactory(params) {
         };
         var evaluations = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
             (0, evaluator_1.evaluateFeaturesByFlagSets)(log, key, flagSetNames, attributes, storage, methodName) :
-            (0, utils_1.isStorageSync)(settings) ? {} : Promise.resolve({}); // Promisify if async
+            isAsync ?
+                Promise.resolve({}) :
+                {};
         return (0, thenable_1.thenable)(evaluations) ? evaluations.then(function (res) { return wrapUp(res); }) : wrapUp(evaluations);
     }
     function getTreatmentsWithConfigByFlagSets(key, flagSetNames, attributes) {

package/cjs/sdkClient/clientInputValidation.js

@@ -5,15 +5,15 @@ var objectAssign_1 = require("../utils/lang/objectAssign");
 var inputValidation_1 = require("../utils/inputValidation");
 var lang_1 = require("../utils/lang");
 var constants_1 = require("../utils/constants");
-var utils_1 = require("../trackers/impressionObserver/utils");
+var mode_1 = require("../utils/settingsValidation/mode");
 var splitFilters_1 = require("../utils/settingsValidation/splitFilters");
 /**
  * Decorator that validates the input before actually executing the client methods.
  * We should "guard" the client here, while not polluting the "real" implementation of those methods.
  */
 function clientInputValidationDecorator(settings, client, readinessManager) {
-    var log = settings.log;
-    var isSync = (0, utils_1.isStorageSync)(settings);
+    var log = settings.log, mode = settings.mode;
+    var isAsync = (0, mode_1.isConsumerMode)(mode);
     /**
      * Avoid repeating this validations code
      */
@@ -28,7 +28,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         var attributes = (0, inputValidation_1.validateAttributes)(log, maybeAttributes, methodName);
         var isNotDestroyed = (0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, methodName);
         if (maybeFlagSetNameOrNames) {
-            flagSetOrFlagSets = (0, splitFilters_1.flagSetsAreValid)(log, methodName, maybeFlagSetNameOrNames, settings.sync.__splitFiltersValidation.groupedFilters.bySet);
+            flagSetOrFlagSets = (0, splitFilters_1.validateFlagSets)(log, methodName, maybeFlagSetNameOrNames, settings.sync.__splitFiltersValidation.groupedFilters.bySet);
         }
         (0, inputValidation_1.validateIfOperational)(log, readinessManager, methodName, splitOrSplits);
         var valid = isNotDestroyed && key && (splitOrSplits || flagSetOrFlagSets.length > 0) && attributes !== false;
@@ -41,7 +41,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         };
     }
     function wrapResult(value) {
-        return isSync ? value : Promise.resolve(value);
+        return isAsync ? Promise.resolve(value) : value;
     }
     function getTreatment(maybeKey, maybeFeatureFlagName, maybeAttributes) {
         var params = validateEvaluationParams(maybeKey, maybeFeatureFlagName, maybeAttributes, constants_1.GET_TREATMENT);
@@ -132,7 +132,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
             return client.track(key, tt, event, eventValue, properties, size);
         }
         else {
-            return isSync ? false : Promise.resolve(false);
+            return isAsync ? Promise.resolve(false) : false;
         }
     }
     return {

package/cjs/sdkManager/index.js

@@ -5,7 +5,7 @@ var objectAssign_1 = require("../utils/lang/objectAssign");
 var thenable_1 = require("../utils/promise/thenable");
 var lang_1 = require("../utils/lang");
 var inputValidation_1 = require("../utils/inputValidation");
-var utils_1 = require("../trackers/impressionObserver/utils");
+var mode_1 = require("../utils/settingsValidation/mode");
 var constants_1 = require("../utils/constants");
 function collectTreatments(splitObject) {
     var conditions = splitObject.conditions;
@@ -42,8 +42,8 @@ function objectsToViews(splitObjects) {
 }
 function sdkManagerFactory(settings, splits, _a) {
     var readinessManager = _a.readinessManager, sdkStatus = _a.sdkStatus;
-    var log = settings.log;
-    var isSync = (0, utils_1.isStorageSync)(settings);
+    var log = settings.log, mode = settings.mode;
+    var isAsync = (0, mode_1.isConsumerMode)(mode);
     return (0, objectAssign_1.objectAssign)(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkStatus), {
@@ -53,7 +53,7 @@ function sdkManagerFactory(settings, splits, _a) {
         split: function (featureFlagName) {
             var splitName = (0, inputValidation_1.validateSplit)(log, featureFlagName, constants_1.SPLIT_FN_LABEL);
             if (!(0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, constants_1.SPLIT_FN_LABEL) || !(0, inputValidation_1.validateIfOperational)(log, readinessManager, constants_1.SPLIT_FN_LABEL) || !splitName) {
-                return isSync ? null : Promise.resolve(null);
+                return isAsync ? Promise.resolve(null) : null;
             }
             var split = splits.getSplit(splitName);
             if ((0, thenable_1.thenable)(split)) {
@@ -70,7 +70,7 @@ function sdkManagerFactory(settings, splits, _a) {
          */
         splits: function () {
             if (!(0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, constants_1.SPLITS_FN_LABEL) || !(0, inputValidation_1.validateIfOperational)(log, readinessManager, constants_1.SPLITS_FN_LABEL)) {
-                return isSync ? [] : Promise.resolve([]);
+                return isAsync ? Promise.resolve([]) : [];
             }
             var currentSplits = splits.getAll();
             return (0, thenable_1.thenable)(currentSplits) ?
@@ -82,7 +82,7 @@ function sdkManagerFactory(settings, splits, _a) {
          */
         names: function () {
             if (!(0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, constants_1.NAMES_FN_LABEL) || !(0, inputValidation_1.validateIfOperational)(log, readinessManager, constants_1.NAMES_FN_LABEL)) {
-                return isSync ? [] : Promise.resolve([]);
+                return isAsync ? Promise.resolve([]) : [];
             }
             var splitNames = splits.getSplitNames();
             return (0, thenable_1.thenable)(splitNames) ?

package/cjs/storages/KeyBuilder.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyBuilder = exports.validatePrefix = void 0;
+exports.getStorageHash = exports.KeyBuilder = exports.validatePrefix = void 0;
 var lang_1 = require("../utils/lang");
+var murmur3_1 = require("../utils/murmur3/murmur3");
 var everythingAtTheEnd = /[^.]+$/;
 var DEFAULT_PREFIX = 'SPLITIO';
 function validatePrefix(prefix) {
@@ -58,6 +59,17 @@ var KeyBuilder = /** @class */ (function () {
             throw new Error('Invalid latency key provided');
         }
     };
+    KeyBuilder.prototype.buildHashKey = function () {
+        return this.prefix + ".hash";
+    };
     return KeyBuilder;
 }());
 exports.KeyBuilder = KeyBuilder;
+/**
+ * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
+ * The hash is in hexadecimal format (8 characters max, 32 bits).
+ */
+function getStorageHash(settings) {
+    return (0, murmur3_1.hash)(settings.core.authorizationKey + "::" + settings.sync.__splitFiltersValidation.queryString).toString(16);
+}
+exports.getStorageHash = getStorageHash;

package/cjs/storages/KeyBuilderCS.js

@@ -9,7 +9,7 @@ var KeyBuilderCS = /** @class */ (function (_super) {
     function KeyBuilderCS(prefix, matchingKey) {
         var _this = _super.call(this, prefix) || this;
         _this.matchingKey = matchingKey;
-        _this.regexSplitsCacheKey = new RegExp("^" + prefix + "\\.(splits?|trafficType)\\.");
+        _this.regexSplitsCacheKey = new RegExp("^" + prefix + "\\.");
         return _this;
     }
     /**
@@ -39,9 +39,6 @@ var KeyBuilderCS = /** @class */ (function (_super) {
     KeyBuilderCS.prototype.isSplitsCacheKey = function (key) {
         return this.regexSplitsCacheKey.test(key);
     };
-    KeyBuilderCS.prototype.buildSplitsFilterQueryKey = function () {
-        return this.prefix + ".splits.filterQuery";
-    };
     return KeyBuilderCS;
 }(KeyBuilder_1.KeyBuilder));
 exports.KeyBuilderCS = KeyBuilderCS;

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -6,6 +6,7 @@ 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.
  */
@@ -16,13 +17,12 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
      * @param {number | undefined} expirationTimestamp
      * @param {ISplitFiltersValidation} splitFiltersValidation
      */
-    function SplitsCacheInLocal(log, keys, expirationTimestamp, splitFiltersValidation) {
-        if (splitFiltersValidation === void 0) { splitFiltersValidation = { queryString: null, groupedFilters: { bySet: [], byName: [], byPrefix: [] }, validFilters: [] }; }
+    function SplitsCacheInLocal(settings, keys, expirationTimestamp) {
         var _this = _super.call(this) || this;
-        _this.log = log;
         _this.keys = keys;
-        _this.splitFiltersValidation = splitFiltersValidation;
-        _this.flagSetsFilter = _this.splitFiltersValidation.groupedFilters.bySet;
+        _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;
@@ -126,14 +126,10 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     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 + 'Split filter query was modified. Updating cache.');
-            var queryKey = this.keys.buildSplitsFilterQueryKey();
-            var queryString = this.splitFiltersValidation.queryString;
+            this.log.info(constants_1.LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache.');
+            var storageHashKey = this.keys.buildHashKey();
             try {
-                if (queryString)
-                    localStorage.setItem(queryKey, queryString);
-                else
-                    localStorage.removeItem(queryKey);
+                localStorage.setItem(storageHashKey, this.storageHash);
             }
             catch (e) {
                 this.log.error(constants_1.LOG_PREFIX + e);
@@ -211,11 +207,11 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
                 this.clear();
         }
     };
+    // @TODO eventually remove `_checkFilterQuery`. Cache should be cleared at the storage level, reusing same logic than PluggableStorage
     SplitsCacheInLocal.prototype._checkFilterQuery = function () {
-        var queryString = this.splitFiltersValidation.queryString;
-        var queryKey = this.keys.buildSplitsFilterQueryKey();
-        var currentQueryString = localStorage.getItem(queryKey);
-        if (currentQueryString !== queryString) {
+        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;

package/cjs/storages/inLocalStorage/index.js

@@ -34,7 +34,7 @@ function InLocalStorage(options) {
         var matchingKey = (0, key_1.getMatching)(settings.core.key);
         var keys = new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey);
         var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
-        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(log, keys, expirationTimestamp, __splitFiltersValidation);
+        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys, expirationTimestamp);
         var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys);
         return {
             splits: splits,

package/cjs/storages/inRedis/SplitsCacheInRedis.js

@@ -52,8 +52,8 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
     };
     SplitsCacheInRedis.prototype._updateFlagSets = function (featureFlagName, flagSetsOfRemovedFlag, flagSetsOfAddedFlag) {
         var _this = this;
-        var removeFromFlagSets = (0, sets_1.returnListDifference)(flagSetsOfRemovedFlag, flagSetsOfAddedFlag);
-        var addToFlagSets = (0, sets_1.returnListDifference)(flagSetsOfAddedFlag, flagSetsOfRemovedFlag);
+        var removeFromFlagSets = (0, sets_1.returnDifference)(flagSetsOfRemovedFlag, flagSetsOfAddedFlag);
+        var addToFlagSets = (0, sets_1.returnDifference)(flagSetsOfAddedFlag, flagSetsOfRemovedFlag);
         if (this.flagSetsFilter.length > 0) {
             addToFlagSets = addToFlagSets.filter(function (flagSet) {
                 return _this.flagSetsFilter.some(function (filterFlagSet) { return filterFlagSet === flagSet; });

package/cjs/storages/inRedis/index.js

@@ -39,7 +39,7 @@ function InRedisStorage(options) {
             telemetry.recordConfig();
         });
         return {
-            splits: new SplitsCacheInRedis_1.SplitsCacheInRedis(log, keys, redisClient),
+            splits: new SplitsCacheInRedis_1.SplitsCacheInRedis(log, keys, redisClient, settings.sync.__splitFiltersValidation),
             segments: new SegmentsCacheInRedis_1.SegmentsCacheInRedis(log, keys, redisClient),
             impressions: new ImpressionsCacheInRedis_1.ImpressionsCacheInRedis(log, keys.buildImpressionsKey(), redisClient, metadata),
             impressionCounts: impressionCountsCache,

package/cjs/storages/pluggable/SplitsCachePluggable.js

@@ -39,8 +39,8 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
     };
     SplitsCachePluggable.prototype._updateFlagSets = function (featureFlagName, flagSetsOfRemovedFlag, flagSetsOfAddedFlag) {
         var _this = this;
-        var removeFromFlagSets = (0, sets_1.returnListDifference)(flagSetsOfRemovedFlag, flagSetsOfAddedFlag);
-        var addToFlagSets = (0, sets_1.returnListDifference)(flagSetsOfAddedFlag, flagSetsOfRemovedFlag);
+        var removeFromFlagSets = (0, sets_1.returnDifference)(flagSetsOfRemovedFlag, flagSetsOfAddedFlag);
+        var addToFlagSets = (0, sets_1.returnDifference)(flagSetsOfAddedFlag, flagSetsOfRemovedFlag);
         if (this.flagSetsFilter.length > 0) {
             addToFlagSets = addToFlagSets.filter(function (flagSet) {
                 return _this.flagSetsFilter.some(function (filterFlagSet) { return filterFlagSet === flagSet; });

package/cjs/storages/pluggable/index.js

@@ -76,15 +76,28 @@ function PluggableStorage(options) {
             undefined;
         // Connects to wrapper and emits SDK_READY event on main client
         var connectPromise = wrapper.connect().then(function () {
-            onReadyCb();
-            // Start periodic flush of async storages if not running synchronizer (producer mode)
-            if (!isSyncronizer) {
+            if (isSyncronizer) {
+                // 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) {
+                        return wrapper.getKeysByPrefix(keys.prefix + ".").then(function (storageKeys) {
+                            return Promise.all(storageKeys.map(function (storageKey) { return wrapper.del(storageKey); }));
+                        }).then(function () { return wrapper.set(keys.buildHashKey(), currentHash); });
+                    }
+                }).then(function () {
+                    onReadyCb();
+                });
+            }
+            else {
+                // Start periodic flush of async storages if not running synchronizer (producer mode)
                 if (impressionCountsCache && impressionCountsCache.start)
                     impressionCountsCache.start();
                 if (uniqueKeysCache && uniqueKeysCache.start)
                     uniqueKeysCache.start();
                 if (telemetry && telemetry.recordConfig)
                     telemetry.recordConfig();
+                onReadyCb();
             }
         }).catch(function (e) {
             e = e || new Error('Error connecting wrapper');

package/cjs/trackers/eventTracker.js

@@ -5,7 +5,7 @@ var objectAssign_1 = require("../utils/lang/objectAssign");
 var thenable_1 = require("../utils/promise/thenable");
 var constants_1 = require("../logger/constants");
 var constants_2 = require("../utils/constants");
-var utils_1 = require("./impressionObserver/utils");
+var mode_1 = require("../utils/settingsValidation/mode");
 /**
  * Event tracker stores events in cache and pass them to the integrations manager if provided.
  *
@@ -13,8 +13,8 @@ var utils_1 = require("./impressionObserver/utils");
  * @param integrationsManager optional event handler used for integrations
  */
 function eventTrackerFactory(settings, eventsCache, integrationsManager, telemetryCache) {
-    var log = settings.log;
-    var isSync = (0, utils_1.isStorageSync)(settings);
+    var log = settings.log, mode = settings.mode;
+    var isAsync = (0, mode_1.isConsumerMode)(mode);
     function queueEventsCallback(eventData, tracked) {
         var eventTypeId = eventData.eventTypeId, trafficTypeName = eventData.trafficTypeName, key = eventData.key, value = eventData.value, timestamp = eventData.timestamp, properties = eventData.properties;
         // Logging every prop would be too much.
@@ -41,7 +41,7 @@ function eventTrackerFactory(settings, eventsCache, integrationsManager, telemet
     return {
         track: function (eventData, size) {
             if (settings.userConsent === constants_2.CONSENT_DECLINED) {
-                return isSync ? false : Promise.resolve(false);
+                return isAsync ? Promise.resolve(false) : false;
             }
             var tracked = eventsCache.track(eventData, size);
             if ((0, thenable_1.thenable)(tracked)) {

package/cjs/utils/lang/sets.js

@@ -24,7 +24,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 **/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.returnListDifference = exports.returnSetsUnion = exports._Set = exports.__getSetConstructor = exports.setToArray = exports.SetPoly = void 0;
+exports.returnDifference = exports.returnSetsUnion = exports._Set = exports.__getSetConstructor = exports.setToArray = exports.SetPoly = void 0;
 var SetPoly = /** @class */ (function () {
     // unlike ES6 `Set`, it only accepts an array as first argument iterable
     function SetPoly(values) {
@@ -108,7 +108,7 @@ function returnSetsUnion(set, set2) {
     return result;
 }
 exports.returnSetsUnion = returnSetsUnion;
-function returnListDifference(list, list2) {
+function returnDifference(list, list2) {
     if (list === void 0) { list = []; }
     if (list2 === void 0) { list2 = []; }
     var result = new exports._Set(list);
@@ -117,4 +117,4 @@ function returnListDifference(list, list2) {
     });
     return setToArray(result);
 }
-exports.returnListDifference = returnListDifference;
+exports.returnDifference = returnDifference;

package/cjs/utils/settingsValidation/index.js

@@ -126,7 +126,7 @@ function settingsValidation(config, validationParams) {
     startup.eventsFirstPushWindow = fromSecondsToMillis(startup.eventsFirstPushWindow);
     // ensure a valid SDK mode
     // @ts-ignore, modify readonly prop
-    withDefaults.mode = (0, mode_1.mode)(withDefaults.core.authorizationKey, withDefaults.mode);
+    withDefaults.mode = (0, mode_1.validateMode)(withDefaults.core.authorizationKey, withDefaults.mode);
     // ensure a valid Storage based on mode defined.
     // @ts-ignore, modify readonly prop
     if (storage)

package/cjs/utils/settingsValidation/mode.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mode = void 0;
+exports.isConsumerMode = exports.validateMode = void 0;
 var constants_1 = require("../constants");
-function mode(key, mode) {
+function validateMode(key, mode) {
     // Leaving the comparison as is, in case we change the mode name but not the setting.
     if (key === 'localhost')
         return constants_1.LOCALHOST_MODE;
@@ -10,4 +10,11 @@ function mode(key, mode) {
         throw Error('Invalid mode provided');
     return mode;
 }
-exports.mode = mode;
+exports.validateMode = validateMode;
+/**
+ * Storage is async if mode is consumer or partial consumer
+ */
+function isConsumerMode(mode) {
+    return constants_1.CONSUMER_MODE === mode || constants_1.CONSUMER_PARTIAL_MODE === mode;
+}
+exports.isConsumerMode = isConsumerMode;

package/cjs/utils/settingsValidation/splitFilters.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.flagSetsAreValid = exports.validateSplitFilters = void 0;
-var constants_1 = require("../constants");
+exports.validateFlagSets = exports.validateSplitFilters = void 0;
 var splits_1 = require("../inputValidation/splits");
-var constants_2 = require("../../logger/constants");
+var constants_1 = require("../../logger/constants");
 var objectAssign_1 = require("../lang/objectAssign");
 var lang_1 = require("../lang");
+var mode_1 = require("./mode");
 // Split filters metadata.
 // Ordered according to their precedency when forming the filter query string: `&names=<values>&prefixes=<values>`
 var FILTERS_METADATA = [
@@ -45,10 +45,10 @@ function validateFilterType(maybeFilterType) {
  */
 function validateSplitFilter(log, type, values, maxLength) {
     // validate and remove invalid and duplicated values
-    var result = (0, splits_1.validateSplits)(log, values, constants_2.LOG_PREFIX_SETTINGS, type + " filter", type + " filter value");
+    var result = (0, splits_1.validateSplits)(log, values, constants_1.LOG_PREFIX_SETTINGS, type + " filter", type + " filter value");
     if (result) {
         if (type === 'bySet') {
-            result = sanitizeFlagSets(log, result);
+            result = sanitizeFlagSets(log, result, constants_1.LOG_PREFIX_SETTINGS);
         }
         // check max length
         if (result.length > maxLength)
@@ -81,7 +81,7 @@ function queryStringBuilder(groupedFilters) {
     return queryParams.length > 0 ? '&' + queryParams.join('&') : null;
 }
 /**
- * Sanitizes set names list taking in account:
+ * Sanitizes set names list taking into account:
  *  - It should be lowercase
  *  - Must adhere the following regular expression /^[a-z0-9][_a-z0-9]{0,49}$/ that means
  *   - must start with a letter or number
@@ -91,20 +91,21 @@ function queryStringBuilder(groupedFilters) {
  *
  * @param {ILogger} log
  * @param {string[]} flagSets
+ * @param {string} method
  * @returns sanitized list of set names
  */
-function sanitizeFlagSets(log, flagSets) {
+function sanitizeFlagSets(log, flagSets, method) {
     var sanitizedSets = flagSets
         .map(function (flagSet) {
         if (CAPITAL_LETTERS_REGEX.test(flagSet)) {
-            log.warn(constants_2.WARN_SPLITS_FILTER_LOWERCASE_SET, [flagSet]);
+            log.warn(constants_1.WARN_LOWERCASE_FLAGSET, [method, flagSet]);
             flagSet = flagSet.toLowerCase();
         }
         return flagSet;
     })
         .filter(function (flagSet) {
         if (!VALID_FLAGSET_REGEX.test(flagSet)) {
-            log.warn(constants_2.WARN_SPLITS_FILTER_INVALID_SET, [flagSet, VALID_FLAGSET_REGEX, flagSet]);
+            log.warn(constants_1.WARN_INVALID_FLAGSET, [method, flagSet, VALID_FLAGSET_REGEX, flagSet]);
             return false;
         }
         if (typeof flagSet !== 'string')
@@ -140,13 +141,13 @@ function validateSplitFilters(log, maybeSplitFilters, mode) {
     if (!maybeSplitFilters)
         return res;
     // Warn depending on the mode
-    if (mode === constants_1.CONSUMER_MODE || mode === constants_1.CONSUMER_PARTIAL_MODE) {
-        log.warn(constants_2.WARN_SPLITS_FILTER_IGNORED);
+    if ((0, mode_1.isConsumerMode)(mode)) {
+        log.warn(constants_1.WARN_SPLITS_FILTER_IGNORED);
         return res;
     }
     // Check collection type
     if (!Array.isArray(maybeSplitFilters) || maybeSplitFilters.length === 0) {
-        log.warn(constants_2.WARN_SPLITS_FILTER_EMPTY);
+        log.warn(constants_1.WARN_SPLITS_FILTER_EMPTY);
         return res;
     }
     // Validate filters and group their values by filter type inside `groupedFilters` object
@@ -156,7 +157,7 @@ function validateSplitFilters(log, maybeSplitFilters, mode) {
             return true;
         }
         else {
-            log.warn(constants_2.WARN_SPLITS_FILTER_INVALID, [index]);
+            log.warn(constants_1.WARN_SPLITS_FILTER_INVALID, [index]);
         }
         return false;
     });
@@ -170,27 +171,27 @@ function validateSplitFilters(log, maybeSplitFilters, mode) {
     // Clean all filters if set filter is present
     if (setFilter) {
         if (configuredFilter(res.validFilters, 'byName') || configuredFilter(res.validFilters, 'byPrefix'))
-            log.error(constants_2.ERROR_SETS_FILTER_EXCLUSIVE);
+            log.error(constants_1.ERROR_SETS_FILTER_EXCLUSIVE);
         (0, objectAssign_1.objectAssign)(res.groupedFilters, { byName: [], byPrefix: [] });
     }
     // build query string
     res.queryString = queryStringBuilder(res.groupedFilters);
-    log.debug(constants_2.SETTINGS_SPLITS_FILTER, [res.queryString]);
+    log.debug(constants_1.SETTINGS_SPLITS_FILTER, [res.queryString]);
     return res;
 }
 exports.validateSplitFilters = validateSplitFilters;
-function flagSetsAreValid(log, method, flagSets, flagSetsInConfig) {
+function validateFlagSets(log, method, flagSets, flagSetsInConfig) {
     var sets = (0, splits_1.validateSplits)(log, flagSets, method, 'flag sets', 'flag set');
-    var toReturn = sets ? sanitizeFlagSets(log, sets) : [];
+    var toReturn = sets ? sanitizeFlagSets(log, sets, method) : [];
     if (flagSetsInConfig.length > 0) {
         toReturn = toReturn.filter(function (flagSet) {
             if (flagSetsInConfig.indexOf(flagSet) > -1) {
                 return true;
             }
-            log.warn(constants_2.WARN_FLAGSET_NOT_CONFIGURED, [method, flagSet]);
+            log.warn(constants_1.WARN_FLAGSET_NOT_CONFIGURED, [method, flagSet]);
             return false;
         });
     }
     return toReturn;
 }
-exports.flagSetsAreValid = flagSetsAreValid;
+exports.validateFlagSets = validateFlagSets;

package/esm/logger/constants.js

@@ -95,8 +95,8 @@ export var WARN_SPLITS_FILTER_EMPTY = 221;
 export var WARN_SDK_KEY = 222;
 export var STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
 export var STREAMING_PARSING_SPLIT_UPDATE = 224;
-export var WARN_SPLITS_FILTER_INVALID_SET = 225;
-export var WARN_SPLITS_FILTER_LOWERCASE_SET = 226;
+export var WARN_INVALID_FLAGSET = 225;
+export var WARN_LOWERCASE_FLAGSET = 226;
 export var WARN_FLAGSET_NOT_CONFIGURED = 227;
 export var WARN_FLAGSET_WITHOUT_FLAGS = 228;
 export var ERROR_ENGINE_COMBINER_IFELSEIF = 300;

package/esm/logger/messages/warn.js

@@ -32,7 +32,7 @@ export var codesWarn = codesError.concat([
     [c.WARN_SDK_KEY, c.LOG_PREFIX_SETTINGS + ': You already have %s. We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'],
     [c.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching MySegments due to an error processing %s notification: %s'],
     [c.STREAMING_PARSING_SPLIT_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching SplitChanges due to an error processing SPLIT_UPDATE notification: %s'],
-    [c.WARN_SPLITS_FILTER_INVALID_SET, c.LOG_PREFIX_SETTINGS + ': you passed %s, flag set must adhere to the regular expressions %s. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. %s was discarded.'],
-    [c.WARN_SPLITS_FILTER_LOWERCASE_SET, c.LOG_PREFIX_SETTINGS + ': flag set %s should be all lowercase - converting string to lowercase.'],
+    [c.WARN_INVALID_FLAGSET, '%s: you passed %s, flag set must adhere to the regular expressions %s. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. %s was discarded.'],
+    [c.WARN_LOWERCASE_FLAGSET, '%s: flag set %s should be all lowercase - converting string to lowercase.'],
     [c.WARN_FLAGSET_WITHOUT_FLAGS, '%s: you passed %s flag set that does not contain cached feature flag names. Please double check what flag sets are in use in the Split user interface.'],
 ]);