@splitsoftware/splitio 10.17.3-rc.1 → 10.17.3-rc.4

package/es/sync/browser.js

@@ -0,0 +1,125 @@
+import PushManagerFactory from './PushManager';
+import FullProducerFactory from '../producer';
+import PartialProducerFactory from '../producer/browser/Partial';
+import { matching } from '../utils/key/factory';
+import { forOwn, toString } from '../utils/lang';
+import logFactory from '../utils/logger';
+import { PUSH_SUBSYSTEM_DOWN, PUSH_SUBSYSTEM_UP } from './constants';
+var log = logFactory('splitio-sync:sync-manager');
+/**
+ * Factory of sync manager for browser
+ *
+ * @param context main client context
+ */
+
+export default function BrowserSyncManagerFactory(mainContext) {
+  // map of user keys to client contexts
+  var contexts = {};
+  var settings = mainContext.get(mainContext.constants.SETTINGS); // call `createInstance` before creating PushManager, since it is in charge of creating the full producer and adding it into the main context.
+
+  var syncManager = createInstance(false, mainContext);
+  var pushManager = settings.streamingEnabled ? PushManagerFactory(mainContext, contexts) : undefined;
+  var mainProducer = mainContext.get(mainContext.constants.PRODUCER);
+
+  function startPolling() {
+    if (!mainProducer.isRunning()) {
+      log.info('Streaming not available. Starting periodic fetch of data.');
+      forOwn(contexts, function (context) {
+        var producer = context.get(context.constants.PRODUCER);
+        producer.start();
+      });
+    } else {
+      log.info('Streaming couldn\'t connect. Continue periodic fetch of data.');
+    }
+  }
+
+  function stopPollingAndSyncAll() {
+    if (mainProducer.isRunning()) {
+      log.info('PUSH (re)connected. Syncing and stopping periodic fetch of data.'); // if polling, stop
+
+      forOwn(contexts, function (context) {
+        var producer = context.get(context.constants.PRODUCER);
+        producer.stop();
+      });
+    }
+
+    syncAll();
+  }
+
+  function syncAll() {
+    // fetch splits and segments
+    var mainProducer = mainContext.get(mainContext.constants.PRODUCER);
+    mainProducer.synchronizeSplits();
+    forOwn(contexts, function (context) {
+      var producer = context.get(context.constants.PRODUCER);
+      producer.synchronizeMySegments();
+    });
+  }
+  /**
+   * Creates a SyncManager that handles the synchronization of clients (main and shared ones).
+   * Internally, it creates the client producer, adds it into its context, and defines the `start` and `stop` methods that handle synchronization.
+   *
+   * @param {Object} context
+   * @param {boolean} isSharedClient
+   */
+
+
+  function createInstance(isSharedClient, context) {
+    var producer = isSharedClient ? PartialProducerFactory(context) : FullProducerFactory(context);
+    var settings = context.get(context.constants.SETTINGS); // we need to stringify the user key (or matching key) in case it is not an string, to hash and pass as query param for authentication
+
+    var userKey = toString(matching(settings.core.key));
+    context.put(context.constants.PRODUCER, producer);
+    if (contexts[userKey]) log.warn('A client with the same user key has already been created. Only the new instance will be properly synchronized.');
+    contexts[userKey] = context;
+    return {
+      start: function start() {
+        // start syncing
+        if (pushManager) {
+          if (!isSharedClient) {
+            syncAll(); // initial syncAll (only when main client is created)
+
+            pushManager.on(PUSH_SUBSYSTEM_UP, stopPollingAndSyncAll);
+            pushManager.on(PUSH_SUBSYSTEM_DOWN, startPolling);
+          } else {
+            if (mainProducer.isRunning()) {
+              // if doing polling, we must start the producer periodic fetch of data
+              producer.start();
+            } else {
+              // if not doing polling, we must perform a `producer.synchronizeMySegments` for the initial fetch
+              // of segments since `syncAll` was already executed when starting the main client
+              producer.synchronizeMySegments();
+            }
+          }
+
+          pushManager.startNewClient(userKey, context);
+        } else {
+          producer.start();
+        }
+      },
+      stop: function stop() {
+        var context = contexts[userKey];
+
+        if (context) {
+          // check in case `client.destroy()` has been invoked more than once for the same client
+          delete contexts[userKey];
+
+          if (pushManager) {
+            pushManager.removeClient(userKey); // stop push if stoping main client
+
+            if (!isSharedClient) pushManager.stop(); // We don't reconnect pushmanager when removing a shared client,
+            // since it is more costly than continue listening the channel
+          }
+
+          if (producer.isRunning()) producer.stop();
+        }
+      }
+    };
+  } // For the main client we return a SyncManager with 3 methods: start, stop and shared. The last is used to instantiate "partial SyncManagers".
+
+
+  syncManager.shared = createInstance.bind(null, true); // pushManager is exposed to close SSE connection in browser on 'unload' DOM event.
+
+  syncManager.pushManager = pushManager;
+  return syncManager;
+}

