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

package/CHANGES.txt

@@ -1,17 +1,18 @@
 1.12.0 (December XX, 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 wrap missing commands: 'hincrby', 'popNRaw', 'flushdb' and 'pipeline.exec'.
+ - Updated Redis adapter to handle timeouts and queueing of some missing commands: 'hincrby', 'popNRaw', and 'pipeline.exec'.
+ - Bugfixing - Fixed manager methods in consumer modes to return results in a promise when the SDK is not operational (not ready or destroyed).
 
 1.11.0 (November 3, 2023)
-  - Added support for Flag Sets on the SDK, which enables grouping feature flags and interacting with the group rather than individually (more details in our documentation):
-    - Added new variations of the get treatment methods to support evaluating flags in given flag set/s.
-      - getTreatmentsByFlagSet and getTreatmentsByFlagSets
-      - getTreatmentsWithConfigByFlagSets and getTreatmentsWithConfigByFlagSets
-    - Added a new optional Split Filter configuration option. This allows the SDK and Split services to only synchronize the flags in the specified flag sets, avoiding unused or unwanted flags from being synced on the SDK instance, bringing all the benefits from a reduced payload.
-      - Note: Only applicable when the SDK is in charge of the rollout data synchronization. When not applicable, the SDK will log a warning on init.
-    - Added `sets` property to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager to expose flag sets on flag views.
-  - Bugfixing - Fixed SDK key validation in NodeJS to ensure the SDK_READY_TIMED_OUT event is emitted when a client-side type SDK key is provided instead of a server-side one (Related to issue https://github.com/splitio/javascript-client/issues/768).
+ - Added support for Flag Sets on the SDK, which enables grouping feature flags and interacting with the group rather than individually (more details in our documentation):
+   - Added new variations of the get treatment methods to support evaluating flags in given flag set/s.
+     - getTreatmentsByFlagSet and getTreatmentsByFlagSets
+     - getTreatmentsWithConfigByFlagSets and getTreatmentsWithConfigByFlagSets
+   - Added a new optional Split Filter configuration option. This allows the SDK and Split services to only synchronize the flags in the specified flag sets, avoiding unused or unwanted flags from being synced on the SDK instance, bringing all the benefits from a reduced payload.
+     - Note: Only applicable when the SDK is in charge of the rollout data synchronization. When not applicable, the SDK will log a warning on init.
+   - Added `sets` property to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager to expose flag sets on flag views.
+ - Bugfixing - Fixed SDK key validation in NodeJS to ensure the SDK_READY_TIMED_OUT event is emitted when a client-side type SDK key is provided instead of a server-side one (Related to issue https://github.com/splitio/javascript-client/issues/768).
 
 1.10.0 (October 20, 2023)
  - Added `defaultTreatment` property to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager (Related to issue https://github.com/splitio/javascript-commons/issues/225).

package/cjs/sdkClient/client.js

@@ -24,12 +24,13 @@ 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;
-    function getTreatment(key, featureFlagName, attributes, withConfig) {
+    function getTreatment(key, featureFlagName, attributes, withConfig, methodName) {
         if (withConfig === void 0) { withConfig = false; }
+        if (methodName === void 0) { methodName = constants_1.GET_TREATMENT; }
         var stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? constants_1.TREATMENT_WITH_CONFIG : constants_1.TREATMENT);
         var wrapUp = function (evaluationResult) {
             var queue = [];
-            var treatment = processEvaluation(evaluationResult, featureFlagName, key, attributes, withConfig, "getTreatment" + (withConfig ? 'withConfig' : ''), queue);
+            var treatment = processEvaluation(evaluationResult, featureFlagName, key, attributes, withConfig, methodName, queue);
             impressionsTracker.track(queue, attributes);
             stopTelemetryTracker(queue[0] && queue[0].label);
             return treatment;
@@ -42,16 +43,17 @@ function clientFactory(params) {
         return (0, thenable_1.thenable)(evaluation) ? evaluation.then(function (res) { return wrapUp(res); }) : wrapUp(evaluation);
     }
     function getTreatmentWithConfig(key, featureFlagName, attributes) {
-        return getTreatment(key, featureFlagName, attributes, true);
+        return getTreatment(key, featureFlagName, attributes, true, constants_1.GET_TREATMENT_WITH_CONFIG);
     }
-    function getTreatments(key, featureFlagNames, attributes, withConfig) {
+    function getTreatments(key, featureFlagNames, attributes, withConfig, methodName) {
         if (withConfig === void 0) { withConfig = false; }
+        if (methodName === void 0) { methodName = constants_1.GET_TREATMENTS; }
         var stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? constants_1.TREATMENTS_WITH_CONFIG : constants_1.TREATMENTS);
         var wrapUp = function (evaluationResults) {
             var queue = [];
             var treatments = {};
             Object.keys(evaluationResults).forEach(function (featureFlagName) {
-                treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key, attributes, withConfig, "getTreatments" + (withConfig ? 'withConfig' : ''), queue);
+                treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key, attributes, withConfig, methodName, queue);
             });
             impressionsTracker.track(queue, attributes);
             stopTelemetryTracker(queue[0] && queue[0].label);
@@ -65,36 +67,37 @@ function clientFactory(params) {
         return (0, thenable_1.thenable)(evaluations) ? evaluations.then(function (res) { return wrapUp(res); }) : wrapUp(evaluations);
     }
     function getTreatmentsWithConfig(key, featureFlagNames, attributes) {
-        return getTreatments(key, featureFlagNames, attributes, true);
+        return getTreatments(key, featureFlagNames, attributes, true, constants_1.GET_TREATMENTS_WITH_CONFIG);
     }
-    function getTreatmentsByFlagSets(key, flagSetNames, attributes, withConfig, method) {
+    function getTreatmentsByFlagSets(key, flagSetNames, attributes, withConfig, method, methodName) {
         if (withConfig === void 0) { withConfig = false; }
         if (method === void 0) { method = constants_1.TREATMENTS_BY_FLAGSETS; }
+        if (methodName === void 0) { methodName = constants_1.GET_TREATMENTS_BY_FLAG_SETS; }
         var stopTelemetryTracker = telemetryTracker.trackEval(method);
         var wrapUp = function (evaluationResults) {
             var queue = [];
             var treatments = {};
             var evaluations = evaluationResults;
             Object.keys(evaluations).forEach(function (featureFlagName) {
-                treatments[featureFlagName] = processEvaluation(evaluations[featureFlagName], featureFlagName, key, attributes, withConfig, "getTreatmentsByFlagSets" + (withConfig ? 'WithConfig' : ''), queue);
+                treatments[featureFlagName] = processEvaluation(evaluations[featureFlagName], featureFlagName, key, attributes, withConfig, methodName, queue);
             });
             impressionsTracker.track(queue, attributes);
             stopTelemetryTracker(queue[0] && queue[0].label);
             return treatments;
         };
         var evaluations = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
-            (0, evaluator_1.evaluateFeaturesByFlagSets)(log, key, flagSetNames, attributes, storage, method) :
+            (0, evaluator_1.evaluateFeaturesByFlagSets)(log, key, flagSetNames, attributes, storage, methodName) :
             (0, utils_1.isStorageSync)(settings) ? {} : Promise.resolve({}); // Promisify if async
         return (0, thenable_1.thenable)(evaluations) ? evaluations.then(function (res) { return wrapUp(res); }) : wrapUp(evaluations);
     }
     function getTreatmentsWithConfigByFlagSets(key, flagSetNames, attributes) {
-        return getTreatmentsByFlagSets(key, flagSetNames, attributes, true, constants_1.TREATMENTS_WITH_CONFIG_BY_FLAGSETS);
+        return getTreatmentsByFlagSets(key, flagSetNames, attributes, true, constants_1.TREATMENTS_WITH_CONFIG_BY_FLAGSETS, constants_1.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
     }
     function getTreatmentsByFlagSet(key, flagSetName, attributes) {
-        return getTreatmentsByFlagSets(key, [flagSetName], attributes, false, constants_1.TREATMENTS_BY_FLAGSET);
+        return getTreatmentsByFlagSets(key, [flagSetName], attributes, false, constants_1.TREATMENTS_BY_FLAGSET, constants_1.GET_TREATMENTS_BY_FLAG_SET);
     }
     function getTreatmentsWithConfigByFlagSet(key, flagSetName, attributes) {
-        return getTreatmentsByFlagSets(key, [flagSetName], attributes, true, constants_1.TREATMENTS_WITH_CONFIG_BY_FLAGSET);
+        return getTreatmentsByFlagSets(key, [flagSetName], attributes, true, constants_1.TREATMENTS_WITH_CONFIG_BY_FLAGSET, constants_1.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
     }
     // Internal function
     function processEvaluation(evaluation, featureFlagName, key, attributes, withConfig, invokingMethodName, queue) {
@@ -136,7 +139,7 @@ function clientFactory(params) {
             properties: properties
         };
         // This may be async but we only warn, we don't actually care if it is valid or not in terms of queueing the event.
-        (0, trafficTypeExistence_1.validateTrafficTypeExistence)(log, readinessManager, storage.splits, mode, trafficTypeName, 'track');
+        (0, trafficTypeExistence_1.validateTrafficTypeExistence)(log, readinessManager, storage.splits, mode, trafficTypeName, constants_1.TRACK_FN_LABEL);
         var result = eventTracker.track(eventData, size);
         if ((0, thenable_1.thenable)(result)) {
             return result.then(function (result) {

package/cjs/sdkClient/clientInputValidation.js

@@ -18,7 +18,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
      * Avoid repeating this validations code
      */
     function validateEvaluationParams(maybeKey, maybeFeatureFlagNameOrNames, maybeAttributes, methodName, maybeFlagSetNameOrNames) {
-        var multi = (0, lang_1.startsWith)(methodName, 'getTreatments');
+        var multi = (0, lang_1.startsWith)(methodName, constants_1.GET_TREATMENTS);
         var key = (0, inputValidation_1.validateKey)(log, maybeKey, methodName);
         var splitOrSplits = false;
         var flagSetOrFlagSets = [];
@@ -44,7 +44,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         return isSync ? value : Promise.resolve(value);
     }
     function getTreatment(maybeKey, maybeFeatureFlagName, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagName, maybeAttributes, 'getTreatment');
+        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagName, maybeAttributes, constants_1.GET_TREATMENT);
         if (params.valid) {
             return client.getTreatment(params.key, params.splitOrSplits, params.attributes);
         }
@@ -53,7 +53,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         }
     }
     function getTreatmentWithConfig(maybeKey, maybeFeatureFlagName, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagName, maybeAttributes, 'getTreatmentWithConfig');
+        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagName, maybeAttributes, constants_1.GET_TREATMENT_WITH_CONFIG);
         if (params.valid) {
             return client.getTreatmentWithConfig(params.key, params.splitOrSplits, params.attributes);
         }
@@ -62,7 +62,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         }
     }
     function getTreatments(maybeKey, maybeFeatureFlagNames, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagNames, maybeAttributes, 'getTreatments');
+        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagNames, maybeAttributes, constants_1.GET_TREATMENTS);
         if (params.valid) {
             return client.getTreatments(params.key, params.splitOrSplits, params.attributes);
         }
@@ -74,7 +74,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         }
     }
     function getTreatmentsWithConfig(maybeKey, maybeFeatureFlagNames, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagNames, maybeAttributes, 'getTreatmentsWithConfig');
+        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagNames, maybeAttributes, constants_1.GET_TREATMENTS_WITH_CONFIG);
         if (params.valid) {
             return client.getTreatmentsWithConfig(params.key, params.splitOrSplits, params.attributes);
         }
@@ -86,7 +86,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         }
     }
     function getTreatmentsByFlagSets(maybeKey, maybeFlagSets, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, 'getTreatmentsByFlagSets', maybeFlagSets);
+        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, constants_1.GET_TREATMENTS_BY_FLAG_SETS, maybeFlagSets);
         if (params.valid) {
             return client.getTreatmentsByFlagSets(params.key, params.flagSetOrFlagSets, params.attributes);
         }
