@splitsoftware/splitio 10.17.2 → 10.17.3-rc.0

package/src/factory/offline.js

@@ -1,60 +0,0 @@
-import objectAssign from 'object-assign';
-import ClientFactory from '../client';
-import OfflineProducerFactory from '../producer/offline';
-import { releaseApiKey } from '../utils/inputValidation';
-
-//
-// Create SDK instance for offline mode.
-//
-function SplitFactoryOffline(context, sharedTrackers) {
-  const sharedInstance = !sharedTrackers;
-  const readiness = context.get(context.constants.READINESS);
-  const storage = context.get(context.constants.STORAGE);
-  const statusManager = context.get(context.constants.STATUS_MANAGER);
-
-  // In LOCALHOST mode, shared clients are ready in the next event-loop cycle than created
-  // and then updated on each SDK_SPLITS_ARRIVED event
-  if (sharedInstance) setTimeout(() => {
-    readiness.splits.on(readiness.splits.SDK_SPLITS_ARRIVED, () => {
-      readiness.gate.emit(readiness.gate.SDK_UPDATE);
-    });
-    readiness.gate.emit(readiness.gate.SDK_READY);
-  }, 0);
-
-  // Producer
-  const producer = sharedInstance ? undefined : OfflineProducerFactory(context);
-
-  // Start background task for flag updates
-  producer && producer.start();
-
-  const api = objectAssign(
-    // Proto linkage of the EventEmitter to prevent any change
-    Object.create(statusManager),
-    // GetTreatment/s
-    ClientFactory(context),
-    // Utilities
-    {
-      // Destroy instance. Async so we respect the online api.
-      destroy() {
-        // Stop background jobs
-        producer && producer.stop();
-        // Cleanup event listeners
-        readiness.destroy();
-        // Cleanup storage
-        storage.destroy && storage.destroy();
-        // Mark the factory as destroyed.
-        context.put(context.constants.DESTROYED, true);
-        !sharedInstance && releaseApiKey();
-
-        return Promise.resolve();
-      }
-    }
-  );
-
-  return {
-    api,
-    metricCollectors: false // We won't collect any metrics on localhost mode.
-  };
-}
-
-export default SplitFactoryOffline;

package/src/factory/online.js

