@splitsoftware/splitio 10.17.3-rc.3 → 10.17.3-rc.4

package/lib/client/browser.js

@@ -0,0 +1,50 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _lang = require("../utils/lang");
+
+var _attributesDecoration = _interopRequireDefault(require("./attributesDecoration"));
+
+var _constants = require("../utils/constants");
+
+var _inputValidation = require("../utils/inputValidation");
+
+function BrowserClientFactory(context) {
+  var _client$track;
+
+  var settings = context.get(context.constants.SETTINGS);
+  var maybeKey = (0, _lang.get)(settings, 'core.key', undefined);
+  var maybeTT = (0, _lang.get)(settings, 'core.trafficType', undefined);
+
+  if (settings.mode === _constants.LOCALHOST_MODE && maybeKey === undefined) {
+    settings.core.key = 'localhost_key';
+  } else {
+    settings.core.key = (0, _inputValidation.validateKey)(maybeKey, 'Client instantiation');
+  } // Key is also binded to the .track method. Same thing happens with trafficType but only if present on configs. (not required)
+
+
+  var trackBindings = [settings.core.key];
+
+  if (maybeTT !== undefined) {
+    var tt = (0, _inputValidation.validateTrafficType)(maybeTT, 'Client instantiation');
+    settings.core.trafficType = tt;
+    trackBindings.push(tt);
+  }
+
+  var client = (0, _attributesDecoration.default)(context, true, trackBindings.length > 1);
+  client.isBrowserClient = true; // In the browser land, we can bind the key and the traffic type (if provided)
+
+  client.getTreatment = client.getTreatment.bind(client, settings.core.key);
+  client.getTreatmentWithConfig = client.getTreatmentWithConfig.bind(client, settings.core.key);
+  client.getTreatments = client.getTreatments.bind(client, settings.core.key);
+  client.getTreatmentsWithConfig = client.getTreatmentsWithConfig.bind(client, settings.core.key);
+  client.track = (_client$track = client.track).bind.apply(_client$track, [client].concat(trackBindings));
+  return client;
+}
+
+var _default = BrowserClientFactory;
+exports.default = _default;

package/lib/client/client.js

