@splitsoftware/splitio-commons 2.4.2-rc.3 → 11.5.0-rc.0

package/src/factory/node.js

@@ -0,0 +1,92 @@
+import { splitApiFactory } from '@splitsoftware/splitio-commons/src/services/splitApi';
+import { syncManagerOnlineFactory } from '@splitsoftware/splitio-commons/src/sync/syncManagerOnline';
+import { pushManagerFactory } from '@splitsoftware/splitio-commons/src/sync/streaming/pushManager';
+import { pollingManagerSSFactory } from '@splitsoftware/splitio-commons/src/sync/polling/pollingManagerSS';
+import { InRedisStorage } from '@splitsoftware/splitio-commons/src/storages/inRedis';
+import { InMemoryStorageFactory } from '@splitsoftware/splitio-commons/src/storages/inMemory/InMemoryStorage';
+import { getCache } from '@splitsoftware/splitio-commons/src/storages/dataLoader';
+import { sdkManagerFactory } from '@splitsoftware/splitio-commons/src/sdkManager';
+import { sdkClientMethodFactory } from '@splitsoftware/splitio-commons/src/sdkClient/sdkClientMethod';
+import { impressionObserverSSFactory } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/impressionObserverSS';
+import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory';
+import { CONSUMER_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
+
+import { localhostFromFileFactory } from '../sync/offline/LocalhostFromFile';
+import { settingsFactory } from '../settings/node';
+import { platform, SignalListener } from '../platform';
+import { bloomFilterFactory } from '../platform/filter/bloomFilter';
+
+const syncManagerOnlineSSFactory = syncManagerOnlineFactory(pollingManagerSSFactory, pushManagerFactory);
+
+function getStorage(settings) {
+  return settings.storage.type === 'REDIS' ?
+    InRedisStorage(settings.storage) :
+    InMemoryStorageFactory;
+}
+
+/**
+ *
+ * @param {import("@splitsoftware/splitio-commons/types/types").ISettings} settings
+ */
+function getModules(settings) {
+
+  const modules = {
+    settings,
+
+    platform,
+
+    storageFactory: getStorage(settings),
+
+    splitApiFactory,
+
+    syncManagerFactory: syncManagerOnlineSSFactory,
+
+    sdkManagerFactory,
+
+    sdkClientMethodFactory,
+
+    SignalListener,
+
+    impressionsObserverFactory: impressionObserverSSFactory,
+
+    filterAdapterFactory: bloomFilterFactory,
+
+    extraProps: (params) => {
+      if (params.settings.mode !== CONSUMER_MODE) {
+        return {
+          getCache(userKeys) {
+            return getCache(params.settings.log, params.storage, userKeys);
+          }
+        };
+      }
+    }
+  };
+
+  switch (settings.mode) {
+    case LOCALHOST_MODE:
+      modules.splitApiFactory = undefined;
+      modules.syncManagerFactory = localhostFromFileFactory;
+      modules.SignalListener = undefined;
+      break;
+    case CONSUMER_MODE:
+      modules.syncManagerFactory = undefined;
+      break;
+  }
+
+  return modules;
+}
+
+/**
+ * SplitFactory for server-side.
+ *
+ * @param {SplitIO.INodeSettings | SplitIO.INodeAsyncSettings} config configuration object used to instantiate the SDK
+ * @param {Function=} __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
+ * @throws Will throw an error if the provided config is invalid.
+ */
+export function SplitFactory(config, __updateModules) {
+  const settings = settingsFactory(config);
+  const modules = getModules(settings);
+  if (__updateModules) __updateModules(modules);
+  return sdkFactory(modules);
+}

package/src/factory/package.json

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

package/src/index.js

@@ -0,0 +1 @@
+export { SplitFactory } from './factory';

package/src/{utils/MinEvents.ts → platform/EventEmitter.js}

@@ -1,14 +1,3 @@
-// @ts-nocheck
-// Trimmed version of "events" library (https://www.npmjs.com/package/events).
-// Removed features:
-// - Max listener leak warning
-// - EventEmitter.prototype.prependListener
-// - EventEmitter.prototype.prependOnceListener
-// - EventEmitter.prototype.listeners
-// - EventEmitter.prototype.rawListeners
-// - EventEmitter.prototype.listenerCount
-// - EventEmitter.prototype.eventNames
-//
 // Copyright Joyent, Inc. and other Node contributors.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a
@@ -30,7 +19,9 @@
 // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-import SplitIO from '../../types/splitio';
+// 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'
@@ -39,12 +30,40 @@ var ReflectApply = R && typeof R.apply === 'function'
     return Function.prototype.apply.call(target, receiver, args);
   };
 
