@splitsoftware/splitio-commons 1.11.0 → 1.12.0-rc.0

package/cjs/storages/inRedis/SegmentsCacheInRedis.js

@@ -54,9 +54,9 @@ var SegmentsCacheInRedis = /** @class */ (function () {
     SegmentsCacheInRedis.prototype.getRegisteredSegments = function () {
         return this.redis.smembers(this.keys.buildRegisteredSegmentsKey());
     };
-    // @TODO remove/review. It is not being used.
+    // @TODO remove or implement. It is not being used.
     SegmentsCacheInRedis.prototype.clear = function () {
-        return this.redis.flushdb().then(function (status) { return status === 'OK'; });
+        return Promise.resolve();
     };
     return SegmentsCacheInRedis;
 }());

package/cjs/storages/inRedis/SplitsCacheInRedis.js

@@ -5,6 +5,7 @@ var tslib_1 = require("tslib");
 var lang_1 = require("../../utils/lang");
 var constants_1 = require("./constants");
 var AbstractSplitsCacheAsync_1 = require("../AbstractSplitsCacheAsync");
+var sets_1 = require("../../utils/lang/sets");
 /**
  * Discard errors for an answer of multiple operations.
  */
@@ -21,11 +22,12 @@ function processPipelineAnswer(results) {
  */
 var SplitsCacheInRedis = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(SplitsCacheInRedis, _super);
-    function SplitsCacheInRedis(log, keys, redis) {
+    function SplitsCacheInRedis(log, keys, redis, splitFiltersValidation) {
         var _this = _super.call(this) || this;
         _this.log = log;
         _this.redis = redis;
         _this.keys = keys;
+        _this.flagSetsFilter = splitFiltersValidation ? splitFiltersValidation.groupedFilters.bySet : [];
         // There is no need to listen for redis 'error' event, because in that case ioredis calls will be rejected and handled by redis storage adapters.
         // But it is done just to avoid getting the ioredis message `Unhandled error event`.
         _this.redis.on('error', function (e) {
@@ -48,6 +50,18 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
         var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
         return this.redis.incr(ttKey);
     };
+    SplitsCacheInRedis.prototype._updateFlagSets = function (featureFlagName, flagSetsOfRemovedFlag, flagSetsOfAddedFlag) {
+        var _this = this;
+        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; });
+            });
+        }
+        var items = [featureFlagName];
+        return Promise.all((0, tslib_1.__spreadArray)((0, tslib_1.__spreadArray)([], removeFromFlagSets.map(function (flagSetName) { return _this.redis.srem(_this.keys.buildFlagSetKey(flagSetName), items); }), true), addToFlagSets.map(function (flagSetName) { return _this.redis.sadd(_this.keys.buildFlagSetKey(flagSetName), items); }), true));
+    };
     /**
      * Add a given split.
      * The returned promise is resolved when the operation success
@@ -57,16 +71,16 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
         var _this = this;
         var splitKey = this.keys.buildSplitKey(name);
         return this.redis.get(splitKey).then(function (splitFromStorage) {
-            // handling parsing errors
-            var parsedPreviousSplit, newStringifiedSplit;
+            // handling parsing error
+            var parsedPreviousSplit, stringifiedNewSplit;
             try {
                 parsedPreviousSplit = splitFromStorage ? JSON.parse(splitFromStorage) : undefined;
-                newStringifiedSplit = JSON.stringify(split);
+                stringifiedNewSplit = JSON.stringify(split);
             }
             catch (e) {
                 throw new Error('Error parsing feature flag definition: ' + e);
             }
-            return _this.redis.set(splitKey, newStringifiedSplit).then(function () {
+            return _this.redis.set(splitKey, stringifiedNewSplit).then(function () {
                 // avoid unnecessary increment/decrement operations
                 if (parsedPreviousSplit && parsedPreviousSplit.trafficTypeName === split.trafficTypeName)
                     return;
@@ -75,7 +89,7 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
                     if (parsedPreviousSplit)
                         return _this._decrementCounts(parsedPreviousSplit);
                 });
-            });
+            }).then(function () { return _this._updateFlagSets(name, parsedPreviousSplit && parsedPreviousSplit.sets, split.sets); });
         }).then(function () { return true; });
     };
     /**
@@ -96,8 +110,9 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
         var _this = this;
         return this.getSplit(name).then(function (split) {
             if (split) {
-                _this._decrementCounts(split);
+                return _this._decrementCounts(split).then(function () { return _this._updateFlagSets(name, split.sets); });
             }
+        }).then(function () {
             return _this.redis.del(_this.keys.buildSplitKey(name));
         });
     };
@@ -172,14 +187,20 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
         return this.redis.keys(this.keys.searchPatternForSplitKeys()).then(function (listOfKeys) { return listOfKeys.map(_this.keys.extractKey); });
     };
     /**
-     * Get list of split names related to a given flag set names list.
-     * The returned promise is resolved with the list of split names,
-     * or rejected if wrapper operation fails.
-     * @todo this is a no-op method to be implemented
+     * Get list of feature flag names related to a given list of flag set names.
+     * The returned promise is resolved with the list of feature flag names per flag set,
+     * or rejected if the pipelined redis operation fails (e.g., timeout).
     */
