@splitsoftware/splitio-commons 1.2.1-rc.1 → 1.2.1-rc.12

package/esm/sdkClient/sdkClientMethodCSWithTT.js

@@ -18,16 +18,7 @@ var method = 'Client instantiation';
  */
 export function sdkClientMethodCSFactory(params) {
     var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, readyTimeout = _a.startup.readyTimeout, log = _a.log;
-    // Keeping the behaviour as in the isomorphic JS SDK: if settings key or TT are invalid,
-    // `false` value is used as binded key/TT of the default client, which leads to several issues.
-    // @TODO update when supporting non-recoverable errors
-    var validKey = validateKey(log, key, method);
-    var validTrafficType;
-    if (trafficType !== undefined) {
-        validTrafficType = validateTrafficType(log, trafficType, method);
-    }
-    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), // @ts-ignore
-    validKey, validTrafficType);
+    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key, trafficType);
     var parsedDefaultKey = keyParser(key);
     var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
     // Cache instances created per factory.
@@ -72,9 +63,8 @@ export function sdkClientMethodCSFactory(params) {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
-                signalListener: undefined,
-                sharedClient: true
-            })), validKey, validTrafficType);
+                signalListener: undefined, // only the main client "destroy" method stops the signal listener
+            }), true), validKey, validTrafficType);
             sharedSyncManager && sharedSyncManager.start();
             log.info(NEW_SHARED_CLIENT);
         }

package/esm/sdkFactory/index.js

@@ -8,11 +8,12 @@ import { createLoggerAPI } from '../logger/sdkLogger';
 import { NEW_FACTORY, RETRIEVE_MANAGER } from '../logger/constants';
 import { metadataBuilder } from '../storages/metadataBuilder';
 import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
