@splitsoftware/splitio 10.17.1 → 10.17.3-rc.1

package/src/platform/EventEmitter.js

@@ -0,0 +1,443 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+// Adaptation of "events" library (https://www.npmjs.com/package/events)
+// exported as an ES module instead of CommonJS, to avoid extra configuration steps when using
+// the ESM build of the SDK with tools that doesn't support CommonJS by default (e.g. Rollup).
+
+var R = typeof Reflect === 'object' ? Reflect : null;
+var ReflectApply = R && typeof R.apply === 'function'
+  ? R.apply
+  : function ReflectApply(target, receiver, args) {
+    return Function.prototype.apply.call(target, receiver, args);
+  };
+
+var ReflectOwnKeys;
+if (R && typeof R.ownKeys === 'function') {
+  ReflectOwnKeys = R.ownKeys;
+} else if (Object.getOwnPropertySymbols) {
+  ReflectOwnKeys = function ReflectOwnKeys(target) {
+    return Object.getOwnPropertyNames(target)
+      .concat(Object.getOwnPropertySymbols(target));
+  };
+} else {
+  ReflectOwnKeys = function ReflectOwnKeys(target) {
+    return Object.getOwnPropertyNames(target);
+  };
+}
+
+function ProcessEmitWarning(warning) {
+  if (console && console.warn) console.warn(warning);
+}
+
+var NumberIsNaN = Number.isNaN || function NumberIsNaN(value) {
+  return value !== value;
+};
+
+export function EventEmitter() {
+  EventEmitter.init.call(this);
+}
+
+EventEmitter.prototype._events = undefined;
+EventEmitter.prototype._eventsCount = 0;
+EventEmitter.prototype._maxListeners = undefined;
+
+// By default EventEmitters will print a warning if more than 10 listeners are
+// added to it. This is a useful default which helps finding memory leaks.
+var defaultMaxListeners = 10;
+
+function checkListener(listener) {
+  if (typeof listener !== 'function') {
+    throw new TypeError('The "listener" argument must be of type Function. Received type ' + typeof listener);
+  }
+}
+
+Object.defineProperty(EventEmitter, 'defaultMaxListeners', {
+  enumerable: true,
+  get: function() {
+    return defaultMaxListeners;
+  },
+  set: function(arg) {
+    if (typeof arg !== 'number' || arg < 0 || NumberIsNaN(arg)) {
+      throw new RangeError('The value of "defaultMaxListeners" is out of range. It must be a non-negative number. Received ' + arg + '.');
+    }
+    defaultMaxListeners = arg;
+  }
+});
+
+EventEmitter.init = function() {
+
+  if (this._events === undefined ||
+      this._events === Object.getPrototypeOf(this)._events) {
+    this._events = Object.create(null);
+    this._eventsCount = 0;
+  }
+
+  this._maxListeners = this._maxListeners || undefined;
+};
+
+// Obviously not all Emitters should be limited to 10. This function allows
+// that to be increased. Set to zero for unlimited.
+EventEmitter.prototype.setMaxListeners = function setMaxListeners(n) {
+  if (typeof n !== 'number' || n < 0 || NumberIsNaN(n)) {
+    throw new RangeError('The value of "n" is out of range. It must be a non-negative number. Received ' + n + '.');
+  }
+  this._maxListeners = n;
+  return this;
+};
+
+function _getMaxListeners(that) {
+  if (that._maxListeners === undefined)
+    return EventEmitter.defaultMaxListeners;
+  return that._maxListeners;
+}
+
+EventEmitter.prototype.getMaxListeners = function getMaxListeners() {
+  return _getMaxListeners(this);
+};
+
+EventEmitter.prototype.emit = function emit(type) {
+  var args = [];
+  for (var i = 1; i < arguments.length; i++) args.push(arguments[i]);
+  var doError = (type === 'error');
+
+  var events = this._events;
+  if (events !== undefined)
+    doError = (doError && events.error === undefined);
+  else if (!doError)
+    return false;
+
+  // If there is no 'error' event listener then throw.
+  if (doError) {
+    var er;
+    if (args.length > 0)
+      er = args[0];
+    if (er instanceof Error) {
+      // Note: The comments on the `throw` lines are intentional, they show
+      // up in Node's output if this results in an unhandled exception.
+      throw er; // Unhandled 'error' event
+    }
+    // At least give some kind of context to the user
+    var err = new Error('Unhandled error.' + (er ? ' (' + er.message + ')' : ''));
+    err.context = er;
+    throw err; // Unhandled 'error' event
+  }
+
+  var handler = events[type];
+
+  if (handler === undefined)
+    return false;
+
+  if (typeof handler === 'function') {
+    ReflectApply(handler, this, args);
+  } else {
+    var len = handler.length;
+    var listeners = arrayClone(handler, len); // eslint-disable-next-line no-redeclare
+    for (var i = 0; i < len; ++i)
+      ReflectApply(listeners[i], this, args);
+  }
+
+  return true;
+};
+
+function _addListener(target, type, listener, prepend) {
+  var m;
+  var events;
+  var existing;
+
+  checkListener(listener);
+
+  events = target._events;
+  if (events === undefined) {
+    events = target._events = Object.create(null);
+    target._eventsCount = 0;
+  } else {
+    // To avoid recursion in the case that type === "newListener"! Before
+    // adding it to the listeners, first emit "newListener".
+    if (events.newListener !== undefined) {
+      target.emit('newListener', type, listener.listener ? listener.listener : listener);
+
+      // Re-assign `events` because a newListener handler could have caused the
+      // this._events to be assigned to a new object
+      events = target._events;
+    }
+    existing = events[type];
+  }
+
+  if (existing === undefined) {
+    // Optimize the case of one listener. Don't need the extra array object.
+    existing = events[type] = listener;
+    ++target._eventsCount;
+  } else {
+    if (typeof existing === 'function') {
+      // Adding the second element, need to change to array.
+      existing = events[type] =
+        prepend ? [listener, existing] : [existing, listener];
+      // If we've already got an array, just append.
+    } else if (prepend) {
+      existing.unshift(listener);
+    } else {
+      existing.push(listener);
+    }
+
+    // Check for listener leak
+    m = _getMaxListeners(target);
+    if (m > 0 && existing.length > m && !existing.warned) {
+      existing.warned = true;
+      // No error code for this since it is a Warning
+      // eslint-disable-next-line no-restricted-syntax
+      var w = new Error('Possible EventEmitter memory leak detected. ' +
+                          existing.length + ' ' + String(type) + ' listeners ' +
+                          'added. Use emitter.setMaxListeners() to ' +
+                          'increase limit');
+      w.name = 'MaxListenersExceededWarning';
+      w.emitter = target;
+      w.type = type;
+      w.count = existing.length;
+      ProcessEmitWarning(w);
+    }
+  }
+
+  return target;
+}
+
+EventEmitter.prototype.addListener = function addListener(type, listener) {
+  return _addListener(this, type, listener, false);
+};
+
+EventEmitter.prototype.on = EventEmitter.prototype.addListener;
+
+EventEmitter.prototype.prependListener =
+    function prependListener(type, listener) {
+      return _addListener(this, type, listener, true);
+    };
+
+function onceWrapper() {
+  if (!this.fired) {
+    this.target.removeListener(this.type, this.wrapFn);
+    this.fired = true;
+    if (arguments.length === 0)
+      return this.listener.call(this.target);
+    return this.listener.apply(this.target, arguments);
+  }
+}
+
+function _onceWrap(target, type, listener) {
+  var state = { fired: false, wrapFn: undefined, target: target, type: type, listener: listener };
+  var wrapped = onceWrapper.bind(state);
+  wrapped.listener = listener;
+  state.wrapFn = wrapped;
+  return wrapped;
+}
+
+EventEmitter.prototype.once = function once(type, listener) {
+  checkListener(listener);
+  this.on(type, _onceWrap(this, type, listener));
+  return this;
+};
+
+EventEmitter.prototype.prependOnceListener =
+    function prependOnceListener(type, listener) {
+      checkListener(listener);
+      this.prependListener(type, _onceWrap(this, type, listener));
+      return this;
+    };
+
+// Emits a 'removeListener' event if and only if the listener was removed.
+EventEmitter.prototype.removeListener =
+    function removeListener(type, listener) {
+      var list, events, position, i, originalListener;
+
+      checkListener(listener);
+
+      events = this._events;
+      if (events === undefined)
+        return this;
+
+      list = events[type];
+      if (list === undefined)
+        return this;
+
+      if (list === listener || list.listener === listener) {
+        if (--this._eventsCount === 0)
+          this._events = Object.create(null);
+        else {
+          delete events[type];
+          if (events.removeListener)
+            this.emit('removeListener', type, list.listener || listener);
+        }
+      } else if (typeof list !== 'function') {
+        position = -1;
+
+        for (i = list.length - 1; i >= 0; i--) {
+          if (list[i] === listener || list[i].listener === listener) {
+            originalListener = list[i].listener;
+            position = i;
+            break;
+          }
+        }
+
+        if (position < 0)
+          return this;
+
+        if (position === 0)
+          list.shift();
+        else {
+          spliceOne(list, position);
+        }
+
+        if (list.length === 1)
+          events[type] = list[0];
+
+        if (events.removeListener !== undefined)
+          this.emit('removeListener', type, originalListener || listener);
+      }
+
+      return this;
+    };
+
+EventEmitter.prototype.off = EventEmitter.prototype.removeListener;
+
+EventEmitter.prototype.removeAllListeners =
+    function removeAllListeners(type) {
+      var listeners, events, i;
+
+      events = this._events;
+      if (events === undefined)
+        return this;
+
+      // not listening for removeListener, no need to emit
+      if (events.removeListener === undefined) {
+        if (arguments.length === 0) {
+          this._events = Object.create(null);
+          this._eventsCount = 0;
+        } else if (events[type] !== undefined) {
+          if (--this._eventsCount === 0)
+            this._events = Object.create(null);
+          else
+            delete events[type];
+        }
+        return this;
+      }
+
+      // emit removeListener for all listeners on all events
+      if (arguments.length === 0) {
+        var keys = Object.keys(events);
+        var key;
+        for (i = 0; i < keys.length; ++i) {
+          key = keys[i];
+          if (key === 'removeListener') continue;
+          this.removeAllListeners(key);
+        }
+        this.removeAllListeners('removeListener');
+        this._events = Object.create(null);
+        this._eventsCount = 0;
+        return this;
+      }
+
+      listeners = events[type];
+
+      if (typeof listeners === 'function') {
+        this.removeListener(type, listeners);
+      } else if (listeners !== undefined) {
+        // LIFO order
+        for (i = listeners.length - 1; i >= 0; i--) {
+          this.removeListener(type, listeners[i]);
+        }
+      }
+
+      return this;
+    };
+
+function _listeners(target, type, unwrap) {
+  var events = target._events;
+
+  if (events === undefined)
+    return [];
+
+  var evlistener = events[type];
+  if (evlistener === undefined)
+    return [];
+
+  if (typeof evlistener === 'function')
+    return unwrap ? [evlistener.listener || evlistener] : [evlistener];
+
+  return unwrap ?
+    unwrapListeners(evlistener) : arrayClone(evlistener, evlistener.length);
+}
+
+EventEmitter.prototype.listeners = function listeners(type) {
+  return _listeners(this, type, true);
+};
+
+EventEmitter.prototype.rawListeners = function rawListeners(type) {
+  return _listeners(this, type, false);
+};
+
+EventEmitter.listenerCount = function(emitter, type) {
+  if (typeof emitter.listenerCount === 'function') {
+    return emitter.listenerCount(type);
+  } else {
+    return listenerCount.call(emitter, type);
+  }
+};
+
+EventEmitter.prototype.listenerCount = listenerCount;
+function listenerCount(type) {
+  var events = this._events;
+
+  if (events !== undefined) {
+    var evlistener = events[type];
+
+    if (typeof evlistener === 'function') {
+      return 1;
+    } else if (evlistener !== undefined) {
+      return evlistener.length;
+    }
+  }
+
+  return 0;
+}
+
+EventEmitter.prototype.eventNames = function eventNames() {
+  return this._eventsCount > 0 ? ReflectOwnKeys(this._events) : [];
+};
+
+function arrayClone(arr, n) {
+  var copy = new Array(n);
+  for (var i = 0; i < n; ++i)
+    copy[i] = arr[i];
+  return copy;
+}
+
+function spliceOne(list, index) {
+  for (; index + 1 < list.length; index++)
+    list[index] = list[index + 1];
+  list.pop();
+}
+
+function unwrapListeners(arr) {
+  var ret = new Array(arr.length);
+  for (var i = 0; i < ret.length; ++i) {
+    ret[i] = arr[i].listener || arr[i];
+  }
+  return ret;
+}