@@ -95,7 +95,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         }
     }
     function getTreatmentsWithConfigByFlagSets(maybeKey, maybeFlagSets, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, 'getTreatmentsWithConfigByFlagSets', maybeFlagSets);
+        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, constants_1.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, maybeFlagSets);
         if (params.valid) {
             return client.getTreatmentsWithConfigByFlagSets(params.key, params.flagSetOrFlagSets, params.attributes);
         }
@@ -104,7 +104,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         }
     }
     function getTreatmentsByFlagSet(maybeKey, maybeFlagSet, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, 'getTreatmentsByFlagSet', [maybeFlagSet]);
+        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, constants_1.GET_TREATMENTS_BY_FLAG_SET, [maybeFlagSet]);
         if (params.valid) {
             return client.getTreatmentsByFlagSet(params.key, params.flagSetOrFlagSets[0], params.attributes);
         }
@@ -113,7 +113,7 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         }
     }
     function getTreatmentsWithConfigByFlagSet(maybeKey, maybeFlagSet, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, 'getTreatmentsWithConfigByFlagSet', [maybeFlagSet]);
+        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, constants_1.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET, [maybeFlagSet]);
         if (params.valid) {
             return client.getTreatmentsWithConfigByFlagSet(params.key, params.flagSetOrFlagSets[0], params.attributes);
         }
