@splitsoftware/splitio 10.17.2 → 10.17.3-rc.3

package/src/storage/SplitCache/InLocalStorage.js

@@ -1,324 +0,0 @@
-import { numberIsFinite, toNumber, numberIsNaN } from '../../utils/lang';
-import usesSegments from '../../utils/splits/usesSegments';
-import logFactory from '../../utils/logger';
-const log = logFactory('splitio-storage:localstorage');
-import killLocally from './killLocally';
-
-class SplitCacheLocalStorage {
-
-  /**
-   * @param {Object} keys
-   * @param {number} expirationTimestamp
-   * @param {Object} splitFiltersValidation
-   */
-  constructor(keys, expirationTimestamp, splitFiltersValidation = { validFilters: [], queryString: null, groupedFilters: { byName: [], byPrefix: [] } }) {
-    this.keys = keys;
-    this.splitFiltersValidation = splitFiltersValidation;
-
-    this.__checkExpiration(expirationTimestamp);
-
-    this.__checkFilterQuery();
-  }
-
-  decrementCount(key) {
-    const count = toNumber(localStorage.getItem(key)) - 1;
-
-    if (count > 0) localStorage.setItem(key, count);
-    else localStorage.removeItem(key);
-  }
-
-  decrementCounts(split) {
-    try {
-      if (split) {
-        if (split.trafficTypeName) {
-          const ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-          this.decrementCount(ttKey);
-        }
-
-        if (usesSegments(split.conditions)) {
-          const segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-          this.decrementCount(segmentsCountKey);
-        }
-      }
-    } catch (e) {
-      log.error(e);
-    }
-  }
-
-  incrementCounts(split) {
-    try {
-      if (split) {
-        if (split.trafficTypeName) {
-          const ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-          localStorage.setItem(ttKey, toNumber(localStorage.getItem(ttKey)) + 1);
-        }
-
-        if (usesSegments(split.conditions)) {
-          const segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-          localStorage.setItem(segmentsCountKey, toNumber(localStorage.getItem(segmentsCountKey)) + 1);
-        }
-      }
-    } catch (e) {
-      log.error(e);
-    }
-  }
-
-  addSplit(splitName, split) {
-    try {
-      const splitKey = this.keys.buildSplitKey(splitName);
-      const splitFromLocalStorage = localStorage.getItem(splitKey);
-      const previousSplit = splitFromLocalStorage ? JSON.parse(splitFromLocalStorage) : null;
-      this.decrementCounts(previousSplit);
-
-      localStorage.setItem(splitKey, split);
-
-      const parsedSplit = split ? JSON.parse(split) : null;
-
-      this.incrementCounts(parsedSplit);
-
-      return true;
-    } catch (e) {
-      log.error(e);
-      return false;
-    }
-  }
-
-  addSplits(entries) {
-    let results = [];
-
-    entries.forEach(keyValuePair => {
-      results.push(this.addSplit(keyValuePair[0], keyValuePair[1]));
-    });
-
-    return results;
-  }
-
-  removeSplit(splitName) {
-    try {
-      const split = this.getSplit(splitName);
-      localStorage.removeItem(this.keys.buildSplitKey(splitName));
-
-      const 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.
-   */
-  removeSplits(names) {
-    let i = 0;
-    let len = names.length;
-    let counter = 0;
-
-    for (; i < len; i++) {
-      counter += this.removeSplit(names[i]);
-    }
-
-    return counter;
-  }
-
-  getSplit(splitName) {
-    return localStorage.getItem(this.keys.buildSplitKey(splitName));
-  }
-
-  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.');
-      const queryKey = this.keys.buildSplitsFilterQueryKey();
-      const { queryString } = this.splitFiltersValidation;
-      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;
-    }
-  }
-
-  getChangeNumber() {
-    const n = -1;
-    let value = localStorage.getItem(this.keys.buildSplitsTillKey());
-
-    if (value !== null) {
-      value = parseInt(value, 10);
-
-      return numberIsNaN(value) ? n : value;
-    }
-
-    return n;
-  }
-
-  getAll() {
-    const len = localStorage.length;
-    const accum = [];
-
-    let cur = 0;
-
-    while (cur < len) {
-      const key = localStorage.key(cur);
-      const value = key && localStorage.getItem(key);
-
-      if (key != null && this.keys.isSplitKey(key) && value) accum.push(value);
-
-      cur++;
-    }
-
-    return accum;
-  }
-
-  getKeys() {
-    const len = localStorage.length;
-    const accum = [];
-
-    let cur = 0;
-
-    while (cur < len) {
-      const key = localStorage.key(cur);
-
-      if (key != null && this.keys.isSplitKey(key)) accum.push(this.keys.extractKey(key));
-
-      cur++;
-    }
-
-    return accum;
-  }
-
-  trafficTypeExists(trafficType) {
-    const ttCount = toNumber(localStorage.getItem(this.keys.buildTrafficTypeKey(trafficType)));
-    return numberIsFinite(ttCount) && ttCount > 0;
-  }
-
-  usesSegments() {
-    // If cache hasn't been synchronized with the cloud, assume we need them.
-    if (!this.hasSync) return true;
-
-    const storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
-    const 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.
-   */
-  flush() {
-    log.info('Flushing Splits data from localStorage');
-
-    // collect item keys
-    const len = localStorage.length;
-    const accum = [];
-    for (let cur = 0; cur < len; cur++) {
-      const key = localStorage.key(cur);
-      if (key != null && this.keys.isSplitCacheKey(key)) accum.push(key);
-    }
-    // remove items
-    accum.forEach(key => {
-      localStorage.removeItem(key);
-    });
-
-    this.hasSync = false;
-  }
-
-  /**
-   * Fetches multiple splits definitions.
-   */
-  fetchMany(splitNames) {
-    const splits = {};
-    splitNames.forEach(splitName => {
-      splits[splitName] = localStorage.getItem(this.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.
-   */
-  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
-   */
-  __checkExpiration(expirationTimestamp) {
-    let value = localStorage.getItem(this.keys.buildLastUpdatedKey());
-    if (value !== null) {
-      value = parseInt(value, 10);
-      if (!numberIsNaN(value) && value < expirationTimestamp) this.flush();
-    }
-  }
-
-  __checkFilterQuery() {
-    const { queryString, groupedFilters } = this.splitFiltersValidation;
-    const queryKey = this.keys.buildSplitsFilterQueryKey();
-    const 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((splitName) => {
-            if (queryString && (
-              groupedFilters.byName.indexOf(splitName) > -1 ||
-              groupedFilters.byPrefix.some(prefix => 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
-              this.cacheReadyButNeedsToFlush = true;
-              return;
-            }
-            this.removeSplit(splitName);
-          });
-        }
-      } catch (e) {
-        log.error(e);
-      }
-    }
-    // if the filter didn't change, nothing is done
-  }
-}
-
-SplitCacheLocalStorage.prototype.killLocally = killLocally;
-
-export default SplitCacheLocalStorage;

package/src/storage/SplitCache/InMemory.js

@@ -1,145 +0,0 @@
-import { numberIsFinite } from '../../utils/lang';
-import usesSegments from '../../utils/splits/usesSegments';
-import killLocally from './killLocally';
-
-class SplitCacheInMemory {
-
-  constructor() {
-    this.flush();
-  }
-
-  addSplit(splitName, split) {
-    const splitFromMemory = this.getSplit(splitName);
-    if (splitFromMemory) { // We had this Split already
-      const previousSplit = JSON.parse(splitFromMemory);
-
-      if (previousSplit.trafficTypeName) {
-        const 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--;
-      }
-    }
-
-    const parsedSplit = JSON.parse(split);
-
-    if (parsedSplit) {
-      // Store the Split.
-      this.splitCache[splitName] = split;
-      // Update TT cache
-      const 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;
-    }
-  }
-
-  addSplits(entries) {
-    let results = [];
-
-    entries.forEach(keyValuePair => {
-      results.push(this.addSplit(keyValuePair[0], keyValuePair[1]));
-    });
-
-    return results;
-  }
-
-  removeSplit(splitName) {
-    const split = this.getSplit(splitName);
-    if (split) {
-      // Delete the Split
-      delete this.splitCache[splitName];
-
-      const parsedSplit = JSON.parse(split);
-      const 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;
-    }
-  }
-
-  removeSplits(splitNames) {
-    splitNames.forEach(n => this.removeSplit(n));
-
-    return splitNames.length;
-  }
-
-  getSplit(splitName) {
-    return this.splitCache[splitName];
-  }
-
-  setChangeNumber(changeNumber) {
-    this.changeNumber = changeNumber;
-
-    return true;
-  }
-
-  getChangeNumber() {
-    return this.changeNumber;
-  }
-
-  getAll() {
-    return this.getKeys().map(key => this.splitCache[key]);
-  }
-
-  getKeys() {
-    return Object.keys(this.splitCache);
-  }
-
-  trafficTypeExists(trafficType) {
-    return numberIsFinite(this.ttCache[trafficType]) && this.ttCache[trafficType] > 0;
-  }
-
-  usesSegments() {
-    return this.getChangeNumber() === -1 || this.splitsWithSegmentsCount > 0;
-  }
-
-  flush() {
-    this.splitCache = {};
-    this.ttCache = {};
-    this.changeNumber = -1;
-    this.splitsWithSegmentsCount = 0;
-  }
-
-  /**
-   * Fetches multiple splits definitions.
-   */
-  fetchMany(splitNames) {
-    const splits = {};
-    splitNames.forEach(splitName => {
-      splits[splitName] = this.splitCache[splitName] || null;
-    });
-    return splits;
-  }
-
-  /**
-   * Check if the splits information is already stored in cache. In memory there is no cache to check.
-   */
-  checkCache() {
-    return false;
-  }
-}
-
-SplitCacheInMemory.prototype.killLocally = killLocally;
-
-export default SplitCacheInMemory;

package/src/storage/SplitCache/InRedis.js

@@ -1,187 +0,0 @@
-import { numberIsFinite, numberIsNaN } from '../../utils/lang';
-import logFactory from '../../utils/logger';
-const log = logFactory('splitio-storage:redis');
-
-/**
- * Discard errors for an answer of multiple operations.
- */
-const processPipelineAnswer = (results) =>
-  results.reduce((accum, errValuePair) => {
-    if (errValuePair[0] === null) accum.push(errValuePair[1]);
-    return accum;
-  }, []);
-
-class SplitCacheInRedis {
-
-  constructor(keys, redis) {
-    this.redis = redis;
-    this.keys = keys;
-    this.redisError = false;
-
-    this.redis.on('error', (e) => {
-      this.redisError = e;
-    });
-
-    this.redis.on('connect', () => {
-      this.redisError = false;
-    });
-  }
-
-  addSplit(splitName, split) {
-    return this.redis.set(
-      this.keys.buildSplitKey(splitName), split
-    ).then(
-      status => status === 'OK'
-    );
-  }
-
-  addSplits(entries) {
-    if (entries.length) {
-      const cmds = entries.map(keyValuePair => ['set', this.keys.buildSplitKey(keyValuePair[0]), keyValuePair[1]]);
-
-      return this.redis.pipeline(cmds)
-        .exec()
-        .then(processPipelineAnswer)
-        .then(answers => answers.map(status => status === 'OK'));
-    } else {
-      return [true];
-    }
-  }
-
-  /**
-   * Remove a given split from Redis. Returns the number of deleted keys.
-   */
-  removeSplit(splitName) {
-    return this.redis.del(this.keys.buildSplitKey(splitName));
-  }
-
-  /**
-   * Bulk delete of splits from Redis. Returns the number of deleted keys.
-   */
-  removeSplits(names) {
-    if (names.length) {
-      return this.redis.del(names.map(n => this.keys.buildSplitKey(n)));
-    } else {
-      return Promise.resolve(0);
-    }
-  }
-
-  /**
-   * Get split definition or null if it's not defined.
-   */
-  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
-   */
-  setChangeNumber(changeNumber) {
-    return this.redis.set(this.keys.buildSplitsTillKey(), changeNumber + '').then(
-      status => status === 'OK'
-    );
-  }
-
-  /**
-   * Get till number or null if it's not defined.
-   *
-   * @TODO pending error handling
-   */
-  getChangeNumber() {
-    return this.redis.get(this.keys.buildSplitsTillKey()).then(value => {
-      const 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.
-   */
-  getAll() {
-    return this.redis.keys(this.keys.searchPatternForSplitKeys()).then(
-      (listOfKeys) => this.redis.pipeline(listOfKeys.map(k => ['get', k])).exec()
-    ).then(processPipelineAnswer);
-  }
-
-  getKeys() {
-    return this.redis.keys(this.keys.searchPatternForSplitKeys()).then(
-      (listOfKeys) => listOfKeys.map(this.keys.extractKey)
-    );
-  }
-
-  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(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(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.
-  usesSegments() {
-    return true;
-  }
-
-  /**
-   * Delete everything in the current database.
-   *
-   * @NOTE documentation says it never fails.
-   */
-  flush() {
-    return this.redis.flushdb().then(status => status === 'OK');
-  }
-
-  /**
-   * Fetches multiple splits definitions.
-   */
-  fetchMany(splitNames) {
-    if (this.redisError) {
-      log.error(this.redisError);
-
-      throw this.redisError;
-    }
-    const splits = {};
-    const keys = splitNames.map(splitName => this.keys.buildSplitKey(splitName));
-    return this.redis.mget(...keys)
-      .then(splitDefinitions => {
-        splitNames.forEach((splitName, idx) => {
-          splits[splitName] = splitDefinitions[idx];
-        });
-        return Promise.resolve(splits);
-      })
-      .catch(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.
-   */
-  checkCache() {
-    return false;
-  }
-}
-
-export default SplitCacheInRedis;

package/src/storage/SplitCache/killLocally.js

@@ -1,33 +0,0 @@
-import thenable from '../../utils/promise/thenable';
-
-/**
- * Kill `splitName` at `this` split storage, setting `defaultTreatment` and `changeNumber`,
- * only if the split exists and its `changeNumber` is older than the given one.
- * Used for SPLIT_KILL push notifications.
- *
- * @param {string} splitName
- * @param {string} defaultTreatment
- * @param {number} changeNumber
- * @returns {Promise} a promise that is resolved once the split kill is performed.
- * The fulfillment value is a boolean: `true` if the kill success updating the split or `false` if no split is updated, for instance,
- * if the `changeNumber` is old, if the `splitName` is not found, or if the storage fails to apply the update.
- */
-export default function killLocally(splitName, defaultTreatment, changeNumber) {
-  const split = this.getSplit(splitName);
-  const splitPromise = thenable(split) ? split : Promise.resolve(split);
-
-  return splitPromise.then((split) => {
-    if (split) {
-      const parsedSplit = JSON.parse(split);
-      if (!parsedSplit.changeNumber || parsedSplit.changeNumber < changeNumber) {
-        parsedSplit.killed = true;
-        parsedSplit.defaultTreatment = defaultTreatment;
-        parsedSplit.changeNumber = changeNumber;
-        const newSplit = JSON.stringify(parsedSplit);
-
-        return this.addSplit(splitName, newSplit);
-      }
-    }
-    return false;
-  });
-}