package/src/platform/browser.js

@@ -0,0 +1,12 @@
+import { EventEmitter } from './EventEmitter';
+import { getFetch } from '../platform/getFetch/browser';
+import { getEventSource } from '../platform/getEventSource/browser';
+import { BrowserSignalListener } from '@splitsoftware/splitio-commons/src/listeners/browser';
+
+export const platform = {
+  getFetch,
+  getEventSource,
+  EventEmitter
+};
+
+export const SignalListener = BrowserSignalListener;

package/src/{services → platform}/getEventSource/browser.js

@@ -1,3 +1,3 @@
-export default function getEventSource() {
+export function getEventSource() {
   return typeof EventSource === 'function' ? EventSource : undefined;
-}
+}

package/src/{services → platform}/getEventSource/node.js

@@ -10,11 +10,11 @@ export function __restore() {
   __isCustom = false;
 }
 
-export default function getEventSource() {
+export function getEventSource() {
   // returns EventSource at `eventsource` package. If not available, return global EventSource or undefined
   try {
     return __isCustom ? __eventSource : require('eventsource');
   } catch (error) {
     return typeof EventSource === 'function' ? EventSource : undefined;
   }
-}
+}

package/src/{services → platform}/getFetch/browser.js

@@ -1,5 +1,5 @@
 import unfetch from 'unfetch';
 
