@splitsoftware/splitio 10.17.2 → 10.17.3-rc.0

package/lib/utils/settings/index.js

@@ -1,214 +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 _lang = require("../lang");
-
-var _language = _interopRequireDefault(require("./language"));
-
-var _runtime = _interopRequireDefault(require("./runtime"));
-
-var _defaults = _interopRequireDefault(require("./defaults"));
-
-var _storage = _interopRequireDefault(require("./storage"));
-
-var _integrations = _interopRequireDefault(require("./integrations"));
-
-var _mode = _interopRequireDefault(require("./mode"));
-
-var _splitFilters = _interopRequireDefault(require("../inputValidation/splitFilters"));
-
-var _logger = require("../../utils/logger");
-
-var _constants = require("../../utils/constants");
-
-var _impressionsMode = _interopRequireDefault(require("./impressionsMode"));
-
-/**
-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 version = '10.17.2';
-var eventsEndpointMatcher = /^\/(testImpressions|metrics|events)/;
-var authEndpointMatcher = /^\/v2\/auth/;
-var streamingEndpointMatcher = /^\/(sse|event-stream)/;
-var base = {
-  // Define which kind of object you want to retrieve from SplitFactory
-  mode: _constants.STANDALONE_MODE,
-  core: {
-    // API token (tight to an environment)
-    authorizationKey: undefined,
-    // key used in your system (only required for browser version)
-    key: undefined,
-    // traffic type for the given key (only used on browser version)
-    trafficType: undefined,
-    // toggle impressions tracking of labels
-    labelsEnabled: true,
-    // toggle sendind (true) or not sending (false) IP and Host Name with impressions, events, and telemetries requests (only used on nodejs version)
-    IPAddressesEnabled: undefined
-  },
-  scheduler: {
-    // fetch feature updates each 30 sec
-    featuresRefreshRate: 30,
-    // fetch segments updates each 60 sec
-    segmentsRefreshRate: 60,
-    // publish metrics each 120 sec
-    metricsRefreshRate: 120,
-    // publish evaluations each 60 sec
-    impressionsRefreshRate: 60,
-    // fetch offline changes each 15 sec
-    offlineRefreshRate: 15,
-    // publish events every 60 seconds after the first flush
-    eventsPushRate: 60,
-    // how many events will be queued before flushing
-    eventsQueueSize: 500,
-    // backoff base seconds to wait before re attempting to connect to push notifications
-    pushRetryBackoffBase: 1
-  },
-  urls: {
-    // CDN having all the information for your environment
-    sdk: 'https://sdk.split.io/api',
-    // Storage for your SDK events
-    events: 'https://events.split.io/api',
-    // SDK Auth Server
-    auth: 'https://auth.split.io/api',
-    // Streaming Server
-    streaming: 'https://streaming.split.io'
-  },
-  // Defines which kind of storage we should instanciate.
-  storage: {
-    type: _constants.STORAGE_MEMORY
-  },
-  // Defines if the logs are enabled, SDK wide.
-  debug: undefined,
-  // Defines the impression listener, but will only be used on NodeJS.
-  impressionListener: undefined,
-  // Instance version.
-  version: _language.default + "-" + version,
-  // List of integrations.
-  integrations: undefined,
-  // toggle using (true) or not using (false) Server-Side Events for synchronizing storage
-  streamingEnabled: true,
-  sync: {
-    splitFilters: undefined,
-    // impressions collection mode
-    impressionsMode: _constants.OPTIMIZED
-  }
-};
-
-function fromSecondsToMillis(n) {
-  return Math.round(n * 1000);
-}
-
-function setupLogger(debugValue) {
-  if (typeof debugValue === 'boolean') {
-    if (debugValue) {
-      _logger.API.enable();
-    } else {
-      _logger.API.disable();
-    }
-  } else if (typeof debugValue === 'string') {
-    _logger.API.setLogLevel(debugValue);
-  }
-}
-
-function defaults(custom) {
-  var withDefaults = (0, _lang.merge)({}, base, _defaults.default, custom); // Scheduler periods
-
-  withDefaults.scheduler.featuresRefreshRate = fromSecondsToMillis(withDefaults.scheduler.featuresRefreshRate);
-  withDefaults.scheduler.segmentsRefreshRate = fromSecondsToMillis(withDefaults.scheduler.segmentsRefreshRate);
-  withDefaults.scheduler.metricsRefreshRate = fromSecondsToMillis(withDefaults.scheduler.metricsRefreshRate);
-  withDefaults.scheduler.impressionsRefreshRate = fromSecondsToMillis(withDefaults.scheduler.impressionsRefreshRate);
-  withDefaults.scheduler.offlineRefreshRate = fromSecondsToMillis(withDefaults.scheduler.offlineRefreshRate);
-  withDefaults.scheduler.eventsPushRate = fromSecondsToMillis(withDefaults.scheduler.eventsPushRate); // Startup periods
-
-  withDefaults.startup.requestTimeoutBeforeReady = fromSecondsToMillis(withDefaults.startup.requestTimeoutBeforeReady);
-  withDefaults.startup.readyTimeout = fromSecondsToMillis(withDefaults.startup.readyTimeout);
-  withDefaults.startup.eventsFirstPushWindow = fromSecondsToMillis(withDefaults.startup.eventsFirstPushWindow); // ensure a valid SDK mode
-
-  withDefaults.mode = (0, _mode.default)(withDefaults.core.authorizationKey, withDefaults.mode); // ensure a valid Storage based on mode defined.
-
-  withDefaults.storage = (0, _storage.default)(withDefaults);
-  setupLogger(withDefaults.debug); // Current ip/hostname information
-
-  withDefaults.runtime = (0, _runtime.default)(withDefaults.core.IPAddressesEnabled, withDefaults.mode === _constants.CONSUMER_MODE); // ensure a valid list of integrations.
-  // `integrations` returns an array of valid integration items.
-
-  withDefaults.integrations = (0, _integrations.default)(withDefaults); // validate push options
-
-  if (withDefaults.streamingEnabled !== false) {
-    withDefaults.streamingEnabled = true; // Backoff bases.
-    // We are not checking if bases are positive numbers. Thus, we might be reauthenticating immediately (`setTimeout` with NaN or negative number)
-
-    withDefaults.scheduler.pushRetryBackoffBase = fromSecondsToMillis(withDefaults.scheduler.pushRetryBackoffBase);
-  } // validate the `splitFilters` settings and parse splits query
-
-
-  var splitFiltersValidation = (0, _splitFilters.default)(withDefaults.sync.splitFilters, withDefaults.mode);
-  withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;
-  withDefaults.sync.__splitFiltersValidation = splitFiltersValidation; // ensure a valid impressionsMode
-
-  withDefaults.sync.impressionsMode = (0, _impressionsMode.default)(withDefaults.sync.impressionsMode);
-  return withDefaults;
-}
-
-var proto = {
-  /**
-   * Switch URLs servers based on target.
-   *
-   * @param {String} target url target
-   * @return {String} completed url
-   */
-  url: function url(target) {
-    if (eventsEndpointMatcher.test(target)) {
-      return "" + this.urls.events + target;
-    }
-
-    if (authEndpointMatcher.test(target)) {
-      return "" + this.urls.auth + target;
-    }
-
-    if (streamingEndpointMatcher.test(target)) {
-      return "" + this.urls.streaming + target;
-    }
-
-    return "" + this.urls.sdk + target;
-  },
-
-  /**
-   * Returns a settings clone with the key and traffic type (if provided) overriden.
-   * @param {SplitKey} key
-   * @param {string} [trafficType]
-   */
-  overrideKeyAndTT: function overrideKeyAndTT(key, trafficType) {
-    return (0, _objectAssign.default)(Object.create(proto), this, {
-      core: (0, _objectAssign.default)({}, this.core, {
-        key: key,
-        trafficType: trafficType
-      })
-    });
-  }
-};
-
-var SettingsFactory = function SettingsFactory(settings) {
-  return (0, _objectAssign.default)(Object.create(proto), defaults(settings));
-};
-
-var _default = SettingsFactory;
-exports.default = _default;