@@ -0,0 +1,174 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _logger = _interopRequireDefault(require("../utils/logger"));
+
+var _evaluator = require("../engine/evaluator");
+
+var _impressions = _interopRequireDefault(require("../trackers/impressions"));
+
+var _event = _interopRequireDefault(require("../trackers/event"));
+
+var _timeTracker = _interopRequireDefault(require("../utils/timeTracker"));
+
+var _thenable = _interopRequireDefault(require("../utils/promise/thenable"));
+
+var _factory = require("../utils/key/factory");
+
+var _inputValidation = require("../utils/inputValidation");
+
+var _labels = require("../utils/labels");
+
+var _constants = require("../utils/constants");
+
+var log = (0, _logger.default)('splitio-client');
+
+function ClientFactory(context) {
+  var storage = context.get(context.constants.STORAGE);
+  var metricCollectors = context.get(context.constants.COLLECTORS);
+  var impressionsTracker = (0, _impressions.default)(context);
+  var eventTracker = (0, _event.default)(context);
+
+  function getTreatment(key, splitName, attributes, withConfig) {
+    if (withConfig === void 0) {
+      withConfig = false;
+    }
+
+    var taskToBeTracked = _timeTracker.default.TaskNames[withConfig ? 'SDK_GET_TREATMENT_WITH_CONFIG' : 'SDK_GET_TREATMENT'];
+
+    var stopLatencyTracker = _timeTracker.default.start(taskToBeTracked, metricCollectors);
+
+    var evaluation = (0, _evaluator.evaluateFeature)(key, splitName, attributes, storage);
+
+    var wrapUp = function wrapUp(evaluationResult) {
+      var treatment = processEvaluation(evaluationResult, splitName, key, attributes, withConfig, "getTreatment" + (withConfig ? 'withConfig' : ''));
+      impressionsTracker.track();
+      stopLatencyTracker();
+      return treatment;
+    };
+
+    return (0, _thenable.default)(evaluation) ? evaluation.then(function (res) {
+      return wrapUp(res);
+    }) : wrapUp(evaluation);
+  }
+
+  function getTreatmentWithConfig(key, splitName, attributes) {
+    return getTreatment(key, splitName, attributes, true);
+  }
+
+  function getTreatments(key, splitNames, attributes, withConfig) {
+    if (withConfig === void 0) {
+      withConfig = false;
+    }
+
+    var taskToBeTracked = _timeTracker.default.TaskNames[withConfig ? 'SDK_GET_TREATMENTS_WITH_CONFIG' : 'SDK_GET_TREATMENTS'];
+
+    var stopLatencyTracker = _timeTracker.default.start(taskToBeTracked, metricCollectors);
+
+    var wrapUp = function wrapUp(evaluationResults) {
+      var results = {};
+      Object.keys(evaluationResults).forEach(function (splitName) {
+        results[splitName] = processEvaluation(evaluationResults[splitName], splitName, key, attributes, withConfig, "getTreatments" + (withConfig ? 'withConfig' : ''));
+      });
+      impressionsTracker.track();
+      stopLatencyTracker();
+      return results;
+    };
+
+    var evaluations = (0, _evaluator.evaluateFeatures)(key, splitNames, attributes, storage);
+    return (0, _thenable.default)(evaluations) ? evaluations.then(function (res) {
+      return wrapUp(res);
+    }) : wrapUp(evaluations);
+  }
+
+  function getTreatmentsWithConfig(key, splitNames, attributes) {
+    return getTreatments(key, splitNames, attributes, true);
+  } // Internal function
+
+
+  function processEvaluation(evaluation, splitName, key, attributes, withConfig, invokingMethodName) {
+    var isSdkReady = context.get(context.constants.READY, true) || context.get(context.constants.READY_FROM_CACHE, true);
+    var matchingKey = (0, _factory.matching)(key);
+    var bucketingKey = (0, _factory.bucketing)(key); // If the SDK was not ready, treatment may be incorrect due to having Splits but not segments data.
+
+    if (!isSdkReady) {
+      evaluation = {
+        treatment: _constants.CONTROL,
+        label: _labels.SDK_NOT_READY
+      };
+    }
+
+    var _evaluation = evaluation,
+        treatment = _evaluation.treatment,
+        label = _evaluation.label,
+        changeNumber = _evaluation.changeNumber,
+        _evaluation$config = _evaluation.config,
+        config = _evaluation$config === void 0 ? null : _evaluation$config;
+    log.info("Split: " + splitName + ". Key: " + matchingKey + ". Evaluation: " + treatment + ". Label: " + label);
+
+    if ((0, _inputValidation.validateSplitExistance)(context, splitName, label, invokingMethodName)) {
+      log.info('Queueing corresponding impression.');
+      impressionsTracker.queue({
+        feature: splitName,
+        keyName: matchingKey,
+        treatment: treatment,
+        time: Date.now(),
+        bucketingKey: bucketingKey,
+        label: label,
+        changeNumber: changeNumber
+      }, attributes);
+    }
+
+    if (withConfig) {
+      return {
+        treatment: treatment,
+        config: config
+      };
+    }
+
+    return treatment;
+  }
+
+  function track(key, trafficTypeName, eventTypeId, value, properties, size) {
+    if (value === void 0) {
+      value = null;
+    }
+
+    if (properties === void 0) {
+      properties = null;
+    }
+
+    if (size === void 0) {
+      size = 1024;
+    }
+
+    var matchingKey = (0, _factory.matching)(key);
+    var timestamp = Date.now();
+    var eventData = {
+      eventTypeId: eventTypeId,
+      trafficTypeName: trafficTypeName,
+      value: value,
+      timestamp: timestamp,
+      key: matchingKey,
+      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, _inputValidation.validateTrafficTypeExistance)(trafficTypeName, context, 'track');
+    return eventTracker.track(eventData, size);
+  }
+
+  return {
+    getTreatment: getTreatment,
+    getTreatmentWithConfig: getTreatmentWithConfig,
+    getTreatments: getTreatments,
+    getTreatmentsWithConfig: getTreatmentsWithConfig,
+    track: track
+  };
+}
+
+var _default = ClientFactory;
+exports.default = _default;

package/lib/client/inputValidation.js

