@splitsoftware/splitio 10.17.2 → 10.17.3-rc.3

package/lib/listeners/browser.js

@@ -1,173 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _bulk = _interopRequireDefault(require("../services/events/bulk"));
-
-var _events = _interopRequireDefault(require("../services/events"));
-
-var _bulk2 = _interopRequireDefault(require("../services/impressions/bulk"));
-
-var _count = _interopRequireDefault(require("../services/impressions/count"));
-
-var _impressions = _interopRequireDefault(require("../services/impressions"));
-
-var _dto = require("../services/impressions/dto");
-
-var _logger = _interopRequireDefault(require("../utils/logger"));
-
-var _constants = require("../utils/constants");
-
-var _objectAssign = _interopRequireDefault(require("object-assign"));
-
-var log = (0, _logger.default)('splitio-client:cleanup'); // 'unload' event is used instead of 'beforeunload', since 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
-
-var UNLOAD_DOM_EVENT = 'unload';
-/**
- * We'll listen for 'unload' event over the window object, since it's the standard way to listen page reload and close.
- *
- */
-
-var BrowserSignalListener = /*#__PURE__*/function () {
-  function BrowserSignalListener(context, syncManager) {
-    this.storage = context.get(context.constants.STORAGE);
-    this.settings = context.get(context.constants.SETTINGS);
-    this.syncManager = syncManager;
-    this.flushData = this.flushData.bind(this);
-
-    if (this.settings.sync.impressionsMode === _constants.OPTIMIZED) {
-      this.impressionsCounter = context.get(context.constants.IMPRESSIONS_COUNTER);
-    }
-  }
-  /**
-   * start method.
-   * Called when SplitFactory is initialized.
-   * We add a handler on unload events. The handler flushes remaining impressions and events to the backend.
-   */
-
-
-  var _proto = BrowserSignalListener.prototype;
-
-  _proto.start = function start() {
-    if (typeof window !== 'undefined' && window.addEventListener) {
-      log.debug('Registering flush handler when unload page event is triggered.');
-      window.addEventListener(UNLOAD_DOM_EVENT, this.flushData);
-    }
-  }
-  /**
-   * stop method.
-   * Called when client is destroyed.
-   * We need to remove the handler for unload events, since it can break if called when Split context was destroyed.
-   */
-  ;
-
-  _proto.stop = function stop() {
-    if (typeof window !== 'undefined' && window.removeEventListener) {
-      log.debug('Deregistering flush handler when unload page event is triggered.');
-      window.removeEventListener(UNLOAD_DOM_EVENT, this.flushData);
-    }
-  }
-  /**
-   * _flushData method.
-   * Called when unload event is triggered. It flushed remaining impressions and events to the backend,
-   * using beacon API if possible, or falling back to regular post transport.
-   */
-  ;
-
-  _proto.flushData = function flushData() {
-    this._flushImpressions();
-
-    this._flushEvents();
-
-    if (this.impressionsCounter) {
-      this._flushImpressionsCount();
-    } // Close streaming
-
-
-    if (this.syncManager && this.syncManager.pushManager) this.syncManager.pushManager.stop();
-  };
-
-  _proto._flushImpressions = function _flushImpressions() {
-    var impressions = this.storage.impressions; // if there are impressions in storage, send them to backend
-
-    if (!impressions.isEmpty()) {
-      var url = this.settings.url('/testImpressions/beacon');
-      var impressionsPayload = (0, _dto.fromImpressionsCollector)(impressions, this.settings);
-      var extraMetadata = {
-        // sim stands for Sync/Split Impressions Mode
-        sim: this.settings.sync.impressionsMode === _constants.OPTIMIZED ? _constants.OPTIMIZED : _constants.DEBUG
-      };
-
-      if (!this._sendBeacon(url, impressionsPayload, extraMetadata)) {
-        (0, _impressions.default)((0, _bulk2.default)(this.settings, {
-          body: JSON.stringify(impressionsPayload)
-        }));
-      }
-
-      impressions.clear();
-    }
-  };
-
-  _proto._flushImpressionsCount = function _flushImpressionsCount() {
-    var impressionsCountPayload = {
-      pf: (0, _dto.fromImpressionsCountCollector)(this.impressionsCounter)
-    };
-    var imprCounts = impressionsCountPayload.pf.length;
-    if (imprCounts === 0) return;
-    var url = this.settings.url('/testImpressions/count/beacon');
-
-    if (!this._sendBeacon(url, impressionsCountPayload)) {
-      (0, _impressions.default)((0, _count.default)(this.settings, {
-        body: JSON.stringify(impressionsCountPayload)
-      }));
-    }
-  };
-
-  _proto._flushEvents = function _flushEvents() {
-    var events = this.storage.events; // if there are events in storage, send them to backend
-
-    if (!events.isEmpty()) {
-      var url = this.settings.url('/events/beacon');
-      var eventsPayload = events.toJSON();
-
-      if (!this._sendBeacon(url, eventsPayload)) {
-        (0, _events.default)((0, _bulk.default)(this.settings, {
-          body: JSON.stringify(eventsPayload)
-        }));
-      }
-
-      events.clear();
-    }
-  }
-  /**
-   * _sendBeacon method.
-   * Util method that check if beacon API is available, build the payload and send it.
-   */
-  ;
-
-  _proto._sendBeacon = function _sendBeacon(url, data, extraMetadata) {
-    // eslint-disable-next-line compat/compat
-    if (typeof navigator !== 'undefined' && navigator.sendBeacon) {
-      var json = {
-        entries: data,
-        token: this.settings.core.authorizationKey,
-        sdk: this.settings.version
-      }; // Extend with endpoint specific metadata where needed
-
-      if (extraMetadata) (0, _objectAssign.default)(json, extraMetadata); // Stringify the payload
-
-      var payload = JSON.stringify(json); // eslint-disable-next-line compat/compat
-
-      return navigator.sendBeacon(url, payload);
-    }
-
-    return false;
-  };
-
-  return BrowserSignalListener;
-}();
-
-exports.default = BrowserSignalListener;