-    SplitsCacheInRedis.prototype.getNamesByFlagSets = function () {
-        this.log.error(constants_1.LOG_PREFIX + 'ByFlagSet/s evaluations are not supported with Redis storage yet.');
-        return Promise.reject();
+    SplitsCacheInRedis.prototype.getNamesByFlagSets = function (flagSets) {
+        var _this = this;
+        return this.redis.pipeline(flagSets.map(function (flagSet) { return ['smembers', _this.keys.buildFlagSetKey(flagSet)]; })).exec()
+            .then(function (results) { return results.map(function (_a, index) {
+            var e = _a[0], value = _a[1];
+            if (e === null)
+                return value;
+            _this.log.error(constants_1.LOG_PREFIX + ("Could not read result from get members of flag set " + flagSets[index] + " due to an error: " + e));
+        }); })
+            .then(function (namesByFlagSets) { return namesByFlagSets.map(function (namesByFlagSet) { return new sets_1._Set(namesByFlagSet); }); });
     };
     /**
      * Check traffic type existence.
@@ -196,24 +217,20 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
                 return false; // if entry doesn't exist, means that TT doesn't exist
             ttCount = parseInt(ttCount, 10);
             if (!(0, lang_1.isFiniteNumber)(ttCount) || ttCount < 0) {
-                _this.log.info(constants_1.LOG_PREFIX + ("Could not validate traffic type existance of " + trafficType + " due to data corruption of some sorts."));
+                _this.log.info(constants_1.LOG_PREFIX + ("Could not validate traffic type existence of " + trafficType + " due to data corruption of some sorts."));
                 return false;
             }
             return ttCount > 0;
         })
             .catch(function (e) {
-            _this.log.error(constants_1.LOG_PREFIX + ("Could not validate traffic type existance of " + trafficType + " due to an error: " + e + "."));
+            _this.log.error(constants_1.LOG_PREFIX + ("Could not validate traffic type existence of " + trafficType + " due to an error: " + e + "."));
             // If there is an error, bypass the validation so the event can get tracked.
             return true;
         });
     };
-    /**
-     * Delete everything in the current database.
-     *
-     * @NOTE documentation says it never fails.
-     */
+    // @TODO remove or implement. It is not being used.
     SplitsCacheInRedis.prototype.clear = function () {
-        return this.redis.flushdb().then(function (status) { return status === 'OK'; });
+        return Promise.resolve();
     };
     /**
      * Fetches multiple splits definitions.

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

@@ -5,6 +5,7 @@ var tslib_1 = require("tslib");
 var lang_1 = require("../../utils/lang");
 var constants_1 = require("./constants");
 var AbstractSplitsCacheAsync_1 = require("../AbstractSplitsCacheAsync");
+var sets_1 = require("../../utils/lang/sets");
 /**
  * ISplitsCacheAsync implementation for pluggable storages.
  */
@@ -16,11 +17,12 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
      * @param keys  Key builder.
      * @param wrapper  Adapted wrapper storage.
      */
-    function SplitsCachePluggable(log, keys, wrapper) {
+    function SplitsCachePluggable(log, keys, wrapper, splitFiltersValidation) {
         var _this = _super.call(this) || this;
         _this.log = log;
         _this.keys = keys;
         _this.wrapper = wrapper;
+        _this.flagSetsFilter = splitFiltersValidation ? splitFiltersValidation.groupedFilters.bySet : [];
         return _this;
     }
     SplitsCachePluggable.prototype._decrementCounts = function (split) {
@@ -35,6 +37,18 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
         var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
         return this.wrapper.incr(ttKey);
     };
+    SplitsCachePluggable.prototype._updateFlagSets = function (featureFlagName, flagSetsOfRemovedFlag, flagSetsOfAddedFlag) {
+        var _this = this;
+        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; });
+            });
+        }
+        var items = [featureFlagName];
+        return Promise.all((0, tslib_1.__spreadArray)((0, tslib_1.__spreadArray)([], removeFromFlagSets.map(function (flagSetName) { return _this.wrapper.removeItems(_this.keys.buildFlagSetKey(flagSetName), items); }), true), addToFlagSets.map(function (flagSetName) { return _this.wrapper.addItems(_this.keys.buildFlagSetKey(flagSetName), items); }), true));
+    };
     /**
      * Add a given split.
      * The returned promise is resolved when the operation success
@@ -62,7 +76,7 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
                     if (parsedPreviousSplit)
                         return _this._decrementCounts(parsedPreviousSplit);
                 });
-            });
+            }).then(function () { return _this._updateFlagSets(name, parsedPreviousSplit && parsedPreviousSplit.sets, split.sets); });
         }).then(function () { return true; });
     };
     /**
@@ -83,8 +97,9 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
         var _this = this;
         return this.getSplit(name).then(function (split) {
             if (split) {
-                _this._decrementCounts(split);
+                return _this._decrementCounts(split).then(function () { return _this._updateFlagSets(name, split.sets); });
             }
+        }).then(function () {
             return _this.wrapper.del(_this.keys.buildSplitKey(name));
         });
     };
@@ -146,14 +161,16 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
         return this.wrapper.getKeysByPrefix(this.keys.buildSplitKeyPrefix()).then(function (listOfKeys) { return listOfKeys.map(_this.keys.extractKey); });
     };
     /**
-     * Get list of split names related to a given flag set names list.
-     * The returned promise is resolved with the list of split names,
-     * or rejected if wrapper operation fails.
-     * @todo this is a no-op method to be implemented
-    */
-    SplitsCachePluggable.prototype.getNamesByFlagSets = function () {
-        this.log.error(constants_1.LOG_PREFIX + 'ByFlagSet/s evaluations are not supported with pluggable storage yet.');
-        return Promise.reject();
+     * Get list of feature flag names related to a given list of flag set names.
+     * The returned promise is resolved with the list of feature flag names per flag set.
+     * It never rejects (If there is a wrapper error for some flag set, an empty set is returned for it).
+     */
+    SplitsCachePluggable.prototype.getNamesByFlagSets = function (flagSets) {
+        var _this = this;
+        return Promise.all(flagSets.map(function (flagSet) {
+            var flagSetKey = _this.keys.buildFlagSetKey(flagSet);
+            return _this.wrapper.getItems(flagSetKey).catch(function () { return []; });
+        })).then(function (namesByFlagSets) { return namesByFlagSets.map(function (namesByFlagSet) { return new sets_1._Set(namesByFlagSet); }); });
     };
     /**
      * Check traffic type existence.

package/cjs/storages/pluggable/index.js

@@ -92,7 +92,7 @@ function PluggableStorage(options) {
             return e; // Propagate error for shared clients
         });
         return {
-            splits: new SplitsCachePluggable_1.SplitsCachePluggable(log, keys, wrapper),
+            splits: new SplitsCachePluggable_1.SplitsCachePluggable(log, keys, wrapper, settings.sync.__splitFiltersValidation),
             segments: new SegmentsCachePluggable_1.SegmentsCachePluggable(log, keys, wrapper),
             impressions: isPartialConsumer ? new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(impressionsQueueSize) : new ImpressionsCachePluggable_1.ImpressionsCachePluggable(log, keys.buildImpressionsKey(), wrapper, metadata),
             impressionCounts: impressionCountsCache,

package/cjs/utils/constants/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OCCUPANCY_SEC = exports.OCCUPANCY_PRI = exports.CONNECTION_ESTABLISHED = exports.TRACK = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSETS = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSET = exports.TREATMENTS_BY_FLAGSETS = exports.TREATMENTS_BY_FLAGSET = exports.TREATMENTS_WITH_CONFIG = exports.TREATMENT_WITH_CONFIG = exports.TREATMENTS = exports.TREATMENT = exports.MY_SEGMENT = exports.SEGMENT = exports.TOKEN = exports.TELEMETRY = exports.EVENTS = exports.IMPRESSIONS_COUNT = exports.IMPRESSIONS = exports.SPLITS = exports.NONE_ENUM = exports.DEBUG_ENUM = exports.OPTIMIZED_ENUM = exports.CONSUMER_PARTIAL_ENUM = exports.CONSUMER_ENUM = exports.STANDALONE_ENUM = exports.DEDUPED = exports.DROPPED = exports.QUEUED = exports.CONSENT_UNKNOWN = exports.CONSENT_DECLINED = exports.CONSENT_GRANTED = exports.STORAGE_PLUGGABLE = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_PARTIAL_MODE = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.NONE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
-exports.PAUSED = exports.ENABLED = exports.DISABLED = exports.NON_REQUESTED = exports.REQUESTED = exports.POLLING = exports.STREAMING = exports.AUTH_REJECTION = exports.SYNC_MODE_UPDATE = exports.ABLY_ERROR = exports.TOKEN_REFRESH = exports.SSE_CONNECTION_ERROR = exports.STREAMING_STATUS = void 0;
+exports.MY_SEGMENT = exports.SEGMENT = exports.TOKEN = exports.TELEMETRY = exports.EVENTS = exports.IMPRESSIONS_COUNT = exports.IMPRESSIONS = exports.SPLITS = exports.NONE_ENUM = exports.DEBUG_ENUM = exports.OPTIMIZED_ENUM = exports.CONSUMER_PARTIAL_ENUM = exports.CONSUMER_ENUM = exports.STANDALONE_ENUM = exports.DEDUPED = exports.DROPPED = exports.QUEUED = exports.NAMES_FN_LABEL = exports.SPLITS_FN_LABEL = exports.SPLIT_FN_LABEL = exports.TRACK_FN_LABEL = exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS = exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET = exports.GET_TREATMENTS_BY_FLAG_SETS = exports.GET_TREATMENTS_BY_FLAG_SET = exports.GET_TREATMENTS_WITH_CONFIG = exports.GET_TREATMENT_WITH_CONFIG = exports.GET_TREATMENTS = exports.GET_TREATMENT = exports.CONSENT_UNKNOWN = exports.CONSENT_DECLINED = exports.CONSENT_GRANTED = exports.STORAGE_PLUGGABLE = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_PARTIAL_MODE = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.NONE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
+exports.PAUSED = exports.ENABLED = exports.DISABLED = exports.NON_REQUESTED = exports.REQUESTED = exports.POLLING = exports.STREAMING = exports.AUTH_REJECTION = exports.SYNC_MODE_UPDATE = exports.ABLY_ERROR = exports.TOKEN_REFRESH = exports.SSE_CONNECTION_ERROR = exports.STREAMING_STATUS = exports.OCCUPANCY_SEC = exports.OCCUPANCY_PRI = exports.CONNECTION_ESTABLISHED = exports.TRACK = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSETS = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSET = exports.TREATMENTS_BY_FLAGSETS = exports.TREATMENTS_BY_FLAGSET = exports.TREATMENTS_WITH_CONFIG = exports.TREATMENT_WITH_CONFIG = exports.TREATMENTS = exports.TREATMENT = void 0;
 // Special treatments
 exports.CONTROL = 'control';
 exports.CONTROL_WITH_CONFIG = {
@@ -33,6 +33,20 @@ exports.STORAGE_PLUGGABLE = 'PLUGGABLE';
 exports.CONSENT_GRANTED = 'GRANTED'; // The user has granted consent for tracking events and impressions
 exports.CONSENT_DECLINED = 'DECLINED'; // The user has declined consent for tracking events and impressions
 exports.CONSENT_UNKNOWN = 'UNKNOWN'; // The user has neither granted nor declined consent for tracking events and impressions
+// Client method names
+exports.GET_TREATMENT = 'getTreatment';
+exports.GET_TREATMENTS = 'getTreatments';
+exports.GET_TREATMENT_WITH_CONFIG = 'getTreatmentWithConfig';
+exports.GET_TREATMENTS_WITH_CONFIG = 'getTreatmentsWithConfig';
+exports.GET_TREATMENTS_BY_FLAG_SET = 'getTreatmentsByFlagSet';
+exports.GET_TREATMENTS_BY_FLAG_SETS = 'getTreatmentsByFlagSets';
+exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET = 'getTreatmentsWithConfigByFlagSet';
+exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS = 'getTreatmentsWithConfigByFlagSets';
+exports.TRACK_FN_LABEL = 'track';
+// Manager method names
+exports.SPLIT_FN_LABEL = 'split';
+exports.SPLITS_FN_LABEL = 'splits';
+exports.NAMES_FN_LABEL = 'names';
 // Telemetry
 exports.QUEUED = 0;
 exports.DROPPED = 1;

package/cjs/utils/inputValidation/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validatePreloadedData = exports.validateTrafficTypeExistance = exports.validateSplitExistance = exports.validateIfOperational = exports.validateIfNotDestroyed = exports.validateTrafficType = exports.validateSplits = exports.validateSplit = exports.validateKey = exports.validateEventProperties = exports.validateEventValue = exports.validateEvent = exports.validateAttributes = exports.releaseApiKey = exports.validateAndTrackApiKey = exports.validateApiKey = void 0;
+exports.validatePreloadedData = exports.validateTrafficTypeExistence = exports.validateSplitExistence = exports.validateIfOperational = exports.validateIfNotDestroyed = exports.validateTrafficType = exports.validateSplits = exports.validateSplit = exports.validateKey = exports.validateEventProperties = exports.validateEventValue = exports.validateEvent = exports.validateAttributes = exports.releaseApiKey = exports.validateAndTrackApiKey = exports.validateApiKey = void 0;
 var apiKey_1 = require("./apiKey");
 Object.defineProperty(exports, "validateApiKey", { enumerable: true, get: function () { return apiKey_1.validateApiKey; } });
 Object.defineProperty(exports, "validateAndTrackApiKey", { enumerable: true, get: function () { return apiKey_1.validateAndTrackApiKey; } });
@@ -24,9 +24,9 @@ Object.defineProperty(exports, "validateTrafficType", { enumerable: true, get: f
 var isOperational_1 = require("./isOperational");
 Object.defineProperty(exports, "validateIfNotDestroyed", { enumerable: true, get: function () { return isOperational_1.validateIfNotDestroyed; } });
 Object.defineProperty(exports, "validateIfOperational", { enumerable: true, get: function () { return isOperational_1.validateIfOperational; } });
-var splitExistance_1 = require("./splitExistance");
-Object.defineProperty(exports, "validateSplitExistance", { enumerable: true, get: function () { return splitExistance_1.validateSplitExistance; } });
-var trafficTypeExistance_1 = require("./trafficTypeExistance");
-Object.defineProperty(exports, "validateTrafficTypeExistance", { enumerable: true, get: function () { return trafficTypeExistance_1.validateTrafficTypeExistance; } });
+var splitExistence_1 = require("./splitExistence");
+Object.defineProperty(exports, "validateSplitExistence", { enumerable: true, get: function () { return splitExistence_1.validateSplitExistence; } });
+var trafficTypeExistence_1 = require("./trafficTypeExistence");
+Object.defineProperty(exports, "validateTrafficTypeExistence", { enumerable: true, get: function () { return trafficTypeExistence_1.validateTrafficTypeExistence; } });
 var preloadedData_1 = require("./preloadedData");
 Object.defineProperty(exports, "validatePreloadedData", { enumerable: true, get: function () { return preloadedData_1.validatePreloadedData; } });

package/cjs/utils/inputValidation/{splitExistance.js → splitExistence.js}

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateSplitExistance = void 0;
+exports.validateSplitExistence = void 0;
 var labels_1 = require("../labels");
 var constants_1 = require("../../logger/constants");
 /**
  * This is defined here and in this format mostly because of the logger and the fact that it's considered a validation at product level.
  * But it's not going to run on the input validation layer. In any case, the most compeling reason to use it as we do is to avoid going to Redis and get a split twice.
  */
-function validateSplitExistance(log, readinessManager, splitName, labelOrSplitObj, method) {
+function validateSplitExistence(log, readinessManager, splitName, labelOrSplitObj, method) {
     if (readinessManager.isReady()) { // Only if it's ready we validate this, otherwise it may just be that the SDK is not ready yet.
         if (labelOrSplitObj === labels_1.SPLIT_NOT_FOUND || labelOrSplitObj == null) {
             log.warn(constants_1.WARN_NOT_EXISTENT_SPLIT, [method, splitName]);
@@ -16,4 +16,4 @@ function validateSplitExistance(log, readinessManager, splitName, labelOrSplitOb
     }
     return true;
 }
-exports.validateSplitExistance = validateSplitExistance;
+exports.validateSplitExistence = validateSplitExistence;

package/cjs/utils/inputValidation/{trafficTypeExistance.js → trafficTypeExistence.js}

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateTrafficTypeExistance = void 0;
+exports.validateTrafficTypeExistence = void 0;
 var thenable_1 = require("../promise/thenable");
 var constants_1 = require("../constants");
 var constants_2 = require("../../logger/constants");
-function logTTExistanceWarning(log, maybeTT, method) {
+function logTTExistenceWarning(log, maybeTT, method) {
     log.warn(constants_2.WARN_NOT_EXISTENT_TT, [method, maybeTT]);
 }
 /**
  * Separated from the previous method since on some cases it'll be async.
  */
-function validateTrafficTypeExistance(log, readinessManager, splitsCache, mode, maybeTT, method) {
+function validateTrafficTypeExistence(log, readinessManager, splitsCache, mode, maybeTT, method) {
     // If not ready or in localhost mode, we won't run the validation
     if (!readinessManager.isReady() || mode === constants_1.LOCALHOST_MODE)
         return true;
@@ -18,14 +18,14 @@ function validateTrafficTypeExistance(log, readinessManager, splitsCache, mode,
     if ((0, thenable_1.thenable)(res)) {
         return res.then(function (isValid) {
             if (!isValid)
-                logTTExistanceWarning(log, maybeTT, method);
+                logTTExistenceWarning(log, maybeTT, method);
             return isValid; // propagate result
         });
     }
     else {
         if (!res)
-            logTTExistanceWarning(log, maybeTT, method);
+            logTTExistenceWarning(log, maybeTT, method);
         return res;
     }
 }
-exports.validateTrafficTypeExistance = validateTrafficTypeExistance;
+exports.validateTrafficTypeExistence = validateTrafficTypeExistence;

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.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,3 +108,13 @@ function returnSetsUnion(set, set2) {
     return result;
 }
 exports.returnSetsUnion = returnSetsUnion;
+function returnDifference(list, list2) {
+    if (list === void 0) { list = []; }
+    if (list2 === void 0) { list2 = []; }
+    var result = new exports._Set(list);
+    list2.forEach(function (item) {
+        result.delete(item);
+    });
+    return setToArray(result);
+}
+exports.returnDifference = returnDifference;

package/cjs/utils/settingsValidation/index.js

@@ -179,7 +179,7 @@ function settingsValidation(config, validationParams) {
         withDefaults.sync.enabled = true;
     }
     // validate the `splitFilters` settings and parse splits query
-    var splitFiltersValidation = (0, splitFilters_1.validateSplitFilters)(log, withDefaults.sync.splitFilters);
+    var splitFiltersValidation = (0, splitFilters_1.validateSplitFilters)(log, withDefaults.sync.splitFilters, withDefaults.mode);
     withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;
     withDefaults.sync.__splitFiltersValidation = splitFiltersValidation;
     // ensure a valid user consent value

package/cjs/utils/settingsValidation/splitFilters.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.flagSetsAreValid = exports.validateSplitFilters = void 0;
+exports.validateFlagSets = exports.validateSplitFilters = void 0;
+var constants_1 = require("../constants");
 var splits_1 = require("../inputValidation/splits");
-var constants_1 = require("../../logger/constants");
+var constants_2 = require("../../logger/constants");
 var objectAssign_1 = require("../lang/objectAssign");
 var lang_1 = require("../lang");
 // Split filters metadata.
@@ -44,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_1.LOG_PREFIX_SETTINGS, type + " filter", type + " filter value");
+    var result = (0, splits_1.validateSplits)(log, values, constants_2.LOG_PREFIX_SETTINGS, type + " filter", type + " filter value");
     if (result) {
         if (type === 'bySet') {
-            result = sanitizeFlagSets(log, result);
+            result = sanitizeFlagSets(log, result, constants_2.LOG_PREFIX_SETTINGS);
         }
         // check max length
         if (result.length > maxLength)
@@ -80,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
@@ -90,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_1.WARN_SPLITS_FILTER_LOWERCASE_SET, [flagSet]);
+            log.warn(constants_2.WARN_LOWERCASE_FLAGSET, [method, flagSet]);
             flagSet = flagSet.toLowerCase();
         }
         return flagSet;
     })
         .filter(function (flagSet) {
         if (!VALID_FLAGSET_REGEX.test(flagSet)) {
-            log.warn(constants_1.WARN_SPLITS_FILTER_INVALID_SET, [flagSet, VALID_FLAGSET_REGEX, flagSet]);
+            log.warn(constants_2.WARN_INVALID_FLAGSET, [method, flagSet, VALID_FLAGSET_REGEX, flagSet]);
             return false;
         }
         if (typeof flagSet !== 'string')
@@ -120,6 +122,7 @@ function configuredFilter(validFilters, filterType) {
  *
  * @param {ILogger} log logger
  * @param {any} maybeSplitFilters split filters configuration param provided by the user
+ * @param {string} mode settings mode
  * @returns it returns an object with the following properties:
  *  - `validFilters`: the validated `splitFilters` configuration object defined by the user.
  *  - `queryString`: the parsed split filter query. it is null if all filters are invalid or all values in filters are invalid.
@@ -127,7 +130,7 @@ function configuredFilter(validFilters, filterType) {
  *
  * @throws Error if the some of the grouped list of values per filter exceeds the max allowed length
  */
-function validateSplitFilters(log, maybeSplitFilters) {
+function validateSplitFilters(log, maybeSplitFilters, mode) {
     // Validation result schema
     var res = {
         validFilters: [],
@@ -137,9 +140,14 @@ function validateSplitFilters(log, maybeSplitFilters) {
     // do nothing if `splitFilters` param is not a non-empty array or mode is not STANDALONE
     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);
+        return res;
+    }
     // Check collection type
     if (!Array.isArray(maybeSplitFilters) || maybeSplitFilters.length === 0) {
-        log.warn(constants_1.WARN_SPLITS_FILTER_EMPTY);
+        log.warn(constants_2.WARN_SPLITS_FILTER_EMPTY);
         return res;
     }
     // Validate filters and group their values by filter type inside `groupedFilters` object
@@ -149,7 +157,7 @@ function validateSplitFilters(log, maybeSplitFilters) {
             return true;
         }
         else {
-            log.warn(constants_1.WARN_SPLITS_FILTER_INVALID, [index]);
+            log.warn(constants_2.WARN_SPLITS_FILTER_INVALID, [index]);
         }
         return false;
     });
@@ -163,27 +171,27 @@ function validateSplitFilters(log, maybeSplitFilters) {
     // Clean all filters if set filter is present
     if (setFilter) {
         if (configuredFilter(res.validFilters, 'byName') || configuredFilter(res.validFilters, 'byPrefix'))
-            log.error(constants_1.ERROR_SETS_FILTER_EXCLUSIVE);
+            log.error(constants_2.ERROR_SETS_FILTER_EXCLUSIVE);
         (0, objectAssign_1.objectAssign)(res.groupedFilters, { byName: [], byPrefix: [] });
     }
     // build query string
     res.queryString = queryStringBuilder(res.groupedFilters);
-    log.debug(constants_1.SETTINGS_SPLITS_FILTER, [res.queryString]);
+    log.debug(constants_2.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_1.WARN_FLAGSET_NOT_CONFIGURED, [method, flagSet]);
+            log.warn(constants_2.WARN_FLAGSET_NOT_CONFIGURED, [method, flagSet]);
             return false;
         });
     }
     return toReturn;
 }
-exports.flagSetsAreValid = flagSetsAreValid;
+exports.validateFlagSets = validateFlagSets;

package/esm/evaluator/index.js

@@ -2,7 +2,8 @@ import { Engine } from './Engine';
 import { thenable } from '../utils/promise/thenable';
 import * as LabelsConstants from '../utils/labels';
 import { CONTROL } from '../utils/constants';
-import { setToArray } from '../utils/lang/sets';
+import { setToArray, returnSetsUnion, _Set } from '../utils/lang/sets';
+import { WARN_FLAGSET_WITHOUT_FLAGS } from '../logger/constants';
 var treatmentException = {
     treatment: CONTROL,
     label: LabelsConstants.EXCEPTION,
@@ -50,8 +51,23 @@ export function evaluateFeatures(log, key, splitNames, attributes, storage) {
         }) :
         getEvaluations(log, splitNames, parsedSplits, key, attributes, storage);
 }
-export function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage) {
+export function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, method) {
     var storedFlagNames;
+    function evaluate(featureFlagsByFlagSets) {
+        var featureFlags = new _Set();
+        for (var i = 0; i < flagSets.length; i++) {
+            var featureFlagByFlagSet = featureFlagsByFlagSets[i];
+            if (featureFlagByFlagSet.size) {
+                featureFlags = returnSetsUnion(featureFlags, featureFlagByFlagSet);
+            }
+            else {
+                log.warn(WARN_FLAGSET_WITHOUT_FLAGS, [method, flagSets[i]]);
+            }
+        }
+        return featureFlags.size ?
+            evaluateFeatures(log, key, setToArray(featureFlags), attributes, storage) :
+            {};
+    }
     // get features by flag sets
     try {
         storedFlagNames = storage.splits.getNamesByFlagSets(flagSets);
@@ -62,11 +78,11 @@ export function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, stora
     }
     // evaluate related features
     return thenable(storedFlagNames) ?
-        storedFlagNames.then(function (splitNames) { return evaluateFeatures(log, key, setToArray(splitNames), attributes, storage); })
+        storedFlagNames.then(function (storedFlagNames) { return evaluate(storedFlagNames); })
             .catch(function () {
             return {};
         }) :
-        evaluateFeatures(log, key, setToArray(storedFlagNames), attributes, storage);
+        evaluate(storedFlagNames);
 }
 function getEvaluation(log, splitJSON, key, attributes, storage) {
     var evaluation = {

package/esm/logger/constants.js

@@ -89,14 +89,16 @@ export var WARN_NOT_EXISTENT_SPLIT = 215;
 export var WARN_LOWERCASE_TRAFFIC_TYPE = 216;
 export var WARN_NOT_EXISTENT_TT = 217;
 export var WARN_INTEGRATION_INVALID = 218;
+export var WARN_SPLITS_FILTER_IGNORED = 219;
 export var WARN_SPLITS_FILTER_INVALID = 220;
 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;
 export var ERROR_LOGLEVEL_INVALID = 301;
 export var ERROR_CLIENT_LISTENER = 302;

package/esm/logger/messages/warn.js

@@ -23,14 +23,16 @@ export var codesWarn = codesError.concat([
     [c.WARN_NOT_EXISTENT_SPLIT, '%s: feature flag "%s" does not exist in this environment. Please double check what feature flags exist in the Split user interface.'],
     [c.WARN_LOWERCASE_TRAFFIC_TYPE, '%s: traffic_type_name should be all lowercase - converting string to lowercase.'],
     [c.WARN_NOT_EXISTENT_TT, '%s: traffic type "%s" does not have any corresponding feature flag in this environment, make sure you\'re tracking your events to a valid traffic type defined in the Split user interface.'],
-    [c.WARN_FLAGSET_NOT_CONFIGURED, '%s: : you passed %s wich is not part of the configured FlagSetsFilter, ignoring Flag Set.'],
+    [c.WARN_FLAGSET_NOT_CONFIGURED, '%s: you passed %s which is not part of the configured FlagSetsFilter, ignoring Flag Set.'],
     // initialization / settings validation
     [c.WARN_INTEGRATION_INVALID, c.LOG_PREFIX_SETTINGS + ': %s integration item(s) at settings is invalid. %s'],
+    [c.WARN_SPLITS_FILTER_IGNORED, c.LOG_PREFIX_SETTINGS + ': feature flag filters are not applicable for Consumer modes where the SDK does not keep rollout data in sync. Filters were discarded'],
     [c.WARN_SPLITS_FILTER_INVALID, c.LOG_PREFIX_SETTINGS + ': feature flag filter at position %s is invalid. It must be an object with a valid filter type ("bySet", "byName" or "byPrefix") and a list of "values".'],
     [c.WARN_SPLITS_FILTER_EMPTY, c.LOG_PREFIX_SETTINGS + ': feature flag filter configuration must be a non-empty array of filter objects.'],
     [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.'],
 ]);