package/es/sync/constants.js

@@ -0,0 +1,42 @@
+// time for refresh token
+export var SECONDS_BEFORE_EXPIRATION = 600; // Internal SDK events, subscribed by SyncManager and PushManager
+
+/**
+ * emitted on SSE and Authenticate non-recoverable errors, STREAMING_DISABLED control notification and authentication with pushEnabled false
+ * triggers `handleNonRetryableError` call
+ */
+
+export var PUSH_NONRETRYABLE_ERROR = 'PUSH_NONRETRYABLE_ERROR';
+/**
+ * emitted on SSE and Authenticate recoverable errors
+ * triggers `handleRetryableError` call
+ */
+
+export var PUSH_RETRYABLE_ERROR = 'PUSH_RETRYABLE_ERROR';
+/**
+ * emitted on STREAMING_RESUMED control notification, OCCUPANCY different than 0, and SSE onopen event
+ * triggers `stopPollingAndSyncAll` call
+ */
+
+export var PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP';
+/**
+ * emitted on STREAMING_PAUSED control notification, OCCUPANCY equal to 0, PUSH_NONRETRYABLE_ERROR and PUSH_RETRYABLE_ERROR events.
+ * triggers `startPolling` and `stopWorkers` calls
+ */
+
+export var PUSH_SUBSYSTEM_DOWN = 'PUSH_SUBSYSTEM_DOWN'; // Update-type push notifications, handled by NotificationProcessor
+
+export var MY_SEGMENTS_UPDATE = 'MY_SEGMENTS_UPDATE';
+export var MY_SEGMENTS_UPDATE_V2 = 'MY_SEGMENTS_UPDATE_V2';
+export var SEGMENT_UPDATE = 'SEGMENT_UPDATE';
+export var SPLIT_KILL = 'SPLIT_KILL';
+export var SPLIT_UPDATE = 'SPLIT_UPDATE'; // Control-type push notifications, handled by NotificationKeeper
+
+export var CONTROL = 'CONTROL';
+export var OCCUPANCY = 'OCCUPANCY';
+export var ControlTypes = {
+  STREAMING_DISABLED: 'STREAMING_DISABLED',
+  STREAMING_PAUSED: 'STREAMING_PAUSED',
+  STREAMING_RESUMED: 'STREAMING_RESUMED',
+  STREAMING_RESET: 'STREAMING_RESET'
+};

package/es/sync/node.js

