@splitsoftware/splitio 10.17.3-rc.2 → 10.17.3

package/lib/engine/transforms/unaryNumeric.js

@@ -0,0 +1,26 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+
+/**
+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 transform(unaryNumericObject) {
+  return unaryNumericObject.value;
+}
+
+var _default = transform;
+exports.default = _default;

package/lib/engine/transforms/whitelist.js

@@ -0,0 +1,28 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _Sets = require("../../utils/lang/Sets");
+
+/**
+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 transform(whitelistObject) {
+  return new _Sets._Set(whitelistObject.whitelist);
+}
+
+var _default = transform;
+exports.default = _default;

package/lib/engine/treatments/index.js

@@ -0,0 +1,73 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _lang = require("../../utils/lang");
+
+/**
+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 Treatments(ranges, treatments) {
+  if (!(this instanceof Treatments)) {
+    return new Treatments(ranges, treatments);
+  }
+
+  if (ranges[ranges.length - 1] !== 100) {
+    throw new RangeError('Provided invalid dataset as input');
+  }
+
+  this._ranges = ranges;
+  this._treatments = treatments;
+}
+
+Treatments.parse = function parse(data) {
+  var _data$reduce = data.reduce(function (accum, value) {
+    var size = value.size,
+        treatment = value.treatment;
+    accum.ranges.push(accum.inc += size);
+    accum.treatments.push(treatment);
+    return accum;
+  }, {
+    inc: 0,
+    ranges: [],
+    treatments: []
+  }),
+      ranges = _data$reduce.ranges,
+      treatments = _data$reduce.treatments;
+
+  return new Treatments(ranges, treatments);
+};
+
+Treatments.prototype.getTreatmentFor = function getTreatmentFor(x) {
+  if (x < 0 || x > 100) {
+    throw new RangeError('Please provide a value between 0 and 100');
+  } // Readme [1]
+  // We need to manually add any dependency which escape of dummy resolution
+  // I'll deal with this in a future release
+  // for (let [k, r] of this._ranges.entries()) {
+  //   if (x <= r) return this._treatments[k];
+  // }
+
+
+  var index = (0, _lang.findIndex)(this._ranges, function (range) {
+    return x <= range;
+  });
+  var treatment = this._treatments[index];
+  return treatment;
+};
+
+var _default = Treatments;
+exports.default = _default;

package/lib/engine/value/index.js

@@ -0,0 +1,64 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _logger = _interopRequireDefault(require("../../utils/logger"));
+
+var _sanitize = _interopRequireDefault(require("./sanitize"));
+
+/**
+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:value');
+
+function parseValue(key, attributeName, attributes) {
+  var value = undefined;
+
+  if (attributeName) {
+    if (attributes) {
+      value = attributes[attributeName];
+      log.debug("Extracted attribute [" + attributeName + "], [" + value + "] will be used for matching.");
+    } else {
+      log.warn("Defined attribute [" + attributeName + "], no attributes received.");
+    }
+  } else {
+    value = key;
+  }
+
+  return value;
+}
+/**
+ * Defines value to be matched (key / attribute).
+ */
+
+
+function value(key, matcherDto, attributes) {
+  var attributeName = matcherDto.attribute;
+  var valueToMatch = parseValue(key, attributeName, attributes);
+  var sanitizedValue = (0, _sanitize.default)(matcherDto.type, valueToMatch, matcherDto.dataType, attributes);
+
+  if (sanitizedValue !== undefined) {
+    return sanitizedValue;
+  } else {
+    log.warn("Value " + valueToMatch + " " + (attributeName ? "for attribute " + attributeName + " " : +'') + "doesn't match with expected type.");
+    return;
+  }
+}
+
+var _default = value;
+exports.default = _default;

package/lib/engine/value/sanitize.js