@@ -0,0 +1,129 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _objectAssign = _interopRequireDefault(require("object-assign"));
+
+var _client = _interopRequireDefault(require("./client"));
+
+var _inputValidation = require("../utils/inputValidation");
+
+var _lang = require("../utils/lang");
+
+var _constants = require("../utils/constants");
+
+/**
+ * We will validate the input before actually executing the client methods. We should "guard" the client here,
+ * while not polluting the "real" implementation of those methods.
+ */
+function ClientInputValidationLayer(context, isKeyBinded, isTTBinded) {
+  var settings = context.get(context.constants.SETTINGS);
+  var isStorageSync = settings.storage.type !== _constants.STORAGE_REDIS; // instantiate the client
+
+  var client = (0, _client.default)(context); // Keep a reference to the original methods
+
+  var clientGetTreatment = client.getTreatment;
+  var clientGetTreatmentWithConfig = client.getTreatmentWithConfig;
+  var clientGetTreatments = client.getTreatments;
+  var clientGetTreatmentsWithConfig = client.getTreatmentsWithConfig;
+  var clientTrack = client.track;
+  /**
+   * Avoid repeating this validations code
+   */
+
+  function validateEvaluationParams(maybeKey, maybeSplitOrSplits, maybeAttributes, methodName) {
+    var multi = (0, _lang.startsWith)(methodName, 'getTreatments');
+    var key = isKeyBinded ? maybeKey : (0, _inputValidation.validateKey)(maybeKey, methodName);
+    var splitOrSplits = multi ? (0, _inputValidation.validateSplits)(maybeSplitOrSplits, methodName) : (0, _inputValidation.validateSplit)(maybeSplitOrSplits, methodName);
+    var attributes = (0, _inputValidation.validateAttributes)(maybeAttributes, methodName);
+    var isOperational = (0, _inputValidation.validateIfDestroyed)(context);
+    (0, _inputValidation.validateIfReady)(context, methodName);
+    var valid = isOperational && key && splitOrSplits && attributes !== false;
+    return {
+      valid: valid,
+      key: key,
+      splitOrSplits: splitOrSplits,
+      attributes: attributes
+    };
+  }
+
+  client.getTreatment = function getTreatment(maybeKey, maybeSplit, maybeAttributes) {
+    var params = validateEvaluationParams(maybeKey, maybeSplit, maybeAttributes, 'getTreatment');
+
+    if (params.valid) {
+      return clientGetTreatment(params.key, params.splitOrSplits, params.attributes);
+    } else {
+      if (isStorageSync) return _constants.CONTROL;
+      return Promise.resolve(_constants.CONTROL);
+    }
+  };
+
+  client.getTreatmentWithConfig = function getTreatmentWithConfig(maybeKey, maybeSplit, maybeAttributes) {
+    var params = validateEvaluationParams(maybeKey, maybeSplit, maybeAttributes, 'getTreatmentWithConfig');
+
+    if (params.valid) {
+      return clientGetTreatmentWithConfig(params.key, params.splitOrSplits, params.attributes);
+    } else {
+      if (isStorageSync) return (0, _objectAssign.default)({}, _constants.CONTROL_WITH_CONFIG);
+      return Promise.resolve((0, _objectAssign.default)({}, _constants.CONTROL_WITH_CONFIG));
+    }
+  };
+
+  client.getTreatments = function getTreatments(maybeKey, maybeSplits, maybeAttributes) {
+    var params = validateEvaluationParams(maybeKey, maybeSplits, maybeAttributes, 'getTreatments');
+
+    if (params.valid) {
+      return clientGetTreatments(params.key, params.splitOrSplits, params.attributes);
+    } else {
+      var res = {};
+      if (params.splitOrSplits) params.splitOrSplits.forEach(function (split) {
+        return res[split] = _constants.CONTROL;
+      });
+      if (isStorageSync) return res;
+      return Promise.resolve(res);
+    }
+  };
+
+  client.getTreatmentsWithConfig = function getTreatmentsWithConfig(maybeKey, maybeSplits, maybeAttributes) {
+    var params = validateEvaluationParams(maybeKey, maybeSplits, maybeAttributes, 'getTreatmentsWithConfig');
+
+    if (params.valid) {
+      return clientGetTreatmentsWithConfig(params.key, params.splitOrSplits, params.attributes);
+    } else {
+      var res = {};
+      if (params.splitOrSplits) params.splitOrSplits.forEach(function (split) {
+        return res[split] = (0, _objectAssign.default)({}, _constants.CONTROL_WITH_CONFIG);
+      });
+      if (isStorageSync) return res;
+      return Promise.resolve(res);
+    }
+  };
+
+  client.track = function track(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties) {
+    var key = isKeyBinded ? maybeKey : (0, _inputValidation.validateKey)(maybeKey, 'track');
+    var tt = isTTBinded ? maybeTT : (0, _inputValidation.validateTrafficType)(maybeTT, 'track');
+    var event = (0, _inputValidation.validateEvent)(maybeEvent, 'track');
+    var eventValue = (0, _inputValidation.validateEventValue)(maybeEventValue, 'track');
+
+    var _validateEventPropert = (0, _inputValidation.validateEventProperties)(maybeProperties, 'track'),
+        properties = _validateEventPropert.properties,
+        size = _validateEventPropert.size;
+
+    var isOperational = (0, _inputValidation.validateIfDestroyed)(context);
+
+    if (isOperational && key && tt && event && eventValue !== false && properties !== false) {
+      return clientTrack(key, tt, event, eventValue, properties, size);
+    } else {
+      if (isStorageSync) return false;
+      return Promise.resolve(false);
+    }
+  };
+
+  return client;
+}
+
+var _default = ClientInputValidationLayer;
+exports.default = _default;