package/lib/listeners/node.js

@@ -1,74 +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 _thenable = _interopRequireDefault(require("../utils/promise/thenable"));
-
-var log = (0, _logger.default)('splitio-client:cleanup');
-/**
- * We'll listen for SIGTERM since it's the standard signal for server shutdown.
- *
- * If you're stopping the execution yourself via the keyboard, or by calling process.exit,
- * you should call the cleanup logic yourself, since we cannot ensure the data is sent after
- * the process is already exiting.
- */
-
-var NodeSignalListener = /*#__PURE__*/function () {
-  function NodeSignalListener() {
-    this._sigtermHandler = this._sigtermHandler.bind(this);
-  }
-
-  var _proto = NodeSignalListener.prototype;
-
-  _proto.start = function start(handler) {
-    this.handler = handler;
-    log.debug('Registering cleanup handlers.');
-    process.on('SIGTERM', this._sigtermHandler);
-  };
-
-  _proto.stop = function stop() {
-    log.debug('Deregistering cleanup handlers.');
-    process.removeListener('SIGTERM', this._sigtermHandler);
-  }
-  /**
-   * Call the handler, clean up listeners and emit the signal again.
-   */
-  ;
-
-  _proto._sigtermHandler = function _sigtermHandler() {
-    var _this = this;
-
-    var wrapUp = function wrapUp() {
-      // Cleaned up, remove handlers.
-      _this.stop(); // This handler prevented the default behaviour, start again.
-
-
-      process.kill(process.pid, 'SIGTERM');
-    };
-
-    log.debug('Split SDK graceful shutdown after SIGTERM.');
-    var handlerResult = null;
-
-    try {
-      handlerResult = this.handler();
-    } catch (err) {
-      log.error("Error with Split graceful shutdown: " + err);
-    }
-
-    if ((0, _thenable.default)(handlerResult)) {
-      // Always exit, even with errors. The promise is returned for UT purposses.
-      return handlerResult.then(wrapUp).catch(wrapUp);
-    } else {
-      wrapUp();
-    }
-  };
-
-  return NodeSignalListener;
-}();
-
-exports.default = NodeSignalListener;

package/lib/listeners/package.json

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

package/lib/manager/index.js

