@splitsoftware/splitio-commons 0.1.1-rc.20 → 1.0.1-rc.2

package/cjs/utils/settingsValidation/storage/storageCS.js

@@ -16,19 +16,33 @@ __InLocalStorageMockFactory.type = constants_2.STORAGE_MEMORY;
  *
  * @param {any} settings config object provided by the user to initialize the sdk
  *
- * @returns {Object} valid storage factory. It might be the default `InMemoryStorageCSFactory` if the provided storage is invalid.
+ * @returns {Object} valid storage factory. Default to `InMemoryStorageCSFactory` if the provided storage is invalid or not compatible with the sdk mode if mode is standalone or localhost
+ *
+ * @throws error if mode is consumer and the provided storage is not compatible
  */
 function validateStorageCS(settings) {
     var _a = settings.storage, storage = _a === void 0 ? InMemoryStorageCS_1.InMemoryStorageCSFactory : _a, log = settings.log, mode = settings.mode;
     // If an invalid storage is provided, fallback into MEMORY
-    if (typeof storage !== 'function' || storage.type !== constants_2.STORAGE_MEMORY && storage.type !== constants_2.STORAGE_LOCALSTORAGE) {
+    if (typeof storage !== 'function' || [constants_2.STORAGE_MEMORY, constants_2.STORAGE_LOCALSTORAGE, constants_2.STORAGE_PLUGGABLE].indexOf(storage.type) === -1) {
         storage = InMemoryStorageCS_1.InMemoryStorageCSFactory;
-        log.warn(constants_1.WARN_STORAGE_INVALID);
+        log.error(constants_1.ERROR_STORAGE_INVALID);
     }
     // In localhost mode with InLocalStorage, fallback to a mock InLocalStorage to emit SDK_READY_FROM_CACHE
     if (mode === constants_2.LOCALHOST_MODE && storage.type === constants_2.STORAGE_LOCALSTORAGE) {
         return __InLocalStorageMockFactory;
     }
+    if ([constants_2.LOCALHOST_MODE, constants_2.STANDALONE_MODE].indexOf(mode) === -1) {
+        // Consumer modes require an async storage
+        if (storage.type !== constants_2.STORAGE_PLUGGABLE)
+            throw new Error('A PluggableStorage instance is required on consumer mode');
+    }
+    else {
+        // Standalone and localhost modes require a sync storage
+        if (storage.type === constants_2.STORAGE_PLUGGABLE) {
+            storage = InMemoryStorageCS_1.InMemoryStorageCSFactory;
+            log.error(constants_1.ERROR_STORAGE_INVALID, [' It requires consumer mode.']);
+        }
+    }
     // return default InMemory storage if provided one is not valid
     return storage;
 }

package/esm/listeners/browser.js

@@ -46,6 +46,8 @@ var BrowserSignalListener = /** @class */ (function () {
      * using beacon API if possible, or falling back to regular post transport.
      */
     BrowserSignalListener.prototype.flushData = function () {
+        if (!this.syncManager)
+            return; // In consumer mode there is not sync manager and data to flush
         var eventsUrl = this.settings.urls.events;
         var extraMetadata = {
             // sim stands for Sync/Split Impressions Mode
@@ -56,7 +58,7 @@ var BrowserSignalListener = /** @class */ (function () {
         if (this.storage.impressionCounts)
             this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, fromImpressionCountsCollector);
         // Close streaming connection
-        if (this.syncManager && this.syncManager.pushManager)
+        if (this.syncManager.pushManager)
             this.syncManager.pushManager.stop();
     };
     BrowserSignalListener.prototype._flushData = function (url, cache, postService, fromCacheToPayload, extraMetadata) {

package/esm/logger/constants.js

@@ -89,9 +89,8 @@ export var WARN_INTEGRATION_INVALID = 218;
 export var WARN_SPLITS_FILTER_IGNORED = 219;
 export var WARN_SPLITS_FILTER_INVALID = 220;
 export var WARN_SPLITS_FILTER_EMPTY = 221;
-export var WARN_STORAGE_INVALID = 222;
-export var WARN_API_KEY = 223;
-export var STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 224;
+export var WARN_API_KEY = 222;
+export var STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
 export var ERROR_ENGINE_COMBINER_IFELSEIF = 300;
 export var ERROR_LOGLEVEL_INVALID = 301;
 export var ERROR_CLIENT_LISTENER = 302;
@@ -116,6 +115,7 @@ export var ERROR_EMPTY_ARRAY = 320;
 export var ERROR_INVALID_IMPRESSIONS_MODE = 321;
 export var ERROR_HTTP = 322;
 export var ERROR_LOCALHOST_MODULE_REQUIRED = 323;
+export var ERROR_STORAGE_INVALID = 324;
 // Log prefixes (a.k.a. tags or categories)
 export var LOG_PREFIX_SETTINGS = 'settings';
 export var LOG_PREFIX_INSTANTIATION = 'Factory instantiation';

package/esm/logger/messages/error.js

@@ -29,5 +29,6 @@ export var codesError = [
     [c.ERROR_EMPTY_ARRAY, '%s: %s must be a non-empty array.'],
     // initialization / settings validation
     [c.ERROR_INVALID_IMPRESSIONS_MODE, c.LOG_PREFIX_SETTINGS + ': you passed an invalid "impressionsMode". It should be one of the following values: %s. Defaulting to "%s" mode.'],
-    [c.ERROR_LOCALHOST_MODULE_REQUIRED, c.LOG_PREFIX_SETTINGS + ': an invalid value was received for "sync.localhostMode" config. A valid entity should be provided for localhost mode.']
+    [c.ERROR_LOCALHOST_MODULE_REQUIRED, c.LOG_PREFIX_SETTINGS + ': an invalid value was received for "sync.localhostMode" config. A valid entity should be provided for localhost mode.'],
+    [c.ERROR_STORAGE_INVALID, c.LOG_PREFIX_SETTINGS + ': The provided storage is invalid.%s Fallbacking into default MEMORY storage'],
 ];

package/esm/logger/messages/warn.js

@@ -28,7 +28,6 @@ export var codesWarn = codesError.concat([
     [c.WARN_SPLITS_FILTER_IGNORED, c.LOG_PREFIX_SETTINGS + ': split filters have been configured but will have no effect if mode is not "%s", since synchronization is being deferred to an external tool.'],
     [c.WARN_SPLITS_FILTER_INVALID, c.LOG_PREFIX_SETTINGS + ': split filter at position %s is invalid. It must be an object with a valid filter type ("byName" or "byPrefix") and a list of "values".'],
     [c.WARN_SPLITS_FILTER_EMPTY, c.LOG_PREFIX_SETTINGS + ': splitFilters configuration must be a non-empty array of filter objects.'],
-    [c.WARN_STORAGE_INVALID, c.LOG_PREFIX_SETTINGS + ': The provided storage is invalid. Fallbacking into default MEMORY storage'],
     [c.WARN_API_KEY, c.LOG_PREFIX_SETTINGS + ': You already have %s. We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'],
     [c.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching MySegments due to an error processing %s notification: %s'],
 ]);

package/esm/sdkClient/sdkClient.js

@@ -1,5 +1,5 @@
 import objectAssign from 'object-assign';
-import { CONSUMER_MODE } from '../utils/constants';
+import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE } from '../utils/constants';
 import { releaseApiKey } from '../utils/inputValidation/apiKey';
 import clientFactory from './client';
 import clientInputValidationDecorator from './clientInputValidation';
@@ -13,8 +13,8 @@ export function sdkClientFactory(params) {
     Object.create(sdkReadinessManager.sdkStatus), 
     // Client API (getTreatment* & track methods)
     clientInputValidationDecorator(settings.log, clientFactory(params), sdkReadinessManager.readinessManager, 
-    // @TODO isStorageSync could be extracted from the storage itself (e.g. `storage.isSync`) to simplify interfaces
-    settings.mode === CONSUMER_MODE ? false : true), 
+    // storage is async if and only if mode is consumer or partial consumer
+    [CONSUMER_MODE, CONSUMER_PARTIAL_MODE].indexOf(settings.mode) === -1 ? true : false), 
     // Sdk destroy
     {
         destroy: function () {
@@ -25,11 +25,11 @@ export function sdkClientFactory(params) {
                 // Cleanup event listeners
                 sdkReadinessManager.readinessManager.destroy();
                 signalListener && signalListener.stop();
-                // Cleanup storage
-                storage.destroy();
                 // Release the API Key if it is the main client
                 if (!sharedClient)
                     releaseApiKey(settings.core.authorizationKey);
+                // Cleanup storage
+                return storage.destroy();
             });
         }
     });

package/esm/sdkClient/sdkClientMethodCS.js

@@ -4,6 +4,7 @@ import { getMatching, keyParser } from '../utils/key';
 import { sdkClientFactory } from './sdkClient';
 import objectAssign from 'object-assign';
 import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING } from '../logger/constants';
+import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
 function buildInstanceId(key) {
     // @ts-ignore
     return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-";
@@ -39,14 +40,24 @@ export function sdkClientMethodCSFactory(params) {
         var instanceId = buildInstanceId(validKey);
         if (!clientInstances[instanceId]) {
             var matchingKey = getMatching(validKey);
-            var sharedSdkReadiness = sdkReadinessManager.shared(readyTimeout);
-            var sharedStorage = storage.shared(matchingKey);
-            var sharedSyncManager = syncManager && syncManager.shared(matchingKey, sharedSdkReadiness.readinessManager, sharedStorage);
+            var sharedSdkReadiness_1 = sdkReadinessManager.shared(readyTimeout);
+            var sharedStorage = storage.shared && storage.shared(matchingKey, function (err) {
+                if (err)
+                    return;
+                // Emit SDK_READY in consumer mode for shared clients
+                sharedSdkReadiness_1.readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED);
+            });
+            // 3 possibilities:
+            // - Standalone mode: both syncManager and sharedSyncManager are defined
+            // - Consumer mode: both syncManager and sharedSyncManager are undefined
+            // - Consumer partial mode: syncManager is defined (only for submitters) but sharedSyncManager is undefined
+            // @ts-ignore
+            var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
             // 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] = clientCSDecorator(sdkClientFactory(objectAssign({}, params, {
-                sdkReadinessManager: sharedSdkReadiness,
-                storage: sharedStorage,
+                sdkReadinessManager: sharedSdkReadiness_1,
+                storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
                 signalListener: undefined,
                 sharedClient: true

package/esm/sdkClient/sdkClientMethodCSWithTT.js

@@ -5,6 +5,7 @@ import { getMatching, keyParser } from '../utils/key';
 import { sdkClientFactory } from './sdkClient';
 import objectAssign from 'object-assign';
 import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING } from '../logger/constants';
+import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
 function buildInstanceId(key, trafficType) {
     // @ts-ignore
     return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType !== undefined ? trafficType : '');
@@ -52,19 +53,29 @@ export function sdkClientMethodCSFactory(params) {
         var instanceId = buildInstanceId(validKey, validTrafficType);
         if (!clientInstances[instanceId]) {
             var matchingKey = getMatching(validKey);
-            var sharedSdkReadiness = sdkReadinessManager.shared(readyTimeout);
-            var sharedStorage = storage.shared(matchingKey);
-            var sharedSyncManager = syncManager.shared(matchingKey, sharedSdkReadiness.readinessManager, sharedStorage);
+            var sharedSdkReadiness_1 = sdkReadinessManager.shared(readyTimeout);
+            var sharedStorage = storage.shared && storage.shared(matchingKey, function (err) {
+                if (err)
+                    return;
+                // Emit SDK_READY in consumer mode for shared clients
+                sharedSdkReadiness_1.readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED);
+            });
+            // 3 possibilities:
+            // - Standalone mode: both syncManager and sharedSyncManager are defined
+            // - Consumer mode: both syncManager and sharedSyncManager are undefined
+            // - Consumer partial mode: syncManager is defined (only for submitters) but sharedSyncManager is undefined
+            // @ts-ignore
+            var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
             // 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] = clientCSDecorator(sdkClientFactory(objectAssign({}, params, {
-                sdkReadinessManager: sharedSdkReadiness,
-                storage: sharedStorage,
+                sdkReadinessManager: sharedSdkReadiness_1,
+                storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
                 signalListener: undefined,
                 sharedClient: true
             })), validKey, validTrafficType);
-            sharedSyncManager.start();
+            sharedSyncManager && sharedSyncManager.start();
             log.info(NEW_SHARED_CLIENT);
         }
         else {

package/esm/sdkFactory/index.js

@@ -27,13 +27,16 @@ export function sdkFactory(params) {
         // ATM, only used by InLocalStorage
         matchingKey: getMatching(settings.core.key),
         splitFiltersValidation: settings.sync.__splitFiltersValidation,
-        // Callback used in consumer mode (`syncManagerFactory` is undefined) to emit SDK_READY
-        onReadyCb: !syncManagerFactory ? function (error) {
+        // ATM, only used by PluggableStorage
+        mode: settings.mode,
+        // Callback used to emit SDK_READY in consumer mode, where `syncManagerFactory` is undefined
+        // or only instantiates submitters, and therefore it is not able to emit readiness events.
+        onReadyCb: function (error) {
             if (error)
                 return; // don't emit SDK_READY if storage failed to connect.
             readinessManager.splits.emit(SDK_SPLITS_ARRIVED);
             readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED);
-        } : undefined,
+        },
         metadata: metadataBuilder(settings),
         log: log
     };