@@ -0,0 +1,60 @@
+import PushManagerFactory from './PushManager';
+import FullProducerFactory from '../producer';
+import logFactory from '../utils/logger';
+import { PUSH_SUBSYSTEM_DOWN, PUSH_SUBSYSTEM_UP } from './constants';
+var log = logFactory('splitio-sync:sync-manager');
+/**
+ * Factory of SyncManager for node
+ *
+ * @param context main client context
+ */
+
+export default function NodeSyncManagerFactory(context) {
+  var producer = FullProducerFactory(context);
+  var settings = context.get(context.constants.SETTINGS); // add producer into the context before creating the PushManager
+
+  context.put(context.constants.PRODUCER, producer);
+  var pushManager = settings.streamingEnabled ? PushManagerFactory(context) : undefined;
+
+  function startPolling() {
+    if (!producer.isRunning()) {
+      log.info('Streaming not available. Starting periodic fetch of data.');
+      producer.start();
+    } else {
+      log.info('Streaming couldn\'t connect. Continue periodic fetch of data.');
+    }
+  }
+
+  function stopPollingAndSyncAll() {
+    log.info('PUSH (re)connected. Syncing and stopping periodic fetch of data.'); // if polling, stop
+
+    if (producer.isRunning()) producer.stop();
+    syncAll();
+  }
+
+  function syncAll() {
+    // fetch splits and segments. There is no need to catch this promise (it is handled by `SplitChangesUpdater`)
+    producer.synchronizeSplits().then(function () {
+      producer.synchronizeSegment();
+    });
+  }
+
+  return {
+    start: function start() {
+      // start syncing
+      if (pushManager) {
+        syncAll();
+        pushManager.on(PUSH_SUBSYSTEM_UP, stopPollingAndSyncAll);
+        pushManager.on(PUSH_SUBSYSTEM_DOWN, startPolling);
+        setTimeout(pushManager.start); // Run in next event-loop cycle as in browser
+      } else {
+        producer.start();
+      }
+    },
+    stop: function stop() {
+      // stop syncing
+      if (pushManager) pushManager.stop();
+      if (producer.isRunning()) producer.stop();
+    }
+  };
+}

package/es/trackers/event.js

@@ -0,0 +1,53 @@
+import objectAssign from 'object-assign';
+import logFactory from '../utils/logger';
+import thenable from '../utils/promise/thenable';
+var log = logFactory('splitio-client:event-tracker');
+
+function EventTracker(context) {
+  var collector = context.get(context.constants.STORAGE).events;
+  var integrationsManager = context.get(context.constants.INTEGRATIONS_MANAGER, true);
+
+  function queueEventsCallback(eventData, tracked) {
+    var eventTypeId = eventData.eventTypeId,
+        trafficTypeName = eventData.trafficTypeName,
+        key = eventData.key,
+        value = eventData.value,
+        timestamp = eventData.timestamp,
+        properties = eventData.properties; // Logging every prop would be too much.
+
+    var msg = "event of type \"" + eventTypeId + "\" for traffic type \"" + trafficTypeName + "\". Key: " + key + ". Value: " + value + ". Timestamp: " + timestamp + ". " + (properties ? 'With properties.' : 'With no properties.');
+
+    if (tracked) {
+      log.info("Successfully queued " + msg);
+
+      if (integrationsManager) {
+        // Wrap in a timeout because we don't want it to be blocking.
+        setTimeout(function () {
+          // copy of event, to avoid unexpected behaviour if modified by integrations
+          var eventDataCopy = objectAssign({}, eventData);
+          if (eventData.properties) eventDataCopy.properties = objectAssign({}, eventData.properties); // integrationsManager does not throw errors (they are internally handled by each integration module)
+
+          integrationsManager.handleEvent(eventDataCopy);
+        }, 0);
+      }
+    } else {
+      log.warn("Failed to queue " + msg);
+    }
+
+    return tracked;
+  }
+
+  return {
+    track: function track(eventData, size) {
+      var tracked = collector.track(eventData, size);
+
+      if (thenable(tracked)) {
+        return tracked.then(queueEventsCallback.bind(null, eventData));
+      } else {
+        return queueEventsCallback(eventData, tracked);
+      }
+    }
+  };
+}
+
+export default EventTracker;

package/es/trackers/impressions.js

