@splitsoftware/splitio-commons 1.3.2-rc.6 → 1.4.1-rc.0

package/CHANGES.txt

@@ -1,4 +1,4 @@
-1.4.0 (May 20, 2022)
+1.4.0 (May 24, 2022)
  - Added `scheduler.telemetryRefreshRate` property to SDK configuration, and deprecated `scheduler.metricsRefreshRate` property.
  - Updated SDK telemetry storage, metrics and updater to be more effective and send less often.
  - Bugfixing - Updated default values for `scheduler.impressionsRefreshRate` config parameter: 300s for OPTIMIZED impression mode and 60s for DEBUG impression mode.

package/cjs/integrations/ga/GaToSplit.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GaToSplit = exports.fixEventTypeId = exports.validateEventData = exports.validateIdentities = exports.defaultPrefix = exports.defaultMapper = void 0;
+exports.autoRequireScript = exports.GaToSplit = exports.fixEventTypeId = exports.validateEventData = exports.validateIdentities = exports.defaultPrefix = exports.defaultMapper = void 0;
 /* eslint-disable no-undef */
 var objectAssign_1 = require("../../utils/lang/objectAssign");
 var lang_1 = require("../../utils/lang");
@@ -12,8 +12,9 @@ var logNameMapper = 'ga-to-split:mapper';
  * that the global command queue has been renamed or not yet defined.
  * @param {string} pluginName The plugin name identifier.
  * @param {Function} pluginConstructor The plugin constructor function.
+ * @param {boolean} autoRequire Whether the integration should automatically queue a 'require' command for each 'create' command.
  */