package/lib/utils/settings/integrations/browser.js

@@ -1,17 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _constants = require("../../../utils/constants");
-
-var _common = _interopRequireDefault(require("./common"));
-
-var validateBrowserIntegrationsSettings = function validateBrowserIntegrationsSettings(settings) {
-  return (0, _common.default)(settings, [_constants.GOOGLE_ANALYTICS_TO_SPLIT, _constants.SPLIT_TO_GOOGLE_ANALYTICS]);
-};
-
-var _default = validateBrowserIntegrationsSettings;
-exports.default = _default;

package/lib/utils/settings/integrations/common.js

@@ -1,40 +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 _lang = require("../../../utils/lang");
-
-var log = (0, _logger.default)('splitio-settings');
-/**
- * This function validates `settings.integrations` object
- *
- * @param {Object} settings SDK settings object to validate
- * @param {Array<string>} validIntegrationTypes list of integration types to filter from `settings.integrations`
- *
- * @returns {Array} array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
- */
-
-var validateIntegrationsSettings = function validateIntegrationsSettings(settings, validIntegrationTypes) {
-  if (validIntegrationTypes === void 0) {
-    validIntegrationTypes = [];
-  }
-
-  var integrations = settings.integrations; // If integrations is not an array or an empty array, we return an empty array (no integrations).
-
-  if (!Array.isArray(integrations) || integrations.length === 0) return []; // We remove invalid integration items
-
-  var validIntegrations = integrations.filter(function (integration) {
-    return integration && (0, _lang.isString)(integration.type) && validIntegrationTypes.indexOf(integration.type) > -1;
-  });
-  var invalids = integrations.length - validIntegrations.length;
-  if (invalids) log.warn(invalids + " integration " + (invalids === 1 ? 'item' : 'items') + " at settings " + (invalids === 1 ? 'is' : 'are') + " invalid: integration items must have a valid 'type' value");
-  return validIntegrations;
-};
-
-var _default = validateIntegrationsSettings;
-exports.default = _default;