@@ -0,0 +1,137 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _logger = _interopRequireDefault(require("../../utils/logger"));
+
+var _lang = require("../../utils/lang");
+
+var _convertions = require("../convertions");
+
+var _types = require("../matchers/types");
+
+/**
+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:sanitize');
+
+function sanitizeNumber(val) {
+  var num = (0, _lang.toNumber)(val);
+  return isNaN(num) ? undefined : num;
+}
+
+function sanitizeString(val) {
+  var valueToSanitize = val;
+
+  if ((0, _lang.isObject)(val)) {
+    // If the value is an object and is not a key, discard it.
+    valueToSanitize = val.matchingKey ? val.matchingKey : undefined;
+  }
+
+  var str = (0, _lang.toString)(valueToSanitize);
+  return str ? str : undefined;
+}
+
+function sanitizeArray(val) {
+  var arr = Array.isArray(val) ? (0, _lang.uniq)(val.map(function (e) {
+    return e + '';
+  })) : [];
+  return arr.length ? arr : undefined;
+}
+
+function sanitizeBoolean(val) {
+  if (val === true || val === false) return val;
+
+  if (typeof val === 'string') {
+    var lowerCaseValue = val.toLocaleLowerCase();
+    if (lowerCaseValue === 'true') return true;
+    if (lowerCaseValue === 'false') return false;
+  }
+
+  return undefined;
+}
+
+function dependencyProcessor(sanitizedValue, attributes) {
+  return {
+    key: sanitizedValue,
+    attributes: attributes
+  };
+}
+/**
+ * We can define a pre-processing for the value, to be executed prior to matcher evaluation.
+ */
+
+
+function getProcessingFunction(matcherTypeID, dataType) {
+  switch (matcherTypeID) {
+    case _types.matcherTypes.EQUAL_TO:
+      return dataType === 'DATETIME' ? _convertions.zeroSinceHH : undefined;
+
+    case _types.matcherTypes.GREATER_THAN_OR_EQUAL_TO:
+    case _types.matcherTypes.LESS_THAN_OR_EQUAL_TO:
+    case _types.matcherTypes.BETWEEN:
+      return dataType === 'DATETIME' ? _convertions.zeroSinceSS : undefined;
+
+    case _types.matcherTypes.IN_SPLIT_TREATMENT:
+      return dependencyProcessor;
+
+    default:
+      return undefined;
+  }
+}
+
+function sanitizeValue(matcherTypeID, value, dataType, attributes) {
+  var processor = getProcessingFunction(matcherTypeID, dataType);
+  var sanitizedValue;
+
+  switch (dataType) {
+    case _types.matcherDataTypes.NUMBER:
+    case _types.matcherDataTypes.DATETIME:
+      sanitizedValue = sanitizeNumber(value);
+      break;
+
+    case _types.matcherDataTypes.STRING:
+      sanitizedValue = sanitizeString(value);
+      break;
+
+    case _types.matcherDataTypes.SET:
+      sanitizedValue = sanitizeArray(value);
+      break;
+
+    case _types.matcherDataTypes.BOOLEAN:
+      sanitizedValue = sanitizeBoolean(value);
+      break;
+
+    case _types.matcherDataTypes.NOT_SPECIFIED:
+      sanitizedValue = value;
+      break;
+
+    default:
+      sanitizedValue = undefined;
+  }
+
+  if (processor) {
+    sanitizedValue = processor(sanitizedValue, attributes);
+  }
+
+  log.debug("Attempted to sanitize [" + value + "] which should be of type [" + dataType + "]. \n Sanitized and processed value => [" + (sanitizedValue instanceof Object ? JSON.stringify(sanitizedValue) : sanitizedValue) + "]");
+  return sanitizedValue;
+}
+
+var _default = sanitizeValue;
+exports.default = _default;

package/lib/events/index.js

