@splitsoftware/splitio 10.17.3 → 10.17.4-rc.0

package/lib/storage/KeysLocalStorage.js

@@ -1,69 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _inheritsLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/inheritsLoose"));
-
-var _lang = require("../utils/lang");
-
-var _Keys = _interopRequireDefault(require("./Keys"));
-
-var _factory = require("../utils/key/factory");
-
-var KeyBuilderForLocalStorage = /*#__PURE__*/function (_KeyBuilder) {
-  (0, _inheritsLoose2.default)(KeyBuilderForLocalStorage, _KeyBuilder);
-
-  function KeyBuilderForLocalStorage(settings) {
-    var _this;
-
-    _this = _KeyBuilder.call(this, settings) || this;
-    _this.regexSplitCacheKey = new RegExp("^" + _this.settings.storage.prefix + "\\.(splits?|trafficType)\\.");
-    return _this;
-  }
-
-  var _proto = KeyBuilderForLocalStorage.prototype;
-
-  _proto.buildSegmentNameKey = function buildSegmentNameKey(segmentName) {
-    return this.settings.storage.prefix + "." + (0, _factory.matching)(this.settings.core.key) + ".segment." + segmentName;
-  };
-
-  _proto.extractSegmentName = function extractSegmentName(builtSegmentKeyName) {
-    var prefix = this.settings.storage.prefix + "." + (0, _factory.matching)(this.settings.core.key) + ".segment.";
-    if ((0, _lang.startsWith)(builtSegmentKeyName, prefix)) return builtSegmentKeyName.substr(prefix.length);
-  };
-
-  _proto.buildSplitsWithSegmentCountKey = function buildSplitsWithSegmentCountKey() {
-    return this.settings.storage.prefix + ".splits.usingSegments";
-  };
-
-  _proto.buildLastUpdatedKey = function buildLastUpdatedKey() {
-    return this.settings.storage.prefix + ".splits.lastUpdated";
-  };
-
-  _proto.isSplitCacheKey = function isSplitCacheKey(key) {
-    return this.regexSplitCacheKey.test(key);
-  };
-
-  _proto.buildSplitsFilterQueryKey = function buildSplitsFilterQueryKey() {
-    return this.settings.storage.prefix + ".splits.filterQuery";
-  } // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
-  ;
-
-  _proto.buildOldSegmentNameKey = function buildOldSegmentNameKey(segmentName) {
-    return (0, _factory.matching)(this.settings.core.key) + "." + this.settings.storage.prefix + ".segment." + segmentName;
-  } // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
-  ;
-
-  _proto.extractOldSegmentKey = function extractOldSegmentKey(maybeOldKey) {
-    var prefix = (0, _factory.matching)(this.settings.core.key) + "." + this.settings.storage.prefix + ".segment.";
-    if ((0, _lang.startsWith)(maybeOldKey, prefix)) return maybeOldKey.substr(prefix.length);
-  };
-
-  return KeyBuilderForLocalStorage;
-}(_Keys.default);
-
-var _default = KeyBuilderForLocalStorage;
-exports.default = _default;

package/lib/storage/LatencyCache/InMemory.js

@@ -1,64 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _findIndex = _interopRequireDefault(require("./findIndex"));
-
-/**
-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 LatencyCacheInMemory = /*#__PURE__*/function () {
-  function LatencyCacheInMemory() {
-    this.clear();
-  }
-
-  var _proto = LatencyCacheInMemory.prototype;
-
-  _proto.clear = function clear() {
-    this.counters = {};
-    return this;
-  };
-
-  _proto.state = function state() {
-    return this.counters;
-  };
-
-  _proto.track = function track(metricName, latency) {
-    // Initialize if needed
-    if (this.counters[metricName] === undefined) {
-      this.counters[metricName] = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
-    } // +1 based on the latency number
-
-
-    this.counters[metricName][(0, _findIndex.default)(latency)]++;
-    return this;
-  };
-
-  _proto.isEmpty = function isEmpty() {
-    return Object.keys(this.counters).length === 0;
-  };
-
-  _proto.toJSON = function toJSON() {
-    return this.counters;
-  };
-
-  return LatencyCacheInMemory;
-}();
-
-var _default = LatencyCacheInMemory;
-exports.default = _default;

package/lib/storage/LatencyCache/InRedis.js