-export default function getFetch() {
+export function getFetch() {
   return typeof fetch === 'function' ? fetch : unfetch;
-}
+}

package/src/{services → platform}/getFetch/node.js

@@ -16,6 +16,6 @@ export function __setFetch(fetch) {
   nodeFetch = fetch;
 }
 
-export default function getFetch() {
+export function getFetch() {
   return nodeFetch;
 }

package/src/platform/node.js

@@ -0,0 +1,14 @@
+import EventEmitter from 'events';
+import { getFetch } from '../platform/getFetch/node';
+import { getEventSource } from '../platform/getEventSource/node';
+import { getOptions } from '../platform/request/options/node';
+import { NodeSignalListener } from '@splitsoftware/splitio-commons/src/listeners/node';
+
+export const platform = {
+  getOptions,
+  getFetch,
+  getEventSource,
+  EventEmitter
+};
+
+export const SignalListener = NodeSignalListener;

package/src/{services → platform}/request/options/node.js

@@ -1,5 +1,5 @@
 /**
-Copyright 2016 Split Software
+Copyright 2022 Split Software
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ const agent = new https.Agent({
   keepAliveMsecs: 1500
 });
 
-export default function getOptions() {
+export function getOptions() {
   return {
     agent
   };

package/src/settings/browser.js

@@ -0,0 +1,18 @@
+import { settingsValidation } from '@splitsoftware/splitio-commons/src/utils/settingsValidation';
+import { defaults } from './defaults/browser';
+import { validateStorage } from './storage/browser';
+import { validateIntegrations } from './integrations/browser';
+import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/builtinLogger';
+import { LocalhostFromObject } from '@splitsoftware/splitio-commons/src/sync/offline/LocalhostFromObject';
+
+const params = {
+  defaults,
+  storage: validateStorage,
+  integrations: validateIntegrations,
+  logger: validateLogger,
+  localhost: () => LocalhostFromObject(),
+};
+
+export function settingsFactory(config) {
+  return settingsValidation(config, params);
+}

package/{es/utils → src}/settings/defaults/browser.js

@@ -1,4 +1,6 @@
-export default {
+import { packageVersion } from './version';
+
+export const defaults = {
   startup: {
     // Stress the request time used while starting up the SDK.
     requestTimeoutBeforeReady: 5,
@@ -8,5 +10,8 @@ export default {
     readyTimeout: 10,
     // Amount of time we will wait before the first push of events.
     eventsFirstPushWindow: 10
-  }
-};
+  },
+
+  // Instance version.
+  version: `javascript-${packageVersion}`,
+};

package/{lib/utils → src}/settings/defaults/node.js

@@ -1,8 +1,6 @@
-"use strict";
+import { packageVersion } from './version';
 
-exports.__esModule = true;
-exports.default = void 0;
-var _default = {
+export const defaults = {
   core: {
     // Default is true.
     IPAddressesEnabled: true
@@ -21,6 +19,8 @@ var _default = {
     featuresRefreshRate: 5,
     impressionsRefreshRate: 300
   },
-  features: '.split'
+  features: '.split',
+
+  // Instance version.
+  version: `nodejs-${packageVersion}`,
 };
-exports.default = _default;

package/src/settings/defaults/version.js

@@ -0,0 +1 @@
+export const packageVersion = '10.17.3-rc.1';

package/src/settings/integrations/browser.js

@@ -0,0 +1,6 @@
+import { GOOGLE_ANALYTICS_TO_SPLIT, SPLIT_TO_GOOGLE_ANALYTICS } from '@splitsoftware/splitio-commons/src/utils/constants/browser';
+import { validateConfigurableIntegrations } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/integrations/configurable';
+
+export const validateIntegrations = settings => {
+  return validateConfigurableIntegrations(settings, [GOOGLE_ANALYTICS_TO_SPLIT, SPLIT_TO_GOOGLE_ANALYTICS]);
+};

package/src/{utils/settings → settings}/integrations/node.js

@@ -1,7 +1,5 @@
 // For now, Node SDK does not support integrations,
 // thus any integrations settings is parsed into undefined.
-const validateNodeIntegrationsSettings = () => {
+export const validateIntegrations = () => {
   return [];
 };
-
-export default validateNodeIntegrationsSettings;

package/src/settings/node.js

@@ -0,0 +1,20 @@
+import { settingsValidation } from '@splitsoftware/splitio-commons/src/utils/settingsValidation';
+import { defaults } from './defaults/node';
+import { validateRuntime } from './runtime/node';
+import { validateStorage } from './storage/node';
+import { validateIntegrations } from './integrations/node';
+import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/builtinLogger';
+import { LocalhostFromFile } from '@splitsoftware/splitio-commons/src/sync/offline/LocalhostFromFile';
+
+const params = {
+  defaults,
+  runtime: validateRuntime,
+  storage: validateStorage,
+  integrations: validateIntegrations,
+  logger: validateLogger,
+  localhost: () => LocalhostFromFile(),
+};
+
+export function settingsFactory(config) {
+  return settingsValidation(config, params);
+}

package/src/{utils/settings → settings}/runtime/node.js

@@ -1,5 +1,5 @@
 /**
-Copyright 2016 Split Software
+Copyright 2022 Split Software
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -17,18 +17,21 @@ limitations under the License.
 import osFunction from 'os';
 import ipFunction from 'ip';
 
-import { UNKNOWN, NA } from '../../constants';
+import { UNKNOWN, NA, CONSUMER_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
+
+export function validateRuntime(settings) {
+  const isIPAddressesEnabled = settings.core.IPAddressesEnabled === true;
+  const isConsumerMode = settings.mode === CONSUMER_MODE;
 
-export default function generateRuntimeSettings(isIPAddressesEnabled, isConsumerMode) {
   // If the values are not available, default to false (for standalone) or "unknown" (for consumer mode, to be used on Redis keys)
   let ip = ipFunction.address() || (isConsumerMode ? UNKNOWN : false);
   let hostname = osFunction.hostname() || (isConsumerMode ? UNKNOWN : false);
-  
+
   if (!isIPAddressesEnabled) { // If IPAddresses setting is not enabled, set as false (for standalone) or "NA" (for consumer mode, to  be used on Redis keys)
     ip = hostname = isConsumerMode ? NA : false;
   }
-  
+
   return {
     ip, hostname
   };
-}
+}