@@ -0,0 +1,80 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _logger = _interopRequireDefault(require("../utils/logger"));
+
+var _timeTracker = _interopRequireDefault(require("../utils/timeTracker"));
+
+var _repeat = _interopRequireDefault(require("../utils/fn/repeat"));
+
+var _events = _interopRequireDefault(require("../services/events"));
+
+var _bulk = _interopRequireDefault(require("../services/events/bulk"));
+
+var log = (0, _logger.default)('splitio-events');
+
+var EventsFactory = function EventsFactory(context) {
+  var settings = context.get(context.constants.SETTINGS);
+  var storage = context.get(context.constants.STORAGE);
+
+  var pushEvents = function pushEvents() {
+    if (storage.events.isEmpty()) return Promise.resolve();
+    log.info("Pushing " + storage.events.state().length + " queued events.");
+
+    var latencyTrackerStop = _timeTracker.default.start(_timeTracker.default.TaskNames.EVENTS_PUSH);
+
+    var json = JSON.stringify(storage.events.toJSON());
+
+    var wrapUpCb = function wrapUpCb() {
+      return latencyTrackerStop();
+    };
+
+    storage.events.clear(); // we always clear the queue.
+
+    return (0, _events.default)((0, _bulk.default)(settings, {
+      body: json
+    })).then(wrapUpCb).catch(wrapUpCb);
+  };
+
+  var stopEventPublisherTimeout = false;
+  var stopEventsPublisher = false;
+
+  var startEventsPublisher = function startEventsPublisher() {
+    return stopEventsPublisher = (0, _repeat.default)(function (schedulePublisher) {
+      return pushEvents().then(function () {
+        return schedulePublisher();
+      });
+    }, settings.scheduler.eventsPushRate);
+  };
+
+  return {
+    start: function start() {
+      // On the browser there may be a wish to wait an specific amount of seconds before the first push.
+      if (settings.startup.eventsFirstPushWindow > 0) {
+        stopEventPublisherTimeout = setTimeout(startEventsPublisher, settings.startup.eventsFirstPushWindow);
+      } else {
+        startEventsPublisher();
+      }
+    },
+    flush: function flush() {
+      return pushEvents();
+    },
+    stop: function stop() {
+      stopEventPublisherTimeout && clearTimeout(stopEventPublisherTimeout);
+      stopEventsPublisher && stopEventsPublisher();
+    },
+    flushAndResetTimer: function flushAndResetTimer() {
+      // Reset the timer and push the events.
+      log.info('Flushing events and reseting timer.');
+      stopEventsPublisher && stopEventsPublisher.reset();
+      return pushEvents();
+    }
+  };
+};
+
+var _default = EventsFactory;
+exports.default = _default;

package/lib/factory/offline.js

@@ -0,0 +1,62 @@
+"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 _offline = _interopRequireDefault(require("../producer/offline"));
+
+var _inputValidation = require("../utils/inputValidation");
+
+//
+// Create SDK instance for offline mode.
+//
+function SplitFactoryOffline(context, sharedTrackers) {
+  var sharedInstance = !sharedTrackers;
+  var readiness = context.get(context.constants.READINESS);
+  var storage = context.get(context.constants.STORAGE);
+  var statusManager = context.get(context.constants.STATUS_MANAGER); // In LOCALHOST mode, shared clients are ready in the next event-loop cycle than created
+  // and then updated on each SDK_SPLITS_ARRIVED event
+
+  if (sharedInstance) setTimeout(function () {
+    readiness.splits.on(readiness.splits.SDK_SPLITS_ARRIVED, function () {
+      readiness.gate.emit(readiness.gate.SDK_UPDATE);
+    });
+    readiness.gate.emit(readiness.gate.SDK_READY);
+  }, 0); // Producer
+
+  var producer = sharedInstance ? undefined : (0, _offline.default)(context); // Start background task for flag updates
+
+  producer && producer.start();
+  var api = (0, _objectAssign.default)( // Proto linkage of the EventEmitter to prevent any change
+  Object.create(statusManager), // GetTreatment/s
+  (0, _client.default)(context), // Utilities
+  {
+    // Destroy instance. Async so we respect the online api.
+    destroy: function destroy() {
+      // Stop background jobs
+      producer && producer.stop(); // Cleanup event listeners
+
+      readiness.destroy(); // Cleanup storage
+
+      storage.destroy && storage.destroy(); // Mark the factory as destroyed.
+
+      context.put(context.constants.DESTROYED, true);
+      !sharedInstance && (0, _inputValidation.releaseApiKey)();
+      return Promise.resolve();
+    }
+  });
+  return {
+    api: api,
+    metricCollectors: false // We won't collect any metrics on localhost mode.
+
+  };
+}
+
+var _default = SplitFactoryOffline;
+exports.default = _default;