@@ -0,0 +1,132 @@
+/**
+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.
+**/
+import objectAssign from 'object-assign';
+import logFactory from '../utils/logger';
+import thenable from '../utils/promise/thenable';
+import ImpressionObserverFactory from '../impressions/observer';
+import { truncateTimeFrame } from '../utils/time';
+import { OPTIMIZED, PRODUCER_MODE, STANDALONE_MODE } from '../utils/constants';
+var log = logFactory('splitio-client:impressions-tracker');
+/**
+ * Checks if impressions previous time should be added or not.
+ */
+
+function shouldAddPt(settings) {
+  return [PRODUCER_MODE, STANDALONE_MODE].indexOf(settings.mode) > -1 ? true : false;
+}
+/**
+ * Checks if it should dedupe impressions or not.
+ */
+
+
+function shouldBeOptimized(settings) {
+  if (!shouldAddPt(settings)) return false;
+  return settings.sync.impressionsMode === OPTIMIZED ? true : false;
+}
+
+function ImpressionsTracker(context) {
+  var collector = context.get(context.constants.STORAGE).impressions;
+  var settings = context.get(context.constants.SETTINGS);
+  var listener = settings.impressionListener;
+  var integrationsManager = context.get(context.constants.INTEGRATIONS_MANAGER, true);
+  var _settings$runtime = settings.runtime,
+      ip = _settings$runtime.ip,
+      hostname = _settings$runtime.hostname;
+  var sdkLanguageVersion = settings.version;
+  var _queue = [];
+  var shouldAddPreviousTime = shouldAddPt(settings);
+  var isOptimized = shouldBeOptimized(settings);
+  var observer = ImpressionObserverFactory(); // Instantiates observer
+
+  var impressionsCounter = context.get(context.constants.IMPRESSIONS_COUNTER);
+  return {
+    queue: function queue(impression, attributes) {
+      _queue.push({
+        impression: impression,
+        attributes: attributes
+      });
+    },
+    track: function track() {
+      var impressionsCount = _queue.length;
+
+      var slice = _queue.splice(0, impressionsCount);
+
+      var impressionsToStore = []; // Track only the impressions that are going to be stored
+      // Wraps impressions to store and adds previousTime if it corresponds
+
+      slice.forEach(function (_ref) {
+        var impression = _ref.impression;
+
+        if (shouldAddPreviousTime) {
+          // Adds previous time if it is enabled
+          impression.pt = observer.testAndSet(impression);
+        }
+
+        var now = Date.now();
+
+        if (isOptimized && impressionsCounter) {
+          // Increments impression counter per featureName
+          impressionsCounter.inc(impression.feature, now, 1);
+        } // Checks if the impression should be added in queue to be sent
+
+
+        if (!isOptimized || !impression.pt || impression.pt < truncateTimeFrame(now)) {
+          impressionsToStore.push(impression);
+        }
+      });
+      var res = collector.track(impressionsToStore); // If we're on an async storage, handle error and log it.
+
+      if (thenable(res)) {
+        res.then(function () {
+          log.debug("Successfully stored " + impressionsCount + " impression" + (impressionsCount === 1 ? '' : 's') + ".");
+        }).catch(function (err) {
+          log.error("Could not store impressions bulk with " + impressionsCount + " impression" + (impressionsCount === 1 ? '' : 's') + ". Error: " + err);
+        });
+      }
+
+      if (listener || integrationsManager) {
+        var _loop = function _loop(i) {
+          var impressionData = {
+            // copy of impression, to avoid unexpected behaviour if modified by integrations or impressionListener
+            impression: objectAssign({}, slice[i].impression),
+            attributes: slice[i].attributes,
+            ip: ip,
+            hostname: hostname,
+            sdkLanguageVersion: sdkLanguageVersion
+          }; // Wrap in a timeout because we don't want it to be blocking.
+
+          setTimeout(function () {
+            // integrationsManager.handleImpression does not throw errors
+            if (integrationsManager) integrationsManager.handleImpression(impressionData);
+
+            try {
+              // An exception on the listeners should not break the SDK.
+              if (listener) listener.logImpression(impressionData);
+            } catch (err) {
+              log.error("Impression listener logImpression method threw: " + err + ".");
+            }
+          }, 0);
+        };
+
+        for (var i = 0; i < impressionsCount; i++) {
+          _loop(i);
+        }
+      }
+    }
+  };
+}
+
+export default ImpressionsTracker;

