@splitsoftware/splitio 10.17.3 → 10.17.4-rc.2

package/es/platform/EventEmitter.js

@@ -0,0 +1,386 @@
+// 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/es/platform/browser.js

@@ -0,0 +1,10 @@
+import { EventEmitter } from './EventEmitter';
+import { getFetch } from '../platform/getFetch/browser';
+import { getEventSource } from '../platform/getEventSource/browser';
+import { BrowserSignalListener } from '@splitsoftware/splitio-commons/esm/listeners/browser';
+export var platform = {
+    getFetch: getFetch,
+    getEventSource: getEventSource,
+    EventEmitter: EventEmitter
+};
+export var SignalListener = BrowserSignalListener;

package/es/platform/getEventSource/browser.js

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

package/es/platform/getEventSource/node.js

@@ -0,0 +1,19 @@
+var __isCustom = false;
+var __eventSource = undefined;
+// This function is only exposed for testing purposes.
+export function __setEventSource(eventSource) {
+    __eventSource = eventSource;
+    __isCustom = true;
+}
+export function __restore() {
+    __isCustom = false;
+}
+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/es/platform/getFetch/browser.js

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

package/es/platform/getFetch/node.js

@@ -0,0 +1,18 @@
+var nodeFetch;
+try {
+    nodeFetch = require('node-fetch');
+    // Handle node-fetch issue https://github.com/node-fetch/node-fetch/issues/1037
+    if (typeof nodeFetch !== 'function')
+        nodeFetch = nodeFetch.default;
+}
+catch (error) {
+    // Try to access global fetch if `node-fetch` package couldn't be imported (e.g., not in a Node environment)
+    nodeFetch = typeof fetch === 'function' ? fetch : undefined;
+}
+// This function is only exposed for testing purposes.
+export function __setFetch(fetch) {
+    nodeFetch = fetch;
+}
+export function getFetch() {
+    return nodeFetch;
+}

package/es/platform/node.js

@@ -0,0 +1,12 @@
+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/esm/listeners/node';
+export var platform = {
+    getOptions: getOptions,
+    getFetch: getFetch,
+    getEventSource: getEventSource,
+    EventEmitter: EventEmitter
+};
+export var SignalListener = NodeSignalListener;

package/es/platform/request/options/node.js

@@ -0,0 +1,13 @@
+// @TODO
+// 1- handle multiple protocols automatically
+// 2- destroy it once the sdk is destroyed
+import https from 'https';
+var agent = new https.Agent({
+    keepAlive: true,
+    keepAliveMsecs: 1500
+});
+export function getOptions() {
+    return {
+        agent: agent
+    };
+}

package/es/settings/browser.js

@@ -0,0 +1,21 @@
+import { settingsValidation } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation';
+import { defaults } from './defaults/browser';
+import { validateRuntime } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/runtime';
+import { validateStorage } from './storage/browser';
+import { validateIntegrations } from './integrations/browser';
+import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/builtinLogger';
+import { LocalhostFromObject } from '@splitsoftware/splitio-commons/esm/sync/offline/LocalhostFromObject';
+import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
+var params = {
+    defaults: defaults,
+    isClientSide: true,
+    runtime: validateRuntime,
+    storage: validateStorage,
+    integrations: validateIntegrations,
+    logger: validateLogger,
+    localhost: function () { return LocalhostFromObject(); },
+    consent: validateConsent,
+};
+export function settingsFactory(config) {
+    return settingsValidation(config, params);
+}

package/es/settings/defaults/browser.js

@@ -0,0 +1,18 @@
+import { packageVersion } from './version';
+import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/esm/utils/constants';
+export var defaults = {
+    startup: {
+        // Stress the request time used while starting up the SDK.
+        requestTimeoutBeforeReady: 5,
+        // How many quick retries we will do while starting up the SDK.
+        retriesOnFailureBeforeReady: 1,
+        // Maximum amount of time used before notifies me a timeout.
+        readyTimeout: 10,
+        // Amount of time we will wait before the first push of events.
+        eventsFirstPushWindow: 10
+    },
+    // Consent is considered granted by default
+    userConsent: CONSENT_GRANTED,
+    // Instance version.
+    version: "javascript-" + packageVersion,
+};

package/es/settings/defaults/node.js