@@ -1,127 +0,0 @@
-import objectAssign from 'object-assign';
-import ClientFactory from '../client';
-import MetricsFactory from '../metrics';
-import EventsFactory from '../events';
-import SyncManagerFactory from '../sync';
-import SignalsListener from '../listeners';
-import { releaseApiKey } from '../utils/inputValidation';
-import { STANDALONE_MODE, PRODUCER_MODE, CONSUMER_MODE } from '../utils/constants';
-
-// map of authorizationKeys to syncManagers, to keep a single instance per factory and needed to create shared clients
-const syncManagers = {};
-
-//
-// Create SDK instance based on the provided configurations
-//
-function SplitFactoryOnline(context, readyTrackers, mainClientMetricCollectors) {
-  const sharedInstance = !!mainClientMetricCollectors;
-  const settings = context.get(context.constants.SETTINGS);
-  const readiness = context.get(context.constants.READINESS);
-  const storage = context.get(context.constants.STORAGE);
-  const statusManager = context.get(context.constants.STATUS_MANAGER);
-
-  // We are only interested in exposable EventEmitter
-  const { gate, splits, segments } = readiness;
-
-  // Events name
-  const { SDK_READY } = gate;
-
-  // Shared instances use parent metrics collectors
-  const metrics = sharedInstance ? undefined : MetricsFactory(context);
-  // Shared instances use parent events queue
-  const events = sharedInstance ? undefined : EventsFactory(context);
-
-  let syncManager;
-
-  switch (settings.mode) {
-    case PRODUCER_MODE:
-    case STANDALONE_MODE: {
-      context.put(context.constants.COLLECTORS, metrics && metrics.collectors);
-      // We don't fully instantiate syncManager if we are creating a shared instance.
-      if (sharedInstance) {
-        syncManager = syncManagers[settings.core.authorizationKey].shared(context);
-      } else {
-        syncManager = SyncManagerFactory(context);
-        syncManagers[settings.core.authorizationKey] = syncManager;
-      }
-      break;
-    }
-    case CONSUMER_MODE: {
-      context.put(context.constants.READY_FROM_CACHE, true); // For SDK inner workings it's supposed to be ready from cache.
-      break;
-    }
-  }
-
-  // Signal listener only needed for main instances
-  const signalsListener = sharedInstance ? undefined : new SignalsListener(context, syncManager);
-
-  if (readyTrackers && syncManager && !sharedInstance) { // Only track ready events for non-shared and non-consumer clients
-    const {
-      sdkReadyTracker, splitsReadyTracker, segmentsReadyTracker
-    } = readyTrackers;
-
-    // Defered setup of collectors for this task, as it is the only ready latency we store on BE.
-    sdkReadyTracker.setCollectorForTask(metrics.collectors);
-
-    gate.once(SDK_READY, sdkReadyTracker);
-    splits.once(splits.SDK_SPLITS_ARRIVED, splitsReadyTracker);
-    segments.once(segments.SDK_SEGMENTS_ARRIVED, segmentsReadyTracker);
-  }
-
-  // Start background jobs tasks
-  syncManager && syncManager.start();
-  metrics && metrics.start();
-  events && context.put(context.constants.EVENTS, events) && events.start();
-
-  // If no collectors are stored we are on a shared instance, save main one.
-  context.put(context.constants.COLLECTORS, mainClientMetricCollectors);
-
-  const api = objectAssign(
-    // Proto linkage of the EventEmitter to prevent any change
-    Object.create(statusManager),
-    // getTreatment/s & track
-    ClientFactory(context),
-    // Utilities
-    {
-      // Destroy instance
-      destroy() {
-        // Stop background jobs
-        syncManager && syncManager.stop();
-        metrics && metrics.stop();
-        events && events.stop();
-
-        // Send impressions and events in parallel.
-        return Promise.all([
-          metrics && metrics.flush(),
-          events && events.flush()
-        ]).then(function () {
-
-          // Cleanup event listeners
-          readiness.destroy();
-          signalsListener && signalsListener.stop();
-
-          // Cleanup storage
-          storage.destroy && storage.destroy();
-          // Mark the factory as destroyed.
-          context.put(context.constants.DESTROYED, true);
-          // And release the API Key and SyncManager
-          if (!sharedInstance) {
-            releaseApiKey(settings.core.authorizationKey);
-            delete syncManagers[settings.core.authorizationKey];
-          }
-        });
-      }
-    }
-  );
-
-  // We'll start the signals listener if the client is not a shared instance.
-  // For now, we will only call destroy.
-  !sharedInstance && signalsListener.start(api.destroy);
-
-  return {
-    api,
-    metricCollectors: metrics && metrics.collectors
-  };
-}
-
-export default SplitFactoryOnline;

package/src/impressions/counter.js

@@ -1,43 +0,0 @@
-import { truncateTimeFrame } from '../utils/time';
-import objectAssign from 'object-assign';
-
-class ImpressionCounter {
-  constructor() {
-    this.cache = {};
-  }
-
-  /**
-  * Builds key to be stored in the cache with the featureName and the timeFrame truncated.
-  */
-  _makeKey(featureName, timeFrame) {
-    return `${featureName}::${truncateTimeFrame(timeFrame)}`;
-  }
-
-  /**
-  * Increments the quantity of impressions with the passed featureName and timeFrame.
-  */
-  inc(featureName, timeFrame, amount) {
-    const key = this._makeKey(featureName, timeFrame);
-    const currentAmount = this.cache[key];
-    this.cache[key] = currentAmount ? currentAmount + amount : amount;
-  }
-
-  /**
-  * Returns all the elements stored in the cache and resets the cache.
-  */
-  popAll() {
-    const res = {};
-    objectAssign(res, this.cache);
-    this.cache = {};
-    return res;
-  }
-
-  /**
-  * Returns how many keys are stored in cache.
-  */
-  size() {
-    return Object.keys(this.cache).length;
-  }
-}
-
-export default ImpressionCounter;

package/src/impressions/hasher/buildKey.js

@@ -1,3 +0,0 @@
-export function buildKey(impression) {
-  return `${impression.keyName}:${impression.feature}:${impression.treatment}:${impression.label}:${impression.changeNumber}`;
-}