-function providePlugin(pluginName, pluginConstructor) {
+function providePlugin(pluginName, pluginConstructor, autoRequire) {
     // get reference to global command queue. Init it if not defined yet.
     // @ts-expect-error
     var gaAlias = window.GoogleAnalyticsObject || 'ga';
@@ -27,6 +28,8 @@ function providePlugin(pluginName, pluginConstructor) {
     // provides the plugin for use with analytics.js.
     // @ts-expect-error
     window[gaAlias]('provide', pluginName, pluginConstructor);
+    if (autoRequire)
+        autoRequireScript();
 }
 // Default mapping: object used for building the default mapper from hits to Split events
 var defaultMapping = {
@@ -246,6 +249,34 @@ 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('splitTracker', SplitTracker);
+    providePlugin('splitTracker', SplitTracker, sdkOptions.autoRequire);
 }
 exports.GaToSplit = GaToSplit;
+function autoRequireScript() {
+    (function (i, r) {
+        i['GoogleAnalyticsObject'] = 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; // Reference to Array.prototype.push
+        i[r].q.push = function () {
+            var result = o.apply(this, arguments);
+            var v = arguments[0];
+            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, `ga('create', 'UA-ID', 'auto')`
+                if (!ts[t]) {
+                    ts[t] = true;
+                    i[r](t ? t + '.require' : 'require', 'splitTracker'); // Auto-require
+                }
+            }
+            return result;
+        };
+    })(window, 'ga');
+}
+exports.autoRequireScript = autoRequireScript;

package/cjs/utils/settingsValidation/index.js

@@ -112,16 +112,9 @@ function settingsValidation(config, validationParams) {
     scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
     scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
     scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
-    if (scheduler.impressionsRefreshRate !== exports.base.scheduler.impressionsRefreshRate) {
-        // Validate impressionsRefreshRate defined by user
-        scheduler.impressionsRefreshRate = validateMinValue('impressionsRefreshRate', scheduler.impressionsRefreshRate, withDefaults.sync.impressionsMode === constants_1.DEBUG ? 1 : 60 // Min is 1 sec for DEBUG and 60 secs for OPTIMIZED
-        );
-    }
-    else {
-        // Default impressionsRefreshRate for DEBUG mode is 60 secs
-        if (withDefaults.sync.impressionsMode === constants_1.DEBUG)
-            scheduler.impressionsRefreshRate = 60;
-    }
+    // Default impressionsRefreshRate for DEBUG mode is 60 secs
+    if ((0, lang_1.get)(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === constants_1.DEBUG)
+        scheduler.impressionsRefreshRate = 60;
     scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
     // Log deprecation for old telemetry param
     if (scheduler.metricsRefreshRate)

package/esm/integrations/ga/GaToSplit.js

@@ -9,8 +9,9 @@ var logNameMapper = 'ga-to-split:mapper';
  * that the global command queue has been renamed or not yet defined.
  * @param {string} pluginName The plugin name identifier.
  * @param {Function} pluginConstructor The plugin constructor function.
+ * @param {boolean} autoRequire Whether the integration should automatically queue a 'require' command for each 'create' command.
  */
-function providePlugin(pluginName, pluginConstructor) {
+function providePlugin(pluginName, pluginConstructor, autoRequire) {
     // get reference to global command queue. Init it if not defined yet.
     // @ts-expect-error
     var gaAlias = window.GoogleAnalyticsObject || 'ga';
@@ -24,6 +25,8 @@ function providePlugin(pluginName, pluginConstructor) {
     // provides the plugin for use with analytics.js.
     // @ts-expect-error
     window[gaAlias]('provide', pluginName, pluginConstructor);
+    if (autoRequire)
+        autoRequireScript();
 }
 // Default mapping: object used for building the default mapper from hits to Split events
 var defaultMapping = {
@@ -240,5 +243,32 @@ 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('splitTracker', SplitTracker);
+    providePlugin('splitTracker', SplitTracker, sdkOptions.autoRequire);
+}
+export function autoRequireScript() {
+    (function (i, r) {
+        i['GoogleAnalyticsObject'] = 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; // Reference to Array.prototype.push
+        i[r].q.push = function () {
+            var result = o.apply(this, arguments);
+            var v = arguments[0];
+            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, `ga('create', 'UA-ID', 'auto')`
+                if (!ts[t]) {
+                    ts[t] = true;
+                    i[r](t ? t + '.require' : 'require', 'splitTracker'); // Auto-require
+                }
+            }
+            return result;
+        };
+    })(window, 'ga');
 }

package/esm/utils/settingsValidation/index.js

@@ -1,4 +1,4 @@
-import { merge } from '../lang';
+import { merge, get } from '../lang';
 import { mode } from './mode';
 import { validateSplitFilters } from './splitFilters';
 import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG } from '../constants';
@@ -109,16 +109,9 @@ export function settingsValidation(config, validationParams) {
     scheduler.offlineRefreshRate = fromSecondsToMillis(scheduler.offlineRefreshRate);
     scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
     scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
-    if (scheduler.impressionsRefreshRate !== base.scheduler.impressionsRefreshRate) {
-        // Validate impressionsRefreshRate defined by user
-        scheduler.impressionsRefreshRate = validateMinValue('impressionsRefreshRate', scheduler.impressionsRefreshRate, withDefaults.sync.impressionsMode === DEBUG ? 1 : 60 // Min is 1 sec for DEBUG and 60 secs for OPTIMIZED
-        );
-    }
-    else {
-        // Default impressionsRefreshRate for DEBUG mode is 60 secs
-        if (withDefaults.sync.impressionsMode === DEBUG)
-            scheduler.impressionsRefreshRate = 60;
-    }
+    // Default impressionsRefreshRate for DEBUG mode is 60 secs
+    if (get(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === DEBUG)
+        scheduler.impressionsRefreshRate = 60;
     scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
     // Log deprecation for old telemetry param
     if (scheduler.metricsRefreshRate)

package/package.json

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

package/src/integrations/ga/GaToSplit.ts

@@ -21,8 +21,9 @@ const logNameMapper = 'ga-to-split:mapper';
  * that the global command queue has been renamed or not yet defined.
  * @param {string} pluginName The plugin name identifier.
  * @param {Function} pluginConstructor The plugin constructor function.
+ * @param {boolean} autoRequire Whether the integration should automatically queue a 'require' command for each 'create' command.
  */
-function providePlugin(pluginName: string, pluginConstructor: Function) {
+function providePlugin(pluginName: string, pluginConstructor: Function, autoRequire?: boolean) {
   // get reference to global command queue. Init it if not defined yet.
   // @ts-expect-error
   const gaAlias = window.GoogleAnalyticsObject || 'ga';
@@ -33,6 +34,8 @@ function providePlugin(pluginName: string, pluginConstructor: Function) {
   // provides the plugin for use with analytics.js.
   // @ts-expect-error
   window[gaAlias]('provide', pluginName, pluginConstructor);
+
+  if (autoRequire) autoRequireScript();
 }
 
 // Default mapping: object used for building the default mapper from hits to Split events
@@ -284,5 +287,38 @@ 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('splitTracker', SplitTracker);
+  providePlugin('splitTracker', SplitTracker, sdkOptions.autoRequire);
+}
+
+export function autoRequireScript() {
+  (function (i: any, r: any) {
+    i['GoogleAnalyticsObject'] = 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; // Reference to Array.prototype.push
+    i[r].q.push = function () {
+      var result = o.apply(this, arguments);
+
+      var v = arguments[0];
+      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, `ga('create', 'UA-ID', 'auto')`
+
+        if (!ts[t]) {
+          ts[t] = true;
+          i[r](t ? t + '.require' : 'require', 'splitTracker'); // Auto-require
+        }
+      }
+
+      return result;
+    };
+
+  })(window, 'ga');
 }

package/src/integrations/ga/types.ts

@@ -53,6 +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 automatically require the `splitTracker` plugin for all created trackers.
+   * If true, it will spy on the ga command queue, and run `ga('[trackerName].require', 'splitTracker');` for each 'create' command.
+   * @property {boolean} autoRequire
+   * @default false
+   */
+  autoRequire?: boolean,
 }
 
 /**

package/src/utils/lang/index.ts

@@ -71,7 +71,7 @@ export function forOwn<T>(obj: { [key: string]: T }, iteratee: (value: T, key: s
  * Safely retrieve the specified prop from obj. If we can't retrieve
  * that property value, we return the default value.
  */
-export function get(obj: any, prop: any, val: any): any {
+export function get(obj: any, prop: any, val?: any): any {
   let res = val;
 
   try { // No risks nor lots of checks.

package/src/utils/settingsValidation/index.ts

@@ -1,4 +1,4 @@
-import { merge } from '../lang';
+import { merge, get } from '../lang';
 import { mode } from './mode';
 import { validateSplitFilters } from './splitFilters';
 import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG } from '../constants';
@@ -131,15 +131,8 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
   scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
 
-  if (scheduler.impressionsRefreshRate !== base.scheduler.impressionsRefreshRate) {
-    // Validate impressionsRefreshRate defined by user
-    scheduler.impressionsRefreshRate = validateMinValue('impressionsRefreshRate', scheduler.impressionsRefreshRate,
-      withDefaults.sync.impressionsMode === DEBUG ? 1 : 60 // Min is 1 sec for DEBUG and 60 secs for OPTIMIZED
-    );
-  } else {
-    // Default impressionsRefreshRate for DEBUG mode is 60 secs
-    if (withDefaults.sync.impressionsMode === DEBUG) scheduler.impressionsRefreshRate = 60;
-  }
+  // Default impressionsRefreshRate for DEBUG mode is 60 secs
+  if (get(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === DEBUG) scheduler.impressionsRefreshRate = 60;
   scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
 
   // Log deprecation for old telemetry param

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

@@ -38,3 +38,4 @@ export declare function fixEventTypeId(log: ILogger, eventTypeId: any): any;
  * @param {object} log factory logger
  */
 export declare function GaToSplit(sdkOptions: GoogleAnalyticsToSplitOptions, params: IIntegrationFactoryParams): void;
+export declare function autoRequireScript(): void;

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

@@ -52,6 +52,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 automatically require the `splitTracker` plugin for all created trackers.
+     * If true, it will spy on the ga command queue, and run `ga('[trackerName].require', 'splitTracker');` for each 'create' command.
+     * @property {boolean} autoRequire
+     * @default false
+     */
+    autoRequire?: boolean;
 }
 /**
  * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.

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

@@ -28,7 +28,7 @@ export declare function forOwn<T>(obj: {
  * Safely retrieve the specified prop from obj. If we can't retrieve
  * that property value, we return the default value.
  */
-export declare function get(obj: any, prop: any, val: any): any;
+export declare function get(obj: any, prop: any, val?: any): any;
 /**
  * Parses an array into a map of different arrays, grouping by the specified prop value.
  */