+import { objectAssign } from '../utils/lang/objectAssign';
 /**
  * Modular SDK factory
  */
 export function sdkFactory(params) {
-    var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, impressionListener = params.impressionListener, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory;
+    var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory;
     var log = settings.log;
     // @TODO handle non-recoverable errors: not start sync, mark the SDK as destroyed, etc.
     // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
@@ -22,6 +23,7 @@ export function sdkFactory(params) {
     var readinessManager = sdkReadinessManager.readinessManager;
     // @TODO consider passing the settings object, so that each storage access only what it needs
     var storageFactoryParams = {
+        impressionsQueueSize: settings.scheduler.impressionsQueueSize,
         eventsQueueSize: settings.scheduler.eventsQueueSize,
         optimize: shouldBeOptimized(settings),
         // ATM, only used by InLocalStorage
@@ -54,21 +56,22 @@ export function sdkFactory(params) {
     var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage });
     // trackers
     var observer = impressionsObserverFactory && impressionsObserverFactory();
-    var impressionsTracker = impressionsTrackerFactory(log, storage.impressions, settings, impressionListener, integrationsManager, observer, storage.impressionCounts);
-    var eventTracker = eventTrackerFactory(log, storage.events, integrationsManager);
+    var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, integrationsManager, observer, storage.impressionCounts);
+    var eventTracker = eventTrackerFactory(settings, storage.events, integrationsManager);
     // signal listener
     var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
     // Sdk client and manager
-    var clientMethod = sdkClientMethodFactory({ eventTracker: eventTracker, impressionsTracker: impressionsTracker, sdkReadinessManager: sdkReadinessManager, settings: settings, storage: storage, syncManager: syncManager, signalListener: signalListener });
+    var ctx = { eventTracker: eventTracker, impressionsTracker: impressionsTracker, sdkReadinessManager: sdkReadinessManager, settings: settings, storage: storage, syncManager: syncManager, signalListener: signalListener };
+    var clientMethod = sdkClientMethodFactory(ctx);
     var managerInstance = sdkManagerFactory(log, storage.splits, sdkReadinessManager);
     syncManager && syncManager.start();
     signalListener && signalListener.start();
     log.info(NEW_FACTORY);
-    return {
+    // @ts-ignore
+    return objectAssign({
         // Split evaluation and event tracking engine
         client: clientMethod,
         // Manager API to explore available information
-        // @ts-ignore
         manager: function () {
             log.debug(RETRIEVE_MANAGER);
             return managerInstance;
@@ -76,5 +79,5 @@ export function sdkFactory(params) {
         // Logger wrapper API
         Logger: createLoggerAPI(settings.log),
         settings: settings,
-    };
+    }, extraProps && extraProps(ctx));
 }

package/esm/services/splitApi.js

@@ -72,7 +72,8 @@ export function splitApiFactory(settings, platform) {
             return splitHttpClient(url, {
                 // Adding extra headers to send impressions in OPTIMIZED or DEBUG modes.
                 method: 'POST',
-                body: body, headers: objectAssign({ SplitSDKImpressionsMode: SplitSDKImpressionsMode }, headers)
+                body: body,
+                headers: objectAssign({ SplitSDKImpressionsMode: SplitSDKImpressionsMode }, headers)
             });
         },
         /**

package/esm/storages/KeyBuilder.js

@@ -1,12 +1,8 @@
-import { endsWith, startsWith } from '../utils/lang';
+import { startsWith } from '../utils/lang';
 var everythingAtTheEnd = /[^.]+$/;
 var DEFAULT_PREFIX = 'SPLITIO';
 export function validatePrefix(prefix) {
-    return prefix && typeof prefix === 'string' ?
-        endsWith(prefix, '.' + DEFAULT_PREFIX) ?
-            prefix : // suffix already appended
-            prefix + '.' + DEFAULT_PREFIX : // append suffix
-        DEFAULT_PREFIX; // use default prefix if none is provided
+    return prefix ? prefix + '.SPLITIO' : 'SPLITIO';
 }
 var KeyBuilder = /** @class */ (function () {
     function KeyBuilder(prefix) {

package/esm/storages/KeyBuilderCS.js

@@ -13,9 +13,19 @@ var KeyBuilderCS = /** @class */ (function (_super) {
      * @override
      */
     KeyBuilderCS.prototype.buildSegmentNameKey = function (segmentName) {
-        return this.matchingKey + "." + this.prefix + ".segment." + segmentName;
+        return this.prefix + "." + this.matchingKey + ".segment." + segmentName;
     };
     KeyBuilderCS.prototype.extractSegmentName = function (builtSegmentKeyName) {
+        var prefix = this.prefix + "." + this.matchingKey + ".segment.";
+        if (startsWith(builtSegmentKeyName, prefix))
+            return builtSegmentKeyName.substr(prefix.length);
+    };
+    // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
+    KeyBuilderCS.prototype.buildOldSegmentNameKey = function (segmentName) {
+        return this.matchingKey + "." + this.prefix + ".segment." + segmentName;
+    };
+    // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
+    KeyBuilderCS.prototype.extractOldSegmentKey = function (builtSegmentKeyName) {
         var prefix = this.matchingKey + "." + this.prefix + ".segment.";
         if (startsWith(builtSegmentKeyName, prefix))
             return builtSegmentKeyName.substr(prefix.length);

package/esm/storages/inLocalStorage/MySegmentsCacheInLocal.js

@@ -57,9 +57,29 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
         var index;
         // Scan current values from localStorage
         var storedSegmentNames = Object.keys(localStorage).reduce(function (accum, key) {
-            var name = _this.keys.extractSegmentName(key);
-            if (name)
-                accum.push(name);
+            var segmentName = _this.keys.extractSegmentName(key);
+            if (segmentName) {
+                accum.push(segmentName);
+            }
+            else {
+                // @BREAKING: This is only to clean up "old" keys. Remove this whole else code block.
+                segmentName = _this.keys.extractOldSegmentKey(key);
+                if (segmentName) { // this was an old segment key, let's clean up.
+                    var newSegmentKey = _this.keys.buildSegmentNameKey(segmentName);
+                    try {
+                        // If the new format key is not there, create it.
+                        if (!localStorage.getItem(newSegmentKey) && names.indexOf(segmentName) > -1) {
+                            localStorage.setItem(newSegmentKey, DEFINED);
+                            // we are migrating a segment, let's track it.
+                            accum.push(segmentName);
+                        }
+                        localStorage.removeItem(key); // we migrated the current key, let's delete it.
+                    }
+                    catch (e) {
+                        _this.log.error(e);
+                    }
+                }
+            }
             return accum;
         }, []);
         // Extreme fast => everything is empty

package/esm/storages/inLocalStorage/index.js

@@ -30,7 +30,7 @@ export function InLocalStorage(options) {
         return {
             splits: new SplitsCacheInLocal(log, keys, expirationTimestamp, params.splitFiltersValidation),
             segments: new MySegmentsCacheInLocal(log, keys),
-            impressions: new ImpressionsCacheInMemory(),
+            impressions: new ImpressionsCacheInMemory(params.impressionsQueueSize),
             impressionCounts: params.optimize ? new ImpressionCountsCacheInMemory() : undefined,
             events: new EventsCacheInMemory(params.eventsQueueSize),
             destroy: function () {

package/esm/storages/inMemory/ImpressionsCacheInMemory.js

@@ -1,13 +1,27 @@
 var ImpressionsCacheInMemory = /** @class */ (function () {
-    function ImpressionsCacheInMemory() {
+    /**
+     *
+     * @param impressionsQueueSize number of queued impressions to call onFullQueueCb.
+     * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
+     */
+    function ImpressionsCacheInMemory(impressionsQueueSize) {
+        if (impressionsQueueSize === void 0) { impressionsQueueSize = 0; }
+        this.maxQueue = impressionsQueueSize;
         this.queue = [];
     }
+    ImpressionsCacheInMemory.prototype.setOnFullQueueCb = function (cb) {
+        this.onFullQueue = cb;
+    };
     /**
      * Store impressions in sequential order
      */
     ImpressionsCacheInMemory.prototype.track = function (data) {
         var _a;
         (_a = this.queue).push.apply(_a, data);
+        // Check if the cache queue is full and we need to flush it.
+        if (this.maxQueue > 0 && this.queue.length >= this.maxQueue && this.onFullQueue) {
+            this.onFullQueue();
+        }
     };
     /**
      * Clear the data stored on the cache.

package/esm/storages/inMemory/InMemoryStorage.js

@@ -13,7 +13,7 @@ export function InMemoryStorageFactory(params) {
     return {
         splits: new SplitsCacheInMemory(),
         segments: new SegmentsCacheInMemory(),
-        impressions: new ImpressionsCacheInMemory(),
+        impressions: new ImpressionsCacheInMemory(params.impressionsQueueSize),
         impressionCounts: params.optimize ? new ImpressionCountsCacheInMemory() : undefined,
         events: new EventsCacheInMemory(params.eventsQueueSize),
         // When using MEMORY we should clean all the caches to leave them empty

package/esm/storages/inMemory/InMemoryStorageCS.js

@@ -13,7 +13,7 @@ export function InMemoryStorageCSFactory(params) {
     return {
         splits: new SplitsCacheInMemory(),
         segments: new MySegmentsCacheInMemory(),
-        impressions: new ImpressionsCacheInMemory(),
+        impressions: new ImpressionsCacheInMemory(params.impressionsQueueSize),
         impressionCounts: params.optimize ? new ImpressionCountsCacheInMemory() : undefined,
         events: new EventsCacheInMemory(params.eventsQueueSize),
         // When using MEMORY we should clean all the caches to leave them empty

package/esm/storages/inRedis/RedisAdapter.js

@@ -143,15 +143,28 @@ var RedisAdapter = /** @class */ (function (_super) {
         else { // If it IS the string URL, that'll be the first param for ioredis.
             result.unshift(options.url);
         }
+        if (options.connectionTimeout) {
+            merge(opts, { connectTimeout: options.connectionTimeout });
+        }
+        if (options.tls) {
+            merge(opts, { tls: options.tls });
+        }
         return result;
     };
     /**
      * Parses the options into what we care about.
      */
     RedisAdapter._defineOptions = function (_a) {
-        var connectionTimeout = _a.connectionTimeout, operationTimeout = _a.operationTimeout, url = _a.url, host = _a.host, port = _a.port, db = _a.db, pass = _a.pass;
+        var connectionTimeout = _a.connectionTimeout, operationTimeout = _a.operationTimeout, url = _a.url, host = _a.host, port = _a.port, db = _a.db, pass = _a.pass, tls = _a.tls;
         var parsedOptions = {
-            connectionTimeout: connectionTimeout, operationTimeout: operationTimeout, url: url, host: host, port: port, db: db, pass: pass
+            connectionTimeout: connectionTimeout,
+            operationTimeout: operationTimeout,
+            url: url,
+            host: host,
+            port: port,
+            db: db,
+            pass: pass,
+            tls: tls
         };
         return merge({}, DEFAULT_OPTIONS, parsedOptions);
     };

package/esm/storages/pluggable/index.js

@@ -51,7 +51,7 @@ export function PluggableStorage(options) {
     validatePluggableStorageOptions(options);
     var prefix = validatePrefix(options.prefix);
     function PluggableStorageFactory(_a) {
-        var log = _a.log, metadata = _a.metadata, onReadyCb = _a.onReadyCb, mode = _a.mode, eventsQueueSize = _a.eventsQueueSize, optimize = _a.optimize;
+        var log = _a.log, metadata = _a.metadata, onReadyCb = _a.onReadyCb, mode = _a.mode, eventsQueueSize = _a.eventsQueueSize, impressionsQueueSize = _a.impressionsQueueSize, optimize = _a.optimize;
         var keys = new KeyBuilderSS(prefix, metadata);
         var wrapper = wrapperAdapter(log, options.wrapper);
         var isPartialConsumer = mode === CONSUMER_PARTIAL_MODE;
@@ -60,7 +60,7 @@ export function PluggableStorage(options) {
         return {
             splits: new SplitsCachePluggable(log, keys, wrapper),
             segments: new SegmentsCachePluggable(log, keys, wrapper),
-            impressions: isPartialConsumer ? new ImpressionsCacheInMemory() : new ImpressionsCachePluggable(log, keys.buildImpressionsKey(), wrapper, metadata),
+            impressions: isPartialConsumer ? new ImpressionsCacheInMemory(impressionsQueueSize) : 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

package/esm/sync/offline/splitsParser/splitsParserFromFile.js

@@ -62,7 +62,7 @@ export function splitsParserFromFileFactory() {
             data = fs.readFileSync(filePath, 'utf-8');
         }
         catch (e) {
-            log.error(e.message);
+            log.error(e && e.message);
             return {};
         }
         if (data === previousMock)

package/esm/sync/polling/fetchers/segmentChangesFetcher.js

@@ -1,4 +1,4 @@
-import { __spreadArrays } from "tslib";
+import { __spreadArray } from "tslib";
 function greedyFetch(fetchSegmentChanges, since, segmentName, noCache) {
     return fetchSegmentChanges(since, segmentName, noCache)
         .then(function (resp) { return resp.json(); })
@@ -9,7 +9,7 @@ function greedyFetch(fetchSegmentChanges, since, segmentName, noCache) {
         }
         else {
             return Promise.all([json, greedyFetch(fetchSegmentChanges, till, segmentName, noCache)]).then(function (flatMe) {
-                return __spreadArrays([flatMe[0]], flatMe[1]);
+                return __spreadArray([flatMe[0]], flatMe[1], true);
             });
         }
     });

package/esm/sync/streaming/SSEClient/index.js

@@ -1,3 +1,4 @@
+import { isString } from '../../../utils/lang';
 var VERSION = '1.1';
 var CONTROL_CHANNEL_REGEX = /^control_/;
 /**
@@ -8,7 +9,7 @@ var CONTROL_CHANNEL_REGEX = /^control_/;
  */
 function buildSSEHeaders(settings) {
     var headers = {
-        SplitSDKClientKey: settings.core.authorizationKey.slice(-4),
+        SplitSDKClientKey: isString(settings.core.authorizationKey) ? settings.core.authorizationKey.slice(-4) : '',
         SplitSDKVersion: settings.version,
     };
     // ip and hostname are false if IPAddressesEnabled is false

package/esm/sync/streaming/pushManager.js

@@ -55,6 +55,7 @@ export function pushManagerFactory(params, pollingManager) {
     // It is used to halt the `connectPush` process if it was in progress.
     var disconnected;
     // flag that indicates a PUSH_NONRETRYABLE_ERROR, condition with which starting pushManager again is ignored.
+    // true if STREAMING_DISABLED control event, or 'pushEnabled: false', or non-recoverable SSE or Auth errors.
     var disabled; // `disabled` implies `disconnected === true`
     /** PushManager functions related to initialization */
     var connectPushRetryBackoff = new Backoff(connectPush, settings.scheduler.pushRetryBackoffBase);
@@ -255,13 +256,15 @@ export function pushManagerFactory(params, pollingManager) {
     return objectAssign(
     // Expose Event Emitter functionality and Event constants
     Object.create(pushEmitter), {
-        // Stop/pause push mode
+        // Stop/pause push mode.
+        // It doesn't emit events. Neither PUSH_SUBSYSTEM_DOWN to start polling.
         stop: function () {
             disconnectPush(); // `handleNonRetryableError` cannot be used as `stop`, because it emits PUSH_SUBSYSTEM_DOWN event, which starts polling.
             if (userKey)
                 this.remove(userKey); // Necessary to properly resume streaming in client-side (e.g., RN SDK transition to foreground).
         },
-        // Start/resume push mode
+        // Start/resume push mode.
+        // It eventually emits PUSH_SUBSYSTEM_DOWN, that starts polling, or PUSH_SUBSYSTEM_UP, that executes a syncAll
         start: function () {
             // Guard condition to avoid calling `connectPush` again if the `start` method is called multiple times or if push has been disabled.
             if (disabled || disconnected === false)
@@ -272,6 +275,10 @@ export function pushManagerFactory(params, pollingManager) {
             else
                 setTimeout(connectPush); // server-side runs in next cycle as in client-side, for consistency with client-side
         },
+        // true/false if start or stop was called last respectively
+        isRunning: function () {
+            return disconnected === false;
+        },
         // [Only for client-side]
         add: function (userKey, mySegmentsSyncTask) {
             var hash = hashUserKey(userKey);

package/esm/sync/submitters/eventsSyncTask.js

@@ -1,28 +1,40 @@
 import { submitterSyncTaskFactory } from './submitterSyncTask';
-import { SUBMITTERS_PUSH_FULL_EVENTS_QUEUE } from '../../logger/constants';
+import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
+var DATA_NAME = 'events';
 /**
  * Sync task that periodically posts tracked events
  */
 export function eventsSyncTaskFactory(log, postEventsBulk, eventsCache, eventsPushRate, eventsFirstPushWindow, latencyTracker) {
     // don't retry events.
-    var syncTask = submitterSyncTaskFactory(log, postEventsBulk, eventsCache, eventsPushRate, 'queued events', latencyTracker);
-    // Set a timer for the first push of events,
+    var syncTask = submitterSyncTaskFactory(log, postEventsBulk, eventsCache, eventsPushRate, DATA_NAME, latencyTracker);
+    // Set a timer for the first push window of events.
+    // Not implemented in the base submitter or sync task, since this feature is only used by the events submitter.
     if (eventsFirstPushWindow > 0) {
+        var running_1 = false;
         var stopEventPublisherTimeout_1;
         var originalStart_1 = syncTask.start;
         syncTask.start = function () {
+            running_1 = true;
             stopEventPublisherTimeout_1 = setTimeout(originalStart_1, eventsFirstPushWindow);
         };
         var originalStop_1 = syncTask.stop;
         syncTask.stop = function () {
+            running_1 = false;
             clearTimeout(stopEventPublisherTimeout_1);
             originalStop_1();
         };
+        syncTask.isRunning = function () {
+            return running_1;
+        };
     }
-    // register eventsSubmitter to be executed when events cache is full
+    // register events submitter to be executed when events cache is full
     eventsCache.setOnFullQueueCb(function () {
-        log.info(SUBMITTERS_PUSH_FULL_EVENTS_QUEUE);
-        syncTask.execute();
+        if (syncTask.isRunning()) {
+            log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+            syncTask.execute();
+        }
+        // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.
+        // Data will be sent when submitter is resumed.
     });
     return syncTask;
 }

package/esm/sync/submitters/impressionsSyncTask.js

@@ -1,5 +1,7 @@
 import { groupBy, forOwn } from '../../utils/lang';
 import { submitterSyncTaskFactory } from './submitterSyncTask';
+import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
+var DATA_NAME = 'impressions';
 /**
  * Converts `impressions` data from cache into request payload.
  */
@@ -32,5 +34,15 @@ export function fromImpressionsCollector(sendLabels, data) {
 export function impressionsSyncTaskFactory(log, postTestImpressionsBulk, impressionsCache, impressionsRefreshRate, sendLabels, latencyTracker) {
     if (sendLabels === void 0) { sendLabels = false; }
     // retry impressions only once.
-    return submitterSyncTaskFactory(log, postTestImpressionsBulk, impressionsCache, impressionsRefreshRate, 'impressions', latencyTracker, fromImpressionsCollector.bind(undefined, sendLabels), 1);
+    var syncTask = submitterSyncTaskFactory(log, postTestImpressionsBulk, impressionsCache, impressionsRefreshRate, DATA_NAME, latencyTracker, fromImpressionsCollector.bind(undefined, sendLabels), 1);
+    // register impressions submitter to be executed when impressions cache is full
+    impressionsCache.setOnFullQueueCb(function () {
+        if (syncTask.isRunning()) {
+            log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+            syncTask.execute();
+        }
+        // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.
+        // Data will be sent when submitter is resumed.
+    });
+    return syncTask;
 }

package/esm/sync/syncManagerOnline.js

@@ -1,6 +1,7 @@
 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';
+import { isConsentGranted } from '../consent';
 /**
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.
@@ -14,7 +15,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
      * SyncManager factory for modular SDK
      */
     return function (params) {
-        var _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled;
+        var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled;
         /** Polling Manager */
         var pollingManager = pollingManagerFactory && pollingManagerFactory(params);
         /** Push Manager */
@@ -49,11 +50,16 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
         var running = false; // flag that indicates whether the syncManager has been started (true) or stopped (false)
         var startFirstTime = true; // flag to distinguish calling the `start` method for the first time, to support pausing and resuming the synchronization
         return {
+            // Exposed for fine-grained control of synchronization.
+            // E.g.: user consent, app state changes (Page hide, Foreground/Background, Online/Offline).
+            pollingManager: pollingManager,
             pushManager: pushManager,
+            submitter: submitter,
             /**
              * Method used to start the syncManager for the first time, or resume it after being stopped.
              */
             start: function () {
+                running = true;
                 // start syncing splits and segments
                 if (pollingManager) {
                     if (pushManager) {
@@ -69,29 +75,27 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                     }
                 }
                 // start periodic data recording (events, impressions, telemetry).
-                if (submitter)
+                if (isConsentGranted(settings))
                     submitter.start();
-                running = true;
             },
             /**
              * Method used to stop/pause the syncManager.
              */
             stop: function () {
+                running = false;
                 // stop syncing
                 if (pushManager)
                     pushManager.stop();
                 if (pollingManager && pollingManager.isRunning())
                     pollingManager.stop();
                 // stop periodic data recording (events, impressions, telemetry).
-                if (submitter)
-                    submitter.stop();
-                running = false;
+                submitter.stop();
             },
             isRunning: function () {
                 return running;
             },
             flush: function () {
-                if (submitter)
+                if (isConsentGranted(settings))
                     return submitter.execute();
                 else
                     return Promise.resolve();

package/esm/trackers/eventTracker.js

@@ -1,13 +1,17 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { thenable } from '../utils/promise/thenable';
 import { EVENTS_TRACKER_SUCCESS, ERROR_EVENTS_TRACKER } from '../logger/constants';
+import { CONSENT_DECLINED } from '../utils/constants';
+import { isStorageSync } from './impressionObserver/utils';
 /**
  * Event tracker stores events in cache and pass them to the integrations manager if provided.
  *
  * @param eventsCache cache to save events
  * @param integrationsManager optional event handler used for integrations
  */
-export function eventTrackerFactory(log, eventsCache, integrationsManager) {
+export function eventTrackerFactory(settings, eventsCache, integrationsManager) {
+    var log = settings.log;
+    var isSync = isStorageSync(settings);
     function queueEventsCallback(eventData, tracked) {
         var eventTypeId = eventData.eventTypeId, trafficTypeName = eventData.trafficTypeName, key = eventData.key, value = eventData.value, timestamp = eventData.timestamp, properties = eventData.properties;
         // Logging every prop would be too much.
@@ -33,6 +37,9 @@ export function eventTrackerFactory(log, eventsCache, integrationsManager) {
     }
     return {
         track: function (eventData, size) {
+            if (settings.userConsent === CONSENT_DECLINED) {
+                return isSync ? false : Promise.resolve(false);
+            }
             var tracked = eventsCache.track(eventData, size);
             if (thenable(tracked)) {
                 return tracked.then(queueEventsCallback.bind(null, eventData));

package/esm/trackers/impressionObserver/utils.js

@@ -1,4 +1,4 @@
-import { CONSUMER_PARTIAL_MODE, OPTIMIZED, PRODUCER_MODE, STANDALONE_MODE } from '../../utils/constants';
+import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE, OPTIMIZED, PRODUCER_MODE, STANDALONE_MODE } from '../../utils/constants';
 /**
  * Checks if impressions previous time should be added or not.
  */
@@ -13,3 +13,9 @@ export function shouldBeOptimized(settings) {
         return false;
     return settings.sync.impressionsMode === OPTIMIZED ? true : false;
 }
+/**
+ * Storage is async if mode is consumer or partial consumer
+ */
+export function isStorageSync(settings) {
+    return [CONSUMER_MODE, CONSUMER_PARTIAL_MODE].indexOf(settings.mode) === -1 ? true : false;
+}

package/esm/trackers/impressionsTracker.js

@@ -2,6 +2,7 @@ import { objectAssign } from '../utils/lang/objectAssign';
 import { thenable } from '../utils/promise/thenable';
 import { truncateTimeFrame } from '../utils/time';
 import { IMPRESSIONS_TRACKER_SUCCESS, ERROR_IMPRESSIONS_TRACKER, ERROR_IMPRESSIONS_LISTENER } from '../logger/constants';
+import { CONSENT_DECLINED } from '../utils/constants';
 /**
  * Impressions tracker stores impressions in cache and pass them to the listener and integrations manager if provided.
  *
@@ -12,16 +13,16 @@ import { IMPRESSIONS_TRACKER_SUCCESS, ERROR_IMPRESSIONS_TRACKER, ERROR_IMPRESSIO
  * @param observer optional impression observer. If provided, previous time (pt property) is included in impression instances
  * @param countsCache optional cache to save impressions count. If provided, impressions will be deduped (OPTIMIZED mode)
  */
-export function impressionsTrackerFactory(log, impressionsCache, 
-// @TODO consider passing only an optional integrationsManager to handle impressions
-_a, impressionListener, integrationsManager, 
+export function impressionsTrackerFactory(settings, impressionsCache, integrationsManager, 
 // if observer is provided, it implies `shouldAddPreviousTime` flag (i.e., if impressions previous time should be added or not)
 observer, 
 // if countsCache is provided, it implies `isOptimized` flag (i.e., if impressions should be deduped or not)
 countsCache) {
-    var _b = _a.runtime, ip = _b.ip, hostname = _b.hostname, version = _a.version;
+    var log = settings.log, impressionListener = settings.impressionListener, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname, version = settings.version;
     return {
         track: function (impressions, attributes) {
+            if (settings.userConsent === CONSENT_DECLINED)
+                return;
             var impressionsCount = impressions.length;
             var impressionsToStore = []; // Track only the impressions that are going to be stored
             // Wraps impressions to store and adds previousTime if it corresponds
@@ -65,7 +66,7 @@ countsCache) {
                         // integrationsManager.handleImpression does not throw errors
                         if (integrationsManager)
                             integrationsManager.handleImpression(impressionData);
-                        try { // An exception on the listeners should not break the SDK.
+                        try { // @ts-ignore. An exception on the listeners should not break the SDK.
                             if (impressionListener)
                                 impressionListener.logImpression(impressionData);
                         }

package/esm/utils/constants/index.js

@@ -24,3 +24,7 @@ export var STORAGE_MEMORY = 'MEMORY';
 export var STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
 export var STORAGE_REDIS = 'REDIS';
 export var STORAGE_PLUGGABLE = 'PLUGGABLE';
+// User consent
+export var CONSENT_GRANTED = 'GRANTED'; // The user has granted consent for tracking events and impressions
+export var CONSENT_DECLINED = 'DECLINED'; // The user has declined consent for tracking events and impressions
+export var CONSENT_UNKNOWN = 'UNKNOWN'; // The user has neither granted nor declined consent for tracking events and impressions

package/esm/utils/inputValidation/attributes.js

@@ -3,7 +3,7 @@ import { validateAttribute } from './attribute';
 import { ERROR_NOT_PLAIN_OBJECT } from '../../logger/constants';
 export function validateAttributes(log, maybeAttrs, method) {
     // Attributes are optional
-    if (isObject(maybeAttrs) || maybeAttrs == undefined) // eslint-disable-line eqeqeq
+    if (maybeAttrs == undefined || isObject(maybeAttrs)) // eslint-disable-line eqeqeq
         return maybeAttrs;
     log.error(ERROR_NOT_PLAIN_OBJECT, [method, 'attributes']);
     return false;

package/esm/utils/inputValidation/key.js

@@ -35,7 +35,8 @@ export function validateKey(log, maybeKey, method) {
         var bucketingKey = validateKeyValue(log, maybeKey.bucketingKey, method, 'bucketingKey');
         if (matchingKey && bucketingKey)
             return {
-                matchingKey: matchingKey, bucketingKey: bucketingKey
+                matchingKey: matchingKey,
+                bucketingKey: bucketingKey
             };
         log.error(ERROR_INVALID_KEY_OBJECT, [method]);
         return false;