@splitsoftware/splitio 10.17.2 → 10.17.3-rc.0

package/es/storage/SplitCache/InLocalStorage.js

@@ -1,332 +0,0 @@
-import { numberIsFinite, toNumber, numberIsNaN } from '../../utils/lang';
-import usesSegments from '../../utils/splits/usesSegments';
-import logFactory from '../../utils/logger';
-var log = logFactory('splitio-storage:localstorage');
-import killLocally from './killLocally';
-
-var SplitCacheLocalStorage = /*#__PURE__*/function () {
-  /**
-   * @param {Object} keys
-   * @param {number} expirationTimestamp
-   * @param {Object} splitFiltersValidation
-   */
-  function SplitCacheLocalStorage(keys, expirationTimestamp, splitFiltersValidation) {
-    if (splitFiltersValidation === void 0) {
-      splitFiltersValidation = {
-        validFilters: [],
-        queryString: null,
-        groupedFilters: {
-          byName: [],
-          byPrefix: []
-        }
-      };
-    }
-
-    this.keys = keys;
-    this.splitFiltersValidation = splitFiltersValidation;
-
-    this.__checkExpiration(expirationTimestamp);
-
-    this.__checkFilterQuery();
-  }
-
-  var _proto = SplitCacheLocalStorage.prototype;
-
-  _proto.decrementCount = function decrementCount(key) {
-    var count = toNumber(localStorage.getItem(key)) - 1;
-    if (count > 0) localStorage.setItem(key, count);else localStorage.removeItem(key);
-  };
-
-  _proto.decrementCounts = function decrementCounts(split) {
-    try {
-      if (split) {
-        if (split.trafficTypeName) {
-          var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-          this.decrementCount(ttKey);
-        }
-
-        if (usesSegments(split.conditions)) {
-          var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-          this.decrementCount(segmentsCountKey);
-        }
-      }
-    } catch (e) {
-      log.error(e);
-    }
-  };
-
-  _proto.incrementCounts = function incrementCounts(split) {
-    try {
-      if (split) {
-        if (split.trafficTypeName) {
-          var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-          localStorage.setItem(ttKey, toNumber(localStorage.getItem(ttKey)) + 1);
-        }
-
-        if (usesSegments(split.conditions)) {
-          var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-          localStorage.setItem(segmentsCountKey, toNumber(localStorage.getItem(segmentsCountKey)) + 1);
-        }
-      }
-    } catch (e) {
-      log.error(e);
-    }
-  };
-
-  _proto.addSplit = function addSplit(splitName, split) {
-    try {
-      var splitKey = this.keys.buildSplitKey(splitName);
-      var splitFromLocalStorage = localStorage.getItem(splitKey);
-      var previousSplit = splitFromLocalStorage ? JSON.parse(splitFromLocalStorage) : null;
-      this.decrementCounts(previousSplit);
-      localStorage.setItem(splitKey, split);
-      var parsedSplit = split ? JSON.parse(split) : null;
-      this.incrementCounts(parsedSplit);
-      return true;
-    } catch (e) {
-      log.error(e);
-      return false;
-    }
-  };
-
-  _proto.addSplits = function addSplits(entries) {
-    var _this = this;
-
-    var results = [];
-    entries.forEach(function (keyValuePair) {
-      results.push(_this.addSplit(keyValuePair[0], keyValuePair[1]));
-    });
-    return results;
-  };
-
-  _proto.removeSplit = function removeSplit(splitName) {
-    try {
-      var split = this.getSplit(splitName);
-      localStorage.removeItem(this.keys.buildSplitKey(splitName));
-      var parsedSplit = JSON.parse(split);
-      this.decrementCounts(parsedSplit);
-      return 1;
-    } catch (e) {
-      log.error(e);
-      return 0;
-    }
-  }
-  /**
-   * Bulk delete of splits from LocalStorage. Returns the number of deleted keys.
-   */
-  ;
-
-  _proto.removeSplits = function removeSplits(names) {
-    var i = 0;
-    var len = names.length;
-    var counter = 0;
-
-    for (; i < len; i++) {
-      counter += this.removeSplit(names[i]);
-    }
-
-    return counter;
-  };
-
-  _proto.getSplit = function getSplit(splitName) {
-    return localStorage.getItem(this.keys.buildSplitKey(splitName));
-  };
-
-  _proto.setChangeNumber = function setChangeNumber(changeNumber) {
-    // when cache is ready but using a new split query, we must flush all split data
-    if (this.cacheReadyButNeedsToFlush) {
-      this.flush();
-      this.cacheReadyButNeedsToFlush = false;
-    } // when using a new split query, we must update it at the store
-
-
-    if (this.updateNewFilter) {
-      log.info('Split filter query was modified. Updating cache.');
-      var queryKey = this.keys.buildSplitsFilterQueryKey();
-      var queryString = this.splitFiltersValidation.queryString;
-
-      try {
-        if (queryString) localStorage.setItem(queryKey, queryString);else localStorage.removeItem(queryKey);
-      } catch (e) {
-        log.error(e);
-      }
-
-      this.updateNewFilter = false;
-    }
-
-    try {
-      localStorage.setItem(this.keys.buildSplitsTillKey(), changeNumber + ''); // update "last updated" timestamp with current time
-
-      localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
-      this.hasSync = true;
-      return true;
-    } catch (e) {
-      log.error(e);
-      return false;
-    }
-  };
-
-  _proto.getChangeNumber = function getChangeNumber() {
-    var n = -1;
-    var value = localStorage.getItem(this.keys.buildSplitsTillKey());
-
-    if (value !== null) {
-      value = parseInt(value, 10);
-      return numberIsNaN(value) ? n : value;
-    }
-
-    return n;
-  };
-
-  _proto.getAll = function getAll() {
-    var len = localStorage.length;
-    var accum = [];
-    var cur = 0;
-
-    while (cur < len) {
-      var key = localStorage.key(cur);
-      var value = key && localStorage.getItem(key);
-      if (key != null && this.keys.isSplitKey(key) && value) accum.push(value);
-      cur++;
-    }
-
-    return accum;
-  };
-
-  _proto.getKeys = function getKeys() {
-    var len = localStorage.length;
-    var accum = [];
-    var cur = 0;
-
-    while (cur < len) {
-      var key = localStorage.key(cur);
-      if (key != null && this.keys.isSplitKey(key)) accum.push(this.keys.extractKey(key));
-      cur++;
-    }
-
-    return accum;
-  };
-
-  _proto.trafficTypeExists = function trafficTypeExists(trafficType) {
-    var ttCount = toNumber(localStorage.getItem(this.keys.buildTrafficTypeKey(trafficType)));
-    return numberIsFinite(ttCount) && ttCount > 0;
-  };
-
-  _proto.usesSegments = function usesSegments() {
-    // If cache hasn't been synchronized with the cloud, assume we need them.
-    if (!this.hasSync) return true;
-    var storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
-    var splitsWithSegmentsCount = storedCount === null ? 0 : toNumber(storedCount);
-
-    if (numberIsFinite(splitsWithSegmentsCount)) {
-      return splitsWithSegmentsCount > 0;
-    } else {
-      return true;
-    }
-  }
-  /**
-   * Removes all splits cache related data from localStorage (splits, counters, changeNumber and lastUpdated).
-   * We cannot simply call `localStorage.clear()` since that implies removing user items from the storage.
-   */
-  ;
-
-  _proto.flush = function flush() {
-    log.info('Flushing Splits data from localStorage'); // collect item keys
-
-    var len = localStorage.length;
-    var accum = [];
-
-    for (var cur = 0; cur < len; cur++) {
-      var key = localStorage.key(cur);
-      if (key != null && this.keys.isSplitCacheKey(key)) accum.push(key);
-    } // remove items
-
-
-    accum.forEach(function (key) {
-      localStorage.removeItem(key);
-    });
-    this.hasSync = false;
-  }
-  /**
-   * Fetches multiple splits definitions.
-   */
-  ;
-
-  _proto.fetchMany = function fetchMany(splitNames) {
-    var _this2 = this;
-
-    var splits = {};
-    splitNames.forEach(function (splitName) {
-      splits[splitName] = localStorage.getItem(_this2.keys.buildSplitKey(splitName));
-    });
-    return splits;
-  }
-  /**
-   * Check if the splits information is already stored in cache.
-   * It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
-   * In this function we could add more code to check if the data is valid.
-   */
-  ;
-
-  _proto.checkCache = function checkCache() {
-    return this.getChangeNumber() > -1 || this.cacheReadyButNeedsToFlush;
-  }
-  /**
-   * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
-   * Clean operation (flush) also updates `lastUpdated` timestamp with current time.
-   *
-   * @param {number | undefined} expirationTimestamp if the value is not a number, data will not be cleaned
-   */
-  ;
-
-  _proto.__checkExpiration = function __checkExpiration(expirationTimestamp) {
-    var value = localStorage.getItem(this.keys.buildLastUpdatedKey());
-
-    if (value !== null) {
-      value = parseInt(value, 10);
-      if (!numberIsNaN(value) && value < expirationTimestamp) this.flush();
-    }
-  };
-
-  _proto.__checkFilterQuery = function __checkFilterQuery() {
-    var _this3 = this;
-
-    var _this$splitFiltersVal = this.splitFiltersValidation,
-        queryString = _this$splitFiltersVal.queryString,
-        groupedFilters = _this$splitFiltersVal.groupedFilters;
-    var queryKey = this.keys.buildSplitsFilterQueryKey();
-    var currentQueryString = localStorage.getItem(queryKey);
-
-    if (currentQueryString !== queryString) {
-      try {
-        // mark cache to update the new query filter on first successful splits fetch
-        this.updateNewFilter = true; // if cache is ready:
-
-        if (this.checkCache()) {
-          // * set change number to -1, to fetch splits with -1 `since` value.
-          localStorage.setItem(this.keys.buildSplitsTillKey(), '-1'); // * remove from cache splits that doesn't match with the new filters
-
-          this.getKeys().forEach(function (splitName) {
-            if (queryString && (groupedFilters.byName.indexOf(splitName) > -1 || groupedFilters.byPrefix.some(function (prefix) {
-              return splitName.startsWith(prefix + '__');
-            }))) {
-              // * set `cacheReadyButNeedsToFlush` so that `checkCache` returns true (the storage is ready to be used) and the data is flushed before updating on first successful splits fetch
-              _this3.cacheReadyButNeedsToFlush = true;
-              return;
-            }
-
-            _this3.removeSplit(splitName);
-          });
-        }
-      } catch (e) {
-        log.error(e);
-      }
-    } // if the filter didn't change, nothing is done
-
-  };
-
-  return SplitCacheLocalStorage;
-}();
-
-SplitCacheLocalStorage.prototype.killLocally = killLocally;
-export default SplitCacheLocalStorage;