package/es/umd.js

@@ -1,3 +1,2 @@
-import { SplitFactory } from './index'; // eslint-disable-next-line import/no-default-export
-
+import { SplitFactory } from './index';
 export default SplitFactory;

package/es/utils/backoff/index.js

@@ -0,0 +1,51 @@
+var Backoff = /*#__PURE__*/function () {
+  /**
+   * Schedule function calls with exponential backoff
+   *
+   * @param {function} cb
+   * @param {number} baseMillis
+   * @param {number} maxMillis
+   */
+  function Backoff(cb, baseMillis, maxMillis) {
+    this.baseMillis = baseMillis || Backoff.DEFAULT_BASE_MILLIS;
+    this.maxMillis = maxMillis || Backoff.DEFAULT_MAX_MILLIS;
+    this.attempts = 0;
+    this.cb = cb;
+  }
+  /**
+   * Schedule a next call to `cb`
+   * @returns scheduled delay in milliseconds
+   */
+
+
+  var _proto = Backoff.prototype;
+
+  _proto.scheduleCall = function scheduleCall() {
+    var _this = this;
+
+    var delayInMillis = Math.min(this.baseMillis * Math.pow(2, this.attempts), this.maxMillis);
+    if (this.timeoutID) clearTimeout(this.timeoutID);
+    this.timeoutID = setTimeout(function () {
+      _this.cb();
+    }, delayInMillis);
+    this.attempts++;
+    return delayInMillis;
+  };
+
+  _proto.reset = function reset() {
+    this.attempts = 0;
+
+    if (this.timeoutID) {
+      clearTimeout(this.timeoutID);
+      this.timeoutID = 0;
+    }
+  };
+
+  return Backoff;
+}();
+
+Backoff.DEFAULT_BASE_MILLIS = 1000; // 1 second
+
+Backoff.DEFAULT_MAX_MILLIS = 1800000; // 30 minutes
+
+export default Backoff;

package/es/utils/base64/browser.js

@@ -0,0 +1,19 @@
+/**
+ * Decode a given string value in Base64 format
+ *
+ * @param {string} value to decode
+ * @throws {ReferenceError} if `atob` function is not defined
+ */
+export function decodeFromBase64(value) {
+  return atob(value);
+}
+/**
+ * Encode a given string value to Base64 format.
+ *
+ * @param {string} value to encode
+ * @throws {ReferenceError} if `btoa` function is not defined
+ */
+
+export function encodeToBase64(value) {
+  return btoa(value);
+}

package/es/utils/base64/node.js

@@ -0,0 +1,19 @@
+/**
+ * Decode a given string value in Base64 format
+ *
+ * @param {string} value to decode
+ */
+export function decodeFromBase64(value) {
+  // for node (version mayor than v4)
+  return Buffer.from(value, 'base64').toString('binary');
+}
+/**
+ * Encode a given string value to Base64 format
+ *
+ * @param {string} value to encode
+ */
+
+export function encodeToBase64(value) {
+  // for node (version mayor than v4)
+  return Buffer.from(value).toString('base64');
+}

package/es/utils/base64/package.json

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

package/es/utils/binarySearch/index.js