@@ -1,115 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _objectAssign = _interopRequireDefault(require("object-assign"));
-
-var _thenable = _interopRequireDefault(require("../utils/promise/thenable"));
-
-var _lang = require("../utils/lang");
-
-var _inputValidation = require("../utils/inputValidation");
-
-var collectTreatments = function collectTreatments(splitObject) {
-  var conditions = splitObject.conditions; // Rollout conditions are supposed to have the entire partitions list, so we find the first one.
-
-  var allTreatmentsCondition = (0, _lang.find)(conditions, function (cond) {
-    return cond.conditionType === 'ROLLOUT';
-  }); // Localstorage mode could fall into a no rollout conditions state. Take the first condition in that case.
-
-  if (!allTreatmentsCondition) allTreatmentsCondition = conditions[0]; // Then extract the treatments from the partitions
-
-  return allTreatmentsCondition ? allTreatmentsCondition.partitions.map(function (v) {
-    return v.treatment;
-  }) : [];
-};
-
-var ObjectToView = function ObjectToView(json) {
-  var splitObject;
-
-  try {
-    splitObject = JSON.parse(json);
-  } catch (e) {
-    return null;
-  }
-
-  if (splitObject == null) return null;
-  return {
-    name: splitObject.name,
-    trafficType: splitObject.trafficTypeName || null,
-    killed: splitObject.killed,
-    changeNumber: splitObject.changeNumber || 0,
-    treatments: collectTreatments(splitObject),
-    configs: splitObject.configurations || {}
-  };
-};
-
-var ObjectsToViews = function ObjectsToViews(jsons) {
-  var views = [];
-  jsons.forEach(function (split) {
-    var view = ObjectToView(split);
-    if (view != null) views.push(view);
-  });
-  return views;
-};
-
-function SplitManagerFactory(_splits, context) {
-  var SPLIT_FN_LABEL = 'split';
-  var statusManager = context.get(context.constants.STATUS_MANAGER);
-  return (0, _objectAssign.default)( // Proto-linkage of the readiness Event Emitter
-  Object.create(statusManager), {
-    /**
-     * Get the Split object corresponding to the given split name if valid
-     */
-    split: function split(maybeSplitName) {
-      var splitName = (0, _inputValidation.validateSplit)(maybeSplitName, SPLIT_FN_LABEL);
-
-      if (!(0, _inputValidation.validateIfDestroyed)(context) || !(0, _inputValidation.validateIfReady)(context, SPLIT_FN_LABEL) || !splitName) {
-        return null;
-      }
-
-      var split = _splits.getSplit(splitName);
-
-      if ((0, _thenable.default)(split)) {
-        return split.then(function (result) {
-          (0, _inputValidation.validateSplitExistance)(context, splitName, result, SPLIT_FN_LABEL);
-          return ObjectToView(result);
-        });
-      }
-
-      (0, _inputValidation.validateSplitExistance)(context, splitName, split, SPLIT_FN_LABEL);
-      return ObjectToView(split);
-    },
-
-    /**
-     * Get the Split objects present on the factory storage
-     */
-    splits: function splits() {
-      if (!(0, _inputValidation.validateIfDestroyed)(context) || !(0, _inputValidation.validateIfReady)(context, 'splits')) {
-        return [];
-      }
-
-      var currentSplits = _splits.getAll();
-
-      if ((0, _thenable.default)(currentSplits)) return currentSplits.then(ObjectsToViews);
-      return ObjectsToViews(currentSplits);
-    },
-
-    /**
-     * Get the Split names present on the factory storage
-     */
-    names: function names() {
-      if (!(0, _inputValidation.validateIfDestroyed)(context) || !(0, _inputValidation.validateIfReady)(context, 'names')) {
-        return [];
-      }
-
-      return _splits.getKeys();
-    }
-  });
-}
-
-var _default = SplitManagerFactory;
-exports.default = _default;

package/lib/metrics/Collectors.js

