@splitsoftware/splitio 10.17.3 → 10.17.4-rc.2

package/CHANGES.txt

@@ -1,3 +1,15 @@
+10.18.0 (March XXX, 2022)
+ - Updated internal dependencies to use @splitsoftware/splitio-commons dependency, which includes:
+      - Added support for user consent in client-side
+      - Added impressionsQueueSize config parameter
+      - Update SplitToGa integration ...
+      - Update modules to simplify the usage with bundling tools ...
+      - Updated dependencies for vulnerability fixes
+      - Bugfixing - Logger settings is configurable per factory instance instead of globally.
+      - Bugfixing - Wrongly logging warning 'No listeners for SDK Readiness detected' in consumer mode.
+  - Added TLS support for Redis
+  -
+
 10.17.3 (February 25, 2022)
  - Updated format for MySegments keys in LocalStorage, keeping backwards compatibility (issue https://github.com/splitio/javascript-client/issues/638).
  - Updated some dependencies for vulnerability fixes.

package/es/factory/browser.js

@@ -0,0 +1,67 @@
+import { splitApiFactory } from '@splitsoftware/splitio-commons/esm/services/splitApi';
+import { syncManagerOnlineFactory } from '@splitsoftware/splitio-commons/esm/sync/syncManagerOnline';
+import { pushManagerFactory } from '@splitsoftware/splitio-commons/esm/sync/streaming/pushManager';
+import { pollingManagerCSFactory } from '@splitsoftware/splitio-commons/esm/sync/polling/pollingManagerCS';
+import { InLocalStorage } from '@splitsoftware/splitio-commons/esm/storages/inLocalStorage';
+import { InMemoryStorageCSFactory } from '@splitsoftware/splitio-commons/esm/storages/inMemory/InMemoryStorageCS';
+import { sdkManagerFactory } from '@splitsoftware/splitio-commons/esm/sdkManager';
+import { sdkClientMethodCSFactory } from '@splitsoftware/splitio-commons/esm/sdkClient/sdkClientMethodCSWithTT';
+import { impressionObserverCSFactory } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/impressionObserverCS';
+import { integrationsManagerFactory } from '@splitsoftware/splitio-commons/esm/integrations/browser';
+import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/storage/storageCS';
+import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory';
+import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/esm/utils/constants';
+import { shouldAddPt } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/utils';
+import { userConsentProps } from '@splitsoftware/splitio-commons/esm/sdkFactory/userConsentProps';
+import { settingsFactory } from '../settings/browser';
+import { platform, SignalListener } from '../platform';
+var 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) {
+    var modules = {
+        settings: settings,
+        platform: platform,
+        storageFactory: getStorage(settings),
+        splitApiFactory: splitApiFactory,
+        syncManagerFactory: syncManagerOnlineCSFactory,
+        sdkManagerFactory: sdkManagerFactory,
+        sdkClientMethodFactory: sdkClientMethodCSFactory,
+        SignalListener: SignalListener,
+        integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? integrationsManagerFactory.bind(null, settings.integrations) : undefined,
+        impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
+        extraProps: userConsentProps
+    };
+    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) {
+    var settings = settingsFactory(config);
+    var modules = getModules(settings);
+    if (__updateModules)
+        __updateModules(modules);
+    return sdkFactory(modules);
+}

package/es/factory/node.js