package/es/storage/SplitCache/InMemory.js

@@ -1,162 +0,0 @@
-import { numberIsFinite } from '../../utils/lang';
-import usesSegments from '../../utils/splits/usesSegments';
-import killLocally from './killLocally';
-
-var SplitCacheInMemory = /*#__PURE__*/function () {
-  function SplitCacheInMemory() {
-    this.flush();
-  }
-
-  var _proto = SplitCacheInMemory.prototype;
-
-  _proto.addSplit = function addSplit(splitName, split) {
-    var splitFromMemory = this.getSplit(splitName);
-
-    if (splitFromMemory) {
-      // We had this Split already
-      var previousSplit = JSON.parse(splitFromMemory);
-
-      if (previousSplit.trafficTypeName) {
-        var previousTtName = previousSplit.trafficTypeName;
-        this.ttCache[previousTtName]--;
-        if (!this.ttCache[previousTtName]) delete this.ttCache[previousTtName];
-      }
-
-      if (usesSegments(previousSplit.conditions)) {
-        // Substract from segments count for the previous version of this Split.
-        this.splitsWithSegmentsCount--;
-      }
-    }
-
-    var parsedSplit = JSON.parse(split);
-
-    if (parsedSplit) {
-      // Store the Split.
-      this.splitCache[splitName] = split; // Update TT cache
-
-      var ttName = parsedSplit.trafficTypeName;
-
-      if (ttName) {
-        // safeguard
-        if (!this.ttCache[ttName]) this.ttCache[ttName] = 0;
-        this.ttCache[ttName]++;
-      } // Add to segments count for the new version of the Split
-
-
-      if (usesSegments(parsedSplit.conditions)) this.splitsWithSegmentsCount++;
-      return true;
-    } else {
-      return false;
-    }
-  };
-
-  _proto.addSplits = function addSplits(entries) {
-    var _this = this;
-
-    var results = [];
-    entries.forEach(function (keyValuePair) {
-      results.push(_this.addSplit(keyValuePair[0], keyValuePair[1]));
-    });
-    return results;
-  };
-
-  _proto.removeSplit = function removeSplit(splitName) {
-    var split = this.getSplit(splitName);
-
-    if (split) {
-      // Delete the Split
-      delete this.splitCache[splitName];
-      var parsedSplit = JSON.parse(split);
-      var ttName = parsedSplit.trafficTypeName;
-
-      if (ttName) {
-        // safeguard
-        this.ttCache[ttName]--; // Update tt cache
-
-        if (!this.ttCache[ttName]) delete this.ttCache[ttName];
-      } // Update the segments count.
-
-
-      if (usesSegments(parsedSplit.conditions)) this.splitsWithSegmentsCount--;
-      return 1;
-    } else {
-      return 0;
-    }
-  };
-
-  _proto.removeSplits = function removeSplits(splitNames) {
-    var _this2 = this;
-
-    splitNames.forEach(function (n) {
-      return _this2.removeSplit(n);
-    });
-    return splitNames.length;
-  };
-
-  _proto.getSplit = function getSplit(splitName) {
-    return this.splitCache[splitName];
-  };
-
-  _proto.setChangeNumber = function setChangeNumber(changeNumber) {
-    this.changeNumber = changeNumber;
-    return true;
-  };
-
-  _proto.getChangeNumber = function getChangeNumber() {
-    return this.changeNumber;
-  };
-
-  _proto.getAll = function getAll() {
-    var _this3 = this;
-
-    return this.getKeys().map(function (key) {
-      return _this3.splitCache[key];
-    });
-  };
-
-  _proto.getKeys = function getKeys() {
-    return Object.keys(this.splitCache);
-  };
-
-  _proto.trafficTypeExists = function trafficTypeExists(trafficType) {
-    return numberIsFinite(this.ttCache[trafficType]) && this.ttCache[trafficType] > 0;
-  };
-
-  _proto.usesSegments = function usesSegments() {
-    return this.getChangeNumber() === -1 || this.splitsWithSegmentsCount > 0;
-  };
-
-  _proto.flush = function flush() {
-    this.splitCache = {};
-    this.ttCache = {};
-    this.changeNumber = -1;
-    this.splitsWithSegmentsCount = 0;
-  }
-  /**
-   * Fetches multiple splits definitions.
-   */
-  ;
-
-  _proto.fetchMany = function fetchMany(splitNames) {
-    var _this4 = this;
-
-    var splits = {};
-    splitNames.forEach(function (splitName) {
-      splits[splitName] = _this4.splitCache[splitName] || null;
-    });
-    return splits;
-  }
-  /**
-   * Check if the splits information is already stored in cache. In memory there is no cache to check.
-   */
-  ;
-
-  _proto.checkCache = function checkCache() {
-    return false;
-  };
-
-  return SplitCacheInMemory;
-}();
-
-SplitCacheInMemory.prototype.killLocally = killLocally;
-export default SplitCacheInMemory;