@@ -1,118 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.ClientCollector = exports.MySegmentsCollector = exports.SplitChangesCollector = exports.SegmentChangesCollector = void 0;
-
-var _inheritsLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/inheritsLoose"));
-
-var ProducerMetricsCollector = /*#__PURE__*/function () {
-  function ProducerMetricsCollector(storage) {
-    this.storage = storage;
-    this.latency = this.latency.bind(this);
-    this.count = this.count.bind(this);
-    this.countException = this.countException.bind(this);
-  }
-
-  var _proto = ProducerMetricsCollector.prototype;
-
-  _proto.latency = function latency(ms) {
-    this.storage.metrics.track(this.metricType + ".time", ms);
-  };
-
-  _proto.count = function count(status) {
-    this.storage.count.track(this.metricType + ".status." + status);
-  };
-
-  _proto.countException = function countException() {
-    this.storage.count.track(this.metricType + ".exception");
-  };
-
-  return ProducerMetricsCollector;
-}();
-
-var SegmentChangesCollector = /*#__PURE__*/function (_ProducerMetricsColle) {
-  (0, _inheritsLoose2.default)(SegmentChangesCollector, _ProducerMetricsColle);
-
-  function SegmentChangesCollector(storage) {
-    var _this;
-
-    _this = _ProducerMetricsColle.call(this, storage) || this;
-    _this.metricType = 'segmentChangeFetcher';
-    return _this;
-  }
-
-  return SegmentChangesCollector;
-}(ProducerMetricsCollector);
-
-exports.SegmentChangesCollector = SegmentChangesCollector;
-
-var SplitChangesCollector = /*#__PURE__*/function (_ProducerMetricsColle2) {
-  (0, _inheritsLoose2.default)(SplitChangesCollector, _ProducerMetricsColle2);
-
-  function SplitChangesCollector(storage) {
-    var _this2;
-
-    _this2 = _ProducerMetricsColle2.call(this, storage) || this;
-    _this2.metricType = 'splitChangeFetcher';
-    return _this2;
-  }
-
-  return SplitChangesCollector;
-}(ProducerMetricsCollector);
-
-exports.SplitChangesCollector = SplitChangesCollector;
-
-var MySegmentsCollector = /*#__PURE__*/function (_ProducerMetricsColle3) {
-  (0, _inheritsLoose2.default)(MySegmentsCollector, _ProducerMetricsColle3);
-
-  function MySegmentsCollector(storage) {
-    var _this3;
-
-    _this3 = _ProducerMetricsColle3.call(this, storage) || this;
-    _this3.metricType = 'mySegmentsFetcher';
-    return _this3;
-  }
-
-  return MySegmentsCollector;
-}(ProducerMetricsCollector);
-
-exports.MySegmentsCollector = MySegmentsCollector;
-
-var ClientCollector = /*#__PURE__*/function () {
-  function ClientCollector(storage) {
-    this.storage = storage;
-    this.ready = this.ready.bind(this);
-    this.getTreatment = this.getTreatment.bind(this);
-    this.getTreatments = this.getTreatments.bind(this);
-    this.getTreatmentWithConfig = this.getTreatmentWithConfig.bind(this);
-    this.getTreatmentsWithConfig = this.getTreatmentsWithConfig.bind(this);
-  }
-
-  var _proto2 = ClientCollector.prototype;
-
-  _proto2.ready = function ready(ms) {
-    this.storage.metrics.track('sdk.ready', ms);
-  };
-
-  _proto2.getTreatment = function getTreatment(ms) {
-    this.storage.metrics.track('sdk.getTreatment', ms);
-  };
-
-  _proto2.getTreatments = function getTreatments(ms) {
-    this.storage.metrics.track('sdk.getTreatments', ms);
-  };
-
-  _proto2.getTreatmentWithConfig = function getTreatmentWithConfig(ms) {
-    this.storage.metrics.track('sdk.getTreatmentWithConfig', ms);
-  };
-
-  _proto2.getTreatmentsWithConfig = function getTreatmentsWithConfig(ms) {
-    this.storage.metrics.track('sdk.getTreatmentsWithConfig', ms);
-  };
-
-  return ClientCollector;
-}();
-
-exports.ClientCollector = ClientCollector;

package/lib/metrics/index.js

