@splitsoftware/splitio 10.17.3 → 10.17.4-rc.2

package/es/integrations/ga/GaToSplit.js

@@ -1,246 +0,0 @@
-import objectAssign from 'object-assign';
-import { isString, numberIsFinite, unicAsStrings } from '../../utils/lang';
-import logFactory from '../../utils/logger';
-import { validateEvent, validateEventValue, validateEventProperties, validateKey, validateTrafficType } from '../../utils/inputValidation';
-var logName = 'splitio-ga-to-split',
-    logNameMapper = logName + ':mapper';
-var log = logFactory(logName);
-/**
- * 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 {string} pluginName The plugin name identifier.
- * @param {Function} pluginConstructor The plugin constructor function.
- */
-
-function providePlugin(pluginName, pluginConstructor) {
-  // get reference to global command queue. Init it if not defined yet.
-  var gaAlias = window.GoogleAnalyticsObject || 'ga';
-
-  window[gaAlias] = window[gaAlias] || function () {
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-
-    (window[gaAlias].q = window[gaAlias].q || []).push(args);
-  }; // provides the plugin for use with analytics.js.
-
-
-  window[gaAlias]('provide', pluginName, pluginConstructor);
-} // Default mapping: object used for building the default mapper from hits to Split events
-
-
-var defaultMapping = {
-  eventTypeId: {
-    event: 'eventAction',
-    social: 'socialAction'
-  },
-  eventValue: {
-    event: 'eventValue',
-    timing: 'timingValue'
-  },
-  eventProperties: {
-    pageview: ['page'],
-    screenview: ['screenName'],
-    event: ['eventCategory', 'eventLabel'],
-    social: ['socialNetwork', 'socialTarget'],
-    timing: ['timingCategory', 'timingVar', 'timingLabel'],
-    exception: ['exDescription', 'exFatal']
-  }
-};
-/**
- * Build a mapper function based on a mapping object
- *
- * @param {object} mapping
- */
-
-function mapperBuilder(mapping) {
-  return function (model) {
-    var hitType = model.get('hitType');
-    var eventTypeId = model.get(mapping.eventTypeId[hitType] || 'hitType');
-    var value = model.get(mapping.eventValue[hitType]);
-    var properties = {};
-    var fields = mapping.eventProperties[hitType];
-
-    if (fields) {
-      for (var i = 0; i < fields.length; i++) {
-        properties[fields[i]] = model.get(fields[i]);
-      }
-    }
-
-    return {
-      eventTypeId: eventTypeId,
-      value: value,
-      properties: properties,
-      timestamp: Date.now()
-    };
-  };
-} // exposed for unit testing purposses.
-
-
-export var defaultMapper = mapperBuilder(defaultMapping);
-export var defaultPrefix = 'ga';
-/**
- * Return a new list of identities removing invalid and duplicated ones.
- *
- * @param {Array} identities list of identities
- * @returns list of valid and unique identities. The list might be empty if `identities` is not an array or all its elements are invalid.
- */
-
-export function validateIdentities(identities) {
-  if (!Array.isArray(identities)) return []; // Remove duplicated identities
-
-  var uniqueIdentities = unicAsStrings(identities); // Filter based on rum-agent identities validator
-
-  return uniqueIdentities.filter(function (identity) {
-    if (!identity) return false;
-    var maybeKey = identity.key;
-    var maybeTT = identity.trafficType;
-    if (!isString(maybeKey) && !numberIsFinite(maybeKey)) return false;
-    if (!isString(maybeTT)) return false;
-    return true;
-  });
-}
-/**
- * Checks if EventData fields (except EventTypeId) are valid, and logs corresponding warnings.
- * EventTypeId is validated separately.
- *
- * @param {EventData} data event data instance to validate. Precondition: data != undefined
- * @returns {boolean} Whether the data instance is a valid EventData or not.
- */
-
-export function validateEventData(eventData) {
-  if (!validateEvent(eventData.eventTypeId, logNameMapper)) return false;
-  if (validateEventValue(eventData.value, logNameMapper) === false) return false;
-
-  var _validateEventPropert = validateEventProperties(eventData.properties, logNameMapper),
-      properties = _validateEventPropert.properties;
-
-  if (properties === false) return false;
-  if (eventData.timestamp && !numberIsFinite(eventData.timestamp)) return false;
-  if (eventData.key && validateKey(eventData.key, logNameMapper) === false) return false;
-  if (eventData.trafficTypeName && validateTrafficType(eventData.trafficTypeName, logNameMapper) === false) return false;
-  return true;
-}
-var INVALID_PREFIX_REGEX = /^[^a-zA-Z0-9]+/;
-var INVALID_SUBSTRING_REGEX = /[^-_.:a-zA-Z0-9]+/g;
-/**
- * Fixes the passed string value to comply with EventTypeId format, by removing invalid characters and truncating if necessary.
- *
- * @param {string} eventTypeId string value to fix.
- * @returns {string} Fixed version of `eventTypeId`.
- */
-
-export function fixEventTypeId(eventTypeId) {
-  // return the input eventTypeId if it cannot be fixed
-  if (!isString(eventTypeId) || eventTypeId.length === 0) {
-    return eventTypeId;
-  } // replace invalid substrings and truncate
-
-
-  var fixed = eventTypeId.replace(INVALID_PREFIX_REGEX, '').replace(INVALID_SUBSTRING_REGEX, '_');
-  var truncated = fixed.slice(0, 80);
-  if (truncated.length < fixed.length) log.warn('EventTypeId was truncated because it cannot be more than 80 characters long.');
-  return truncated;
-}
-/**
- * GaToSplit integration.
- * This function provides the SplitTracker plugin to ga command queue.
- *
- * @param {object} sdkOptions options passed at the SDK integrations settings
- * @param {object} storage SDK storage passed to track events
- * @param {object} coreSettings core settings used to define an identity if no one provided as SDK or plugin options
- */
-
-function GaToSplit(sdkOptions, storage, coreSettings) {
-  var defaultOptions = {
-    prefix: defaultPrefix,
-    // We set default identities if key and TT are present in settings.core
-    identities: coreSettings.key && coreSettings.trafficType ? [{
-      key: coreSettings.key,
-      trafficType: coreSettings.trafficType
-    }] : undefined
-  };
-
-  var SplitTracker = // Constructor for the SplitTracker plugin.
-  function SplitTracker(tracker, pluginOptions) {
-    // precedence of options: SDK options (config.integrations) overwrite pluginOptions (`ga('require', 'splitTracker', pluginOptions)`)
-    var opts = objectAssign({}, defaultOptions, sdkOptions, pluginOptions);
-    this.tracker = tracker; // Validate identities
-
-    var validIdentities = validateIdentities(opts.identities);
-
-    if (validIdentities.length === 0) {
-      log.warn('No valid identities were provided. Please check that you are passing a valid list of identities or providing a traffic type at the SDK configuration.');
-      return;
-    }
-
-    var invalids = validIdentities.length - opts.identities.length;
-
-    if (invalids) {
-      log.warn(invalids + " identities were discarded because they are invalid or duplicated. Identities must be an array of objects with key and trafficType.");
-    }
-
-    opts.identities = validIdentities; // Validate prefix
-
-    if (!isString(opts.prefix)) {
-      log.warn('The provided `prefix` was ignored since it is invalid. Please check that you are passing a string object as `prefix`.');
-      opts.prefix = undefined;
-    } // Overwrite sendHitTask to perform plugin tasks:
-    // 1) filter hits
-    // 2) map hits to Split events
-    // 3) handle events, i.e., validate and send them to Split BE
-
-
-    var originalSendHitTask = tracker.get('sendHitTask');
-    tracker.set('sendHitTask', function (model) {
-      originalSendHitTask(model); // filter hit if `hits` flag is false or if it comes from Split-to-GA integration
-
-      if (opts.hits === false || model.get('splitHit')) return;
-
-      try {
-        if (opts.filter && !opts.filter(model)) return;
-      } catch (err) {
-        log.warn("GaToSplit custom filter threw: " + err);
-        return;
-      } // map hit into an EventData instance
-
-
-      var eventData = defaultMapper(model);
-
-      if (opts.mapper) {
-        try {
-          eventData = opts.mapper(model, eventData);
-        } catch (err) {
-          log.warn("GaToSplit custom mapper threw: " + err);
-          return;
-        }
-
-        if (!eventData) return;
-      } // Add prefix. Nothing is appended if the prefix is falsy, e.g. undefined or ''.
-
-
-      if (opts.prefix) eventData.eventTypeId = opts.prefix + "." + eventData.eventTypeId;
-      eventData.eventTypeId = fixEventTypeId(eventData.eventTypeId);
-      if (!validateEventData(eventData)) return; // Store the event
-
-      if (eventData.key && eventData.trafficTypeName) {
-        storage.events.track(eventData);
-      } else {
-        // Store the event for each Key-TT pair (identities), if key and TT is not present in eventData
-        opts.identities.forEach(function (identity) {
-          var event = objectAssign({
-            key: identity.key,
-            trafficTypeName: identity.trafficType
-          }, eventData);
-          storage.events.track(event);
-        });
-      }
-    });
-    log.info('Started GA-to-Split integration');
-  }; // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
-
-
-  providePlugin('splitTracker', SplitTracker);
-}
-
-export default GaToSplit;