package/lib/utils/settings/integrations/node.js

@@ -1,13 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-
-// For now, Node SDK does not support integrations,
-// thus any integrations settings is parsed into undefined.
-var validateNodeIntegrationsSettings = function validateNodeIntegrationsSettings() {
-  return [];
-};
-
-var _default = validateNodeIntegrationsSettings;
-exports.default = _default;

package/lib/utils/settings/integrations/package.json

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

package/lib/utils/settings/language/browser.js

@@ -1,22 +0,0 @@
-"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.
-**/
-var _default = 'javascript';
-exports.default = _default;

package/lib/utils/settings/language/node.js

@@ -1,22 +0,0 @@
-"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.
-**/
-var _default = 'nodejs';
-exports.default = _default;

package/lib/utils/settings/language/package.json

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

package/lib/utils/settings/mode.js

@@ -1,16 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _constants = require("../constants");
-
-function mode(key, mode) {
-  // Leaving the comparison as is, in case we change the mode name but not the setting.
-  if (key === 'localhost') return _constants.LOCALHOST_MODE;
-  if ([_constants.STANDALONE_MODE, _constants.PRODUCER_MODE, _constants.CONSUMER_MODE].indexOf(mode) === -1) throw Error('Invalid mode provided');
-  return mode;
-}
-
-var _default = mode;
-exports.default = _default;

package/lib/utils/settings/runtime/browser.js

@@ -1,26 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = generateRuntimeSettings;
-
-/**
-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 generateRuntimeSettings() {
-  return {
-    ip: false,
-    hostname: false
-  };
-}

package/lib/utils/settings/runtime/package.json

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

package/lib/utils/settings/storage/package.json

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

package/lib/utils/splits/usesSegments.js

@@ -1,27 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-
-/**
- * Given a list of conditions, it returns a boolean flagging if those conditions 
- * use segments matchers (rules & whitelists)
- */
-function usesSegments(conditions) {
-  if (conditions === void 0) {
-    conditions = [];
-  }
-
-  for (var i = 0; i < conditions.length; i++) {
-    var matchers = conditions[i].matcherGroup.matchers;
-
-    for (var j = 0; j < matchers.length; j++) {
-      if (matchers[j].matcherType === 'IN_SEGMENT') return true;
-    }
-  }
-
-  return false;
-}
-
-var _default = usesSegments;
-exports.default = _default;

package/lib/utils/time/index.js