package/lib/factory/online.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 _metrics = _interopRequireDefault(require("../metrics"));
+
+var _events = _interopRequireDefault(require("../events"));
+
+var _sync = _interopRequireDefault(require("../sync"));
+
+var _listeners = _interopRequireDefault(require("../listeners"));
+
+var _inputValidation = require("../utils/inputValidation");
+
+var _constants = require("../utils/constants");
+
+// map of authorizationKeys to syncManagers, to keep a single instance per factory and needed to create shared clients
+var syncManagers = {}; //
+// Create SDK instance based on the provided configurations
+//
+
+function SplitFactoryOnline(context, readyTrackers, mainClientMetricCollectors) {
+  var sharedInstance = !!mainClientMetricCollectors;
+  var settings = context.get(context.constants.SETTINGS);
+  var readiness = context.get(context.constants.READINESS);
+  var storage = context.get(context.constants.STORAGE);
+  var statusManager = context.get(context.constants.STATUS_MANAGER); // We are only interested in exposable EventEmitter
+
+  var gate = readiness.gate,
+      splits = readiness.splits,
+      segments = readiness.segments; // Events name
+
+  var SDK_READY = gate.SDK_READY; // Shared instances use parent metrics collectors
+
+  var metrics = sharedInstance ? undefined : (0, _metrics.default)(context); // Shared instances use parent events queue
+
+  var events = sharedInstance ? undefined : (0, _events.default)(context);
+  var syncManager;
+
+  switch (settings.mode) {
+    case _constants.PRODUCER_MODE:
+    case _constants.STANDALONE_MODE:
+      {
+        context.put(context.constants.COLLECTORS, metrics && metrics.collectors); // We don't fully instantiate syncManager if we are creating a shared instance.
+
+        if (sharedInstance) {
+          syncManager = syncManagers[settings.core.authorizationKey].shared(context);
+        } else {
+          syncManager = (0, _sync.default)(context);
+          syncManagers[settings.core.authorizationKey] = syncManager;
+        }
+
+        break;
+      }
+
+    case _constants.CONSUMER_MODE:
+      {
+        context.put(context.constants.READY_FROM_CACHE, true); // For SDK inner workings it's supposed to be ready from cache.
+
+        break;
+      }
+  } // Signal listener only needed for main instances
+
+
+  var signalsListener = sharedInstance ? undefined : new _listeners.default(context, syncManager);
+
+  if (readyTrackers && syncManager && !sharedInstance) {
+    // Only track ready events for non-shared and non-consumer clients
+    var sdkReadyTracker = readyTrackers.sdkReadyTracker,
+        splitsReadyTracker = readyTrackers.splitsReadyTracker,
+        segmentsReadyTracker = readyTrackers.segmentsReadyTracker; // Defered setup of collectors for this task, as it is the only ready latency we store on BE.
+
+    sdkReadyTracker.setCollectorForTask(metrics.collectors);
+    gate.once(SDK_READY, sdkReadyTracker);
+    splits.once(splits.SDK_SPLITS_ARRIVED, splitsReadyTracker);
+    segments.once(segments.SDK_SEGMENTS_ARRIVED, segmentsReadyTracker);
+  } // Start background jobs tasks
+
+
+  syncManager && syncManager.start();
+  metrics && metrics.start();
+  events && context.put(context.constants.EVENTS, events) && events.start(); // If no collectors are stored we are on a shared instance, save main one.
+
+  context.put(context.constants.COLLECTORS, mainClientMetricCollectors);
+  var api = (0, _objectAssign.default)( // Proto linkage of the EventEmitter to prevent any change
+  Object.create(statusManager), // getTreatment/s & track
+  (0, _client.default)(context), // Utilities
+  {
+    // Destroy instance
+    destroy: function destroy() {
+      // Stop background jobs
+      syncManager && syncManager.stop();
+      metrics && metrics.stop();
+      events && events.stop(); // Send impressions and events in parallel.
+
+      return Promise.all([metrics && metrics.flush(), events && events.flush()]).then(function () {
+        // Cleanup event listeners
+        readiness.destroy();
+        signalsListener && signalsListener.stop(); // Cleanup storage
+
+        storage.destroy && storage.destroy(); // Mark the factory as destroyed.
+
+        context.put(context.constants.DESTROYED, true); // And release the API Key and SyncManager
+
+        if (!sharedInstance) {
+          (0, _inputValidation.releaseApiKey)(settings.core.authorizationKey);
+          delete syncManagers[settings.core.authorizationKey];
+        }
+      });
+    }
+  }); // We'll start the signals listener if the client is not a shared instance.
+  // For now, we will only call destroy.
+
+  !sharedInstance && signalsListener.start(api.destroy);
+  return {
+    api: api,
+    metricCollectors: metrics && metrics.collectors
+  };
+}
+
+var _default = SplitFactoryOnline;
+exports.default = _default;