package/es/integrations/ga/SplitToGa.js

@@ -1,127 +0,0 @@
-import logFactory from '../../utils/logger';
-import { uniq } from '../../utils/lang';
-import { SPLIT_IMPRESSION, SPLIT_EVENT } from '../../utils/constants';
-var log = logFactory('splitio-split-to-ga');
-
-var SplitToGa = /*#__PURE__*/function () {
-  // Default mapper function.
-  SplitToGa.defaultMapper = function defaultMapper(_ref) {
-    var type = _ref.type,
-        payload = _ref.payload;
-
-    switch (type) {
-      case SPLIT_IMPRESSION:
-        return {
-          hitType: 'event',
-          eventCategory: 'split-impression',
-          eventAction: 'Evaluate ' + payload.impression.feature,
-          eventLabel: 'Treatment: ' + payload.impression.treatment + '. Targeting rule: ' + payload.impression.label + '.',
-          nonInteraction: true
-        };
-
-      case SPLIT_EVENT:
-        return {
-          hitType: 'event',
-          eventCategory: 'split-event',
-          eventAction: payload.eventTypeId,
-          eventValue: payload.value,
-          nonInteraction: true
-        };
-    }
-
-    return null;
-  } // Util to access ga command queue, accounting for the possibility that it has been renamed.
-  ;
-
-  SplitToGa.getGa = function getGa() {
-    return typeof window !== 'undefined' ? window[window['GoogleAnalyticsObject'] || 'ga'] : undefined;
-  }
-  /**
-   * Validates if a given object is a UniversalAnalytics.FieldsObject instance, and logs a warning if not.
-   * It checks that the object contains a `hitType`, since it is the minimal field required to send the hit
-   * and avoid the GA error `No hit type specified. Aborting hit.`.
-   * Other validations (e.g., an `event` hitType must have a `eventCategory` and `eventAction`) are handled
-   * and logged (as warnings or errors depending the case) by GA debugger, but the hit is sent anyway.
-   *
-   * @param {UniversalAnalytics.FieldsObject} fieldsObject object to validate.
-   * @returns {boolean} Whether the data instance is a valid FieldsObject or not.
-   */
-  ;
-
-  SplitToGa.validateFieldsObject = function validateFieldsObject(fieldsObject) {
-    if (fieldsObject && fieldsObject.hitType) return true;
-    log.warn('your custom mapper returned an invalid FieldsObject instance. It must be an object with at least a `hitType` field.');
-    return false;
-  };
-
-  function SplitToGa(options) {
-    // Check if `ga` object is available
-    if (typeof SplitToGa.getGa() !== 'function') {
-      log.warn('`ga` command queue not found. No hits will be sent.'); // Return an empty object to avoid creating a SplitToGa instance
-
-      return {};
-    }
-
-    this.trackerNames = SplitToGa.defaultTrackerNames;
-
-    if (options) {
-      if (typeof options.filter === 'function') this.filter = options.filter;
-      if (typeof options.mapper === 'function') this.mapper = options.mapper; // We strip off duplicated values if we received a `trackerNames` param.
-      // We don't warn if a tracker does not exist, since the user might create it after the SDK is initialized.
-      // Note: GA allows to create and get trackers using a string or number as tracker name, and does nothing if other types are used.
-
-      if (Array.isArray(options.trackerNames)) this.trackerNames = uniq(options.trackerNames); // No need to validate `impressions` and `events` flags. Any other value than `false` is ignored.
-
-      this.impressions = options.impressions;
-      this.events = options.events;
-    }
-
-    log.info('Started Split-to-GA integration');
-  }
-
-  var _proto = SplitToGa.prototype;
-
-  _proto.queue = function queue(data) {
-    // access ga command queue via `getGa` method, accounting for the possibility that
-    // the global `ga` reference was not yet mutated by analytics.js.
-    var ga = SplitToGa.getGa();
-
-    if (ga) {
-      if (this.impressions === false && data.type === SPLIT_IMPRESSION) return;
-      if (this.events === false && data.type === SPLIT_EVENT) return;
-      var fieldsObject;
-
-      try {
-        // only try/catch filter and mapper, which might be defined by the user
-        // filter
-        if (this.filter && !this.filter(data)) return; // map data into a FieldsObject instance
-
-        fieldsObject = SplitToGa.defaultMapper(data);
-
-        if (this.mapper) {
-          fieldsObject = this.mapper(data, fieldsObject); // don't send the hit if it is falsy or invalid
-
-          if (!fieldsObject || !SplitToGa.validateFieldsObject(fieldsObject)) return;
-        }
-      } catch (err) {
-        log.warn("SplitToGa queue method threw: " + err + ". No hit was sent.");
-        return;
-      } // send the hit
-
-
-      this.trackerNames.forEach(function (trackerName) {
-        var sendCommand = trackerName ? trackerName + ".send" : 'send'; // mark the hit as a Split one to avoid the loop.
-
-        fieldsObject.splitHit = true; // Send to GA using our reference to the GA object.
-
-        ga(sendCommand, fieldsObject);
-      });
-    }
-  };
-
-  return SplitToGa;
-}(); // A falsy object represents the default tracker
-
-
-SplitToGa.defaultTrackerNames = [''];
-export default SplitToGa;