package/es/storage/SplitCache/InRedis.js

@@ -1,214 +0,0 @@
-import { numberIsFinite, numberIsNaN } from '../../utils/lang';
-import logFactory from '../../utils/logger';
-var log = logFactory('splitio-storage:redis');
-/**
- * Discard errors for an answer of multiple operations.
- */
-
-var processPipelineAnswer = function processPipelineAnswer(results) {
-  return results.reduce(function (accum, errValuePair) {
-    if (errValuePair[0] === null) accum.push(errValuePair[1]);
-    return accum;
-  }, []);
-};
-
-var SplitCacheInRedis = /*#__PURE__*/function () {
-  function SplitCacheInRedis(keys, redis) {
-    var _this = this;
-
-    this.redis = redis;
-    this.keys = keys;
-    this.redisError = false;
-    this.redis.on('error', function (e) {
-      _this.redisError = e;
-    });
-    this.redis.on('connect', function () {
-      _this.redisError = false;
-    });
-  }
-
-  var _proto = SplitCacheInRedis.prototype;
-
-  _proto.addSplit = function addSplit(splitName, split) {
-    return this.redis.set(this.keys.buildSplitKey(splitName), split).then(function (status) {
-      return status === 'OK';
-    });
-  };
-
-  _proto.addSplits = function addSplits(entries) {
-    var _this2 = this;
-
-    if (entries.length) {
-      var cmds = entries.map(function (keyValuePair) {
-        return ['set', _this2.keys.buildSplitKey(keyValuePair[0]), keyValuePair[1]];
-      });
-      return this.redis.pipeline(cmds).exec().then(processPipelineAnswer).then(function (answers) {
-        return answers.map(function (status) {
-          return status === 'OK';
-        });
-      });
-    } else {
-      return [true];
-    }
-  }
-  /**
-   * Remove a given split from Redis. Returns the number of deleted keys.
-   */
-  ;
-
-  _proto.removeSplit = function removeSplit(splitName) {
-    return this.redis.del(this.keys.buildSplitKey(splitName));
-  }
-  /**
-   * Bulk delete of splits from Redis. Returns the number of deleted keys.
-   */
-  ;
-
-  _proto.removeSplits = function removeSplits(names) {
-    var _this3 = this;
-
-    if (names.length) {
-      return this.redis.del(names.map(function (n) {
-        return _this3.keys.buildSplitKey(n);
-      }));
-    } else {
-      return Promise.resolve(0);
-    }
-  }
-  /**
-   * Get split definition or null if it's not defined.
-   */
-  ;
-
-  _proto.getSplit = function getSplit(splitName) {
-    if (this.redisError) {
-      log.error(this.redisError);
-      throw this.redisError;
-    }
-
-    return this.redis.get(this.keys.buildSplitKey(splitName));
-  }
-  /**
-   * Set till number.
-   *
-   * @TODO pending error handling
-   */
-  ;
-
-  _proto.setChangeNumber = function setChangeNumber(changeNumber) {
-    return this.redis.set(this.keys.buildSplitsTillKey(), changeNumber + '').then(function (status) {
-      return status === 'OK';
-    });
-  }
-  /**
-   * Get till number or null if it's not defined.
-   *
-   * @TODO pending error handling
-   */
-  ;
-
-  _proto.getChangeNumber = function getChangeNumber() {
-    return this.redis.get(this.keys.buildSplitsTillKey()).then(function (value) {
-      var i = parseInt(value, 10);
-      return numberIsNaN(i) ? -1 : i;
-    });
-  }
-  /**
-   * @TODO we need to benchmark which is the maximun number of commands we could
-   *       pipeline without kill redis performance.
-   */
-  ;
-
-  _proto.getAll = function getAll() {
-    var _this4 = this;
-
-    return this.redis.keys(this.keys.searchPatternForSplitKeys()).then(function (listOfKeys) {
-      return _this4.redis.pipeline(listOfKeys.map(function (k) {
-        return ['get', k];
-      })).exec();
-    }).then(processPipelineAnswer);
-  };
-
-  _proto.getKeys = function getKeys() {
-    var _this5 = this;
-
-    return this.redis.keys(this.keys.searchPatternForSplitKeys()).then(function (listOfKeys) {
-      return listOfKeys.map(_this5.keys.extractKey);
-    });
-  };
-
-  _proto.trafficTypeExists = function trafficTypeExists(trafficType) {
-    // If there is a number there should be > 0, otherwise the TT is considered as not existent.
-    return this.redis.get(this.keys.buildTrafficTypeKey(trafficType)).then(function (ttCount) {
-      ttCount = parseInt(ttCount, 10);
-
-      if (!numberIsFinite(ttCount) || ttCount < 0) {
-        log.info("Could not validate traffic type existance of " + trafficType + " due to data corruption of some sorts.");
-        return false;
-      }
-
-      return ttCount > 0;
-    }).catch(function (e) {
-      log.error("Could not validate traffic type existance of " + trafficType + " due to an error: " + e + "."); // If there is an error, bypass the validation so the event can get tracked.
-
-      return true;
-    });
-  } // noop, just keeping the interface. This is used by client-side implementations only.
-  ;
-
-  _proto.usesSegments = function usesSegments() {
-    return true;
-  }
-  /**
-   * Delete everything in the current database.
-   *
-   * @NOTE documentation says it never fails.
-   */
-  ;
-
-  _proto.flush = function flush() {
-    return this.redis.flushdb().then(function (status) {
-      return status === 'OK';
-    });
-  }
-  /**
-   * Fetches multiple splits definitions.
-   */
-  ;
-
-  _proto.fetchMany = function fetchMany(splitNames) {
-    var _this6 = this,
-        _this$redis;
-
-    if (this.redisError) {
-      log.error(this.redisError);
-      throw this.redisError;
-    }
-
-    var splits = {};
-    var keys = splitNames.map(function (splitName) {
-      return _this6.keys.buildSplitKey(splitName);
-    });
-    return (_this$redis = this.redis).mget.apply(_this$redis, keys).then(function (splitDefinitions) {
-      splitNames.forEach(function (splitName, idx) {
-        splits[splitName] = splitDefinitions[idx];
-      });
-      return Promise.resolve(splits);
-    }).catch(function (e) {
-      log.error("Could not grab splits due to an error: " + e + ".");
-      return Promise.reject(e);
-    });
-  }
-  /**
-   * Check if the splits information is already stored in cache. Redis would actually be the cache.
-   */
-  ;
-
-  _proto.checkCache = function checkCache() {
-    return false;
-  };
-
-  return SplitCacheInRedis;
-}();
-
-export default SplitCacheInRedis;