package/lib/client/node.js

@@ -0,0 +1,14 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = NodeClientFactory;
+
+var _inputValidation = _interopRequireDefault(require("./inputValidation"));
+
+function NodeClientFactory(context) {
+  var client = (0, _inputValidation.default)(context);
+  client.isBrowserClient = false;
+  return client;
+}

package/lib/client/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "./node.js",
+  "browser": "./browser.js"
+}

package/lib/engine/combiners/and.js

@@ -0,0 +1,65 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _lang = require("../../utils/lang");
+
+var _logger = _interopRequireDefault(require("../../utils/logger"));
+
+var _thenable = _interopRequireDefault(require("../../utils/promise/thenable"));
+
+/**
+Copyright 2016 Split Software
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+**/
+var log = (0, _logger.default)('splitio-engine:combiner');
+
+function andResults(results) {
+  var i = 0;
+  var len = results.length;
+  var hasMatchedAll; // loop through all the matchers an stop at the first one returning false.
+
+  for (; i < len && results[i]; i++) {// logic is run inside the condition of evaluates next step.
+  }
+
+  hasMatchedAll = i === len;
+  log.debug("[andCombiner] evaluates to " + hasMatchedAll);
+  return hasMatchedAll;
+}
+
+function andCombinerContext(matchers) {
+  function andCombiner() {
+    for (var _len = arguments.length, params = new Array(_len), _key = 0; _key < _len; _key++) {
+      params[_key] = arguments[_key];
+    }
+
+    var matcherResults = matchers.map(function (matcher) {
+      return matcher.apply(void 0, params);
+    }); // If any matching result is a thenable we should use Promise.all
+
+    if ((0, _lang.findIndex)(matcherResults, _thenable.default) !== -1) {
+      return Promise.all(matcherResults).then(andResults);
+    } else {
+      return andResults(matcherResults);
+    }
+  }
+
+  return andCombiner;
+}
+
+var _default = andCombinerContext;
+exports.default = _default;

package/lib/engine/combiners/ifelseif.js