@@ -1,53 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _inheritsLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/inheritsLoose"));
-
-var _findIndex = _interopRequireDefault(require("./findIndex"));
-
-var _BaseMetricsAsyncCache = _interopRequireDefault(require("../BaseMetricsAsyncCache"));
-
-/**
-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 LatencyCacheInRedis = /*#__PURE__*/function (_BaseMetricsAsyncCach) {
-  (0, _inheritsLoose2.default)(LatencyCacheInRedis, _BaseMetricsAsyncCach);
-
-  function LatencyCacheInRedis(keys, redis) {
-    var _this;
-
-    _this = _BaseMetricsAsyncCach.call(this) || this;
-    _this.keys = keys;
-    _this.redis = redis;
-    return _this;
-  }
-
-  var _proto = LatencyCacheInRedis.prototype;
-
-  _proto.track = function track(metricName, latency) {
-    var bucketNumber = (0, _findIndex.default)(latency);
-    return this.redis.incr(this.keys.buildLatencyKey(metricName, bucketNumber)).catch(function () {// noop, for telemetry metrics there's no need to throw.
-    });
-  };
-
-  return LatencyCacheInRedis;
-}(_BaseMetricsAsyncCache.default);
-
-var _default = LatencyCacheInRedis;
-exports.default = _default;

package/lib/storage/LatencyCache/findIndex.js

@@ -1,12 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _binarySearch = _interopRequireDefault(require("../../utils/binarySearch"));
-
-var _default = _binarySearch.default.bind(null, [1, 1.5, 2.25, 3.38, 5.06, 7.59, 11.39, 17.09, 25.63, 38.44, 57.67, 86.5, 129.75, 194.62, 291.93, 437.89, 656.84, 985.26, 1477.89, 2216.84, 3325.26, 4987.89, 7481.83]);
-
-exports.default = _default;

package/lib/storage/Meta.js

@@ -1,12 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = MetaBuilder;
-
-function MetaBuilder(settings) {
-  return {
-    s: settings.version,
-    i: settings.runtime.ip,
-    n: settings.runtime.hostname
-  };
-}

package/lib/storage/RedisAdapter.js