@@ -122,12 +122,12 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         }
     }
     function track(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties) {
-        var key = (0, inputValidation_1.validateKey)(log, maybeKey, 'track');
-        var tt = (0, inputValidation_1.validateTrafficType)(log, maybeTT, 'track');
-        var event = (0, inputValidation_1.validateEvent)(log, maybeEvent, 'track');
-        var eventValue = (0, inputValidation_1.validateEventValue)(log, maybeEventValue, 'track');
-        var _a = (0, inputValidation_1.validateEventProperties)(log, maybeProperties, 'track'), properties = _a.properties, size = _a.size;
-        var isNotDestroyed = (0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, 'track');
+        var key = (0, inputValidation_1.validateKey)(log, maybeKey, constants_1.TRACK_FN_LABEL);
+        var tt = (0, inputValidation_1.validateTrafficType)(log, maybeTT, constants_1.TRACK_FN_LABEL);
+        var event = (0, inputValidation_1.validateEvent)(log, maybeEvent, constants_1.TRACK_FN_LABEL);
+        var eventValue = (0, inputValidation_1.validateEventValue)(log, maybeEventValue, constants_1.TRACK_FN_LABEL);
+        var _a = (0, inputValidation_1.validateEventProperties)(log, maybeProperties, constants_1.TRACK_FN_LABEL), properties = _a.properties, size = _a.size;
+        var isNotDestroyed = (0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, constants_1.TRACK_FN_LABEL);
         if (isNotDestroyed && key && tt && event && eventValue !== false && properties !== false) { // @ts-expect-error
             return client.track(key, tt, event, eventValue, properties, size);
         }

package/cjs/sdkFactory/index.js

@@ -66,7 +66,7 @@ function sdkFactory(params) {
     ctx.signalListener = signalListener;
     // SDK client and manager
     var clientMethod = sdkClientMethodFactory(ctx);
-    var managerInstance = sdkManagerFactory(log, storage.splits, sdkReadinessManager);
+    var managerInstance = sdkManagerFactory(settings, storage.splits, sdkReadinessManager);
     syncManager && syncManager.start();
     signalListener && signalListener.start();
     log.info(constants_1.NEW_FACTORY);

package/cjs/sdkManager/index.js

@@ -5,9 +5,8 @@ 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 SPLIT_FN_LABEL = 'split';
-var SPLITS_FN_LABEL = 'splits';
-var NAMES_FN_LABEL = 'names';
+var utils_1 = require("../trackers/impressionObserver/utils");
+var constants_1 = require("../utils/constants");
 function collectTreatments(splitObject) {
     var conditions = splitObject.conditions;
     // Rollout conditions are supposed to have the entire partitions list, so we find the first one.
@@ -41,8 +40,10 @@ function objectsToViews(splitObjects) {
     });
     return views;
 }
-function sdkManagerFactory(log, splits, _a) {
+function sdkManagerFactory(settings, splits, _a) {
     var readinessManager = _a.readinessManager, sdkStatus = _a.sdkStatus;
+    var log = settings.log;
+    var isSync = (0, utils_1.isStorageSync)(settings);
     return (0, objectAssign_1.objectAssign)(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkStatus), {
@@ -50,26 +51,26 @@ function sdkManagerFactory(log, splits, _a) {
          * Get the feature flag object corresponding to the given feature flag name if valid
          */
         split: function (featureFlagName) {
-            var splitName = (0, inputValidation_1.validateSplit)(log, featureFlagName, SPLIT_FN_LABEL);
-            if (!(0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, SPLIT_FN_LABEL) || !(0, inputValidation_1.validateIfOperational)(log, readinessManager, SPLIT_FN_LABEL) || !splitName) {
-                return null;
+            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);
             }
             var split = splits.getSplit(splitName);
             if ((0, thenable_1.thenable)(split)) {
                 return split.catch(function () { return null; }).then(function (result) {
-                    (0, inputValidation_1.validateSplitExistence)(log, readinessManager, splitName, result, SPLIT_FN_LABEL);
+                    (0, inputValidation_1.validateSplitExistence)(log, readinessManager, splitName, result, constants_1.SPLIT_FN_LABEL);
                     return objectToView(result);
                 });
             }
-            (0, inputValidation_1.validateSplitExistence)(log, readinessManager, splitName, split, SPLIT_FN_LABEL);
+            (0, inputValidation_1.validateSplitExistence)(log, readinessManager, splitName, split, constants_1.SPLIT_FN_LABEL);
             return objectToView(split);
         },
         /**
          * Get the feature flag objects present on the factory storage
          */
         splits: function () {
-            if (!(0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, SPLITS_FN_LABEL) || !(0, inputValidation_1.validateIfOperational)(log, readinessManager, SPLITS_FN_LABEL)) {
-                return [];
+            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([]);
             }
             var currentSplits = splits.getAll();
             return (0, thenable_1.thenable)(currentSplits) ?
@@ -80,8 +81,8 @@ function sdkManagerFactory(log, splits, _a) {
          * Get the feature flag names present on the factory storage
          */
         names: function () {
-            if (!(0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, NAMES_FN_LABEL) || !(0, inputValidation_1.validateIfOperational)(log, readinessManager, NAMES_FN_LABEL)) {
-                return [];
+            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([]);
             }
             var splitNames = splits.getSplitNames();
             return (0, thenable_1.thenable)(splitNames) ?

package/cjs/storages/inRedis/ImpressionCountsCacheInRedis.js

@@ -23,7 +23,11 @@ var ImpressionCountsCacheInRedis = /** @class */ (function (_super) {
         var keys = Object.keys(counts);
         if (!keys.length)
             return Promise.resolve(false);
-        return this.redis.pipelineExec(keys.map(function (key) { return ['hincrby', _this.key, key, counts[key]]; }))
+        var pipeline = this.redis.pipeline();
+        keys.forEach(function (key) {
+            pipeline.hincrby(_this.key, key, counts[key]);
+        });
+        return pipeline.exec()
             .then(function (data) {
             // If this is the creation of the key on Redis, set the expiration for it in 3600 seconds.
             if (data.length && data.length === keys.length) {

package/cjs/storages/inRedis/RedisAdapter.js

@@ -9,7 +9,8 @@ var thenable_1 = require("../../utils/promise/thenable");
 var timeout_1 = require("../../utils/promise/timeout");
 var LOG_PREFIX = 'storage:redis-adapter: ';
 // If we ever decide to fully wrap every method, there's a Commander.getBuiltinCommands from ioredis.
-var METHODS_TO_PROMISE_WRAP = ['set', 'exec', 'del', 'get', 'keys', 'sadd', 'srem', 'sismember', 'smembers', 'incr', 'rpush', 'expire', 'mget', 'lrange', 'ltrim', 'hset', 'hincrby', 'popNRaw', 'flushdb', 'pipelineExec'];
+var METHODS_TO_PROMISE_WRAP = ['set', 'exec', 'del', 'get', 'keys', 'sadd', 'srem', 'sismember', 'smembers', 'incr', 'rpush', 'expire', 'mget', 'lrange', 'ltrim', 'hset', 'hincrby', 'popNRaw'];
+var METHODS_TO_PROMISE_WRAP_EXEC = ['pipeline'];
 // Not part of the settings since it'll vary on each storage. We should be removing storage specific logic from elsewhere.
 var DEFAULT_OPTIONS = {
     connectionTimeout: 10000,
@@ -27,6 +28,7 @@ var DEFAULT_LIBRARY_OPTIONS = {
 var RedisAdapter = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(RedisAdapter, _super);
     function RedisAdapter(log, storageSettings) {
+        if (storageSettings === void 0) { storageSettings = {}; }
         var _this = this;
         var options = RedisAdapter._defineOptions(storageSettings);
         // Call the ioredis constructor
@@ -40,9 +42,6 @@ var RedisAdapter = /** @class */ (function (_super) {
         _this._setDisconnectWrapper();
         return _this;
     }
-    RedisAdapter.prototype.pipelineExec = function (commands) {
-        return this.pipeline(commands).exec();
-    };
     RedisAdapter.prototype._listenToEvents = function () {
         var _this = this;
         this.once('ready', function () {
@@ -61,13 +60,15 @@ var RedisAdapter = /** @class */ (function (_super) {
     };
     RedisAdapter.prototype._setTimeoutWrappers = function () {
         var instance = this;
-        METHODS_TO_PROMISE_WRAP.forEach(function (methodName) {
-            var originalMethod = instance[methodName];
-            instance[methodName] = function () {
+        var wrapCommand = function (originalMethod, methodName) {
+            // The value of "this" in this function should be the instance actually executing the method. It might be the instance referred (the base one)
+            // or it can be the instance of a Pipeline object.
+            return function () {
                 var params = arguments;
+                var caller = this;
                 function commandWrapper() {
                     instance.log.debug(LOG_PREFIX + "Executing " + methodName + ".");
-                    var result = originalMethod.apply(instance, params);
+                    var result = originalMethod.apply(caller, params);
                     if ((0, thenable_1.thenable)(result)) {
                         // For handling pending commands on disconnect, add to the set and remove once finished.
                         // On sync commands there's no need, only thenables.
@@ -86,10 +87,10 @@ var RedisAdapter = /** @class */ (function (_super) {
                     return result;
                 }
                 if (instance._notReadyCommandsQueue) {
-                    return new Promise(function (res, rej) {
+                    return new Promise(function (resolve, reject) {
                         instance._notReadyCommandsQueue.unshift({
-                            resolve: res,
-                            reject: rej,
+                            resolve: resolve,
+                            reject: reject,
                             command: commandWrapper,
                             name: methodName.toUpperCase()
                         });
@@ -99,6 +100,22 @@ var RedisAdapter = /** @class */ (function (_super) {
                     return commandWrapper();
                 }
             };
+        };
+        // Wrap regular async methods to track timeouts and queue when Redis is not yet executing commands.
+        METHODS_TO_PROMISE_WRAP.forEach(function (methodName) {
+            var originalFn = instance[methodName];
+            instance[methodName] = wrapCommand(originalFn, methodName);
+        });
+        // Special handling for pipeline~like methods. We need to wrap the async trigger, which is exec, but return the Pipeline right away.
+        METHODS_TO_PROMISE_WRAP_EXEC.forEach(function (methodName) {
+            var originalFn = instance[methodName];
+            // "First level wrapper" to handle the sync execution and wrap async, queueing later if applicable.
+            instance[methodName] = function () {
+                var res = originalFn.apply(instance, arguments);
+                var originalExec = res.exec;
+                res.exec = wrapCommand(originalExec, methodName + '.exec').bind(res);
+                return res;
+            };
         });
     };
     RedisAdapter.prototype._setDisconnectWrapper = function () {
@@ -160,7 +177,7 @@ var RedisAdapter = /** @class */ (function (_super) {
      * Parses the options into what we care about.
      */
     RedisAdapter._defineOptions = function (_a) {
-        var _b = _a === void 0 ? {} : _a, connectionTimeout = _b.connectionTimeout, operationTimeout = _b.operationTimeout, url = _b.url, host = _b.host, port = _b.port, db = _b.db, pass = _b.pass, tls = _b.tls;
+        var connectionTimeout = _a.connectionTimeout, operationTimeout = _a.operationTimeout, url = _a.url, host = _a.host, port = _a.port, db = _a.db, pass = _a.pass, tls = _a.tls;
         var parsedOptions = {
             connectionTimeout: connectionTimeout,
             operationTimeout: operationTimeout,

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

@@ -171,7 +171,7 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
     SplitsCacheInRedis.prototype.getAll = function () {
         var _this = this;
         return this.redis.keys(this.keys.searchPatternForSplitKeys())
-            .then(function (listOfKeys) { return _this.redis.pipelineExec(listOfKeys.map(function (k) { return ['get', k]; })); })
+            .then(function (listOfKeys) { return _this.redis.pipeline(listOfKeys.map(function (k) { return ['get', k]; })).exec(); })
             .then(processPipelineAnswer)
             .then(function (splitDefinitions) { return splitDefinitions.map(function (splitDefinition) {
             return JSON.parse(splitDefinition);
@@ -189,11 +189,11 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
     /**
      * 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.
+     * or rejected if the pipelined redis operation fails (e.g., timeout).
     */
     SplitsCacheInRedis.prototype.getNamesByFlagSets = function (flagSets) {
         var _this = this;
-        return this.redis.pipelineExec(flagSets.map(function (flagSet) { return ['smembers', _this.keys.buildFlagSetKey(flagSet)]; }))
+        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)
@@ -228,13 +228,9 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
             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/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/redis/RedisMock.js

@@ -9,16 +9,22 @@ function asyncFunction(data) {
     return Promise.resolve(data);
 }
 var IDENTITY_METHODS = [];
-var ASYNC_METHODS = ['rpush', 'hincrby', 'pipelineExec'];
+var ASYNC_METHODS = ['rpush', 'hincrby'];
+var PIPELINE_METHODS = ['rpush', 'hincrby'];
 var RedisMock = /** @class */ (function () {
     function RedisMock() {
         var _this = this;
+        this.pipelineMethods = { exec: jest.fn(asyncFunction) };
         IDENTITY_METHODS.forEach(function (method) {
             _this[method] = jest.fn(identityFunction);
         });
         ASYNC_METHODS.forEach(function (method) {
             _this[method] = jest.fn(asyncFunction);
         });
+        PIPELINE_METHODS.forEach(function (method) {
+            _this.pipelineMethods[method] = _this[method];
+        });
+        this.pipeline = jest.fn(function () { return _this.pipelineMethods; });
     }
     return RedisMock;
 }());

package/esm/sdkClient/client.js

@@ -4,7 +4,7 @@ import { getMatching, getBucketing } from '../utils/key';
 import { validateSplitExistence } from '../utils/inputValidation/splitExistence';
 import { validateTrafficTypeExistence } from '../utils/inputValidation/trafficTypeExistence';
 import { SDK_NOT_READY } from '../utils/labels';
-import { CONTROL, TREATMENT, TREATMENTS, TREATMENT_WITH_CONFIG, TREATMENTS_WITH_CONFIG, TRACK, TREATMENTS_WITH_CONFIG_BY_FLAGSETS, TREATMENTS_BY_FLAGSETS, TREATMENTS_BY_FLAGSET, TREATMENTS_WITH_CONFIG_BY_FLAGSET } from '../utils/constants';
+import { CONTROL, TREATMENT, TREATMENTS, TREATMENT_WITH_CONFIG, TREATMENTS_WITH_CONFIG, TRACK, TREATMENTS_WITH_CONFIG_BY_FLAGSETS, TREATMENTS_BY_FLAGSETS, TREATMENTS_BY_FLAGSET, TREATMENTS_WITH_CONFIG_BY_FLAGSET, GET_TREATMENTS_WITH_CONFIG, GET_TREATMENTS_BY_FLAG_SETS, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, GET_TREATMENTS_BY_FLAG_SET, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET, GET_TREATMENT_WITH_CONFIG, GET_TREATMENT, GET_TREATMENTS, TRACK_FN_LABEL } from '../utils/constants';
 import { IMPRESSION, IMPRESSION_QUEUEING } from '../logger/constants';
 import { isStorageSync } from '../trackers/impressionObserver/utils';
 var treatmentNotReady = { treatment: CONTROL, label: SDK_NOT_READY };
@@ -21,12 +21,13 @@ function treatmentsNotReady(featureFlagNames) {
 export 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;
-    function getTreatment(key, featureFlagName, attributes, withConfig) {
+    function getTreatment(key, featureFlagName, attributes, withConfig, methodName) {
         if (withConfig === void 0) { withConfig = false; }
+        if (methodName === void 0) { methodName = GET_TREATMENT; }
         var stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? TREATMENT_WITH_CONFIG : TREATMENT);
         var wrapUp = function (evaluationResult) {
             var queue = [];
-            var treatment = processEvaluation(evaluationResult, featureFlagName, key, attributes, withConfig, "getTreatment" + (withConfig ? 'withConfig' : ''), queue);
+            var treatment = processEvaluation(evaluationResult, featureFlagName, key, attributes, withConfig, methodName, queue);
             impressionsTracker.track(queue, attributes);
             stopTelemetryTracker(queue[0] && queue[0].label);
             return treatment;
@@ -39,16 +40,17 @@ export function clientFactory(params) {
         return thenable(evaluation) ? evaluation.then(function (res) { return wrapUp(res); }) : wrapUp(evaluation);
     }
     function getTreatmentWithConfig(key, featureFlagName, attributes) {
-        return getTreatment(key, featureFlagName, attributes, true);
+        return getTreatment(key, featureFlagName, attributes, true, GET_TREATMENT_WITH_CONFIG);
     }
-    function getTreatments(key, featureFlagNames, attributes, withConfig) {
+    function getTreatments(key, featureFlagNames, attributes, withConfig, methodName) {
         if (withConfig === void 0) { withConfig = false; }
+        if (methodName === void 0) { methodName = GET_TREATMENTS; }
         var stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? TREATMENTS_WITH_CONFIG : TREATMENTS);
         var wrapUp = function (evaluationResults) {
             var queue = [];
             var treatments = {};
             Object.keys(evaluationResults).forEach(function (featureFlagName) {
-                treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key, attributes, withConfig, "getTreatments" + (withConfig ? 'withConfig' : ''), queue);
+                treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key, attributes, withConfig, methodName, queue);
             });
             impressionsTracker.track(queue, attributes);
             stopTelemetryTracker(queue[0] && queue[0].label);
@@ -62,36 +64,37 @@ export function clientFactory(params) {
         return thenable(evaluations) ? evaluations.then(function (res) { return wrapUp(res); }) : wrapUp(evaluations);
     }
     function getTreatmentsWithConfig(key, featureFlagNames, attributes) {
-        return getTreatments(key, featureFlagNames, attributes, true);
+        return getTreatments(key, featureFlagNames, attributes, true, GET_TREATMENTS_WITH_CONFIG);
     }
-    function getTreatmentsByFlagSets(key, flagSetNames, attributes, withConfig, method) {
+    function getTreatmentsByFlagSets(key, flagSetNames, attributes, withConfig, method, methodName) {
         if (withConfig === void 0) { withConfig = false; }
         if (method === void 0) { method = TREATMENTS_BY_FLAGSETS; }
+        if (methodName === void 0) { methodName = GET_TREATMENTS_BY_FLAG_SETS; }
         var stopTelemetryTracker = telemetryTracker.trackEval(method);
         var wrapUp = function (evaluationResults) {
             var queue = [];
             var treatments = {};
             var evaluations = evaluationResults;
             Object.keys(evaluations).forEach(function (featureFlagName) {
-                treatments[featureFlagName] = processEvaluation(evaluations[featureFlagName], featureFlagName, key, attributes, withConfig, "getTreatmentsByFlagSets" + (withConfig ? 'WithConfig' : ''), queue);
+                treatments[featureFlagName] = processEvaluation(evaluations[featureFlagName], featureFlagName, key, attributes, withConfig, methodName, queue);
             });
             impressionsTracker.track(queue, attributes);
             stopTelemetryTracker(queue[0] && queue[0].label);
             return treatments;
         };
         var evaluations = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
-            evaluateFeaturesByFlagSets(log, key, flagSetNames, attributes, storage, method) :
+            evaluateFeaturesByFlagSets(log, key, flagSetNames, attributes, storage, methodName) :
             isStorageSync(settings) ? {} : Promise.resolve({}); // Promisify if async
         return thenable(evaluations) ? evaluations.then(function (res) { return wrapUp(res); }) : wrapUp(evaluations);
     }
     function getTreatmentsWithConfigByFlagSets(key, flagSetNames, attributes) {
-        return getTreatmentsByFlagSets(key, flagSetNames, attributes, true, TREATMENTS_WITH_CONFIG_BY_FLAGSETS);
+        return getTreatmentsByFlagSets(key, flagSetNames, attributes, true, TREATMENTS_WITH_CONFIG_BY_FLAGSETS, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS);
     }
     function getTreatmentsByFlagSet(key, flagSetName, attributes) {
-        return getTreatmentsByFlagSets(key, [flagSetName], attributes, false, TREATMENTS_BY_FLAGSET);
+        return getTreatmentsByFlagSets(key, [flagSetName], attributes, false, TREATMENTS_BY_FLAGSET, GET_TREATMENTS_BY_FLAG_SET);
     }
     function getTreatmentsWithConfigByFlagSet(key, flagSetName, attributes) {
-        return getTreatmentsByFlagSets(key, [flagSetName], attributes, true, TREATMENTS_WITH_CONFIG_BY_FLAGSET);
+        return getTreatmentsByFlagSets(key, [flagSetName], attributes, true, TREATMENTS_WITH_CONFIG_BY_FLAGSET, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET);
     }
     // Internal function
     function processEvaluation(evaluation, featureFlagName, key, attributes, withConfig, invokingMethodName, queue) {
@@ -133,7 +136,7 @@ export function clientFactory(params) {
             properties: properties
         };
         // This may be async but we only warn, we don't actually care if it is valid or not in terms of queueing the event.
-        validateTrafficTypeExistence(log, readinessManager, storage.splits, mode, trafficTypeName, 'track');
+        validateTrafficTypeExistence(log, readinessManager, storage.splits, mode, trafficTypeName, TRACK_FN_LABEL);
         var result = eventTracker.track(eventData, size);
         if (thenable(result)) {
             return result.then(function (result) {