@@ -0,0 +1,88 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _lang = require("../../utils/lang");
+
+var _logger = _interopRequireDefault(require("../../utils/logger"));
+
+var _thenable = _interopRequireDefault(require("../../utils/promise/thenable"));
+
+var LabelsConstants = _interopRequireWildcard(require("../../utils/labels"));
+
+var _constants = require("../../utils/constants");
+
+/**
+Copyright 2016 Split Software
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+**/
+var log = (0, _logger.default)('splitio-engine:combiner');
+
+function unexpectedInputHandler() {
+  log.error('Invalid Split provided, no valid conditions found');
+  return {
+    treatment: _constants.CONTROL,
+    label: LabelsConstants.EXCEPTION
+  };
+}
+
+function computeTreatment(predicateResults) {
+  var len = predicateResults.length;
+
+  for (var i = 0; i < len; i++) {
+    var evaluation = predicateResults[i];
+
+    if (evaluation !== undefined) {
+      log.debug("Treatment found: " + evaluation.treatment);
+      return evaluation;
+    }
+  }
+
+  log.debug('All predicates evaluated, no treatment found.');
+  return undefined;
+}
+
+function ifElseIfCombinerContext(predicates) {
+  function ifElseIfCombiner(key, seed, trafficAllocation, trafficAllocationSeed, attributes, algo, splitEvaluator) {
+    // In Async environments we are going to have async predicates. There is none way to know
+    // before hand so we need to evaluate all the predicates, verify for thenables, and finally,
+    // define how to return the treatment (wrap result into a Promise or not).
+    var predicateResults = predicates.map(function (evaluator) {
+      return evaluator(key, seed, trafficAllocation, trafficAllocationSeed, splitEvaluator, attributes, algo);
+    }); // if we find a thenable
+
+    if ((0, _lang.findIndex)(predicateResults, _thenable.default) !== -1) {
+      return Promise.all(predicateResults).then(function (results) {
+        return computeTreatment(results);
+      });
+    }
+
+    return computeTreatment(predicateResults);
+  } // if there is none predicates, then there was an error in parsing phase
+
+
+  if (!Array.isArray(predicates) || Array.isArray(predicates) && predicates.length === 0) {
+    return unexpectedInputHandler;
+  } else {
+    return ifElseIfCombiner;
+  }
+}
+
+var _default = ifElseIfCombinerContext;
+exports.default = _default;

package/lib/engine/condition/index.js

@@ -0,0 +1,76 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _engine = _interopRequireDefault(require("../engine"));
+
+var _thenable = _interopRequireDefault(require("../../utils/promise/thenable"));
+
+var LabelsConstants = _interopRequireWildcard(require("../../utils/labels"));
+
+/**
+Copyright 2016 Split Software
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+**/
+// Build Evaluation object if and only if matchingResult is true
+function match(matchingResult, bucketingKey, seed, treatments, label, algo) {
+  if (matchingResult) {
+    var treatment = _engine.default.getTreatment(bucketingKey, seed, treatments, algo);
+
+    return {
+      treatment: treatment,
+      label: label
+    };
+  } // else we should notify the engine to continue evaluating
+
+
+  return undefined;
+} // Condition factory
+
+
+function conditionContext(matcherEvaluator, treatments, label, conditionType) {
+  function conditionEvaluator(key, seed, trafficAllocation, trafficAllocationSeed, splitEvaluator, attributes, algo) {
+    // Whitelisting has more priority than traffic allocation, so we don't apply this filtering to those conditions.
+    if (conditionType === 'ROLLOUT' && !_engine.default.shouldApplyRollout(trafficAllocation, key.bucketingKey, trafficAllocationSeed, algo)) {
+      return {
+        treatment: undefined,
+        label: LabelsConstants.NOT_IN_SPLIT
+      };
+    } // matcherEvaluator could be Async, this relays on matchers return value, so we need
+    // to verify for thenable before play with the result.
+    // Also, we pass splitEvaluator function in case we have a matcher that needs to evaluate another split,
+    // as well as the entire key object for the same reason.
+
+
+    var matches = matcherEvaluator(key, attributes, splitEvaluator);
+
+    if ((0, _thenable.default)(matches)) {
+      return matches.then(function (result) {
+        return match(result, key.bucketingKey, seed, treatments, label, algo);
+      });
+    }
+
+    return match(matches, key.bucketingKey, seed, treatments, label, algo);
+  }
+
+  return conditionEvaluator;
+}
+
+var _default = conditionContext;
+exports.default = _default;

package/lib/engine/convertions/index.js

@@ -0,0 +1,36 @@
+"use strict";
+
+exports.__esModule = true;
+exports.zeroSinceHH = zeroSinceHH;
+exports.zeroSinceSS = zeroSinceSS;
+
+/**
+Copyright 2016 Split Software
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+**/
+function zeroSinceHH(millisSinceEpoch
+/*: number */
+)
+/*: number */
+{
+  return new Date(millisSinceEpoch).setUTCHours(0, 0, 0, 0);
+}
+
+function zeroSinceSS(millisSinceEpoch
+/*: number */
+)
+/*: number */
+{
+  return new Date(millisSinceEpoch).setUTCSeconds(0, 0);
+}