@@ -0,0 +1,63 @@
+import { splitApiFactory } from '@splitsoftware/splitio-commons/esm/services/splitApi';
+import { syncManagerOnlineFactory } from '@splitsoftware/splitio-commons/esm/sync/syncManagerOnline';
+import { pushManagerFactory } from '@splitsoftware/splitio-commons/esm/sync/streaming/pushManager';
+import { pollingManagerSSFactory } from '@splitsoftware/splitio-commons/esm/sync/polling/pollingManagerSS';
+import { InRedisStorage } from '@splitsoftware/splitio-commons/esm/storages/inRedis';
+import { InMemoryStorageFactory } from '@splitsoftware/splitio-commons/esm/storages/inMemory/InMemoryStorage';
+import { sdkManagerFactory } from '@splitsoftware/splitio-commons/esm/sdkManager';
+import { sdkClientMethodFactory } from '@splitsoftware/splitio-commons/esm/sdkClient/sdkClientMethod';
+import { impressionObserverSSFactory } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/impressionObserverSS';
+import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory';
+import { CONSUMER_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
+import { shouldAddPt } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/utils';
+import { settingsFactory } from '../settings/node';
+import { platform, SignalListener } from '../platform';
+var 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) {
+    var modules = {
+        settings: settings,
+        platform: platform,
+        storageFactory: getStorage(settings),
+        splitApiFactory: splitApiFactory,
+        syncManagerFactory: syncManagerOnlineSSFactory,
+        sdkManagerFactory: sdkManagerFactory,
+        sdkClientMethodFactory: sdkClientMethodFactory,
+        SignalListener: SignalListener,
+        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) {
+    var settings = settingsFactory(config);
+    var modules = getModules(settings);
+    if (__updateModules)
+        __updateModules(modules);
+    return sdkFactory(modules);
+}

package/es/index.js

@@ -1,132 +1,16 @@
-import ManagerFactory from './manager';
-import StorageFactory from './storage';
-import ReadinessGateFacade from './readiness';
-import SettingsFactory from './utils/settings';
-import Context from './utils/context';
-import keyParser from './utils/key/parser';
-import logFactory, { API } from './utils/logger';
-var log = logFactory('splitio');
-import tracker from './utils/timeTracker';
-import SplitFactoryOnline from './factory/online';
-import SplitFactoryOffline from './factory/offline';
-import sdkStatusManager from './readiness/statusManager';
-import { LOCALHOST_MODE } from './utils/constants';
-import { validateApiKey, validateKey, validateTrafficType } from './utils/inputValidation';
-import IntegrationsManagerFactory from './integrations';
-import ImpressionCounter from './impressions/counter';
-
-var buildInstanceId = function buildInstanceId(key, trafficType) {
-  return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType !== undefined ? trafficType : '');
-};
-
-export function SplitFactory(config) {
-  // Cache instances created per factory.
-  var clientInstances = {}; // Tracking times. We need to do it here because we need the storage created.
-
-  var readyLatencyTrackers = {
-    splitsReadyTracker: tracker.start(tracker.TaskNames.SPLITS_READY),
-    segmentsReadyTracker: tracker.start(tracker.TaskNames.SEGMENTS_READY),
-    sdkReadyTracker: tracker.start(tracker.TaskNames.SDK_READY)
-  };
-  var context = new Context(); // Put settings config within context
-
-  var settings = SettingsFactory(config);
-  context.put(context.constants.SETTINGS, settings); // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
-
-  validateApiKey(settings.core.authorizationKey); // Put readiness and statusManager within context
-  // Done before adding storage, to let it access readiness gate synchronously
-
-  var gateFactory = ReadinessGateFacade();
-  var readiness = gateFactory(settings.startup.readyTimeout);
-  context.put(context.constants.READINESS, readiness);
-  var statusManager = sdkStatusManager(context);
-  context.put(context.constants.STATUS_MANAGER, statusManager); // Put storage config within context
-
-  var storage = StorageFactory(context);
-  context.put(context.constants.STORAGE, storage); // Put counter
-
-  var impressionsCounter = new ImpressionCounter(); // Instantiates new counter for Impressions
-
-  context.put(context.constants.IMPRESSIONS_COUNTER, impressionsCounter); // Put integrationsManager within context.
-  // It needs to access the storage, settings and potentially other pieces, so it's registered after them.
-
-  var integrationsManager = IntegrationsManagerFactory(context);
-  context.put(context.constants.INTEGRATIONS_MANAGER, integrationsManager); // Define which type of factory to use
-
-  var splitFactory = settings.mode === LOCALHOST_MODE ? SplitFactoryOffline : SplitFactoryOnline;
-
-  var _splitFactory = splitFactory(context, readyLatencyTrackers),
-      mainClientInstance = _splitFactory.api,
-      mainClientMetricCollectors = _splitFactory.metricCollectors; // It makes no sense to have multiple instances of the manager.
-
-
-  var managerInstance = ManagerFactory(storage.splits, context);
-  var parsedDefaultKey = keyParser(settings.core.key);
-  var defaultInstanceId = buildInstanceId(parsedDefaultKey, settings.core.trafficType);
-  clientInstances[defaultInstanceId] = mainClientInstance;
-  log.info('New Split SDK instance created.');
-  return {
-    // Split evaluation and event tracking engine
-    client: function client(key, trafficType) {
-      if (key === undefined) {
-        log.debug('Retrieving default SDK client.');
-        return mainClientInstance;
-      }
-
-      if (typeof storage.shared != 'function') {
-        throw new Error('Shared Client not supported by the storage mechanism. Create isolated instances instead.');
-      } // Validate the key value
-
-
-      var validKey = validateKey(key, 'Shared Client instantiation');
-
-      if (validKey === false) {
-        throw new Error('Shared Client needs a valid key.');
-      }
-
-      var validTrafficType;
-
-      if (trafficType !== undefined) {
-        validTrafficType = validateTrafficType(trafficType, 'Shared Client instantiation');
-
-        if (validTrafficType === false) {
-          throw new Error('Shared Client needs a valid traffic type or no traffic type at all.');
-        }
-      }
-
-      var instanceId = buildInstanceId(validKey, validTrafficType);
-
-      if (!clientInstances[instanceId]) {
-        var sharedSettings = settings.overrideKeyAndTT(validKey, validTrafficType);
-        var sharedContext = new Context();
-
-        var _readiness = gateFactory(sharedSettings.startup.readyTimeout);
-
-        sharedContext.put(context.constants.READY_FROM_CACHE, context.get(context.constants.READY_FROM_CACHE, true));
-        sharedContext.put(context.constants.READINESS, _readiness); // for shared clients, the internal offset of added/removed SDK_READY callbacks is -1
-
-        sharedContext.put(context.constants.STATUS_MANAGER, sdkStatusManager(sharedContext, -1));
-        sharedContext.put(context.constants.SETTINGS, sharedSettings);
-        sharedContext.put(context.constants.STORAGE, storage.shared(sharedSettings));
-        sharedContext.put(context.constants.IMPRESSIONS_COUNTER, impressionsCounter); // As shared clients reuse all the storage information, we don't need to check here if we
-        // will use offline or online mode. We should stick with the original decision.
-
-        clientInstances[instanceId] = splitFactory(sharedContext, false, mainClientMetricCollectors).api;
-        log.info('New shared client instance created.');
-      } else {
-        log.debug('Retrieving existing SDK client.');
-      }
-
-      return clientInstances[instanceId];
-    },
-    // Manager API to explore available information
-    manager: function manager() {
-      log.info('Manager instance retrieved.');
-      return managerInstance;
-    },
-    // Logger wrapper API
-    Logger: API,
-    // Expose SDK settings
-    settings: settings
-  };
-}
+/**
+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.
+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.
+**/
+export { SplitFactory } from './factory';