package/lib/impressions/counter.js

@@ -0,0 +1,61 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _time = require("../utils/time");
+
+var _objectAssign = _interopRequireDefault(require("object-assign"));
+
+var ImpressionCounter = /*#__PURE__*/function () {
+  function ImpressionCounter() {
+    this.cache = {};
+  }
+  /**
+  * Builds key to be stored in the cache with the featureName and the timeFrame truncated.
+  */
+
+
+  var _proto = ImpressionCounter.prototype;
+
+  _proto._makeKey = function _makeKey(featureName, timeFrame) {
+    return featureName + "::" + (0, _time.truncateTimeFrame)(timeFrame);
+  }
+  /**
+  * Increments the quantity of impressions with the passed featureName and timeFrame.
+  */
+  ;
+
+  _proto.inc = function inc(featureName, timeFrame, amount) {
+    var key = this._makeKey(featureName, timeFrame);
+
+    var currentAmount = this.cache[key];
+    this.cache[key] = currentAmount ? currentAmount + amount : amount;
+  }
+  /**
+  * Returns all the elements stored in the cache and resets the cache.
+  */
+  ;
+
+  _proto.popAll = function popAll() {
+    var res = {};
+    (0, _objectAssign.default)(res, this.cache);
+    this.cache = {};
+    return res;
+  }
+  /**
+  * Returns how many keys are stored in cache.
+  */
+  ;
+
+  _proto.size = function size() {
+    return Object.keys(this.cache).length;
+  };
+
+  return ImpressionCounter;
+}();
+
+var _default = ImpressionCounter;
+exports.default = _default;

package/lib/impressions/hasher/buildKey.js

@@ -0,0 +1,8 @@
+"use strict";
+
+exports.__esModule = true;
+exports.buildKey = buildKey;
+
+function buildKey(impression) {
+  return impression.keyName + ":" + impression.feature + ":" + impression.treatment + ":" + impression.label + ":" + impression.changeNumber;
+}

package/lib/impressions/hasher/hashImpression128.js

@@ -0,0 +1,12 @@
+"use strict";
+
+exports.__esModule = true;
+exports.hashImpression128 = hashImpression128;
+
+var _murmur3_128_x = require("../../engine/engine/murmur3/murmur3_128_x86");
+
+var _buildKey = require("./buildKey");
+
+function hashImpression128(impression) {
+  return (0, _murmur3_128_x.hash128)((0, _buildKey.buildKey)(impression));
+}