@@ -0,0 +1,24 @@
+import { packageVersion } from './version';
+export var defaults = {
+    core: {
+        // Default is true.
+        IPAddressesEnabled: true
+    },
+    startup: {
+        // Stress the request time used while starting up the SDK.
+        requestTimeoutBeforeReady: 15,
+        // How many quick retries we will do while starting up the SDK.
+        retriesOnFailureBeforeReady: 1,
+        // Maximum amount of time used before notifies me a timeout.
+        readyTimeout: 15,
+        // Don't wait a specific time for first flush on Node, no page load here.
+        eventsFirstPushWindow: 0
+    },
+    scheduler: {
+        featuresRefreshRate: 5,
+        impressionsRefreshRate: 300
+    },
+    features: '.split',
+    // Instance version.
+    version: "nodejs-" + packageVersion,
+};

package/es/settings/defaults/version.js

@@ -0,0 +1 @@
+export var packageVersion = '10.17.4-rc.2';

package/es/settings/integrations/browser.js

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

package/es/settings/node.js

@@ -0,0 +1,18 @@
+import { settingsValidation } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation';
+import { defaults } from './defaults/node';
+import { validateRuntime } from './runtime/node';
+import { validateStorage } from './storage/node';
+import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/builtinLogger';
+import { LocalhostFromFile } from '@splitsoftware/splitio-commons/esm/sync/offline/LocalhostFromFile';
+var params = {
+    defaults: defaults,
+    runtime: validateRuntime,
+    storage: validateStorage,
+    logger: validateLogger,
+    localhost: function () { return LocalhostFromFile(); },
+    consent: function () { return undefined; }, // resets settings.userConsent to the default
+    // In Node.js the SDK ignores `config.integrations`, so a validator for integrations is not required
+};
+export function settingsFactory(config) {
+    return settingsValidation(config, params);
+}

package/es/settings/runtime/node.js

@@ -0,0 +1,17 @@
+import osFunction from 'os';
+import ipFunction from 'ip';
+import { UNKNOWN, NA, CONSUMER_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
+export function validateRuntime(settings) {
+    var isIPAddressesEnabled = settings.core.IPAddressesEnabled === true;
+    var isConsumerMode = settings.mode === CONSUMER_MODE;
+    // If the values are not available, default to false (for standalone) or "unknown" (for consumer mode, to be used on Redis keys)
+    var ip = ipFunction.address() || (isConsumerMode ? UNKNOWN : false);
+    var 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: ip,
+        hostname: hostname
+    };
+}

package/es/settings/storage/browser.js

@@ -0,0 +1,29 @@
+import { isLocalStorageAvailable } from '@splitsoftware/splitio-commons/esm/utils/env/isLocalStorageAvailable';
+import { LOCALHOST_MODE, STORAGE_MEMORY } from '@splitsoftware/splitio-commons/esm/utils/constants';
+var STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
+export function validateStorage(settings) {
+    var log = settings.log, mode = settings.mode, _a = settings.storage, _b = _a === void 0 ? { type: STORAGE_MEMORY } : _a, type = _b.type, _c = _b.options, options = _c === void 0 ? {} : _c, prefix = _b.prefix;
+    var __originalType;
+    var fallbackToMemory = function () {
+        __originalType = type;
+        type = STORAGE_MEMORY;
+    };
+    // In localhost mode, fallback to Memory storage and track original type to emit SDK_READY_FROM_CACHE if corresponds.
+    // ATM, other mode settings (e.g., 'consumer') are ignored in client-side API, and so treated as standalone.
+    if (mode === LOCALHOST_MODE && type === STORAGE_LOCALSTORAGE) {
+        fallbackToMemory();
+    }
+    // If an invalid storage type is provided OR we want to use LOCALSTORAGE and
+    // it's not available, fallback into MEMORY
+    if (type !== STORAGE_MEMORY && type !== STORAGE_LOCALSTORAGE ||
+        type === STORAGE_LOCALSTORAGE && !isLocalStorageAvailable()) {
+        fallbackToMemory();
+        log.error('Invalid or unavailable storage. Fallbacking into MEMORY storage');
+    }
+    return {
+        type: type,
+        options: options,
+        prefix: prefix,
+        __originalType: __originalType
+    };
+}