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

package/lib/settings/defaults/browser.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaults = void 0;
-var version_1 = require("./version");
-exports.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
-    },
-    // Instance version.
-    version: "javascript-" + version_1.packageVersion,
-};

package/lib/settings/defaults/node.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaults = void 0;
-var version_1 = require("./version");
-exports.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-" + version_1.packageVersion,
-};

package/lib/settings/defaults/version.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.packageVersion = void 0;
-exports.packageVersion = '10.17.3-rc.3';

package/lib/settings/integrations/browser.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateIntegrations = void 0;
-var browser_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants/browser");
-var configurable_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/integrations/configurable");
-function validateIntegrations(settings) {
-    return (0, configurable_1.validateConfigurableIntegrations)(settings, [browser_1.GOOGLE_ANALYTICS_TO_SPLIT, browser_1.SPLIT_TO_GOOGLE_ANALYTICS]);
-}
-exports.validateIntegrations = validateIntegrations;

package/lib/settings/node.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.settingsFactory = void 0;
-var settingsValidation_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation");
-var node_1 = require("./defaults/node");
-var node_2 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/runtime/node");
-var node_3 = require("./storage/node");
-var builtinLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/builtinLogger");
-var LocalhostFromFile_1 = require("@splitsoftware/splitio-commons/cjs/sync/offline/LocalhostFromFile");
-var params = {
-    defaults: node_1.defaults,
-    runtime: node_2.validateRuntime,
-    storage: node_3.validateStorage,
-    logger: builtinLogger_1.validateLogger,
-    localhost: function () { return (0, LocalhostFromFile_1.LocalhostFromFile)(); },
-    // For now, Node SDK ignores settings.integrations, so no integration validator is passed
-};
-function settingsFactory(config) {
-    return (0, settingsValidation_1.settingsValidation)(config, params);
-}
-exports.settingsFactory = settingsFactory;

package/lib/settings/storage/browser.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateStorage = void 0;
-var isLocalStorageAvailable_1 = require("@splitsoftware/splitio-commons/cjs/utils/env/isLocalStorageAvailable");
-var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
-var STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
-function validateStorage(settings) {
-    var log = settings.log, mode = settings.mode, _a = settings.storage, _b = _a === void 0 ? { type: constants_1.STORAGE_MEMORY } : _a, type = _b.type, _c = _b.options, options = _c === void 0 ? {} : _c, prefix = _b.prefix;
-    var __originalType;
-    if (prefix) {
-        prefix += '.SPLITIO';
-    }
-    else {
-        prefix = 'SPLITIO';
-    }
-    var fallbackToMemory = function () {
-        __originalType = type;
-        type = constants_1.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 === constants_1.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 !== constants_1.STORAGE_MEMORY && type !== STORAGE_LOCALSTORAGE ||
-        type === STORAGE_LOCALSTORAGE && !(0, isLocalStorageAvailable_1.isLocalStorageAvailable)()) {
-        fallbackToMemory();
-        log.error('Invalid or unavailable storage. Fallbacking into MEMORY storage');
-    }
-    return {
-        type: type,
-        options: options,
-        prefix: prefix,
-        __originalType: __originalType
-    };
-}
-exports.validateStorage = validateStorage;

package/lib/settings/storage/node.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateStorage = void 0;
-var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
-function validateStorage(settings) {
-    var log = settings.log, mode = settings.mode, _a = settings.storage, _b = _a === void 0 ? { type: constants_1.STORAGE_MEMORY } : _a, type = _b.type, _c = _b.options, options = _c === void 0 ? {} : _c, prefix = _b.prefix;
-    if (prefix) {
-        prefix += '.SPLITIO';
-    }
-    else {
-        prefix = 'SPLITIO';
-    }
-    // We can have MEMORY, REDIS or an invalid storage type
-    switch (type) {
-        case constants_1.STORAGE_REDIS: {
-            // If passing REDIS storage in localhost or standalone mode, we log an error and fallback to MEMORY storage
-            if (mode === constants_1.STANDALONE_MODE || mode === constants_1.LOCALHOST_MODE) {
-                log.error('The provided REDIS storage is invalid for this mode. It requires consumer mode. Fallbacking into default MEMORY storage.');
-                return {
-                    type: constants_1.STORAGE_MEMORY,
-                    prefix: prefix
-                };
-            }
-            var host = options.host, port = options.port, db = options.db, pass = options.pass, url = options.url, connectionTimeout = options.connectionTimeout, operationTimeout = options.operationTimeout;
-            if (process.env.REDIS_HOST)
-                host = process.env.REDIS_HOST;
-            if (process.env.REDIS_PORT)
-                port = process.env.REDIS_PORT;
-            if (process.env.REDIS_DB)
-                db = process.env.REDIS_DB;
-            if (process.env.REDIS_PASS)
-                pass = process.env.REDIS_PASS;
-            if (process.env.REDIS_URL)
-                url = process.env.REDIS_URL;
-            var newOpts = {
-                connectionTimeout: connectionTimeout,
-                operationTimeout: operationTimeout
-            };
-            if (url) {
-                newOpts.url = url;
-            }
-            else {
-                newOpts.host = host;
-                newOpts.port = port;
-                newOpts.db = db;
-                newOpts.pass = pass;
-            }
-            return {
-                type: type,
-                prefix: prefix,
-                options: newOpts
-            };
-        }
-        // For now, we don't have modifiers or settings for MEMORY in NodeJS
-        case constants_1.STORAGE_MEMORY:
-        default: {
-            // If passing MEMORY storage in consumer mode, throw an error (no way to fallback to REDIS storage)
-            if (mode === constants_1.CONSUMER_MODE)
-                throw new Error('A REDIS storage is required on consumer mode');
-            // If passing an invalid storage type, log an error
-            if (type !== constants_1.STORAGE_MEMORY)
-                log.error("The provided '" + type + "' storage type is invalid. Fallbacking into default MEMORY storage.");
-            return {
-                type: constants_1.STORAGE_MEMORY,
-                prefix: prefix
-            };
-        }
-    }
-}
-exports.validateStorage = validateStorage;

