@splitsoftware/splitio 10.17.3 → 10.17.4-rc.0

package/src/integrations/ga/GaToSplit.js

@@ -1,278 +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';
-const logName = 'splitio-ga-to-split', logNameMapper = logName + ':mapper';
-const 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.
-  const gaAlias = window.GoogleAnalyticsObject || 'ga';
-  window[gaAlias] = window[gaAlias] || function (...args) {
-    (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
-const 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) {
-    const hitType = model.get('hitType');
-
-    const eventTypeId = model.get(mapping.eventTypeId[hitType] || 'hitType');
-
-    const value = model.get(mapping.eventValue[hitType]);
-
-    const properties = {};
-    const fields = mapping.eventProperties[hitType];
-    if (fields) {
-      for (let i = 0; i < fields.length; i++) {
-        properties[fields[i]] = model.get(fields[i]);
-      }
-    }
-
-    return {
-      eventTypeId,
-      value,
-      properties,
-      timestamp: Date.now(),
-    };
-  };
-}
-
-// exposed for unit testing purposses.
-export const defaultMapper = mapperBuilder(defaultMapping);
-
-export const 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
-  const uniqueIdentities = unicAsStrings(identities);
-
-  // Filter based on rum-agent identities validator
-  return uniqueIdentities.filter(identity => {
-    if (!identity)
-      return false;
-
-    const maybeKey = identity.key;
-    const 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;
-
-  const { properties } = validateEventProperties(eventData.properties, logNameMapper);
-  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;
-}
-
-const INVALID_PREFIX_REGEX = /^[^a-zA-Z0-9]+/;
-const 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
-  const fixed = eventTypeId
-    .replace(INVALID_PREFIX_REGEX, '')
-    .replace(INVALID_SUBSTRING_REGEX, '_');
-  const 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) {
-
-  const 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
-  };
-
-  class SplitTracker {
-
-    // Constructor for the SplitTracker plugin.
-    constructor(tracker, pluginOptions) {
-
-      // precedence of options: SDK options (config.integrations) overwrite pluginOptions (`ga('require', 'splitTracker', pluginOptions)`)
-      const opts = objectAssign({}, defaultOptions, sdkOptions, pluginOptions);
-
-      this.tracker = tracker;
-
-      // Validate identities
-      const 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;
-      }
-
-      const 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
-      const 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
-        let 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(identity => {
-            const 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/src/integrations/ga/SplitToGa.js

@@ -1,125 +0,0 @@
-import logFactory from '../../utils/logger';
-import { uniq } from '../../utils/lang';
-import { SPLIT_IMPRESSION, SPLIT_EVENT } from '../../utils/constants';
-const log = logFactory('splitio-split-to-ga');
-
-class SplitToGa {
-
-  // Default mapper function.
-  static defaultMapper({ type, 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.
-  static 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.
-   */
-  static 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;
-  }
-
-  constructor(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');
-  }
-
-  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.
-    const ga = SplitToGa.getGa();
-    if (ga) {
-
-      if(this.impressions === false && data.type === SPLIT_IMPRESSION) return;
-      if(this.events === false && data.type === SPLIT_EVENT) return;
-
-      let 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(trackerName => {
-        const 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);
-      });
-    }
-  }
-
-}
-
-// A falsy object represents the default tracker
-SplitToGa.defaultTrackerNames = [''];
-
-export default SplitToGa;

package/src/integrations/node.js

@@ -1,4 +0,0 @@
-const integrationsManagerFactory = () => {
-};
-
-export default integrationsManagerFactory;

package/src/integrations/package.json

@@ -1,4 +0,0 @@
-{
-  "main": "./node.js",
-  "browser": "./browser.js"
-}

package/src/listeners/browser.js

@@ -1,137 +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';
-
-const 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.
-const 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.
- *
- */
-export default class BrowserSignalListener {
-
-  constructor(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.
-   */
-  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.
-   */
-  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.
-   */
-  flushData() {
-    this._flushImpressions();
-    this._flushEvents();
-    if (this.impressionsCounter) {
-      this._flushImpressionsCount();
-    }
-    // Close streaming
-    if (this.syncManager && this.syncManager.pushManager) this.syncManager.pushManager.stop();
-  }
-
-  _flushImpressions() {
-    const impressions = this.storage.impressions;
-    // if there are impressions in storage, send them to backend
-    if (!impressions.isEmpty()) {
-      const url = this.settings.url('/testImpressions/beacon');
-      const impressionsPayload = fromImpressionsCollector(impressions, this.settings);
-      const 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();
-    }
-  }
-
-  _flushImpressionsCount() {
-    const impressionsCountPayload = { pf: fromImpressionsCountCollector(this.impressionsCounter) };
-    const imprCounts = impressionsCountPayload.pf.length;
-    if (imprCounts === 0) return;
-    const url = this.settings.url('/testImpressions/count/beacon');
-    if (!this._sendBeacon(url, impressionsCountPayload)) {
-      impressionsService(impressionsCountRequest(this.settings, { body: JSON.stringify(impressionsCountPayload) }));
-    }
-  }
-
-  _flushEvents() {
-    const events = this.storage.events;
-    // if there are events in storage, send them to backend
-    if (!events.isEmpty()) {
-      const url = this.settings.url('/events/beacon');
-      const 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.
-   */
-  _sendBeacon(url, data, extraMetadata) {
-    // eslint-disable-next-line compat/compat
-    if (typeof navigator !== 'undefined' && navigator.sendBeacon) {
-      const 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
-      const payload = JSON.stringify(json);
-
-      // eslint-disable-next-line compat/compat
-      return navigator.sendBeacon(url, payload);
-    }
-    return false;
-  }
-}

package/src/listeners/node.js

@@ -1,59 +0,0 @@
-import logFactory from '../utils/logger';
-import thenable from '../utils/promise/thenable';
-const 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.
- */
-export default class NodeSignalListener {
-  constructor() {
-    this._sigtermHandler = this._sigtermHandler.bind(this);
-  }
-
-  start(handler) {
-    this.handler = handler;
-
-    log.debug('Registering cleanup handlers.');
-    process.on('SIGTERM', this._sigtermHandler);
-  }
-
-  stop() {
-    log.debug('Deregistering cleanup handlers.');
-    process.removeListener('SIGTERM', this._sigtermHandler);
-  }
-
-  /**
-   * Call the handler, clean up listeners and emit the signal again.
-   */
-  _sigtermHandler() {
-    const 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.');
-
-    let 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();
-    }
-  }
-}
-

package/src/listeners/package.json

@@ -1,4 +0,0 @@
-{
-  "main": "./node.js",
-  "browser": "./browser.js"
-}