@@ -1,12 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.truncateTimeFrame = truncateTimeFrame;
-var DEDUP_WINDOW_SIZE_MS = 3600 * 1000;
-/**
-* Truncates de time frame received with the time window.
-*/
-
-function truncateTimeFrame(timestampInMs) {
-  return timestampInMs - timestampInMs % DEDUP_WINDOW_SIZE_MS;
-}

package/lib/utils/timeTracker/index.js

@@ -1,213 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-exports.__esModule = true;
-exports.default = void 0;
-
-var _lang = require("../lang");
-
-var _LoggerFactory = require("../logger/LoggerFactory");
-
-var _timer = _interopRequireDefault(require("./timer"));
-
-var _thenable = _interopRequireDefault(require("../promise/thenable"));
-
-var _CALLBACKS;
-
-// logger to be used on this module
-var logger = new _LoggerFactory.Logger('[TIME TRACKER]', {
-  showLevel: false
-}); // Map we will use for storing timers data
-
-var timers = {}; // Tasks constants
-
-var CONSTANTS = {
-  SDK_READY: 'Getting ready - Split SDK',
-  SDK_GET_TREATMENT: 'SDK - Get Treatment',
-  SDK_GET_TREATMENTS: 'SDK - Get Treatments',
-  SDK_GET_TREATMENT_WITH_CONFIG: 'SDK - Get Treatment with config',
-  SDK_GET_TREATMENTS_WITH_CONFIG: 'SDK - Get Treatments with config',
-  SPLITS_READY: 'Getting ready - Splits',
-  SEGMENTS_READY: 'Getting ready - Segments',
-  METRICS_PUSH: 'Pushing - Metrics',
-  IMPRESSIONS_PUSH: 'Pushing - Impressions',
-  EVENTS_PUSH: 'Pushing - Events',
-  MY_SEGMENTS_FETCH: 'Fetching - My Segments',
-  SEGMENTS_FETCH: 'Fetching - Segments',
-  SPLITS_FETCH: 'Fetching - Splits'
-}; // Tasks callbacks, if any
-
-var CALLBACKS = (_CALLBACKS = {}, _CALLBACKS[CONSTANTS.SDK_READY] = {
-  collector: 'client',
-  method: 'ready'
-}, _CALLBACKS[CONSTANTS.SDK_GET_TREATMENT] = {
-  collector: 'client',
-  method: 'getTreatment'
-}, _CALLBACKS[CONSTANTS.SDK_GET_TREATMENTS] = {
-  collector: 'client',
-  method: 'getTreatments'
-}, _CALLBACKS[CONSTANTS.SDK_GET_TREATMENT_WITH_CONFIG] = {
-  collector: 'client',
-  method: 'getTreatmentWithConfig'
-}, _CALLBACKS[CONSTANTS.SDK_GET_TREATMENTS_WITH_CONFIG] = {
-  collector: 'client',
-  method: 'getTreatmentsWithConfig'
-}, _CALLBACKS[CONSTANTS.MY_SEGMENTS_FETCH] = {
-  collector: 'mySegments',
-  method: 'latency'
-}, _CALLBACKS[CONSTANTS.SEGMENTS_FETCH] = {
-  collector: 'segmentChanges',
-  method: 'latency'
-}, _CALLBACKS[CONSTANTS.SPLITS_FETCH] = {
-  collector: 'splitChanges',
-  method: 'latency'
-}, _CALLBACKS);
-/**
- * Generates the timer keys using the task name and a modifier, if any.
- * @param {string} task - The task name
- * @param {string} modifier - (optional) The modifier, if any.
- * @return {string} The generated timer key
- */
-
-var generateTimerKey = function generateTimerKey(task, modifier) {
-  return typeof modifier === 'string' ? task + modifier : task;
-};
-/**
- * Given the collectors map, it returns the specific collector for a given task.
- *
- * @param {string} task - The task name
- * @param {Object} collectors - The collectors map
- */
-
-
-var getCollectorForTask = function getCollectorForTask(task, collectors) {
-  var callbackData = CALLBACKS[task];
-  if (callbackData && collectors) return collectors[callbackData.collector];
-  return false;
-};
-/**
- * Given a collector and a task, returns the callback function that should be called when we stop the timer.
- *
- * @param {string} task - The task name
- * @param {Object} collector - The collector object for the task
- */
-
-
-var getCallbackForTask = function getCallbackForTask(task, collector) {
-  var callbackData = CALLBACKS[task];
-  if (callbackData && collector) return collector[callbackData.method];
-  return false;
-};
-
-var TrackerAPI = {
-  /**
-   * "Private" method, used to attach count/countException and stop callbacks to a promise.
-   *
-   * @param {Promise} promise - The promise we want to attach the callbacks.
-   * @param {string} task - The name of the task.
-   * @param {string} modifier - (optional) The modifier for the task, if any.
-   */
-  __attachToPromise: function __attachToPromise(promise, task, collector, modifier) {
-    var _this = this;
-
-    return promise.then(function (resp) {
-      _this.stop(task, modifier);
-
-      if (collector && collector.count) collector.count(resp.status);
-      return resp;
-    }).catch(function (err) {
-      _this.stop(task, modifier);
-
-      if (collector && collector.countException) collector.countException();
-      throw err;
-    });
-  },
-
-  /**
-   * Starts tracking the time for a given task. All tasks tracked are considered "unique" because
-   * there may be multiple SDK instances tracking a "generic" task, making any task non-generic.
-   *
-   * @param {string} task - The task we are starting.
-   * @param {Object} collectors - The collectors map.
-   * @param {Promise} promise - (optional) The promise we are tracking.
-   * @return {Function | Promise} The stop function for this specific task or the promise received with the callbacks registered.
-   */
-  start: function start(task, collectors, promise) {
-    var taskUniqueId = (0, _lang.uniqueId)();
-    var taskCollector = getCollectorForTask(task, collectors);
-    var result; // If we are registering a promise with this task, we should count the status and the exceptions as well
-    // as stopping the task when the promise resolves. Then return the promise
-
-    if ((0, _thenable.default)(promise)) {
-      result = this.__attachToPromise(promise, task, taskCollector, taskUniqueId);
-    } else {
-      // If not, we return the stop function, as it will be stopped manually.
-      result = this.stop.bind(this, task, taskUniqueId);
-
-      if (CALLBACKS[task] && !taskCollector) {
-        // and provide a way for a defered setup of the collector, if needed.
-        result.setCollectorForTask = this.setCollectorForTask.bind(this, task, taskUniqueId);
-      }
-    } // We start the timer, with an uniqueId attached to it's name, and save tracking info for this task.
-
-
-    var trackingKey = generateTimerKey(task, taskUniqueId);
-    var cb = getCallbackForTask(task, taskCollector);
-    timers[trackingKey] = {
-      cb: cb,
-      timer: (0, _timer.default)()
-    };
-    return result;
-  },
-
-  /**
-   * Setup the collector for a task that reports metrics.
-   *
-   * @param {string} task - The task name
-   * @param {string} taskUniqueId - The unique identifier for this task
-   * @param {Object} collectors - The collectors map.
-   */
-  setCollectorForTask: function setCollectorForTask(task, taskUniqueId, collectors) {
-    var taskCollector = getCollectorForTask(task, collectors);
-
-    if (taskCollector) {
-      var trackingKey = generateTimerKey(task, taskUniqueId);
-      timers[trackingKey].cb = getCallbackForTask(task, taskCollector);
-    }
-  },
-
-  /**
-   * Stops the tracking of a given task.
-   *
-   * @param {string} task - The task we are starting.
-   * @param {string} modifier - (optional) The modifier for that specific task.
-   */
-  stop: function stop(task, modifier) {
-    var timerName = generateTimerKey(task, modifier);
-    var timerData = timers[timerName];
-
-    if (timerData) {
-      // Stop the timer and round result for readability.
-      var et = timerData.timer();
-      logger.debug("[" + task + "] took " + et + "ms to finish."); // Check if we have a tracker callback.
-
-      if (timerData.cb) {
-        // If we have a callback, we call it with the elapsed time of the task and then delete the reference.
-        timerData.cb(et);
-      } // Remove the task tracking reference.
-
-
-      delete timers[timerName];
-      return et;
-    }
-  },
-
-  /**
-   * The constants shortcut for the task names.
-   */
-  TaskNames: CONSTANTS
-}; // Our "time tracker" API
-
-var _default = TrackerAPI;
-exports.default = _default;