package/server/package.json

@@ -1,5 +0,0 @@
-{
-  "main": "../lib/factory/node.js",
-  "module": "../es/factory/node.js",
-  "types": "../types/server/index.d.ts"
-}

package/src/factory/browser.js

@@ -1,83 +0,0 @@
-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 { pollingManagerCSFactory } from '@splitsoftware/splitio-commons/src/sync/polling/pollingManagerCS';
-import { InLocalStorage } from '@splitsoftware/splitio-commons/src/storages/inLocalStorage';
-import { InMemoryStorageCSFactory } from '@splitsoftware/splitio-commons/src/storages/inMemory/InMemoryStorageCS';
-import { sdkManagerFactory } from '@splitsoftware/splitio-commons/src/sdkManager';
-import { sdkClientMethodCSFactory } from '@splitsoftware/splitio-commons/src/sdkClient/sdkClientMethodCSWithTT';
-import { impressionObserverCSFactory } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/impressionObserverCS';
-import { integrationsManagerFactory } from '@splitsoftware/splitio-commons/src/integrations/browser';
-import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/storage/storageCS';
-import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory';
-import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/src/utils/constants';
-import { shouldAddPt } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/utils';
-
-import { settingsFactory } from '../settings/browser';
-import { platform, SignalListener } from '../platform';
-
-const syncManagerOnlineCSFactory = syncManagerOnlineFactory(pollingManagerCSFactory, pushManagerFactory);
-
-function getStorage(settings) {
-  return settings.storage.type === STORAGE_LOCALSTORAGE ?
-    InLocalStorage(settings.storage)
-    : settings.storage.__originalType === STORAGE_LOCALSTORAGE ?
-      __InLocalStorageMockFactory
-      : InMemoryStorageCSFactory;
-}
-
-/**
- *
- * @param {import("@splitsoftware/splitio-commons/types/types").ISettings} settings
- */
-function getModules(settings) {
-
-  const modules = {
-    settings,
-
-    platform,
-
-    storageFactory: getStorage(settings),
-
-    splitApiFactory,
-
-    syncManagerFactory: syncManagerOnlineCSFactory,
-
-    sdkManagerFactory,
-
-    sdkClientMethodFactory: sdkClientMethodCSFactory,
-
-    SignalListener,
-
-    impressionListener: settings.impressionListener,
-
-    integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? integrationsManagerFactory.bind(null, settings.integrations) : undefined,
-
-    impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
-  };
-
-  switch (settings.mode) {
-    case LOCALHOST_MODE:
-      modules.splitApiFactory = undefined;
-      modules.syncManagerFactory = settings.sync.localhostMode;
-      modules.SignalListener = undefined;
-      break;
-  }
-
-  return modules;
-}
-
-/**
- * SplitFactory for client-side.
- *
- * @param {SplitIO.IBrowserSettings} 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/node.js

@@ -1,80 +0,0 @@
-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 { 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 { shouldAddPt } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/utils';
-
-import { settingsFactory } from '../settings/node';
-import { platform, SignalListener } from '../platform';
-
-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,
-
-    impressionListener: settings.impressionListener,
-
-    impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverSSFactory : undefined,
-  };
-
-  switch (settings.mode) {
-    case LOCALHOST_MODE:
-      modules.splitApiFactory = undefined;
-      modules.syncManagerFactory = settings.sync.localhostMode;
-      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);
-}