@splitsoftware/splitio-commons 1.4.2-rc.0 → 1.4.2-rc.1

package/CHANGES.txt

@@ -1,6 +1,7 @@
 1.4.2 (June XX, 2022)
- - Added `autoRequire` configuration for GoogleAnalyticsToSplit integration (See https://help.split.io/hc/en-us/articles/360040838752#google-tag-manager).
+ - Added `sync.enabled` property to SDK configuration to allow synchronize splits and segments only once.
  - Updated telemetry to submit data even if user consent is not granted.
+ - Updated submitters logic, to avoid duplicating the post of impressions to Split cloud when the SDK is destroyed while performing its periodic post of impressions.
 
 1.4.1 (June 13, 2022)
  - Bugfixing - Updated submitters logic, to avoid dropping impressions and events that are being tracked while POST request is pending.

package/cjs/integrations/ga/GaToSplit.js

@@ -10,24 +10,23 @@ var logNameMapper = 'ga-to-split:mapper';
 /**
  * Provides a plugin to use with analytics.js, accounting for the possibility
  * that the global command queue has been renamed or not yet defined.
- * @param window Reference to global object.
- * @param pluginName The plugin name identifier.
- * @param pluginConstructor The plugin constructor function.
- * @param log Logger instance.
- * @param autoRequire If true, log error when auto-require script is not detected
+ * @param {string} pluginName The plugin name identifier.
+ * @param {Function} pluginConstructor The plugin constructor function.
  */
-function providePlugin(window, pluginName, pluginConstructor, log, autoRequire) {
+function providePlugin(pluginName, pluginConstructor) {
     // get reference to global command queue. Init it if not defined yet.
+    // @ts-expect-error
     var gaAlias = window.GoogleAnalyticsObject || 'ga';
     window[gaAlias] = window[gaAlias] || function () {
-        (window[gaAlias].q = window[gaAlias].q || []).push(arguments);
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        (window[gaAlias].q = window[gaAlias].q || []).push(args);
     };
     // provides the plugin for use with analytics.js.
+    // @ts-expect-error
     window[gaAlias]('provide', pluginName, pluginConstructor);
-    if (autoRequire && (!window[gaAlias].q || window[gaAlias].q.push === [].push)) {
-        // Expecting spy on ga.q push method but not found
-        log.error('Auto-require script was expected but not provided.');
-    }
 }
 // Default mapping: object used for building the default mapper from hits to Split events
 var defaultMapping = {
@@ -247,6 +246,6 @@ function GaToSplit(sdkOptions, params) {
         return SplitTracker;
     }());
     // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
-    providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire);
+    providePlugin('splitTracker', SplitTracker);
 }
 exports.GaToSplit = GaToSplit;

package/cjs/sync/syncManagerOnline.js