@@ -1,212 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _inheritsLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/inheritsLoose"));
-
-var _ioredis2 = _interopRequireDefault(require("ioredis"));
-
-var _lang = require("../utils/lang");
-
-var _Sets = require("../utils/lang/Sets");
-
-var _thenable = _interopRequireDefault(require("../utils/promise/thenable"));
-
-var _timeout = _interopRequireDefault(require("../utils/promise/timeout"));
-
-var _logger = _interopRequireDefault(require("../utils/logger"));
-
-var log = (0, _logger.default)('splitio-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', 'pipeline', 'expire', 'mget']; // 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,
-  operationTimeout: 5000
-}; // Library specifics.
-
-var DEFAULT_LIBRARY_OPTIONS = {
-  enableOfflineQueue: false,
-  connectTimeout: DEFAULT_OPTIONS.connectionTimeout,
-  lazyConnect: false
-};
-/**
- * Redis adapter on top of the library of choice (written with ioredis) for some extra control.
- */
-
-var RedisAdapter = /*#__PURE__*/function (_ioredis) {
-  (0, _inheritsLoose2.default)(RedisAdapter, _ioredis);
-
-  function RedisAdapter(storageSettings) {
-    var _this;
-
-    var options = RedisAdapter._defineOptions(storageSettings); // Call the ioredis constructor
-
-
-    _this = _ioredis.call.apply(_ioredis, [this].concat(RedisAdapter._defineLibrarySettings(options))) || this;
-    _this._options = options;
-    _this._notReadyCommandsQueue = [];
-    _this._runningCommands = new _Sets._Set();
-
-    _this._listenToEvents();
-
-    _this._setTimeoutWrappers();
-
-    _this._setDisconnectWrapper();
-
-    return _this;
-  }
-
-  var _proto = RedisAdapter.prototype;
-
-  _proto._listenToEvents = function _listenToEvents() {
-    var _this2 = this;
-
-    this.once('ready', function () {
-      var commandsCount = _this2._notReadyCommandsQueue ? _this2._notReadyCommandsQueue.length : 0;
-      log.info("Redis connection established. Queued commands: " + commandsCount + ".");
-      commandsCount && _this2._notReadyCommandsQueue.forEach(function (queued) {
-        log.info("Executing queued " + queued.name + " command.");
-        queued.command().then(queued.resolve).catch(queued.reject);
-      }); // After the SDK is ready for the first time we'll stop queueing commands. This is just so we can keep handling BUR for them.
-
-      _this2._notReadyCommandsQueue = false;
-    });
-    this.once('close', function () {
-      log.info('Redis connection closed.');
-    });
-  };
-
-  _proto._setTimeoutWrappers = function _setTimeoutWrappers() {
-    var instance = this;
-    METHODS_TO_PROMISE_WRAP.forEach(function (method) {
-      var originalMethod = instance[method];
-
-      instance[method] = function () {
-        var params = arguments;
-
-        function commandWrapper() {
-          log.debug("Executing " + method + "."); // Return original method
-
-          var result = originalMethod.apply(instance, params);
-
-          if ((0, _thenable.default)(result)) {
-            // For handling pending commands on disconnect, add to the set and remove once finished.
-            // On sync commands there's no need, only thenables.
-            instance._runningCommands.add(result);
-
-            var cleanUpRunningCommandsCb = function cleanUpRunningCommandsCb(res) {
-              instance._runningCommands.delete(result);
-
-              return res;
-            }; // Both success and error remove from queue.
-
-
-            result.then(cleanUpRunningCommandsCb, cleanUpRunningCommandsCb);
-            return (0, _timeout.default)(instance._options.operationTimeout, result).catch(function (err) {
-              log.error(method + " operation threw an error or exceeded configured timeout of " + instance._options.operationTimeout + "ms. Message: " + err); // Handling is not the adapter responsibility.
-
-              throw err;
-            });
-          }
-
-          return result;
-        }
-
-        if (instance._notReadyCommandsQueue) {
-          return new Promise(function (res, rej) {
-            instance._notReadyCommandsQueue.unshift({
-              resolve: res,
-              reject: rej,
-              command: commandWrapper,
-              name: method.toUpperCase()
-            });
-          });
-        } else {
-          return commandWrapper();
-        }
-      };
-    });
-  };
-
-  _proto._setDisconnectWrapper = function _setDisconnectWrapper() {
-    var instance = this;
-    var originalMethod = instance.disconnect;
-
-    instance.disconnect = function disconnect() {
-      var params = arguments;
-      setTimeout(function deferedDisconnect() {
-        if (instance._runningCommands.size > 0) {
-          log.info("Attempting to disconnect but there are " + instance._runningCommands.size + " commands still waiting for resolution. Defering disconnection until those finish.");
-          Promise.all((0, _Sets.setToArray)(instance._runningCommands)).then(function () {
-            log.debug('Pending commands finished successfully, disconnecting.');
-            originalMethod.apply(instance, params);
-          }).catch(function (e) {
-            log.warn("Pending commands finished with error: " + e + ". Proceeding with disconnection.");
-            originalMethod.apply(instance, params);
-          });
-        } else {
-          log.debug('No commands pending execution, disconnect.'); // Nothing pending, just proceed.
-
-          originalMethod.apply(instance, params);
-        }
-      }, 10);
-    };
-  }
-  /**
-   * Receives the options and returns an array of parameters for the ioredis constructor.
-   * Keeping both redis setup options for backwards compatibility.
-   */
-  ;
-
-  RedisAdapter._defineLibrarySettings = function _defineLibrarySettings(options) {
-    var opts = (0, _lang.merge)({}, DEFAULT_LIBRARY_OPTIONS);
-    var result = [opts];
-
-    if (!(0, _lang.isString)(options.url)) {
-      (0, _lang.merge)(opts, {
-        // If it's not the string URL, merge the params separately.
-        host: options.host,
-        port: options.port,
-        db: options.db,
-        password: options.pass
-      });
-    } else {
-      // If it IS the string URL, that'll be the first param for ioredis.
-      result.unshift(options.url);
-    }
-
-    return result;
-  }
-  /**
-   * Parses the options into what we care about.
-   */
-  ;
-
-  RedisAdapter._defineOptions = function _defineOptions(_ref) {
-    var connectionTimeout = _ref.connectionTimeout,
-        operationTimeout = _ref.operationTimeout,
-        url = _ref.url,
-        host = _ref.host,
-        port = _ref.port,
-        db = _ref.db,
-        pass = _ref.pass;
-    var parsedOptions = {
-      connectionTimeout: connectionTimeout,
-      operationTimeout: operationTimeout,
-      url: url,
-      host: host,
-      port: port,
-      db: db,
-      pass: pass
-    };
-    return (0, _lang.merge)({}, DEFAULT_OPTIONS, parsedOptions);
-  };
-
-  return RedisAdapter;
-}(_ioredis2.default);
-
-exports.default = RedisAdapter;

package/lib/storage/SegmentCache/InLocalStorage/index.js