package/esm/storages/inMemory/InMemoryStorage.js

@@ -10,9 +10,6 @@ import { STORAGE_MEMORY } from '../../utils/constants';
  * @param params parameters required by EventsCacheSync
  */
 export function InMemoryStorageFactory(params) {
-    // InMemory storage is always ready
-    if (params.onReadyCb)
-        setTimeout(params.onReadyCb);
     return {
         splits: new SplitsCacheInMemory(),
         segments: new SegmentsCacheInMemory(),

package/esm/storages/inRedis/index.js

@@ -21,8 +21,7 @@ export function InRedisStorage(options) {
         var redisClient = new RedisAdapter(log, options.options || {});
         // subscription to Redis connect event in order to emit SDK_READY event on consumer mode
         redisClient.on('connect', function () {
-            if (onReadyCb)
-                onReadyCb();
+            onReadyCb();
         });
         return {
             splits: new SplitsCacheInRedis(log, keys, redisClient),

package/esm/storages/pluggable/SplitsCachePluggable.js

@@ -8,7 +8,7 @@ import AbstractSplitsCacheAsync from '../AbstractSplitsCacheAsync';
 var SplitsCachePluggable = /** @class */ (function (_super) {
     __extends(SplitsCachePluggable, _super);
     /**
-     * Create a SplitsCache that uses a custom storage wrapper.
+     * Create a SplitsCache that uses a storage wrapper.
      * @param log  Logger instance.
      * @param keys  Key builder.
      * @param wrapper  Adapted wrapper storage.

package/esm/storages/pluggable/inMemoryWrapper.js

@@ -1,12 +1,15 @@
 import { startsWith, toNumber } from '../../utils/lang';
 import { setToArray, _Set } from '../../utils/lang/sets';
 /**
- * Creates a ICustomStorageWrapper implementation that stores items in memory.
+ * Creates a IPluggableStorageWrapper implementation that stores items in memory.
  * The `_cache` property is the object were items are stored.
  * Intended for testing purposes.
+ *
+ * @param connDelay delay in millis for `connect` resolve. If not provided, `connect` resolves inmediatelly.
  */
-export function inMemoryWrapperFactory() {
+export function inMemoryWrapperFactory(connDelay) {
     var _cache = {};
+    var _connDelay = connDelay;
     return {
         /** Holds items (for key-value operations), list of items (for list operations) and set of items (for set operations) */
         _cache: _cache,
@@ -114,8 +117,19 @@ export function inMemoryWrapperFactory() {
                 return Promise.resolve(setToArray(set));
             return Promise.reject('key is not a set');
         },
-        // always connects and close
-        connect: function () { return Promise.resolve(); },
-        close: function () { return Promise.resolve(); },
+        // always connects and disconnects
+        connect: function () {
+            if (typeof _connDelay === 'number') {
+                return new Promise(function (res) { return setTimeout(res, _connDelay); });
+            }
+            else {
+                return Promise.resolve();
+            }
+        },
+        disconnect: function () { return Promise.resolve(); },
+        // for testing
+        _setConnDelay: function (connDelay) {
+            _connDelay = connDelay;
+        }
     };
 }

package/esm/storages/pluggable/index.js

@@ -1,3 +1,4 @@
+import { __assign } from "tslib";
 import KeyBuilderSS from '../KeyBuilderSS';
 import { SplitsCachePluggable } from './SplitsCachePluggable';
 import { SegmentsCachePluggable } from './SegmentsCachePluggable';
@@ -6,8 +7,11 @@ import { EventsCachePluggable } from './EventsCachePluggable';
 import { wrapperAdapter, METHODS_TO_PROMISE_WRAP } from './wrapperAdapter';
 import { isObject } from '../../utils/lang';
 import { validatePrefix } from '../KeyBuilder';
-import { STORAGE_CUSTOM } from '../../utils/constants';
-var NO_VALID_WRAPPER = 'Expecting custom storage `wrapper` in options, but no valid wrapper instance was provided.';
+import { CONSUMER_PARTIAL_MODE, STORAGE_PLUGGABLE } from '../../utils/constants';
+import ImpressionsCacheInMemory from '../inMemory/ImpressionsCacheInMemory';
+import EventsCacheInMemory from '../inMemory/EventsCacheInMemory';
+import ImpressionCountsCacheInMemory from '../inMemory/ImpressionCountsCacheInMemory';
+var NO_VALID_WRAPPER = 'Expecting pluggable storage `wrapper` in options, but no valid wrapper instance was provided.';
 var NO_VALID_WRAPPER_INTERFACE = 'The provided wrapper instance doesn’t follow the expected interface. Check our docs.';
 /**
  * Validate pluggable storage factory options.
@@ -23,6 +27,23 @@ function validatePluggableStorageOptions(options) {
     if (missingMethods.length)
         throw new Error(NO_VALID_WRAPPER_INTERFACE + " The following methods are missing or invalid: " + missingMethods);
 }
+// subscription to wrapper connect event in order to emit SDK_READY event
+function wrapperConnect(wrapper, onReadyCb) {
+    wrapper.connect().then(function () {
+        onReadyCb();
+    }).catch(function (e) {
+        onReadyCb(e || new Error('Error connecting wrapper'));
+    });
+}
+// Async return type in `client.track` method on consumer partial mode
+// No need to promisify impressions cache
+function promisifyEventsTrack(events) {
+    var origTrack = events.track;
+    events.track = function () {
+        return Promise.resolve(origTrack.apply(this, arguments));
+    };
+    return events;
+}
 /**
  * Pluggable storage factory for consumer server-side & client-side SplitFactory.
  */
@@ -30,29 +51,32 @@ export function PluggableStorage(options) {
     validatePluggableStorageOptions(options);
     var prefix = validatePrefix(options.prefix);
     function PluggableStorageFactory(_a) {
-        var log = _a.log, metadata = _a.metadata, onReadyCb = _a.onReadyCb;
+        var log = _a.log, metadata = _a.metadata, onReadyCb = _a.onReadyCb, mode = _a.mode, eventsQueueSize = _a.eventsQueueSize, optimize = _a.optimize;
         var keys = new KeyBuilderSS(prefix, metadata);
         var wrapper = wrapperAdapter(log, options.wrapper);
-        // subscription to Wrapper connect event in order to emit SDK_READY event
-        wrapper.connect().then(function () {
-            if (onReadyCb)
-                onReadyCb();
-        }).catch(function (e) {
-            if (onReadyCb)
-                onReadyCb(e || new Error('Error connecting wrapper'));
-        });
+        var isPartialConsumer = mode === CONSUMER_PARTIAL_MODE;
+        // Connects to wrapper and emits SDK_READY event on main client
+        wrapperConnect(wrapper, onReadyCb);
         return {
             splits: new SplitsCachePluggable(log, keys, wrapper),
             segments: new SegmentsCachePluggable(log, keys, wrapper),
-            impressions: new ImpressionsCachePluggable(log, keys.buildImpressionsKey(), wrapper, metadata),
-            events: new EventsCachePluggable(log, keys.buildEventsKey(), wrapper, metadata),
+            impressions: isPartialConsumer ? new ImpressionsCacheInMemory() : new ImpressionsCachePluggable(log, keys.buildImpressionsKey(), wrapper, metadata),
+            impressionCounts: optimize ? new ImpressionCountsCacheInMemory() : undefined,
+            events: isPartialConsumer ? promisifyEventsTrack(new EventsCacheInMemory(eventsQueueSize)) : new EventsCachePluggable(log, keys.buildEventsKey(), wrapper, metadata),
             // @TODO add telemetry cache when required
-            // Disconnect the underlying storage, to release its resources (such as open files, database connections, etc).
+            // Disconnect the underlying storage
             destroy: function () {
-                return wrapper.close();
+                return wrapper.disconnect();
+            },
+            // emits SDK_READY event on shared clients and returns a reference to the storage
+            shared: function (_, onReadyCb) {
+                wrapperConnect(wrapper, onReadyCb);
+                return __assign(__assign({}, this), { 
+                    // no-op destroy, to disconnect the wrapper only when the main client is destroyed
+                    destroy: function () { } });
             }
         };
     }
-    PluggableStorageFactory.type = STORAGE_CUSTOM;
+    PluggableStorageFactory.type = STORAGE_PLUGGABLE;
     return PluggableStorageFactory;
 }

package/esm/storages/pluggable/wrapperAdapter.js

@@ -16,14 +16,14 @@ export var METHODS_TO_PROMISE_WRAP = [
     'removeItems',
     'getItems',
     'connect',
-    'close'
+    'disconnect'
 ];
 /**
- * Adapter of the Custom Storage Wrapper.
+ * Adapter of the Pluggable Storage Wrapper.
  * Used to handle exceptions as rejected promises, in order to simplify the error handling on storages.
  *
  * @param log logger instance
- * @param wrapper custom storage wrapper to adapt
+ * @param wrapper storage wrapper to adapt
  * @returns an adapted version of the given storage wrapper
  */
 export function wrapperAdapter(log, wrapper) {

package/esm/sync/polling/updaters/mySegmentsUpdater.js

@@ -19,7 +19,7 @@ export function mySegmentsUpdaterFactory(log, mySegmentsFetcher, splitsCache, my
         // NOTE: We only collect metrics on startup.
         // mySegmentsPromise = tracker.start(tracker.TaskNames.MY_SEGMENTS_FETCH, startingUp ? metricCollectors : false, mySegmentsPromise);
     }
-    // @TODO if allowing custom storages, handle async execution
+    // @TODO if allowing pluggable storages, handle async execution
     function updateSegments(segmentsData) {
         var shouldNotifyUpdate;
         if (Array.isArray(segmentsData)) {

package/esm/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js

@@ -67,7 +67,6 @@ var SplitsUpdateWorker = /** @class */ (function () {
      */
     SplitsUpdateWorker.prototype.killSplit = function (_a) {
         var changeNumber = _a.changeNumber, splitName = _a.splitName, defaultTreatment = _a.defaultTreatment;
-        // @TODO handle retry due to errors in storage, once we allow the definition of custom async storages
         if (this.splitsCache.killLocally(splitName, defaultTreatment, changeNumber)) {
             // trigger an SDK_UPDATE if Split was killed locally
             this.splitsEventEmitter.emit(SDK_SPLITS_ARRIVED, true);

package/esm/sync/submitters/submitterManager.js

@@ -0,0 +1,15 @@
+import { syncTaskComposite } from '../syncTaskComposite';
+import { eventsSyncTaskFactory } from './eventsSyncTask';
+import { impressionsSyncTaskFactory } from './impressionsSyncTask';
+import { impressionCountsSyncTaskFactory } from './impressionCountsSyncTask';
+export function submitterManagerFactory(settings, storage, splitApi) {
+    var log = settings.log;
+    var submitters = [
+        impressionsSyncTaskFactory(log, splitApi.postTestImpressionsBulk, storage.impressions, settings.scheduler.impressionsRefreshRate, settings.core.labelsEnabled),
+        eventsSyncTaskFactory(log, splitApi.postEventsBulk, storage.events, settings.scheduler.eventsPushRate, settings.startup.eventsFirstPushWindow)
+        // @TODO add telemetry submitter
+    ];
+    if (storage.impressionCounts)
+        submitters.push(impressionCountsSyncTaskFactory(log, splitApi.postTestImpressionsCount, storage.impressionCounts));
+    return syncTaskComposite(submitters);
+}

package/esm/sync/syncManagerOnline.js

@@ -1,7 +1,4 @@
-import { syncTaskComposite } from './syncTaskComposite';
-import { eventsSyncTaskFactory } from './submitters/eventsSyncTask';
-import { impressionsSyncTaskFactory } from './submitters/impressionsSyncTask';
-import { impressionCountsSyncTaskFactory } from './submitters/impressionCountsSyncTask';
+import { submitterManagerFactory } from './submitters/submitterManager';
 import { PUSH_SUBSYSTEM_UP, PUSH_SUBSYSTEM_DOWN } from './streaming/constants';
 import { SYNC_START_POLLING, SYNC_CONTINUE_POLLING, SYNC_STOP_POLLING } from '../logger/constants';
 /**
@@ -20,21 +17,14 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
         var settings = _a.settings, platform = _a.platform, splitApi = _a.splitApi, storage = _a.storage, readiness = _a.readiness;
         var log = settings.log;
         /** Polling Manager */
-        var pollingManager = pollingManagerFactory(splitApi, storage, readiness, settings);
+        var pollingManager = pollingManagerFactory && pollingManagerFactory(splitApi, storage, readiness, settings);
         /** Push Manager */
-        var pushManager = settings.streamingEnabled && pushManagerFactory ?
+        var pushManager = settings.streamingEnabled && pollingManager && pushManagerFactory ?
             pushManagerFactory(pollingManager, storage, readiness, splitApi.fetchAuth, platform, settings) :
             undefined;
         /** Submitter Manager */
-        // It is not inyected via a factory as push and polling managers, because at the moment it is mandatory and the same for server-side and client-side variants
-        var submitters = [
-            impressionsSyncTaskFactory(log, splitApi.postTestImpressionsBulk, storage.impressions, settings.scheduler.impressionsRefreshRate, settings.core.labelsEnabled),
-            eventsSyncTaskFactory(log, splitApi.postEventsBulk, storage.events, settings.scheduler.eventsPushRate, settings.startup.eventsFirstPushWindow)
-            // @TODO add telemetry submitter
-        ];
-        if (storage.impressionCounts)
-            submitters.push(impressionCountsSyncTaskFactory(log, splitApi.postTestImpressionsCount, storage.impressionCounts));
-        var submitter = syncTaskComposite(submitters);
+        // It is not inyected as push and polling managers, because at the moment it is required
+        var submitter = submitterManagerFactory(settings, storage, splitApi);
         /** Sync Manager logic */
         function startPolling() {
             if (!pollingManager.isRunning()) {
@@ -66,16 +56,18 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
              */
             start: function () {
                 // start syncing splits and segments
-                if (pushManager) {
-                    // Doesn't call `syncAll` when the syncManager is resuming
-                    if (startFirstTime) {
-                        pollingManager.syncAll();
-                        startFirstTime = false;
+                if (pollingManager) {
+                    if (pushManager) {
+                        // Doesn't call `syncAll` when the syncManager is resuming
+                        if (startFirstTime) {
+                            pollingManager.syncAll();
+                            startFirstTime = false;
+                        }
+                        pushManager.start();
+                    }
+                    else {
+                        pollingManager.start();
                     }
-                    pushManager.start();
-                }
-                else {
-                    pollingManager.start();
                 }
                 // start periodic data recording (events, impressions, telemetry).
                 submitter && submitter.start();
@@ -88,7 +80,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                 // stop syncing
                 if (pushManager)
                     pushManager.stop();
-                if (pollingManager.isRunning())
+                if (pollingManager && pollingManager.isRunning())
                     pollingManager.stop();
                 // stop periodic data recording (events, impressions, telemetry).
                 if (submitter)
@@ -105,8 +97,10 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                     return Promise.resolve();
             },
             // [Only used for client-side]
-            // It assumes that polling and push managers implement the interfaces for client-side
+            // If polling and push managers are defined (standalone mode), they implement the interfaces for client-side
             shared: function (matchingKey, readinessManager, storage) {
+                if (!pollingManager)
+                    return;
                 var mySegmentsSyncTask = pollingManager.add(matchingKey, readinessManager, storage);
                 return {
                     isRunning: mySegmentsSyncTask.isRunning,

package/esm/trackers/impressionObserver/utils.js

@@ -1,9 +1,9 @@
-import { OPTIMIZED, PRODUCER_MODE, STANDALONE_MODE } from '../../utils/constants';
+import { CONSUMER_PARTIAL_MODE, OPTIMIZED, PRODUCER_MODE, STANDALONE_MODE } from '../../utils/constants';
 /**
  * Checks if impressions previous time should be added or not.
  */
 export function shouldAddPt(settings) {
-    return [PRODUCER_MODE, STANDALONE_MODE].indexOf(settings.mode) > -1 ? true : false;
+    return [PRODUCER_MODE, STANDALONE_MODE, CONSUMER_PARTIAL_MODE].indexOf(settings.mode) > -1 ? true : false;
 }
 /**
  * Checks if it should dedupe impressions or not.

package/esm/utils/constants/index.js

@@ -18,8 +18,9 @@ export var LOCALHOST_MODE = 'localhost';
 export var STANDALONE_MODE = 'standalone';
 export var PRODUCER_MODE = 'producer';
 export var CONSUMER_MODE = 'consumer';
+export var CONSUMER_PARTIAL_MODE = 'consumer_partial';
 // Storage types
 export var STORAGE_MEMORY = 'MEMORY';
 export var STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
 export var STORAGE_REDIS = 'REDIS';
-export var STORAGE_CUSTOM = 'CUSTOM';
+export var STORAGE_PLUGGABLE = 'PLUGGABLE';

package/esm/utils/settingsValidation/mode.js

@@ -1,9 +1,9 @@
-import { LOCALHOST_MODE, STANDALONE_MODE, PRODUCER_MODE, CONSUMER_MODE } from '../constants';
+import { LOCALHOST_MODE, STANDALONE_MODE, PRODUCER_MODE, CONSUMER_MODE, CONSUMER_PARTIAL_MODE } from '../constants';
 export default function mode(key, mode) {
     // Leaving the comparison as is, in case we change the mode name but not the setting.
     if (key === 'localhost')
         return LOCALHOST_MODE;
-    if ([STANDALONE_MODE, PRODUCER_MODE, CONSUMER_MODE].indexOf(mode) === -1)
+    if ([STANDALONE_MODE, PRODUCER_MODE, CONSUMER_MODE, CONSUMER_PARTIAL_MODE].indexOf(mode) === -1)
         throw Error('Invalid mode provided');
     return mode;
 }

package/esm/utils/settingsValidation/storage/storageCS.js

@@ -1,6 +1,6 @@
 import { InMemoryStorageCSFactory } from '../../../storages/inMemory/InMemoryStorageCS';
-import { WARN_STORAGE_INVALID } from '../../../logger/constants';
-import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE, STORAGE_MEMORY } from '../../../utils/constants';
+import { ERROR_STORAGE_INVALID } from '../../../logger/constants';
+import { LOCALHOST_MODE, STANDALONE_MODE, STORAGE_PLUGGABLE, STORAGE_LOCALSTORAGE, STORAGE_MEMORY } from '../../../utils/constants';
 export function __InLocalStorageMockFactory(params) {
     var result = InMemoryStorageCSFactory(params);
     result.splits.checkCache = function () { return true; }; // to emit SDK_READY_FROM_CACHE
@@ -12,19 +12,33 @@ __InLocalStorageMockFactory.type = STORAGE_MEMORY;
  *
  * @param {any} settings config object provided by the user to initialize the sdk
  *
- * @returns {Object} valid storage factory. It might be the default `InMemoryStorageCSFactory` if the provided storage is invalid.
+ * @returns {Object} valid storage factory. Default to `InMemoryStorageCSFactory` if the provided storage is invalid or not compatible with the sdk mode if mode is standalone or localhost
+ *
+ * @throws error if mode is consumer and the provided storage is not compatible
  */
 export function validateStorageCS(settings) {
     var _a = settings.storage, storage = _a === void 0 ? InMemoryStorageCSFactory : _a, log = settings.log, mode = settings.mode;
     // If an invalid storage is provided, fallback into MEMORY
-    if (typeof storage !== 'function' || storage.type !== STORAGE_MEMORY && storage.type !== STORAGE_LOCALSTORAGE) {
+    if (typeof storage !== 'function' || [STORAGE_MEMORY, STORAGE_LOCALSTORAGE, STORAGE_PLUGGABLE].indexOf(storage.type) === -1) {
         storage = InMemoryStorageCSFactory;
-        log.warn(WARN_STORAGE_INVALID);
+        log.error(ERROR_STORAGE_INVALID);
     }
     // In localhost mode with InLocalStorage, fallback to a mock InLocalStorage to emit SDK_READY_FROM_CACHE
     if (mode === LOCALHOST_MODE && storage.type === STORAGE_LOCALSTORAGE) {
         return __InLocalStorageMockFactory;
     }
+    if ([LOCALHOST_MODE, STANDALONE_MODE].indexOf(mode) === -1) {
+        // Consumer modes require an async storage
+        if (storage.type !== STORAGE_PLUGGABLE)
+            throw new Error('A PluggableStorage instance is required on consumer mode');
+    }
+    else {
+        // Standalone and localhost modes require a sync storage
+        if (storage.type === STORAGE_PLUGGABLE) {
+            storage = InMemoryStorageCSFactory;
+            log.error(ERROR_STORAGE_INVALID, [' It requires consumer mode.']);
+        }
+    }
     // return default InMemory storage if provided one is not valid
     return storage;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "0.1.1-rc.20",
+  "version": "1.0.1-rc.2",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",