-export const EventEmitter: { new(): SplitIO.IEventEmitter } = function EventEmitter() {
-  EventEmitter.init.call(this);
+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);
+}
+
+// eslint-disable-next-line compat/compat
+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') {
@@ -52,6 +71,19 @@ function checkListener(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 ||
@@ -59,6 +91,28 @@ EventEmitter.init = function () {
     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) {
@@ -79,7 +133,7 @@ EventEmitter.prototype.emit = function emit(type) {
       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.
+      // up in Node.js output if this results in an unhandled exception.
       throw er; // Unhandled 'error' event
     }
     // At least give some kind of context to the user
@@ -97,8 +151,8 @@ EventEmitter.prototype.emit = function emit(type) {
     ReflectApply(handler, this, args);
   } else {
     var len = handler.length;
-    var listeners = arrayClone(handler, len);
-    for (let i = 0; i < len; ++i)
+    var listeners = arrayClone(handler, len); // eslint-disable-next-line no-redeclare
+    for (var i = 0; i < len; ++i)
       ReflectApply(listeners[i], this, args);
   }
 
@@ -106,6 +160,7 @@ EventEmitter.prototype.emit = function emit(type) {
 };
 
 function _addListener(target, type, listener, prepend) {
+  var m;
   var events;
   var existing;
 
@@ -119,8 +174,7 @@ function _addListener(target, type, listener, prepend) {
     // 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);
+      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
@@ -144,6 +198,23 @@ function _addListener(target, type, listener, prepend) {
     } 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;
@@ -155,6 +226,11 @@ EventEmitter.prototype.addListener = function addListener(type, listener) {
 
 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);
@@ -179,6 +255,13 @@ EventEmitter.prototype.once = function once(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) {
@@ -285,6 +368,60 @@ EventEmitter.prototype.removeAllListeners =
     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)
@@ -297,3 +434,11 @@ function spliceOne(list, 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,14 @@
+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';
+import { now } from '@splitsoftware/splitio-commons/src/utils/timeTracker/now/browser';
+
+export const platform = {
+  getFetch,
+  getEventSource,
+  EventEmitter,
+  now
+};
+
+export const SignalListener = BrowserSignalListener;

package/src/platform/filter/bloomFilter.js

@@ -0,0 +1,33 @@
+import { BloomFilter } from 'bloom-filters';
+
+const EXPECTED_INSERTIONS = 10000000;
+const ERROR_RATE = 0.01;
+const REFRESH_RATE = 24 * 60 * 60000; // 24HS
+
+export function bloomFilterFactory(expectedInsertions = EXPECTED_INSERTIONS, errorRate = ERROR_RATE, refreshRate = REFRESH_RATE) {
+  let filter = BloomFilter.create(expectedInsertions, errorRate);
+
+  return {
+
+    refreshRate: refreshRate,
+
+    add(key, value) {
+      const data = `${key}:${value}`;
+      if (filter.has(data)) {
+        return false;
+      }
+      filter.add(data);
+      return true;
+    },
+
+    contains(key, value) {
+      const data = `${key}:${value}`;
+      return filter.has(data);
+    },
+
+    clear() {
+      filter = BloomFilter.create(expectedInsertions, errorRate);
+    }
+
+  };
+}

package/src/platform/getEventSource/browser.js

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