@@ -1,171 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _logger = _interopRequireDefault(require("../../../utils/logger"));
-
-var log = (0, _logger.default)('splitio-storage:localstorage');
-var DEFINED = '1';
-
-var SegmentCacheInLocalStorage = /*#__PURE__*/function () {
-  function SegmentCacheInLocalStorage(keys) {
-    this.keys = keys; // There is not need to flush segments cache like splits cache, since resetSegments receives the up-to-date list of active segments
-  }
-
-  var _proto = SegmentCacheInLocalStorage.prototype;
-
-  _proto.addToSegment = function addToSegment(segmentName
-  /*, segmentKeys: Array<string>*/
-  ) {
-    var segmentKey = this.keys.buildSegmentNameKey(segmentName);
-
-    try {
-      localStorage.setItem(segmentKey, DEFINED);
-      return true;
-    } catch (e) {
-      log.error(e);
-      return false;
-    }
-  };
-
-  _proto.removeFromSegment = function removeFromSegment(segmentName
-  /*, segmentKeys: Array<string>*/
-  ) {
-    var segmentKey = this.keys.buildSegmentNameKey(segmentName);
-
-    try {
-      localStorage.removeItem(segmentKey);
-      return true;
-    } catch (e) {
-      log.error(e);
-      return false;
-    }
-  }
-  /**
-   * Reset (update) the cached list of segments with the given list, removing and adding segments if necessary.
-   *
-   * @param {string[]} segmentNames list of segment names
-   * @returns boolean indicating if the cache was updated (i.e., given list was different from the cached one)
-   */
-  ;
-
-  _proto.resetSegments = function resetSegments(segmentNames) {
-    var _this = this;
-
-    var isDiff = false;
-    var index; // Scan current values from localStorage
-
-    var storedSegmentNames = Object.keys(localStorage).reduce(function (accum, key) {
-      var segmentName = _this.keys.extractSegmentName(key);
-
-      if (segmentName) {
-        accum.push(segmentName);
-      } else {
-        // @BREAKING: This is only to clean up "old" keys. Remove this whole else code block.
-        segmentName = _this.keys.extractOldSegmentKey(key);
-
-        if (segmentName) {
-          // this was an old segment key, let's clean up.
-          var newSegmentKey = _this.keys.buildSegmentNameKey(segmentName);
-
-          try {
-            // If the new format key is not there, create it.
-            if (!localStorage.getItem(newSegmentKey) && segmentNames.indexOf(segmentName) > -1) {
-              localStorage.setItem(newSegmentKey, DEFINED); // we are migrating a segment, let's track it.
-
-              accum.push(segmentName);
-            }
-
-            localStorage.removeItem(key); // we migrated the current key, let's delete it.
-          } catch (e) {
-            log.error(e);
-          }
-        }
-      }
-
-      return accum;
-    }, []); // Extreme fast => everything is empty
-
-    if (segmentNames.length === 0 && storedSegmentNames.length === segmentNames.length) return isDiff; // Quick path
-
-    if (storedSegmentNames.length !== segmentNames.length) {
-      isDiff = true;
-      storedSegmentNames.forEach(function (segmentName) {
-        return _this.removeFromSegment(segmentName);
-      });
-      segmentNames.forEach(function (segmentName) {
-        return _this.addToSegment(segmentName);
-      });
-    } else {
-      // Slowest path => we need to find at least 1 difference because
-      for (index = 0; index < segmentNames.length && storedSegmentNames.indexOf(segmentNames[index]) !== -1; index++) {// TODO: why empty statement?
-      }
-
-      if (index < segmentNames.length) {
-        isDiff = true;
-        storedSegmentNames.forEach(function (segmentName) {
-          return _this.removeFromSegment(segmentName);
-        });
-        segmentNames.forEach(function (segmentName) {
-          return _this.addToSegment(segmentName);
-        });
-      }
-    }
-
-    return isDiff;
-  };
-
-  _proto.isInSegment = function isInSegment(segmentName
-  /*, key: string*/
-  ) {
-    return localStorage.getItem(this.keys.buildSegmentNameKey(segmentName)) === DEFINED;
-  };
-
-  _proto.setChangeNumber = function setChangeNumber()
-  /*segmentName: string, changeNumber: number*/
-  {
-    return true;
-  };
-
-  _proto.getChangeNumber = function getChangeNumber()
-  /*segmentName: string*/
-  {
-    return -1;
-  };
-
-  _proto.registerSegment = function registerSegment()
-  /*segment: string*/
-  {
-    return false;
-  };
-
-  _proto.registerSegments = function registerSegments()
-  /*segments: Iterable<string>*/
-  {
-    return false;
-  };
-
-  _proto.getRegisteredSegments = function getRegisteredSegments() {
-    return [];
-  }
-  /**
-   * Removes list of segments from localStorage
-   * @NOTE this method is not being used at the moment
-   */
-  ;
-
-  _proto.flush = function flush() {
-    log.info('Flushing MySegments data from localStorage'); // We cannot simply call `localStorage.clear()` since that implies removing user items from the storage
-    // We could optimize next sentence, since it implies iterating over all localStorage items
-
-    this.resetSegments([]);
-  };
-
-  return SegmentCacheInLocalStorage;
-}();
-
-var _default = SegmentCacheInLocalStorage;
-exports.default = _default;