package/es/integrations/node.js

@@ -1,3 +0,0 @@
-var integrationsManagerFactory = function integrationsManagerFactory() {};
-
-export default integrationsManagerFactory;

package/es/listeners/browser.js

@@ -1,157 +0,0 @@
-import eventsBulkRequest from '../services/events/bulk';
-import eventsService from '../services/events';
-import impressionsBulkRequest from '../services/impressions/bulk';
-import impressionsCountRequest from '../services/impressions/count';
-import impressionsService from '../services/impressions';
-import { fromImpressionsCollector, fromImpressionsCountCollector } from '../services/impressions/dto';
-import logFactory from '../utils/logger';
-import { OPTIMIZED, DEBUG } from '../utils/constants';
-import objectAssign from 'object-assign';
-var log = logFactory('splitio-client:cleanup'); // 'unload' event is used instead of 'beforeunload', since 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
-
-var UNLOAD_DOM_EVENT = 'unload';
-/**
- * We'll listen for 'unload' event over the window object, since it's the standard way to listen page reload and close.
- *
- */
-
-var BrowserSignalListener = /*#__PURE__*/function () {
-  function BrowserSignalListener(context, syncManager) {
-    this.storage = context.get(context.constants.STORAGE);
-    this.settings = context.get(context.constants.SETTINGS);
-    this.syncManager = syncManager;
-    this.flushData = this.flushData.bind(this);
-
-    if (this.settings.sync.impressionsMode === OPTIMIZED) {
-      this.impressionsCounter = context.get(context.constants.IMPRESSIONS_COUNTER);
-    }
-  }
-  /**
-   * start method.
-   * Called when SplitFactory is initialized.
-   * We add a handler on unload events. The handler flushes remaining impressions and events to the backend.
-   */
-
-
-  var _proto = BrowserSignalListener.prototype;
-
-  _proto.start = function start() {
-    if (typeof window !== 'undefined' && window.addEventListener) {
-      log.debug('Registering flush handler when unload page event is triggered.');
-      window.addEventListener(UNLOAD_DOM_EVENT, this.flushData);
-    }
-  }
-  /**
-   * stop method.
-   * Called when client is destroyed.
-   * We need to remove the handler for unload events, since it can break if called when Split context was destroyed.
-   */
-  ;
-
-  _proto.stop = function stop() {
-    if (typeof window !== 'undefined' && window.removeEventListener) {
-      log.debug('Deregistering flush handler when unload page event is triggered.');
-      window.removeEventListener(UNLOAD_DOM_EVENT, this.flushData);
-    }
-  }
-  /**
-   * _flushData method.
-   * Called when unload event is triggered. It flushed remaining impressions and events to the backend,
-   * using beacon API if possible, or falling back to regular post transport.
-   */
-  ;
-
-  _proto.flushData = function flushData() {
-    this._flushImpressions();
-
-    this._flushEvents();
-
-    if (this.impressionsCounter) {
-      this._flushImpressionsCount();
-    } // Close streaming
-
-
-    if (this.syncManager && this.syncManager.pushManager) this.syncManager.pushManager.stop();
-  };
-
-  _proto._flushImpressions = function _flushImpressions() {
-    var impressions = this.storage.impressions; // if there are impressions in storage, send them to backend
-
-    if (!impressions.isEmpty()) {
-      var url = this.settings.url('/testImpressions/beacon');
-      var impressionsPayload = fromImpressionsCollector(impressions, this.settings);
-      var extraMetadata = {
-        // sim stands for Sync/Split Impressions Mode
-        sim: this.settings.sync.impressionsMode === OPTIMIZED ? OPTIMIZED : DEBUG
-      };
-
-      if (!this._sendBeacon(url, impressionsPayload, extraMetadata)) {
-        impressionsService(impressionsBulkRequest(this.settings, {
-          body: JSON.stringify(impressionsPayload)
-        }));
-      }
-
-      impressions.clear();
-    }
-  };
-
-  _proto._flushImpressionsCount = function _flushImpressionsCount() {
-    var impressionsCountPayload = {
-      pf: fromImpressionsCountCollector(this.impressionsCounter)
-    };
-    var imprCounts = impressionsCountPayload.pf.length;
-    if (imprCounts === 0) return;
-    var url = this.settings.url('/testImpressions/count/beacon');
-
-    if (!this._sendBeacon(url, impressionsCountPayload)) {
-      impressionsService(impressionsCountRequest(this.settings, {
-        body: JSON.stringify(impressionsCountPayload)
-      }));
-    }
-  };
-
-  _proto._flushEvents = function _flushEvents() {
-    var events = this.storage.events; // if there are events in storage, send them to backend
-
-    if (!events.isEmpty()) {
-      var url = this.settings.url('/events/beacon');
-      var eventsPayload = events.toJSON();
-
-      if (!this._sendBeacon(url, eventsPayload)) {
-        eventsService(eventsBulkRequest(this.settings, {
-          body: JSON.stringify(eventsPayload)
-        }));
-      }
-
-      events.clear();
-    }
-  }
-  /**
-   * _sendBeacon method.
-   * Util method that check if beacon API is available, build the payload and send it.
-   */
-  ;
-
-  _proto._sendBeacon = function _sendBeacon(url, data, extraMetadata) {
-    // eslint-disable-next-line compat/compat
-    if (typeof navigator !== 'undefined' && navigator.sendBeacon) {
-      var json = {
-        entries: data,
-        token: this.settings.core.authorizationKey,
-        sdk: this.settings.version
-      }; // Extend with endpoint specific metadata where needed
-
-      if (extraMetadata) objectAssign(json, extraMetadata); // Stringify the payload
-
-      var payload = JSON.stringify(json); // eslint-disable-next-line compat/compat
-
-      return navigator.sendBeacon(url, payload);
-    }
-
-    return false;
-  };
-
-  return BrowserSignalListener;
-}();
-
-export { BrowserSignalListener as default };