@@ -19,11 +19,11 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
      * SyncManager factory for modular SDK
      */
     return function (params) {
-        var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled, telemetryTracker = params.telemetryTracker;
+        var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled, syncEnabled = _a.sync.enabled, telemetryTracker = params.telemetryTracker;
         /** Polling Manager */
         var pollingManager = pollingManagerFactory && pollingManagerFactory(params);
         /** Push Manager */
-        var pushManager = streamingEnabled && pollingManager && pushManagerFactory ?
+        var pushManager = syncEnabled && streamingEnabled && pollingManager && pushManagerFactory ?
             pushManagerFactory(params, pollingManager) :
             undefined;
         /** Submitter Manager */
@@ -69,16 +69,25 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                 running = true;
                 // start syncing splits and segments
                 if (pollingManager) {
-                    if (pushManager) {
-                        // Doesn't call `syncAll` when the syncManager is resuming
+                    // If synchronization is disabled pushManager and pollingManager should not start
+                    if (syncEnabled) {
+                        if (pushManager) {
+                            // Doesn't call `syncAll` when the syncManager is resuming
+                            if (startFirstTime) {
+                                pollingManager.syncAll();
+                                startFirstTime = false;
+                            }
+                            pushManager.start();
+                        }
+                        else {
+                            pollingManager.start();
+                        }
+                    }
+                    else {
                         if (startFirstTime) {
                             pollingManager.syncAll();
                             startFirstTime = false;
                         }
-                        pushManager.start();
-                    }
-                    else {
-                        pollingManager.start();
                     }
                 }
                 // start periodic data recording (events, impressions, telemetry).
@@ -112,22 +121,28 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                 return {
                     isRunning: mySegmentsSyncTask.isRunning,
                     start: function () {
-                        if (pushManager) {
-                            if (pollingManager.isRunning()) {
-                                // if doing polling, we must start the periodic fetch of data
-                                if (storage.splits.usesSegments())
-                                    mySegmentsSyncTask.start();
+                        if (syncEnabled) {
+                            if (pushManager) {
+                                if (pollingManager.isRunning()) {
+                                    // if doing polling, we must start the periodic fetch of data
+                                    if (storage.splits.usesSegments())
+                                        mySegmentsSyncTask.start();
+                                }
+                                else {
+                                    // if not polling, we must execute the sync task for the initial fetch
+                                    // of segments since `syncAll` was already executed when starting the main client
+                                    mySegmentsSyncTask.execute();
+                                }
+                                pushManager.add(matchingKey, mySegmentsSyncTask);
                             }
                             else {
-                                // if not polling, we must execute the sync task for the initial fetch
-                                // of segments since `syncAll` was already executed when starting the main client
-                                mySegmentsSyncTask.execute();
+                                if (storage.splits.usesSegments())
+                                    mySegmentsSyncTask.start();
                             }
-                            pushManager.add(matchingKey, mySegmentsSyncTask);
                         }
                         else {
-                            if (storage.splits.usesSegments())
-                                mySegmentsSyncTask.start();
+                            if (!readinessManager.isReady())
+                                mySegmentsSyncTask.execute();
                         }
                     },
                     stop: function () {

package/cjs/sync/syncTask.js

@@ -4,8 +4,8 @@ exports.syncTaskFactory = void 0;
 var constants_1 = require("../logger/constants");
 /**
  * Creates a syncTask that handles the periodic execution of a given task ("start" and "stop" methods).
- * The task can be executed once calling the "execute" method.
- * NOTE: Multiple calls to "execute" are not queued. Use "isExecuting" method to handle synchronization.
+ * The task can be also executed by calling the "execute" method. Multiple execute calls are chained to run secuentially and avoid race conditions.
+ * For example, submitters executed on SDK destroy or full queue, while periodic execution is pending.
  *
  * @param log  Logger instance.
  * @param task  Task to execute that returns a promise that NEVER REJECTS. Otherwise, periodic execution can result in Unhandled Promise Rejections.
@@ -15,8 +15,8 @@ var constants_1 = require("../logger/constants");
  */
 function syncTaskFactory(log, task, period, taskName) {
     if (taskName === void 0) { taskName = 'task'; }
-    // Flag that indicates if the task is being executed
-    var executing = false;
+    // Task promise while it is pending. Undefined once the promise is resolved
+    var pendingTask;
     // flag that indicates if the task periodic execution has been started/stopped.
     var running = false;
     // Auxiliar counter used to avoid race condition when calling `start` & `stop` intermittently
@@ -30,13 +30,19 @@ function syncTaskFactory(log, task, period, taskName) {
         for (var _i = 0; _i < arguments.length; _i++) {
             args[_i] = arguments[_i];
         }
-        executing = true;
+        // If task is executing, chain the new execution
+        if (pendingTask) {
+            return pendingTask.then(function () {
+                return execute.apply(void 0, args);
+            });
+        }
+        // Execute task
         log.debug(constants_1.SYNC_TASK_EXECUTE, [taskName]);
-        return task.apply(void 0, args).then(function (result) {
-            executing = false;
+        pendingTask = task.apply(void 0, args).then(function (result) {
+            pendingTask = undefined;
             return result;
         });
-        // No need to handle promise rejection because it is a pre-condition that provided task never rejects.
+        return pendingTask;
     }
     function periodicExecute(currentRunningId) {
         return execute.apply(void 0, runningArgs).then(function (result) {
@@ -48,10 +54,9 @@ function syncTaskFactory(log, task, period, taskName) {
         });
     }
     return {
-        // @TODO check if we need to queued `execute` calls, to avoid possible race conditions on submitters and updaters with streaming.
         execute: execute,
         isExecuting: function () {
-            return executing;
+            return pendingTask !== undefined;
         },
         start: function () {
             var args = [];

package/cjs/utils/settingsValidation/index.js

@@ -73,7 +73,8 @@ exports.base = {
         splitFilters: undefined,
         // impressions collection mode
         impressionsMode: constants_1.OPTIMIZED,
-        localhostMode: undefined
+        localhostMode: undefined,
+        enabled: true
     },
     // Logger
     log: undefined
@@ -167,6 +168,10 @@ function settingsValidation(config, validationParams) {
         // We are not checking if bases are positive numbers. Thus, we might be reauthenticating immediately (`setTimeout` with NaN or negative number)
         scheduler.pushRetryBackoffBase = fromSecondsToMillis(scheduler.pushRetryBackoffBase);
     }
+    // validate sync enabled
+    if (withDefaults.sync.enabled !== false) { // @ts-ignore, modify readonly prop
+        withDefaults.sync.enabled = true;
+    }
     // validate the `splitFilters` settings and parse splits query
     var splitFiltersValidation = (0, splitFilters_1.validateSplitFilters)(log, withDefaults.sync.splitFilters, withDefaults.mode);
     withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;

package/esm/integrations/ga/GaToSplit.js

@@ -7,24 +7,23 @@ var logNameMapper = 'ga-to-split:mapper';
 /**
  * Provides a plugin to use with analytics.js, accounting for the possibility
  * that the global command queue has been renamed or not yet defined.
- * @param window Reference to global object.
- * @param pluginName The plugin name identifier.
- * @param pluginConstructor The plugin constructor function.
- * @param log Logger instance.
- * @param autoRequire If true, log error when auto-require script is not detected
+ * @param {string} pluginName The plugin name identifier.
+ * @param {Function} pluginConstructor The plugin constructor function.
  */
-function providePlugin(window, pluginName, pluginConstructor, log, autoRequire) {
+function providePlugin(pluginName, pluginConstructor) {
     // get reference to global command queue. Init it if not defined yet.
+    // @ts-expect-error
     var gaAlias = window.GoogleAnalyticsObject || 'ga';
     window[gaAlias] = window[gaAlias] || function () {
-        (window[gaAlias].q = window[gaAlias].q || []).push(arguments);
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        (window[gaAlias].q = window[gaAlias].q || []).push(args);
     };
     // provides the plugin for use with analytics.js.
+    // @ts-expect-error
     window[gaAlias]('provide', pluginName, pluginConstructor);
-    if (autoRequire && (!window[gaAlias].q || window[gaAlias].q.push === [].push)) {
-        // Expecting spy on ga.q push method but not found
-        log.error('Auto-require script was expected but not provided.');
-    }
 }
 // Default mapping: object used for building the default mapper from hits to Split events
 var defaultMapping = {
@@ -241,5 +240,5 @@ export function GaToSplit(sdkOptions, params) {
         return SplitTracker;
     }());
     // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
-    providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire);
+    providePlugin('splitTracker', SplitTracker);
 }

package/esm/sync/syncManagerOnline.js

@@ -16,11 +16,11 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
      * SyncManager factory for modular SDK
      */
     return function (params) {
-        var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled, telemetryTracker = params.telemetryTracker;
+        var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled, syncEnabled = _a.sync.enabled, telemetryTracker = params.telemetryTracker;
         /** Polling Manager */
         var pollingManager = pollingManagerFactory && pollingManagerFactory(params);
         /** Push Manager */
-        var pushManager = streamingEnabled && pollingManager && pushManagerFactory ?
+        var pushManager = syncEnabled && streamingEnabled && pollingManager && pushManagerFactory ?
             pushManagerFactory(params, pollingManager) :
             undefined;
         /** Submitter Manager */
@@ -66,16 +66,25 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                 running = true;
                 // start syncing splits and segments
                 if (pollingManager) {
-                    if (pushManager) {
-                        // Doesn't call `syncAll` when the syncManager is resuming
+                    // If synchronization is disabled pushManager and pollingManager should not start
+                    if (syncEnabled) {
+                        if (pushManager) {
+                            // Doesn't call `syncAll` when the syncManager is resuming
+                            if (startFirstTime) {
+                                pollingManager.syncAll();
+                                startFirstTime = false;
+                            }
+                            pushManager.start();
+                        }
+                        else {
+                            pollingManager.start();
+                        }
+                    }
+                    else {
                         if (startFirstTime) {
                             pollingManager.syncAll();
                             startFirstTime = false;
                         }
-                        pushManager.start();
-                    }
-                    else {
-                        pollingManager.start();
                     }
                 }
                 // start periodic data recording (events, impressions, telemetry).
@@ -109,22 +118,28 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                 return {
                     isRunning: mySegmentsSyncTask.isRunning,
                     start: function () {
-                        if (pushManager) {
-                            if (pollingManager.isRunning()) {
-                                // if doing polling, we must start the periodic fetch of data
-                                if (storage.splits.usesSegments())
-                                    mySegmentsSyncTask.start();
+                        if (syncEnabled) {
+                            if (pushManager) {
+                                if (pollingManager.isRunning()) {
+                                    // if doing polling, we must start the periodic fetch of data
+                                    if (storage.splits.usesSegments())
+                                        mySegmentsSyncTask.start();
+                                }
+                                else {
+                                    // if not polling, we must execute the sync task for the initial fetch
+                                    // of segments since `syncAll` was already executed when starting the main client
+                                    mySegmentsSyncTask.execute();
+                                }
+                                pushManager.add(matchingKey, mySegmentsSyncTask);
                             }
                             else {
-                                // if not polling, we must execute the sync task for the initial fetch
-                                // of segments since `syncAll` was already executed when starting the main client
-                                mySegmentsSyncTask.execute();
+                                if (storage.splits.usesSegments())
+                                    mySegmentsSyncTask.start();
                             }
-                            pushManager.add(matchingKey, mySegmentsSyncTask);
                         }
                         else {
-                            if (storage.splits.usesSegments())
-                                mySegmentsSyncTask.start();
+                            if (!readinessManager.isReady())
+                                mySegmentsSyncTask.execute();
                         }
                     },
                     stop: function () {

package/esm/sync/syncTask.js

@@ -1,8 +1,8 @@
 import { SYNC_TASK_EXECUTE, SYNC_TASK_START, SYNC_TASK_STOP } from '../logger/constants';
 /**
  * Creates a syncTask that handles the periodic execution of a given task ("start" and "stop" methods).
- * The task can be executed once calling the "execute" method.
- * NOTE: Multiple calls to "execute" are not queued. Use "isExecuting" method to handle synchronization.
+ * The task can be also executed by calling the "execute" method. Multiple execute calls are chained to run secuentially and avoid race conditions.
+ * For example, submitters executed on SDK destroy or full queue, while periodic execution is pending.
  *
  * @param log  Logger instance.
  * @param task  Task to execute that returns a promise that NEVER REJECTS. Otherwise, periodic execution can result in Unhandled Promise Rejections.
@@ -12,8 +12,8 @@ import { SYNC_TASK_EXECUTE, SYNC_TASK_START, SYNC_TASK_STOP } from '../logger/co
  */
 export function syncTaskFactory(log, task, period, taskName) {
     if (taskName === void 0) { taskName = 'task'; }
-    // Flag that indicates if the task is being executed
-    var executing = false;
+    // Task promise while it is pending. Undefined once the promise is resolved
+    var pendingTask;
     // flag that indicates if the task periodic execution has been started/stopped.
     var running = false;
     // Auxiliar counter used to avoid race condition when calling `start` & `stop` intermittently
@@ -27,13 +27,19 @@ export function syncTaskFactory(log, task, period, taskName) {
         for (var _i = 0; _i < arguments.length; _i++) {
             args[_i] = arguments[_i];
         }
-        executing = true;
+        // If task is executing, chain the new execution
+        if (pendingTask) {
+            return pendingTask.then(function () {
+                return execute.apply(void 0, args);
+            });
+        }
+        // Execute task
         log.debug(SYNC_TASK_EXECUTE, [taskName]);
-        return task.apply(void 0, args).then(function (result) {
-            executing = false;
+        pendingTask = task.apply(void 0, args).then(function (result) {
+            pendingTask = undefined;
             return result;
         });
-        // No need to handle promise rejection because it is a pre-condition that provided task never rejects.
+        return pendingTask;
     }
     function periodicExecute(currentRunningId) {
         return execute.apply(void 0, runningArgs).then(function (result) {
@@ -45,10 +51,9 @@ export function syncTaskFactory(log, task, period, taskName) {
         });
     }
     return {
-        // @TODO check if we need to queued `execute` calls, to avoid possible race conditions on submitters and updaters with streaming.
         execute: execute,
         isExecuting: function () {
-            return executing;
+            return pendingTask !== undefined;
         },
         start: function () {
             var args = [];

package/esm/utils/settingsValidation/index.js

@@ -70,7 +70,8 @@ export var base = {
         splitFilters: undefined,
         // impressions collection mode
         impressionsMode: OPTIMIZED,
-        localhostMode: undefined
+        localhostMode: undefined,
+        enabled: true
     },
     // Logger
     log: undefined
@@ -164,6 +165,10 @@ export function settingsValidation(config, validationParams) {
         // We are not checking if bases are positive numbers. Thus, we might be reauthenticating immediately (`setTimeout` with NaN or negative number)
         scheduler.pushRetryBackoffBase = fromSecondsToMillis(scheduler.pushRetryBackoffBase);
     }
+    // validate sync enabled
+    if (withDefaults.sync.enabled !== false) { // @ts-ignore, modify readonly prop
+        withDefaults.sync.enabled = true;
+    }
     // validate the `splitFilters` settings and parse splits query
     var splitFiltersValidation = validateSplitFilters(log, withDefaults.sync.splitFilters, withDefaults.mode);
     withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;

package/package.json

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

package/src/integrations/ga/GaToSplit.ts

@@ -19,26 +19,20 @@ const logNameMapper = 'ga-to-split:mapper';
 /**
  * Provides a plugin to use with analytics.js, accounting for the possibility
  * that the global command queue has been renamed or not yet defined.
- * @param window Reference to global object.
- * @param pluginName The plugin name identifier.
- * @param pluginConstructor The plugin constructor function.
- * @param log Logger instance.
- * @param autoRequire If true, log error when auto-require script is not detected
+ * @param {string} pluginName The plugin name identifier.
+ * @param {Function} pluginConstructor The plugin constructor function.
  */
-function providePlugin(window: any, pluginName: string, pluginConstructor: Function, log: ILogger, autoRequire?: boolean) {
+function providePlugin(pluginName: string, pluginConstructor: Function) {
   // get reference to global command queue. Init it if not defined yet.
+  // @ts-expect-error
   const gaAlias = window.GoogleAnalyticsObject || 'ga';
-  window[gaAlias] = window[gaAlias] || function () {
-    (window[gaAlias].q = window[gaAlias].q || []).push(arguments);
+  window[gaAlias] = window[gaAlias] || function (...args: any[]) { // @ts-expect-error
+    (window[gaAlias].q = window[gaAlias].q || []).push(args);
   };
 
   // provides the plugin for use with analytics.js.
+  // @ts-expect-error
   window[gaAlias]('provide', pluginName, pluginConstructor);
-
-  if (autoRequire && (!window[gaAlias].q || window[gaAlias].q.push === [].push)) {
-    // Expecting spy on ga.q push method but not found
-    log.error('Auto-require script was expected but not provided.');
-  }
 }
 
 // Default mapping: object used for building the default mapper from hits to Split events
@@ -290,5 +284,5 @@ export function GaToSplit(sdkOptions: GoogleAnalyticsToSplitOptions, params: IIn
   }
 
   // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
-  providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire);
+  providePlugin('splitTracker', SplitTracker);
 }

package/src/integrations/ga/types.ts

@@ -53,24 +53,13 @@ export interface GoogleAnalyticsToSplitOptions {
    * If not provided, events are sent using the key and traffic type provided at SDK config
    */
   identities?: Identity[],
-  /**
-   * Optional flag to log an error if the `auto-require` script is not detected.
-   * The auto-require script automatically requires the `splitTracker` plugin for created trackers,
-   * and should be placed right after your Google Analytics, GTM or gtag.js script tag.
-   *
-   * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-tag-manager}
-   *
-   * @property {boolean} autoRequire
-   * @default false
-   */
-  autoRequire?: boolean,
 }
 
 /**
  * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
  * Used by the browser variant of the isomorphic JS SDK.
  *
- * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-analytics-to-split}
+ * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#google-analytics-to-split}
  */
 export interface IGoogleAnalyticsToSplitConfig extends GoogleAnalyticsToSplitOptions {
   type: 'GOOGLE_ANALYTICS_TO_SPLIT'
@@ -140,7 +129,7 @@ export interface SplitToGoogleAnalyticsOptions {
  * Enable 'Split to Google Analytics' integration, to track Split impressions and events as Google Analytics hits.
  * Used by the browser variant of the isomorphic JS SDK.
  *
- * @see {@link https://help.split.io/hc/en-us/articles/360040838752#split-to-google-analytics}
+ * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#split-to-google-analytics}
  */
 export interface ISplitToGoogleAnalyticsConfig extends SplitToGoogleAnalyticsOptions {
   type: 'SPLIT_TO_GOOGLE_ANALYTICS'

package/src/sdkClient/clientAttributesDecoration.ts

@@ -5,7 +5,7 @@ import { ILogger } from '../logger/types';
 import { objectAssign } from '../utils/lang/objectAssign';
 
 /**
- * Add in memory attributes storage methods and combine them with any attribute received from the getTreatment/s call 
+ * Add in memory attributes storage methods and combine them with any attribute received from the getTreatment/s call
  */
 export function clientAttributesDecoration<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(log: ILogger, client: TClient) {
 
@@ -52,10 +52,10 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
     getTreatments: getTreatments,
     getTreatmentsWithConfig: getTreatmentsWithConfig,
     track: track,
-    
+
     /**
      * Add an attribute to client's in memory attributes storage
-     * 
+     *
      * @param {string} attributeName Attrinute name
      * @param {string, number, boolean, list} attributeValue Attribute value
      * @returns {boolean} true if the attribute was stored and false otherways
@@ -70,7 +70,7 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
 
     /**
      * Returns the attribute with the given key
-     * 
+     *
      * @param {string} attributeName Attribute name
      * @returns {Object} Attribute with the given key
      */
@@ -81,7 +81,7 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
 
     /**
      * Add to client's in memory attributes storage the attributes in 'attributes'
-     * 
+     *
      * @param {Object} attributes Object with attributes to store
      * @returns true if attributes were stored an false otherways
      */
@@ -92,7 +92,7 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
 
     /**
      * Return all the attributes stored in client's in memory attributes storage
-     * 
+     *
      * @returns {Object} returns all the stored attributes
      */
     getAttributes(): Record<string, Object> {
@@ -101,8 +101,8 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
 
     /**
      * Removes from client's in memory attributes storage the attribute with the given key
-     * 
-     * @param {string} attributeName 
+     *
+     * @param {string} attributeName
      * @returns {boolean} true if attribute was removed and false otherways
      */
     removeAttribute(attributeName: string) {
@@ -116,7 +116,7 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
     clearAttributes() {
       return attributeStorage.clear();
     }
-    
+
   });
 
 }

package/src/sync/syncManagerOnline.ts

@@ -28,13 +28,13 @@ export function syncManagerOnlineFactory(
    */
   return function (params: ISdkFactoryContextSync): ISyncManagerCS {
 
-    const { settings, settings: { log, streamingEnabled }, telemetryTracker } = params;
+    const { settings, settings: { log, streamingEnabled, sync: { enabled: syncEnabled } },  telemetryTracker } = params;
 
     /** Polling Manager */
     const pollingManager = pollingManagerFactory && pollingManagerFactory(params);
 
     /** Push Manager */
-    const pushManager = streamingEnabled && pollingManager && pushManagerFactory ?
+    const pushManager = syncEnabled && streamingEnabled && pollingManager && pushManagerFactory ?
       pushManagerFactory(params, pollingManager) :
       undefined;
 
@@ -89,15 +89,24 @@ export function syncManagerOnlineFactory(
 
         // start syncing splits and segments
         if (pollingManager) {
-          if (pushManager) {
-            // Doesn't call `syncAll` when the syncManager is resuming
+
+          // If synchronization is disabled pushManager and pollingManager should not start
+          if (syncEnabled) {
+            if (pushManager) {
+              // Doesn't call `syncAll` when the syncManager is resuming
+              if (startFirstTime) {
+                pollingManager.syncAll();
+                startFirstTime = false;
+              }
+              pushManager.start();
+            } else {
+              pollingManager.start();
+            }
+          } else {
             if (startFirstTime) {
               pollingManager.syncAll();
               startFirstTime = false;
             }
-            pushManager.start();
-          } else {
-            pollingManager.start();
           }
         }
 
@@ -137,18 +146,22 @@ export function syncManagerOnlineFactory(
         return {
           isRunning: mySegmentsSyncTask.isRunning,
           start() {
-            if (pushManager) {
-              if (pollingManager!.isRunning()) {
-                // if doing polling, we must start the periodic fetch of data
-                if (storage.splits.usesSegments()) mySegmentsSyncTask.start();
+            if (syncEnabled) {
+              if (pushManager) {
+                if (pollingManager!.isRunning()) {
+                  // if doing polling, we must start the periodic fetch of data
+                  if (storage.splits.usesSegments()) mySegmentsSyncTask.start();
+                } else {
+                  // if not polling, we must execute the sync task for the initial fetch
+                  // of segments since `syncAll` was already executed when starting the main client
+                  mySegmentsSyncTask.execute();
+                }
+                pushManager.add(matchingKey, mySegmentsSyncTask);
               } else {
-                // if not polling, we must execute the sync task for the initial fetch
-                // of segments since `syncAll` was already executed when starting the main client
-                mySegmentsSyncTask.execute();
+                if (storage.splits.usesSegments()) mySegmentsSyncTask.start();
               }
-              pushManager.add(matchingKey, mySegmentsSyncTask);
             } else {
-              if (storage.splits.usesSegments()) mySegmentsSyncTask.start();
+              if (!readinessManager.isReady()) mySegmentsSyncTask.execute();
             }
           },
           stop() {

package/src/sync/syncTask.ts

@@ -4,8 +4,8 @@ import { ISyncTask } from './types';
 
 /**
  * Creates a syncTask that handles the periodic execution of a given task ("start" and "stop" methods).
- * The task can be executed once calling the "execute" method.
- * NOTE: Multiple calls to "execute" are not queued. Use "isExecuting" method to handle synchronization.
+ * The task can be also executed by calling the "execute" method. Multiple execute calls are chained to run secuentially and avoid race conditions.
+ * For example, submitters executed on SDK destroy or full queue, while periodic execution is pending.
  *
  * @param log  Logger instance.
  * @param task  Task to execute that returns a promise that NEVER REJECTS. Otherwise, periodic execution can result in Unhandled Promise Rejections.
@@ -15,8 +15,8 @@ import { ISyncTask } from './types';
  */
 export function syncTaskFactory<Input extends any[], Output = any>(log: ILogger, task: (...args: Input) => Promise<Output>, period: number, taskName = 'task'): ISyncTask<Input, Output> {
 
-  // Flag that indicates if the task is being executed
-  let executing = false;
+  // Task promise while it is pending. Undefined once the promise is resolved
+  let pendingTask: Promise<Output> | undefined;
   // flag that indicates if the task periodic execution has been started/stopped.
   let running = false;
   // Auxiliar counter used to avoid race condition when calling `start` & `stop` intermittently
@@ -26,14 +26,21 @@ export function syncTaskFactory<Input extends any[], Output = any>(log: ILogger,
   // Id of the periodic call timeout
   let timeoutID: any;
 
-  function execute(...args: Input) {
-    executing = true;
+  function execute(...args: Input): Promise<Output> {
+    // If task is executing, chain the new execution
+    if (pendingTask) {
+      return pendingTask.then(() => {
+        return execute(...args);
+      });
+    }
+
+    // Execute task
     log.debug(SYNC_TASK_EXECUTE, [taskName]);
-    return task(...args).then(result => {
-      executing = false;
+    pendingTask = task(...args).then(result => {
+      pendingTask = undefined;
       return result;
     });
-    // No need to handle promise rejection because it is a pre-condition that provided task never rejects.
+    return pendingTask;
   }
 
   function periodicExecute(currentRunningId: number) {
@@ -46,11 +53,10 @@ export function syncTaskFactory<Input extends any[], Output = any>(log: ILogger,
   }
 
   return {
-    // @TODO check if we need to queued `execute` calls, to avoid possible race conditions on submitters and updaters with streaming.
     execute,
 
     isExecuting() {
-      return executing;
+      return pendingTask !== undefined;
     },
 
     start(...args: Input) {

package/src/types.ts

@@ -117,7 +117,8 @@ export interface ISettings {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
     __splitFiltersValidation: ISplitFiltersValidation,
-    localhostMode?: SplitIO.LocalhostFactory
+    localhostMode?: SplitIO.LocalhostFactory,
+    enabled: boolean
   },
   readonly runtime: {
     ip: string | false
@@ -214,6 +215,11 @@ interface ISharedSettings {
      * @default 'OPTIMIZED'
      */
     impressionsMode?: SplitIO.ImpressionsMode,
+    /**
+     * Enables synchronization.
+     * @property {boolean} enabled
+     */
+    enabled: boolean
   }
 }
 /**

package/src/utils/settingsValidation/index.ts

@@ -83,7 +83,8 @@ export const base = {
     splitFilters: undefined,
     // impressions collection mode
     impressionsMode: OPTIMIZED,
-    localhostMode: undefined
+    localhostMode: undefined,
+    enabled: true
   },
 
   // Logger
@@ -191,6 +192,11 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
     scheduler.pushRetryBackoffBase = fromSecondsToMillis(scheduler.pushRetryBackoffBase);
   }
 
+  // validate sync enabled
+  if (withDefaults.sync.enabled !== false) { // @ts-ignore, modify readonly prop
+    withDefaults.sync.enabled = true;
+  }
+
   // validate the `splitFilters` settings and parse splits query
   const splitFiltersValidation = validateSplitFilters(log, withDefaults.sync.splitFilters, withDefaults.mode);
   withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;

package/types/integrations/ga/types.d.ts

@@ -52,23 +52,12 @@ export interface GoogleAnalyticsToSplitOptions {
      * If not provided, events are sent using the key and traffic type provided at SDK config
      */
     identities?: Identity[];
-    /**
-     * Optional flag to log an error if the `auto-require` script is not detected.
-     * The auto-require script automatically requires the `splitTracker` plugin for created trackers,
-     * and should be placed right after your Google Analytics, GTM or gtag.js script tag.
-     *
-     * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-tag-manager}
-     *
-     * @property {boolean} autoRequire
-     * @default false
-     */
-    autoRequire?: boolean;
 }
 /**
  * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
  * Used by the browser variant of the isomorphic JS SDK.
  *
- * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-analytics-to-split}
+ * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#google-analytics-to-split}
  */
 export interface IGoogleAnalyticsToSplitConfig extends GoogleAnalyticsToSplitOptions {
     type: 'GOOGLE_ANALYTICS_TO_SPLIT';
@@ -136,7 +125,7 @@ export interface SplitToGoogleAnalyticsOptions {
  * Enable 'Split to Google Analytics' integration, to track Split impressions and events as Google Analytics hits.
  * Used by the browser variant of the isomorphic JS SDK.
  *
- * @see {@link https://help.split.io/hc/en-us/articles/360040838752#split-to-google-analytics}
+ * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#split-to-google-analytics}
  */
 export interface ISplitToGoogleAnalyticsConfig extends SplitToGoogleAnalyticsOptions {
     type: 'SPLIT_TO_GOOGLE_ANALYTICS';

package/types/sync/syncTask.d.ts

@@ -2,8 +2,8 @@ import { ILogger } from '../logger/types';
 import { ISyncTask } from './types';
 /**
  * Creates a syncTask that handles the periodic execution of a given task ("start" and "stop" methods).
- * The task can be executed once calling the "execute" method.
- * NOTE: Multiple calls to "execute" are not queued. Use "isExecuting" method to handle synchronization.
+ * The task can be also executed by calling the "execute" method. Multiple execute calls are chained to run secuentially and avoid race conditions.
+ * For example, submitters executed on SDK destroy or full queue, while periodic execution is pending.
  *
  * @param log  Logger instance.
  * @param task  Task to execute that returns a promise that NEVER REJECTS. Otherwise, periodic execution can result in Unhandled Promise Rejections.

package/types/types.d.ts

@@ -112,6 +112,7 @@ export interface ISettings {
         impressionsMode: SplitIO.ImpressionsMode;
         __splitFiltersValidation: ISplitFiltersValidation;
         localhostMode?: SplitIO.LocalhostFactory;
+        enabled: boolean;
     };
     readonly runtime: {
         ip: string | false;
@@ -208,6 +209,11 @@ interface ISharedSettings {
          * @default 'OPTIMIZED'
          */
         impressionsMode?: SplitIO.ImpressionsMode;
+        /**
+         * Enables synchronization.
+         * @property {boolean} enabled
+         */
+        enabled: boolean;
     };
 }
 /**

package/types/utils/settingsValidation/index.d.ts

@@ -37,6 +37,7 @@ export declare const base: {
         splitFilters: undefined;
         impressionsMode: string;
         localhostMode: undefined;
+        enabled: boolean;
     };
     log: undefined;
 };

package/cjs/integrations/ga/autoRequire.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.autoRequire = void 0;
-/* eslint-disable no-undef */
-/**
- * Auto-require script to use with GaToSplit integration
- */
-function autoRequire() {
-    (function (i, r, s) {
-        i[s] = i[s] || r;
-        i[r] = i[r] || function () { i[r].q.push(arguments); };
-        i[r].q = i[r].q || [];
-        var ts = {}; // Tracker names
-        var o = i[r].q.push;
-        i[r].q.push = function (v) {
-            var result = o.apply(this, arguments);
-            if (v && v[0] === 'create') {
-                var t = typeof v[2] === 'object' && typeof v[2].name === 'string' ?
-                    v[2].name : // `ga('create', 'UA-ID', { name: 'trackerName', ... })`
-                    typeof v[3] === 'object' && typeof v[3].name === 'string' ?
-                        v[3].name : // `ga('create', 'UA-ID', 'auto', { name: 'trackerName', ... })`
-                        typeof v[3] === 'string' ?
-                            v[3] : // `ga('create', 'UA-ID', 'auto', 'trackerName')`
-                            undefined; // No name tracker, e.g.: `ga('create', 'UA-ID', 'auto')`
-                if (!ts[t]) {
-                    ts[t] = true;
-                    i[r](t ? t + '.require' : 'require', 'splitTracker'); // Auto-require
-                }
-            }
-            return result;
-        };
-    })(window, 'ga', 'GoogleAnalyticsObject');
-}
-exports.autoRequire = autoRequire;

package/esm/integrations/ga/autoRequire.js

@@ -1,30 +0,0 @@
-/* eslint-disable no-undef */
-/**
- * Auto-require script to use with GaToSplit integration
- */
-export function autoRequire() {
-    (function (i, r, s) {
-        i[s] = i[s] || r;
-        i[r] = i[r] || function () { i[r].q.push(arguments); };
-        i[r].q = i[r].q || [];
-        var ts = {}; // Tracker names
-        var o = i[r].q.push;
-        i[r].q.push = function (v) {
-            var result = o.apply(this, arguments);
-            if (v && v[0] === 'create') {
-                var t = typeof v[2] === 'object' && typeof v[2].name === 'string' ?
-                    v[2].name : // `ga('create', 'UA-ID', { name: 'trackerName', ... })`
-                    typeof v[3] === 'object' && typeof v[3].name === 'string' ?
-                        v[3].name : // `ga('create', 'UA-ID', 'auto', { name: 'trackerName', ... })`
-                        typeof v[3] === 'string' ?
-                            v[3] : // `ga('create', 'UA-ID', 'auto', 'trackerName')`
-                            undefined; // No name tracker, e.g.: `ga('create', 'UA-ID', 'auto')`
-                if (!ts[t]) {
-                    ts[t] = true;
-                    i[r](t ? t + '.require' : 'require', 'splitTracker'); // Auto-require
-                }
-            }
-            return result;
-        };
-    })(window, 'ga', 'GoogleAnalyticsObject');
-}

package/src/integrations/ga/autoRequire.ts

@@ -1,35 +0,0 @@
-/* eslint-disable no-undef */
-/**
- * Auto-require script to use with GaToSplit integration
- */
-export function autoRequire() {
-  (function (i: any, r: string, s: string) {
-    i[s] = i[s] || r;
-    i[r] = i[r] || function () { i[r].q.push(arguments); };
-    i[r].q = i[r].q || [];
-
-    var ts: any = {}; // Tracker names
-    var o = i[r].q.push;
-    i[r].q.push = function (v: any) {
-      var result = o.apply(this, arguments);
-
-      if (v && v[0] === 'create') {
-        var t = typeof v[2] === 'object' && typeof v[2].name === 'string' ?
-          v[2].name : // `ga('create', 'UA-ID', { name: 'trackerName', ... })`
-          typeof v[3] === 'object' && typeof v[3].name === 'string' ?
-            v[3].name : // `ga('create', 'UA-ID', 'auto', { name: 'trackerName', ... })`
-            typeof v[3] === 'string' ?
-              v[3] : // `ga('create', 'UA-ID', 'auto', 'trackerName')`
-              undefined; // No name tracker, e.g.: `ga('create', 'UA-ID', 'auto')`
-
-        if (!ts[t]) {
-          ts[t] = true;
-          i[r](t ? t + '.require' : 'require', 'splitTracker'); // Auto-require
-        }
-      }
-
-      return result;
-    };
-
-  })(window, 'ga', 'GoogleAnalyticsObject');
-}