package/src/impressions/hasher/hashImpression128.js

@@ -1,6 +0,0 @@
-import { hash128 } from '../../engine/engine/murmur3/murmur3_128_x86';
-import { buildKey } from './buildKey';
-
-export function hashImpression128(impression) {
-  return hash128(buildKey(impression));
-}

package/src/impressions/hasher/hashImpression32.js

@@ -1,6 +0,0 @@
-import murmur from '../../engine/engine/murmur3/murmur3';
-import { buildKey } from './buildKey';
-
-export function hashImpression32(impression) {
-  return murmur.hash(buildKey(impression));
-}

package/src/impressions/observer/browser.js

@@ -1,8 +0,0 @@
-import ImpressionObserver from './observer';
-import { hashImpression32 } from '../hasher/hashImpression32';
-
-const LAST_SEEN_CACHE_SIZE = 500; // cache up to 500 impression hashes
-
-const BrowserImpressionObserverFactory = () => new ImpressionObserver(LAST_SEEN_CACHE_SIZE, hashImpression32);
-
-export default BrowserImpressionObserverFactory;

package/src/impressions/observer/node.js

@@ -1,8 +0,0 @@
-import ImpressionObserver from './observer';
-import { hashImpression128 } from '../hasher/hashImpression128';
-
-const LAST_SEEN_CACHE_SIZE = 500000; // cache up to 500k impression hashes
-
-const NodeImpressionObserverFactory = () => new ImpressionObserver(LAST_SEEN_CACHE_SIZE, hashImpression128);
-
-export default NodeImpressionObserverFactory;

package/src/impressions/observer/observer.js

@@ -1,17 +0,0 @@
-import LRU from '../../utils/lrucache/lrucache';
-
-class ImpressionObserver {
-  constructor(size, hasher) {
-    this.cache = new LRU(size);
-    this.hasher = hasher;
-  }
-
-  testAndSet(impression) {
-    const hash = this.hasher(impression);
-    const previous = this.cache.get(hash);
-    this.cache.set(hash, impression.time);
-    return previous;
-  }
-}
-
-export default ImpressionObserver;

package/src/impressions/observer/package.json

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

package/src/integrations/browser.js

@@ -1,57 +0,0 @@
-import GaToSplit from './ga/GaToSplit';
-import SplitToGa from './ga/SplitToGa';
-import { GOOGLE_ANALYTICS_TO_SPLIT, SPLIT_TO_GOOGLE_ANALYTICS, SPLIT_IMPRESSION, SPLIT_EVENT } from '../utils/constants';
-
-/**
- * Factory function for browser IntegrationsManager.
- * The integrations manager instantiates integration modules, and bypass tracked events and impressions to them.
- *
- * @param {Context} context SplitFactory context
- *
- * @returns integration manager or null if `integrations` are not present in settings.
- */
-const integrationsManagerFactory = context => {
-  const settings = context.get(context.constants.SETTINGS);
-
-  const listeners = [];
-
-  // No need to check if `settings.integrations` is an array. It was already validated in settings validation
-  settings.integrations.forEach(integrationOptions => {
-    const { type } = integrationOptions;
-    let integration;
-
-    switch (type) {
-      case GOOGLE_ANALYTICS_TO_SPLIT: {
-        const storage = context.get(context.constants.STORAGE);
-        const coreSettings = settings.core;
-        integration = GaToSplit(integrationOptions, storage, coreSettings);
-        break;
-      }
-
-      case SPLIT_TO_GOOGLE_ANALYTICS: {
-        integration = new SplitToGa(integrationOptions);
-        break;
-      }
-    }
-
-    if (integration && integration.queue)
-      listeners.push(integration);
-  });
-
-  // If `listeners` is empty, not return a integration manager
-  if (listeners.length === 0)
-    return;
-
-  // Exception safe methods: each integration module is responsable for handling errors
-  return {
-    handleImpression: function (impressionData) {
-      listeners.forEach(listener => listener.queue({ type: SPLIT_IMPRESSION, payload: impressionData }));
-    },
-    handleEvent: function (eventData) {
-      listeners.forEach(listener => listener.queue({ type: SPLIT_EVENT, payload: eventData }));
-    }
-  };
-
-};
-
-export default integrationsManagerFactory;

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;