package/es/listeners/node.js

@@ -1,65 +0,0 @@
-import logFactory from '../utils/logger';
-import thenable from '../utils/promise/thenable';
-var log = logFactory('splitio-client:cleanup');
-/**
- * We'll listen for SIGTERM since it's the standard signal for server shutdown.
- *
- * If you're stopping the execution yourself via the keyboard, or by calling process.exit,
- * you should call the cleanup logic yourself, since we cannot ensure the data is sent after
- * the process is already exiting.
- */
-
-var NodeSignalListener = /*#__PURE__*/function () {
-  function NodeSignalListener() {
-    this._sigtermHandler = this._sigtermHandler.bind(this);
-  }
-
-  var _proto = NodeSignalListener.prototype;
-
-  _proto.start = function start(handler) {
-    this.handler = handler;
-    log.debug('Registering cleanup handlers.');
-    process.on('SIGTERM', this._sigtermHandler);
-  };
-
-  _proto.stop = function stop() {
-    log.debug('Deregistering cleanup handlers.');
-    process.removeListener('SIGTERM', this._sigtermHandler);
-  }
-  /**
-   * Call the handler, clean up listeners and emit the signal again.
-   */
-  ;
-
-  _proto._sigtermHandler = function _sigtermHandler() {
-    var _this = this;
-
-    var wrapUp = function wrapUp() {
-      // Cleaned up, remove handlers.
-      _this.stop(); // This handler prevented the default behaviour, start again.
-
-
-      process.kill(process.pid, 'SIGTERM');
-    };
-
-    log.debug('Split SDK graceful shutdown after SIGTERM.');
-    var handlerResult = null;
-
-    try {
-      handlerResult = this.handler();
-    } catch (err) {
-      log.error("Error with Split graceful shutdown: " + err);
-    }
-
-    if (thenable(handlerResult)) {
-      // Always exit, even with errors. The promise is returned for UT purposses.
-      return handlerResult.then(wrapUp).catch(wrapUp);
-    } else {
-      wrapUp();
-    }
-  };
-
-  return NodeSignalListener;
-}();
-
-export { NodeSignalListener as default };