@@ -1,182 +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 _timeTracker = _interopRequireDefault(require("../utils/timeTracker"));
-
-var _repeat = _interopRequireDefault(require("../utils/fn/repeat"));
-
-var _metrics = _interopRequireDefault(require("../services/metrics"));
-
-var _times = _interopRequireDefault(require("../services/metrics/times"));
-
-var _counters = _interopRequireDefault(require("../services/metrics/counters"));
-
-var _dto = require("../services/metrics/dto");
-
-var _impressions = _interopRequireDefault(require("../services/impressions"));
-
-var _bulk = _interopRequireDefault(require("../services/impressions/bulk"));
-
-var _count = _interopRequireDefault(require("../services/impressions/count"));
-
-var _dto2 = require("../services/impressions/dto");
-
-var _Collectors = require("./Collectors");
-
-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-metrics');
-var IMPRESSIONS_COUNT_RATE = 1800000; // 30 minutes
-
-var MetricsFactory = function MetricsFactory(context) {
-  var impressionsRetries = 0;
-  var settings = context.get(context.constants.SETTINGS);
-  var storage = context.get(context.constants.STORAGE);
-  var impressionsCounter = context.get(context.constants.IMPRESSIONS_COUNTER);
-  var shouldPushImpressionsCount = settings.sync.impressionsMode === _constants.OPTIMIZED;
-
-  var pushMetrics = function pushMetrics() {
-    if (storage.metrics.isEmpty() && storage.count.isEmpty()) return Promise.resolve();
-    log.debug('Pushing metrics');
-
-    var latencyTrackerStop = _timeTracker.default.start(_timeTracker.default.TaskNames.METRICS_PUSH); // POST latencies
-
-
-    var latenciesPromise = storage.metrics.isEmpty() ? null : (0, _metrics.default)((0, _times.default)(settings, {
-      body: JSON.stringify((0, _dto.fromLatenciesCollector)(storage.metrics))
-    })).then(function () {
-      return storage.metrics.clear();
-    }).catch(function () {
-      return storage.metrics.clear();
-    }); // POST counters
-
-    var countersPromise = storage.count.isEmpty() ? null : (0, _metrics.default)((0, _counters.default)(settings, {
-      body: JSON.stringify((0, _dto.fromCountersCollector)(storage.count))
-    })).then(function () {
-      return storage.count.clear();
-    }).catch(function () {
-      return storage.count.clear();
-    });
-    return Promise.all([latenciesPromise, countersPromise]).then(function (resp) {
-      // After both finishes, track the end and return the results
-      latencyTrackerStop();
-      return resp;
-    });
-  };
-
-  var pushImpressions = function pushImpressions() {
-    if (storage.impressions.isEmpty()) return Promise.resolve();
-    var imprCount = storage.impressions.queue.length;
-    log.info("Pushing " + imprCount + " impressions");
-
-    var latencyTrackerStop = _timeTracker.default.start(_timeTracker.default.TaskNames.IMPRESSIONS_PUSH);
-
-    return (0, _impressions.default)((0, _bulk.default)(settings, {
-      body: JSON.stringify((0, _dto2.fromImpressionsCollector)(storage.impressions, settings))
-    })).then(function () {
-      impressionsRetries = 0;
-      storage.impressions.clear();
-    }).catch(function (err) {
-      if (impressionsRetries) {
-        // For now we retry only once.
-        log.warn("Droping " + imprCount + " impressions after retry. Reason " + err + ".");
-        impressionsRetries = 0;
-        storage.impressions.clear();
-      } else {
-        impressionsRetries++;
-        log.warn("Failed to push " + imprCount + " impressions, keeping data to retry on next iteration. Reason " + err + ".");
-      }
-    }).then(function () {
-      return latencyTrackerStop();
-    });
-  };
-
-  var pushImpressionsCount = function pushImpressionsCount() {
-    var pf = (0, _dto2.fromImpressionsCountCollector)(impressionsCounter);
-    var imprCounts = pf.length;
-    if (imprCounts === 0) return Promise.resolve();
-    log.info("Pushing count of impressions for " + imprCounts + " features");
-    return (0, _impressions.default)((0, _count.default)(settings, {
-      body: JSON.stringify({
-        pf: pf
-      })
-    })).then(function () {
-      impressionsRetries = 0;
-    }).catch(function (err) {
-      if (impressionsRetries) {
-        // For now we retry only once.
-        log.warn("Droping count of impressions for " + imprCounts + " features after retry. Reason " + err + ".");
-        impressionsRetries = 0;
-      } else {
-        impressionsRetries++;
-        log.warn("Failed to push impressions count for " + imprCounts + " features, keeping data to retry on next iteration. Reason " + err + ".");
-      }
-    });
-  };
-
-  var stopImpressionsPublisher = false;
-  var stopPerformancePublisher = false;
-  var stopImpressionsCountPublisher = false;
-  return {
-    start: function start() {
-      stopImpressionsPublisher = (0, _repeat.default)(function (schedulePublisher) {
-        return pushImpressions().then(function () {
-          return schedulePublisher();
-        });
-      }, settings.scheduler.impressionsRefreshRate);
-      stopPerformancePublisher = (0, _repeat.default)(function (schedulePublisher) {
-        return pushMetrics().then(function () {
-          return schedulePublisher();
-        });
-      }, settings.scheduler.metricsRefreshRate);
-
-      if (shouldPushImpressionsCount) {
-        stopImpressionsCountPublisher = (0, _repeat.default)(function (schedulePublisher) {
-          return pushImpressionsCount().then(function () {
-            return schedulePublisher();
-          });
-        }, IMPRESSIONS_COUNT_RATE);
-      }
-    },
-    flush: function flush() {
-      if (shouldPushImpressionsCount) pushImpressionsCount();
-      return pushImpressions();
-    },
-    stop: function stop() {
-      stopImpressionsPublisher && stopImpressionsPublisher();
-      stopPerformancePublisher && stopPerformancePublisher();
-      stopImpressionsCountPublisher && stopImpressionsCountPublisher();
-    },
-    // Metrics collectors
-    collectors: {
-      segmentChanges: new _Collectors.SegmentChangesCollector(storage),
-      splitChanges: new _Collectors.SplitChangesCollector(storage),
-      mySegments: new _Collectors.MySegmentsCollector(storage),
-      client: new _Collectors.ClientCollector(storage)
-    }
-  };
-};
-
-var _default = MetricsFactory;
-exports.default = _default;