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

package/CHANGES.txt

@@ -1,3 +1,12 @@
+1.0.0 (October 20, 2021)
+- BREAKING CHANGE on multiple modules due to general polishing, improvements and bug fixes. In most cases the change is to use named exports. This affected mostly modules related with synchronization and storages.
+ - Updated streaming logic to use the newest version of our streaming service, including:
+   - Integration with Auth service V2, connecting to the new channels and applying the received connection delay.
+   - Implemented handling of the new MySegmentsV2 notification types (SegmentRemoval, KeyList, Bounded and Unbounded)
+   - New control notification for environment scoped streaming reset.
+- Updated localhost mode to emit SDK_READY_FROM_CACHE event in Browser when using localStorage (Related to issue https://github.com/splitio/react-client/issues/34).
+- Updated dependencies for vulnerability fixes.
+
 0.1.0 (March 30, 2021)
  - Initial public release. It includes common modules to be consumed by the different Split implementations written in JavaScript. Based on the original JS SDK in the `javascript-client` repository.
  - It's designed with a modular approach, with the following goals in mind:

package/README.md

@@ -24,17 +24,18 @@ To learn more about Split, contact hello@split.io, or get started with feature f
 
 Split has built and maintains SDKs for:
 
-* .NET [Github](https://github.com/splitio/.net-core-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
+* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
 * GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
 * iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
 * Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* Javascript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
-* Javascript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
 * React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
+* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
 * Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
 * Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 

package/cjs/listeners/browser.js

@@ -49,6 +49,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
@@ -59,7 +61,7 @@ var BrowserSignalListener = /** @class */ (function () {
         if (this.storage.impressionCounts)
             this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, impressionCountsSyncTask_1.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/cjs/logger/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_IMPRESSIONS_MODE = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_API_KEY = exports.WARN_STORAGE_INVALID = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_EVENTS_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_SPLITS_SEGMENTS = exports.SYNC_SPLITS_REMOVED = exports.SYNC_SPLITS_NEW = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_WHITELIST = exports.ENGINE_MATCHER_STARTS_WITH = exports.ENGINE_MATCHER_STRING_INVALID = exports.ENGINE_MATCHER_STRING = exports.ENGINE_MATCHER_SEGMENT = exports.ENGINE_MATCHER_PART_OF = exports.ENGINE_MATCHER_LESS = exports.ENGINE_MATCHER_GREATER = exports.ENGINE_MATCHER_ENDS_WITH = exports.ENGINE_MATCHER_EQUAL_TO_SET = exports.ENGINE_MATCHER_EQUAL = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_MATCHER_CONTAINS_STRING = exports.ENGINE_MATCHER_CONTAINS_ANY = exports.ENGINE_MATCHER_CONTAINS_ALL = exports.ENGINE_MATCHER_BOOLEAN = exports.ENGINE_MATCHER_BETWEEN = exports.ENGINE_MATCHER_ALL = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
+exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_IMPRESSIONS_MODE = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_API_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_EVENTS_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_SPLITS_SEGMENTS = exports.SYNC_SPLITS_REMOVED = exports.SYNC_SPLITS_NEW = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_WHITELIST = exports.ENGINE_MATCHER_STARTS_WITH = exports.ENGINE_MATCHER_STRING_INVALID = exports.ENGINE_MATCHER_STRING = exports.ENGINE_MATCHER_SEGMENT = exports.ENGINE_MATCHER_PART_OF = exports.ENGINE_MATCHER_LESS = exports.ENGINE_MATCHER_GREATER = exports.ENGINE_MATCHER_ENDS_WITH = exports.ENGINE_MATCHER_EQUAL_TO_SET = exports.ENGINE_MATCHER_EQUAL = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_MATCHER_CONTAINS_STRING = exports.ENGINE_MATCHER_CONTAINS_ANY = exports.ENGINE_MATCHER_CONTAINS_ALL = exports.ENGINE_MATCHER_BOOLEAN = exports.ENGINE_MATCHER_BETWEEN = exports.ENGINE_MATCHER_ALL = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
 /**
  * Message codes used to trim string log messages from commons and client-side API modules,
  * in order to reduce the minimal SDK size for Browser and eventually other client-side environments.
@@ -92,9 +92,8 @@ exports.WARN_INTEGRATION_INVALID = 218;
 exports.WARN_SPLITS_FILTER_IGNORED = 219;
 exports.WARN_SPLITS_FILTER_INVALID = 220;
 exports.WARN_SPLITS_FILTER_EMPTY = 221;
-exports.WARN_STORAGE_INVALID = 222;
-exports.WARN_API_KEY = 223;
-exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 224;
+exports.WARN_API_KEY = 222;
+exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
 exports.ERROR_ENGINE_COMBINER_IFELSEIF = 300;
 exports.ERROR_LOGLEVEL_INVALID = 301;
 exports.ERROR_CLIENT_LISTENER = 302;
@@ -119,6 +118,7 @@ exports.ERROR_EMPTY_ARRAY = 320;
 exports.ERROR_INVALID_IMPRESSIONS_MODE = 321;
 exports.ERROR_HTTP = 322;
 exports.ERROR_LOCALHOST_MODULE_REQUIRED = 323;
+exports.ERROR_STORAGE_INVALID = 324;
 // Log prefixes (a.k.a. tags or categories)
 exports.LOG_PREFIX_SETTINGS = 'settings';
 exports.LOG_PREFIX_INSTANTIATION = 'Factory instantiation';

package/cjs/logger/messages/error.js

@@ -33,5 +33,6 @@ exports.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/cjs/logger/messages/warn.js

@@ -32,7 +32,6 @@ exports.codesWarn = error_1.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/cjs/sdkClient/sdkClient.js

@@ -17,8 +17,8 @@ function sdkClientFactory(params) {
     Object.create(sdkReadinessManager.sdkStatus), 
     // Client API (getTreatment* & track methods)
     clientInputValidation_1.default(settings.log, client_1.default(params), sdkReadinessManager.readinessManager, 
-    // @TODO isStorageSync could be extracted from the storage itself (e.g. `storage.isSync`) to simplify interfaces
-    settings.mode === constants_1.CONSUMER_MODE ? false : true), 
+    // storage is async if and only if mode is consumer or partial consumer
+    [constants_1.CONSUMER_MODE, constants_1.CONSUMER_PARTIAL_MODE].indexOf(settings.mode) === -1 ? true : false), 
     // Sdk destroy
     {
         destroy: function () {
@@ -29,11 +29,11 @@ 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)
                     apiKey_1.releaseApiKey(settings.core.authorizationKey);
+                // Cleanup storage
+                return storage.destroy();
             });
         }
     });

package/cjs/sdkClient/sdkClientMethodCS.js

@@ -8,6 +8,7 @@ var key_2 = require("../utils/key");
 var sdkClient_1 = require("./sdkClient");
 var object_assign_1 = tslib_1.__importDefault(require("object-assign"));
 var constants_1 = require("../logger/constants");
+var constants_2 = require("../readiness/constants");
 function buildInstanceId(key) {
     // @ts-ignore
     return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-";
@@ -43,14 +44,24 @@ function sdkClientMethodCSFactory(params) {
         var instanceId = buildInstanceId(validKey);
         if (!clientInstances[instanceId]) {
             var matchingKey = key_2.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(constants_2.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] = clientCS_1.default(sdkClient_1.sdkClientFactory(object_assign_1.default({}, params, {
-                sdkReadinessManager: sharedSdkReadiness,
-                storage: sharedStorage,
+                sdkReadinessManager: sharedSdkReadiness_1,
+                storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
                 signalListener: undefined,
                 sharedClient: true

package/cjs/sdkClient/sdkClientMethodCSWithTT.js

@@ -9,6 +9,7 @@ var key_2 = require("../utils/key");
 var sdkClient_1 = require("./sdkClient");
 var object_assign_1 = tslib_1.__importDefault(require("object-assign"));
 var constants_1 = require("../logger/constants");
+var constants_2 = require("../readiness/constants");
 function buildInstanceId(key, trafficType) {
     // @ts-ignore
     return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType !== undefined ? trafficType : '');
@@ -56,19 +57,29 @@ function sdkClientMethodCSFactory(params) {
         var instanceId = buildInstanceId(validKey, validTrafficType);
         if (!clientInstances[instanceId]) {
             var matchingKey = key_2.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(constants_2.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] = clientCS_1.default(sdkClient_1.sdkClientFactory(object_assign_1.default({}, 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(constants_1.NEW_SHARED_CLIENT);
         }
         else {

package/cjs/sdkFactory/index.js

@@ -31,13 +31,16 @@ function sdkFactory(params) {
         // ATM, only used by InLocalStorage
         matchingKey: key_1.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(constants_2.SDK_SPLITS_ARRIVED);
             readinessManager.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
-        } : undefined,
+        },
         metadata: metadataBuilder_1.metadataBuilder(settings),
         log: log
     };

package/cjs/storages/inMemory/InMemoryStorage.js

@@ -14,9 +14,6 @@ var constants_1 = require("../../utils/constants");
  * @param params parameters required by EventsCacheSync
  */
 function InMemoryStorageFactory(params) {
-    // InMemory storage is always ready
-    if (params.onReadyCb)
-        setTimeout(params.onReadyCb);
     return {
         splits: new SplitsCacheInMemory_1.default(),
         segments: new SegmentsCacheInMemory_1.default(),

package/cjs/storages/inRedis/index.js

@@ -25,8 +25,7 @@ function InRedisStorage(options) {
         var redisClient = new RedisAdapter_1.default(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_1.default(log, keys, redisClient),

package/cjs/storages/pluggable/SplitsCachePluggable.js

@@ -11,7 +11,7 @@ var AbstractSplitsCacheAsync_1 = tslib_1.__importDefault(require("../AbstractSpl
 var SplitsCachePluggable = /** @class */ (function (_super) {
     tslib_1.__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/cjs/storages/pluggable/inMemoryWrapper.js

@@ -4,12 +4,15 @@ exports.inMemoryWrapperFactory = void 0;
 var lang_1 = require("../../utils/lang");
 var sets_1 = require("../../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.
  */
-function inMemoryWrapperFactory() {
+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,
@@ -117,9 +120,20 @@ function inMemoryWrapperFactory() {
                 return Promise.resolve(sets_1.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;
+        }
     };
 }
 exports.inMemoryWrapperFactory = inMemoryWrapperFactory;

package/cjs/storages/pluggable/index.js

@@ -11,7 +11,10 @@ var wrapperAdapter_1 = require("./wrapperAdapter");
 var lang_1 = require("../../utils/lang");
 var KeyBuilder_1 = require("../KeyBuilder");
 var constants_1 = require("../../utils/constants");
-var NO_VALID_WRAPPER = 'Expecting custom storage `wrapper` in options, but no valid wrapper instance was provided.';
+var ImpressionsCacheInMemory_1 = tslib_1.__importDefault(require("../inMemory/ImpressionsCacheInMemory"));
+var EventsCacheInMemory_1 = tslib_1.__importDefault(require("../inMemory/EventsCacheInMemory"));
+var ImpressionCountsCacheInMemory_1 = tslib_1.__importDefault(require("../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.
@@ -27,6 +30,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.
  */
@@ -34,30 +54,33 @@ function PluggableStorage(options) {
     validatePluggableStorageOptions(options);
     var prefix = KeyBuilder_1.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_1.default(prefix, metadata);
         var wrapper = wrapperAdapter_1.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 === constants_1.CONSUMER_PARTIAL_MODE;
+        // Connects to wrapper and emits SDK_READY event on main client
+        wrapperConnect(wrapper, onReadyCb);
         return {
             splits: new SplitsCachePluggable_1.SplitsCachePluggable(log, keys, wrapper),
             segments: new SegmentsCachePluggable_1.SegmentsCachePluggable(log, keys, wrapper),
-            impressions: new ImpressionsCachePluggable_1.ImpressionsCachePluggable(log, keys.buildImpressionsKey(), wrapper, metadata),
-            events: new EventsCachePluggable_1.EventsCachePluggable(log, keys.buildEventsKey(), wrapper, metadata),
+            impressions: isPartialConsumer ? new ImpressionsCacheInMemory_1.default() : new ImpressionsCachePluggable_1.ImpressionsCachePluggable(log, keys.buildImpressionsKey(), wrapper, metadata),
+            impressionCounts: optimize ? new ImpressionCountsCacheInMemory_1.default() : undefined,
+            events: isPartialConsumer ? promisifyEventsTrack(new EventsCacheInMemory_1.default(eventsQueueSize)) : new EventsCachePluggable_1.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 tslib_1.__assign(tslib_1.__assign({}, this), { 
+                    // no-op destroy, to disconnect the wrapper only when the main client is destroyed
+                    destroy: function () { } });
             }
         };
     }
-    PluggableStorageFactory.type = constants_1.STORAGE_CUSTOM;
+    PluggableStorageFactory.type = constants_1.STORAGE_PLUGGABLE;
     return PluggableStorageFactory;
 }
 exports.PluggableStorage = PluggableStorage;

package/cjs/storages/pluggable/wrapperAdapter.js

@@ -19,14 +19,14 @@ exports.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
  */
 function wrapperAdapter(log, wrapper) {

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

@@ -23,7 +23,7 @@ function mySegmentsUpdaterFactory(log, mySegmentsFetcher, splitsCache, mySegment
         // 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/cjs/sync/streaming/UpdateWorkers/SplitsUpdateWorker.js

@@ -70,7 +70,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(constants_1.SDK_SPLITS_ARRIVED, true);

package/cjs/sync/submitters/submitterManager.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.submitterManagerFactory = void 0;
+var syncTaskComposite_1 = require("../syncTaskComposite");
+var eventsSyncTask_1 = require("./eventsSyncTask");
+var impressionsSyncTask_1 = require("./impressionsSyncTask");
+var impressionCountsSyncTask_1 = require("./impressionCountsSyncTask");
+function submitterManagerFactory(settings, storage, splitApi) {
+    var log = settings.log;
+    var submitters = [
+        impressionsSyncTask_1.impressionsSyncTaskFactory(log, splitApi.postTestImpressionsBulk, storage.impressions, settings.scheduler.impressionsRefreshRate, settings.core.labelsEnabled),
+        eventsSyncTask_1.eventsSyncTaskFactory(log, splitApi.postEventsBulk, storage.events, settings.scheduler.eventsPushRate, settings.startup.eventsFirstPushWindow)
+        // @TODO add telemetry submitter
+    ];
+    if (storage.impressionCounts)
+        submitters.push(impressionCountsSyncTask_1.impressionCountsSyncTaskFactory(log, splitApi.postTestImpressionsCount, storage.impressionCounts));
+    return syncTaskComposite_1.syncTaskComposite(submitters);
+}
+exports.submitterManagerFactory = submitterManagerFactory;

package/cjs/sync/syncManagerOnline.js

@@ -1,10 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.syncManagerOnlineFactory = void 0;
-var syncTaskComposite_1 = require("./syncTaskComposite");
-var eventsSyncTask_1 = require("./submitters/eventsSyncTask");
-var impressionsSyncTask_1 = require("./submitters/impressionsSyncTask");
-var impressionCountsSyncTask_1 = require("./submitters/impressionCountsSyncTask");
+var submitterManager_1 = require("./submitters/submitterManager");
 var constants_1 = require("./streaming/constants");
 var constants_2 = require("../logger/constants");
 /**
@@ -23,21 +20,14 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
         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 = [
-            impressionsSyncTask_1.impressionsSyncTaskFactory(log, splitApi.postTestImpressionsBulk, storage.impressions, settings.scheduler.impressionsRefreshRate, settings.core.labelsEnabled),
-            eventsSyncTask_1.eventsSyncTaskFactory(log, splitApi.postEventsBulk, storage.events, settings.scheduler.eventsPushRate, settings.startup.eventsFirstPushWindow)
-            // @TODO add telemetry submitter
-        ];
-        if (storage.impressionCounts)
-            submitters.push(impressionCountsSyncTask_1.impressionCountsSyncTaskFactory(log, splitApi.postTestImpressionsCount, storage.impressionCounts));
-        var submitter = syncTaskComposite_1.syncTaskComposite(submitters);
+        // It is not inyected as push and polling managers, because at the moment it is required
+        var submitter = submitterManager_1.submitterManagerFactory(settings, storage, splitApi);
         /** Sync Manager logic */
         function startPolling() {
             if (!pollingManager.isRunning()) {
@@ -69,16 +59,18 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
              */
             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();
@@ -91,7 +83,7 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                 // stop syncing
                 if (pushManager)
                     pushManager.stop();
-                if (pollingManager.isRunning())
+                if (pollingManager && pollingManager.isRunning())
                     pollingManager.stop();
                 // stop periodic data recording (events, impressions, telemetry).
                 if (submitter)
@@ -108,8 +100,10 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                     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/cjs/trackers/impressionObserver/utils.js

@@ -6,7 +6,7 @@ var constants_1 = require("../../utils/constants");
  * Checks if impressions previous time should be added or not.
  */
 function shouldAddPt(settings) {
-    return [constants_1.PRODUCER_MODE, constants_1.STANDALONE_MODE].indexOf(settings.mode) > -1 ? true : false;
+    return [constants_1.PRODUCER_MODE, constants_1.STANDALONE_MODE, constants_1.CONSUMER_PARTIAL_MODE].indexOf(settings.mode) > -1 ? true : false;
 }
 exports.shouldAddPt = shouldAddPt;
 /**

package/cjs/utils/constants/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.STORAGE_CUSTOM = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
+exports.STORAGE_PLUGGABLE = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_PARTIAL_MODE = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
 // Special treatments
 exports.CONTROL = 'control';
 exports.CONTROL_WITH_CONFIG = {
@@ -21,8 +21,9 @@ exports.LOCALHOST_MODE = 'localhost';
 exports.STANDALONE_MODE = 'standalone';
 exports.PRODUCER_MODE = 'producer';
 exports.CONSUMER_MODE = 'consumer';
+exports.CONSUMER_PARTIAL_MODE = 'consumer_partial';
 // Storage types
 exports.STORAGE_MEMORY = 'MEMORY';
 exports.STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
 exports.STORAGE_REDIS = 'REDIS';
-exports.STORAGE_CUSTOM = 'CUSTOM';
+exports.STORAGE_PLUGGABLE = 'PLUGGABLE';

package/cjs/utils/settingsValidation/mode.js

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