@@ -0,0 +1,50 @@
+/**
+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 bs(items, value) {
+  var startIndex = 0;
+  var stopIndex = items.length - 1;
+  var middle = Math.floor((stopIndex + startIndex) / 2);
+  var minIndex = startIndex;
+  var maxIndex = stopIndex;
+
+  while (items[middle] !== value && startIndex < stopIndex) {
+    // adjust search area
+    if (value < items[middle]) {
+      stopIndex = middle - 1;
+    } else if (value > items[middle]) {
+      startIndex = middle + 1;
+    } // recalculate middle
+
+
+    middle = Math.floor((stopIndex + startIndex) / 2);
+  } // correct if middle is out of range
+
+
+  if (middle < minIndex) {
+    middle = minIndex;
+  } else if (middle > maxIndex) {
+    middle = maxIndex;
+  } // we want to always return based on strict minor comparation
+
+
+  if (value < items[middle] && middle > minIndex) {
+    return middle - 1;
+  }
+
+  return middle;
+}
+
+export default bs;

package/es/utils/constants/index.js

@@ -0,0 +1,38 @@
+// SDK Modes
+export var LOCALHOST_MODE = 'localhost';
+export var STANDALONE_MODE = 'standalone';
+export var PRODUCER_MODE = 'producer';
+export var CONSUMER_MODE = 'consumer'; // Storage types
+
+export var STORAGE_MEMORY = 'MEMORY';
+export var STORAGE_REDIS = 'REDIS';
+export var STORAGE_LOCALSTORAGE = 'LOCALSTORAGE'; // Special treatments
+
+export var CONTROL = 'control';
+export var CONTROL_WITH_CONFIG = {
+  treatment: CONTROL,
+  config: null
+}; // Constants for unknown and not-applicable values
+
+export var UNKNOWN = 'unknown';
+export var NA = 'NA'; // Integration types
+
+export var GOOGLE_ANALYTICS_TO_SPLIT = 'GOOGLE_ANALYTICS_TO_SPLIT';
+export var SPLIT_TO_GOOGLE_ANALYTICS = 'SPLIT_TO_GOOGLE_ANALYTICS'; // Integration data types
+
+export var SPLIT_IMPRESSION = 'IMPRESSION';
+export var SPLIT_EVENT = 'EVENT'; // Split filters metadata.
+// Ordered according to their precedency when forming the filter query string: `&names=<values>&prefixes=<values>`
+
+export var FILTERS_METADATA = [{
+  type: 'byName',
+  maxLength: 400,
+  queryParam: 'names='
+}, {
+  type: 'byPrefix',
+  maxLength: 50,
+  queryParam: 'prefixes='
+}]; // Impression collection modes
+
+export var DEBUG = 'DEBUG';
+export var OPTIMIZED = 'OPTIMIZED';

package/es/utils/context/constants.js

@@ -0,0 +1,30 @@
+export var COLLECTORS = 'metrics_collectors';
+export var DESTROYED = 'is_destroyed';
+export var EVENTS = 'events_publisher';
+export var HAS_TIMEDOUT = 'has_timedout';
+export var INTEGRATIONS_MANAGER = 'integrations_manager';
+export var MY_SEGMENTS_CHANGE_WORKER = 'my_segments_change_worker';
+export var PRODUCER = 'producer';
+export var READINESS = 'readiness_gate';
+export var READY = 'is_ready';
+export var READY_FROM_CACHE = 'is_ready_from_cache';
+export var SETTINGS = 'settings';
+export var STATUS_MANAGER = 'status_manager';
+export var STORAGE = 'storage';
+export var IMPRESSIONS_COUNTER = 'impressions_counter';
+export default {
+  COLLECTORS: COLLECTORS,
+  DESTROYED: DESTROYED,
+  EVENTS: EVENTS,
+  HAS_TIMEDOUT: HAS_TIMEDOUT,
+  INTEGRATIONS_MANAGER: INTEGRATIONS_MANAGER,
+  MY_SEGMENTS_CHANGE_WORKER: MY_SEGMENTS_CHANGE_WORKER,
+  PRODUCER: PRODUCER,
+  READINESS: READINESS,
+  READY: READY,
+  READY_FROM_CACHE: READY_FROM_CACHE,
+  SETTINGS: SETTINGS,
+  STATUS_MANAGER: STATUS_MANAGER,
+  STORAGE: STORAGE,
+  IMPRESSIONS_COUNTER: IMPRESSIONS_COUNTER
+};