castled-js-sdk 0.0.1 → 0.0.3

package/src/integrations/GA/browser.js

@@ -0,0 +1,816 @@
+/* eslint-disable class-methods-use-this */
+import is from 'is';
+import each from 'component-each';
+import logger from '../../utils/logUtil';
+import { rejectArr } from '../../utils/utils';
+import ScriptLoader from '../../utils/ScriptLoader';
+import { NAME } from './constants';
+
+export default class GA {
+  constructor(config, analytics, destinationInfo) {
+    if (analytics.logLevel) {
+      logger.setLogLevel(analytics.logLevel);
+    }
+    this.analytics = analytics;
+    this.trackingID = config.trackingID;
+    this.sendUserId = config.sendUserId || false;
+    this.dimensions = config.dimensions || [];
+    this.metrics = config.metrics || [];
+    this.contentGroupings = config.contentGroupings || [];
+    this.nonInteraction = config.nonInteraction || false;
+    this.anonymizeIp = config.anonymizeIp || false;
+    this.useGoogleAmpClientId = config.useGoogleAmpClientId || false;
+
+    this.domain = config.domain || 'auto';
+    this.doubleClick = config.doubleClick || false;
+    this.enhancedEcommerce = config.enhancedEcommerce || false;
+    this.enhancedLinkAttribution = config.enhancedLinkAttribution || false;
+
+    this.includeSearch = config.includeSearch || false;
+    this.setAllMappedProps = config.setAllMappedProps || true;
+    this.siteSpeedSampleRate = config.siteSpeedSampleRate || 1;
+    this.sampleRate = config.sampleRate || 100;
+    this.trackCategorizedPages = config.trackCategorizedPages || true;
+    this.trackNamedPages = config.trackNamedPages || true;
+    this.useRichEventNames = config.useRichEventNames || false;
+    this.optimizeContainerId = config.optimize || '';
+    this.resetCustomDimensionsOnPage = config.resetCustomDimensionsOnPage || [];
+    this.enhancedEcommerceLoaded = 0;
+    this.namedTracker = config.namedTracker || false;
+    this.name = NAME;
+    this.eventWithCategoryFieldProductScoped = [
+      'product clicked',
+      'product added',
+      'product viewed',
+      'product removed',
+    ];
+    ({
+      shouldApplyDeviceModeTransformation: this.shouldApplyDeviceModeTransformation,
+      propagateEventsUntransformedOnError: this.propagateEventsUntransformedOnError,
+      destinationId: this.destinationId,
+    } = destinationInfo ?? {});
+  }
+
+  initializeGlobalObject() {
+    window.GoogleAnalyticsObject = 'ga';
+    window.ga =
+      window.ga ||
+      function a() {
+        window.ga.q = window.ga.q || [];
+        // eslint-disable-next-line prefer-rest-params
+        window.ga.q.push(arguments);
+      };
+    window.ga.l = new Date().getTime();
+  }
+
+  loadScript() {
+    ScriptLoader('google-analytics', 'https://www.google-analytics.com/analytics.js');
+  }
+
+  init() {
+    this.pageCalled = false;
+    this.dimensionsArray = {};
+    let elementTo;
+    this.dimensions.forEach((element) => {
+      if (element.to.startsWith('dimension')) {
+        this.dimensionsArray[element.from] = element.to;
+      } else {
+        /* eslint-disable no-param-reassign */
+        elementTo = element.to.replace(/cd/g, 'dimension');
+        this.dimensionsArray[element.from] = elementTo;
+      }
+    });
+    this.metricsArray = {};
+    this.metrics.forEach((element) => {
+      if (element.to.startsWith('dimension')) {
+        this.metricsArray[element.from] = element.to;
+      } else {
+        elementTo = element.to.replace(/cm/g, 'metric');
+        this.metricsArray[element.from] = elementTo;
+      }
+    });
+    this.contentGroupingsArray = {};
+    this.contentGroupings.forEach((element) => {
+      this.contentGroupingsArray[element.from] = element.to;
+    });
+
+    if (this.analytics.loadIntegration) {
+      this.initializeGlobalObject();
+      this.loadScript();
+    }
+
+    // create ga with these properties. if the properties are empty it will take default values.
+    const config = {
+      cookieDomain: this.domain || GA.prototype.defaults.domain,
+      siteSpeedSampleRate: this.siteSpeedSampleRate,
+      sampleRate: this.sampleRate,
+      allowLinker: true,
+      useAmpClientId: this.useGoogleAmpClientId,
+    };
+
+    // set tracker name to rudderGATracker if on
+    if (this.namedTracker) {
+      config.name = 'rudderGATracker';
+      this.trackerName = 'rudderGATracker.';
+    } else {
+      this.trackerName = '';
+    }
+    window.ga('create', this.trackingID, config);
+
+    if (this.analytics.loadIntegration) {
+      if (this.optimizeContainerId) {
+        window.ga(`${this.trackerName}require`, this.optimizeContainerId);
+      }
+
+      // ecommerce is required
+      if (!this.ecommerce) {
+        window.ga(`${this.trackerName}require`, 'ecommerce');
+        this.ecommerce = true;
+      }
+
+      // this is to display advertising
+      if (this.doubleClick) {
+        window.ga(`${this.trackerName}require`, 'displayfeatures');
+      }
+
+      // https://support.google.com/analytics/answer/2558867?hl=en
+      if (this.enhancedLinkAttribution) {
+        window.ga(`${this.trackerName}require`, 'linkid');
+      }
+    }
+
+    // a warning is in ga debugger if anonymize is false after initialization
+    if (this.anonymizeIp) {
+      window.ga(`${this.trackerName}set`, 'anonymizeIp', true);
+    }
+
+    logger.debug('===in init GA===');
+  }
+
+  identify(htElement) {
+    // send global id
+    if (this.sendUserId && htElement.message.userId) {
+      window.ga(`${this.trackerName}set`, 'userId', htElement.message.userId);
+    }
+
+    // custom dimensions and metrics
+    const custom = this.metricsFunction(
+      htElement.message.context.traits,
+      this.dimensionsArray,
+      this.metricsArray,
+      this.contentGroupingsArray,
+    );
+
+    if (Object.keys(custom).length > 0) {
+      window.ga(`${this.trackerName}set`, custom);
+    }
+
+    logger.debug('in GoogleAnalyticsManager identify');
+  }
+
+  // eslint-disable-next-line sonarjs/cognitive-complexity
+  track(htElement) {
+    const self = this;
+    // Ecommerce events
+    const { event, properties, name, context } = htElement.message;
+    let { total } = properties;
+    const { campaign } = context;
+    const {
+      tax,
+      step,
+      value,
+      revenue,
+      products,
+      shipping,
+      currency,
+      affiliation,
+      nonInteraction,
+      label: eventLabel,
+      order_id: orderId,
+      category: eventCategory,
+    } = properties;
+
+    const options = this.extractCheckoutOptions(htElement);
+    const props = properties;
+    const data = {};
+    const eventAction = event || name || '';
+    let eventValue = '';
+    let payload;
+    let params;
+    let filters;
+    let sorts;
+
+    const orderIdNotPresentErrorMessage = 'order_id not present events are not sent to GA';
+
+    if (event === 'Order Completed' && !this.enhancedEcommerce) {
+      // order_id is required
+      if (!orderId) {
+        logger.debug(orderIdNotPresentErrorMessage);
+        return;
+      }
+
+      // add transaction
+      window.ga(`${this.trackerName}ecommerce:addTransaction`, {
+        affiliation,
+        shipping,
+        revenue: total || revenue,
+        tax,
+        id: orderId,
+        currency,
+      });
+
+      if (Array.isArray(products)) {
+        // products added
+        products.forEach((product) => {
+          const productTrack = self.createProductTrack(htElement, product);
+
+          window.ga(`${this.trackerName}ecommerce:addItem`, {
+            category: productTrack.properties.category,
+            quantity: productTrack.properties.quantity,
+            price: productTrack.properties.price,
+            name: productTrack.properties.name,
+            sku: productTrack.properties.sku,
+            id: orderId,
+            currency: productTrack.properties.currency,
+          });
+        });
+      }
+
+      window.ga(`${this.trackerName}ecommerce:send`);
+    }
+
+    // enhanced ecommerce events
+    else if (this.enhancedEcommerce) {
+      switch (event) {
+        case 'Checkout Started':
+        case 'Checkout Step Viewed':
+        case 'Order Updated':
+          this.loadEnhancedEcommerce(htElement);
+          each(products, (product) => {
+            let productTrack = self.createProductTrack(htElement, product);
+            productTrack = { message: productTrack };
+
+            self.enhancedEcommerceTrackProduct(productTrack);
+          });
+
+          window.ga(`${this.trackerName}ec:setAction`, 'checkout', {
+            step: step || 1,
+            option: options || undefined,
+          });
+
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Checkout Step Completed':
+          if (!props.step) {
+            logger.debug('step not present events are not sent to GA');
+            return;
+          }
+          params = {
+            step: props.step || 1,
+            option: options || undefined,
+          };
+
+          this.loadEnhancedEcommerce(htElement);
+
+          window.ga(`${this.trackerName}ec:setAction`, 'checkout_option', params);
+          window.ga(`${this.trackerName}send`, 'event', 'Checkout', 'Option');
+          break;
+        case 'Order Completed':
+          total = total || revenue || 0;
+
+          if (!orderId) {
+            logger.debug(orderIdNotPresentErrorMessage);
+            return;
+          }
+          this.loadEnhancedEcommerce(htElement);
+
+          each(products, (product) => {
+            let productTrack = self.createProductTrack(htElement, product);
+            productTrack = { message: productTrack };
+            self.enhancedEcommerceTrackProduct(productTrack);
+          });
+          window.ga(`${this.trackerName}ec:setAction`, 'purchase', {
+            id: orderId,
+            affiliation: props.affiliation,
+            revenue: total || revenue,
+            tax: props.tax,
+            shipping: props.shipping,
+            coupon: props.coupon,
+          });
+
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Order Refunded':
+          if (!orderId) {
+            logger.debug(orderIdNotPresentErrorMessage);
+            return;
+          }
+          this.loadEnhancedEcommerce(htElement);
+
+          each(products, (product) => {
+            const track = { properties: product };
+            window.ga(`${this.trackerName}ec:addProduct`, {
+              id: track.properties.product_id || track.properties.id || track.properties.sku,
+              quantity: track.properties.quantity,
+            });
+          });
+
+          window.ga(`${this.trackerName}ec:setAction`, 'refund', {
+            id: orderId,
+          });
+
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Product Added':
+          this.loadEnhancedEcommerce(htElement);
+          this.enhancedEcommerceTrackProductAction(htElement, 'add', null);
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Product Removed':
+          this.loadEnhancedEcommerce(htElement);
+          this.enhancedEcommerceTrackProductAction(htElement, 'remove', null);
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Product Viewed':
+          this.loadEnhancedEcommerce(htElement);
+
+          if (props.list) data.list = props.list;
+          this.enhancedEcommerceTrackProductAction(htElement, 'detail', data);
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Product Clicked':
+          this.loadEnhancedEcommerce(htElement);
+
+          if (props.list) data.list = props.list;
+          this.enhancedEcommerceTrackProductAction(htElement, 'click', data);
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Promotion Viewed':
+          this.loadEnhancedEcommerce(htElement);
+          window.ga(`${this.trackerName}ec:addPromo`, {
+            id: props.promotion_id || props.id,
+            name: props.name,
+            creative: props.creative,
+            position: props.position,
+          });
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Promotion Clicked':
+          this.loadEnhancedEcommerce(htElement);
+
+          window.ga(`${this.trackerName}ec:addPromo`, {
+            id: props.promotion_id || props.id,
+            name: props.name,
+            creative: props.creative,
+            position: props.position,
+          });
+          window.ga(`${this.trackerName}ec:setAction`, 'promo_click', {});
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Product List Viewed':
+          this.loadEnhancedEcommerce(htElement);
+
+          each(products, (product) => {
+            const item = { properties: product };
+            if (!(item.properties.product_id || item.properties.sku) && !item.properties.name) {
+              logger.debug('product_id/sku/name of product not present events are not sent to GA');
+              return;
+            }
+            let impressionObj = {
+              id: item.properties.product_id || item.properties.sku,
+              name: item.properties.name,
+              category: item.properties.category || props.category,
+              list: props.list_id || props.category || 'products',
+              brand: item.properties.band,
+              variant: item.properties.variant,
+              price: item.properties.price,
+              position: self.getProductPosition(item, products),
+            };
+            impressionObj = {
+              ...impressionObj,
+              ...self.metricsFunction(
+                item.properties,
+                self.dimensionsArray,
+                self.metricsArray,
+                self.contentGroupingsArray,
+              ),
+            };
+            Object.keys(impressionObj).forEach((key) => {
+              if (impressionObj[key] === undefined) delete impressionObj[key];
+            });
+            window.ga(`${this.trackerName}ec:addImpression`, impressionObj);
+          });
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        case 'Product List Filtered':
+          props.filters = props.filters || [];
+          props.sorts = props.sorts || [];
+          filters = props.filters.map((obj) => `${obj.type}:${obj.value}`).join();
+          sorts = props.sorts.map((obj) => `${obj.type}:${obj.value}`).join();
+
+          this.loadEnhancedEcommerce(htElement);
+
+          each(products, (product) => {
+            const item = { properties: product };
+
+            if (!(item.properties.product_id || item.properties.sku) && !item.properties.name) {
+              logger.debug('product_id/sku/name of product not present events are not sent to GA');
+              return;
+            }
+
+            let impressionObj = {
+              id: item.properties.product_id || item.sku,
+              name: item.name,
+              category: item.category || props.category,
+              list: props.list_id || props.category || 'search results',
+              brand: props.brand,
+              variant: `${filters}::${sorts}`,
+              price: item.price,
+              position: self.getProductPosition(item, products),
+            };
+
+            impressionObj = {
+              impressionObj,
+              ...self.metricsFunction(
+                item.properties,
+                self.dimensionsArray,
+                self.metricsArray,
+                self.contentGroupingsArray,
+              ),
+            };
+            Object.keys(impressionObj).forEach((key) => {
+              if (impressionObj[key] === undefined) delete impressionObj[key];
+            });
+            window.ga(`${this.trackerName}ec:addImpression`, impressionObj);
+          });
+          this.pushEnhancedEcommerce(htElement);
+          break;
+        default:
+          if (properties) {
+            eventValue = value || revenue;
+          }
+
+          payload = {
+            eventCategory: eventCategory || 'All',
+            eventAction,
+            eventLabel,
+            eventValue: this.formatValue(eventValue),
+            // Allow users to override their nonInteraction integration setting for any single particluar event.
+            nonInteraction: nonInteraction !== undefined ? !!nonInteraction : !!this.nonInteraction,
+          };
+
+          if (campaign) {
+            if (campaign.name) payload.campaignName = campaign.name;
+            if (campaign.source) payload.campaignSource = campaign.source;
+            if (campaign.medium) payload.campaignMedium = campaign.medium;
+            if (campaign.content) payload.campaignContent = campaign.content;
+            if (campaign.term) payload.campaignKeyword = campaign.term;
+          }
+
+          payload = {
+            payload,
+            ...this.setCustomDimenionsAndMetrics(properties),
+          };
+
+          window.ga(`${this.trackerName}send`, 'event', payload.payload);
+          logger.debug('in GoogleAnalyticsManager track');
+      }
+    } else {
+      if (properties) {
+        eventValue = value || revenue;
+      }
+
+      payload = {
+        eventCategory: eventCategory || 'All',
+        eventAction,
+        eventLabel,
+        eventValue: this.formatValue(eventValue),
+        // Allow users to override their nonInteraction integration setting for any single particluar event.
+        nonInteraction: nonInteraction !== undefined ? !!nonInteraction : !!this.nonInteraction,
+      };
+
+      if (campaign) {
+        if (campaign.name) payload.campaignName = campaign.name;
+        if (campaign.source) payload.campaignSource = campaign.source;
+        if (campaign.medium) payload.campaignMedium = campaign.medium;
+        if (campaign.content) payload.campaignContent = campaign.content;
+        if (campaign.term) payload.campaignKeyword = campaign.term;
+      }
+
+      payload = {
+        payload,
+        ...this.setCustomDimenionsAndMetrics(properties),
+      };
+
+      window.ga(`${this.trackerName}send`, 'event', payload.payload);
+      logger.debug('in GoogleAnalyticsManager track');
+    }
+  }
+
+  page(htElement) {
+    logger.debug('in GoogleAnalyticsManager page');
+
+    const { properties, context } = htElement.message;
+    const { category, referrer } = properties;
+    const eventProperties = properties;
+    let name;
+    if (category && htElement.message.name) {
+      name = `${category} ${htElement.message.name}`;
+    } else if (!category && !htElement.message.name) {
+      name = '';
+    } else {
+      name = htElement.message.name || category;
+    }
+
+    const campaign = context.campaign || {};
+    let pageview = {};
+    const pagePath = this.path(eventProperties, this.includeSearch);
+    const pageReferrer = referrer || '';
+    let pageTitle;
+    if (!category && !htElement.message.name) pageTitle = eventProperties.title;
+    else if (!category) pageTitle = htElement.message.name;
+    else if (!htElement.message.name) pageTitle = category;
+    else pageTitle = name;
+
+    pageview.page = pagePath;
+    pageview.title = pageTitle;
+    pageview.location = eventProperties.url;
+
+    if (campaign) {
+      if (campaign.name) pageview.campaignName = campaign.name;
+      if (campaign.source) pageview.campaignSource = campaign.source;
+      if (campaign.medium) pageview.campaignMedium = campaign.medium;
+      if (campaign.content) pageview.campaignContent = campaign.content;
+      if (campaign.term) pageview.campaignKeyword = campaign.term;
+    }
+
+    const resetCustomDimensions = {};
+    for (let i = 0; i < this.resetCustomDimensionsOnPage.length; i += 1) {
+      const property = this.resetCustomDimensionsOnPage[i].resetCustomDimensionsOnPage;
+      if (this.dimensionsArray[property]) {
+        resetCustomDimensions[this.dimensionsArray[property]] = null;
+      }
+    }
+    window.ga(`${this.trackerName}set`, resetCustomDimensions);
+
+    // adds more properties to pageview which will be sent
+    pageview = {
+      ...pageview,
+      ...this.setCustomDimenionsAndMetrics(eventProperties),
+    };
+    const payload = {
+      page: pagePath,
+      title: pageTitle,
+    };
+    logger.debug(`referrer: ${pageReferrer}`);
+    logger.debug('document referrer: ', document.referrer);
+    if (pageReferrer !== document.referrer) payload.referrer = pageReferrer;
+
+    window.ga(`${this.trackerName}set`, payload);
+
+    if (this.pageCalled) delete pageview.location;
+
+    window.ga(`${this.trackerName}send`, 'pageview', pageview);
+
+    // categorized pages
+    if (category && this.trackCategorizedPages) {
+      if (this.useRichEventNames) {
+        htElement.message.event = `Viewed ${category} Page`;
+        htElement.message.type = 'track';
+      }
+      this.track(htElement, { nonInteraction: 1 });
+    }
+
+    // named pages
+    if (name && this.trackNamedPages) {
+      if (this.useRichEventNames) {
+        htElement.message.event = `Viewed ${name} Page`;
+        htElement.message.type = 'track';
+      }
+      this.track(htElement, { nonInteraction: 1 });
+    }
+    this.pageCalled = true;
+  }
+
+  isLoaded() {
+    logger.debug('in GA isLoaded');
+    return !!window.gaplugins;
+  }
+
+  isReady() {
+    return !!window.gaplugins;
+  }
+
+  /**
+   *
+   *
+   * @param  {} obj  incoming properties
+   * @param  {} dimensions   the dimension mapping which is entered by the user in the ui. Eg: firstName : dimension1
+   * @param  {} metrics  the metrics mapping which is entered by the user in the ui. Eg: age : metrics1
+   * @param  {} contentGroupings the contentGrouping mapping which is entered by the user in the ui. Eg: section : contentGrouping1
+   *
+   * This function maps these dimensions,metrics and contentGroupings with the incoming properties to send it to GA where the user has to set the corresponding dimension/metric/content group.
+   * For example if:
+   * if obj -> {age: 24}
+   * metrics -> {age: metric1}
+   * then the function will return {metric1:24} and it will be shown sent to GA if metric1 is set there.
+   *
+   * if obj -> {age: 24}
+   * metrics - {revenue: metric2}
+   * then the function will return {} as there is no corresponding mapping of metric.
+   *
+   */
+  metricsFunction(obj, dimensions, metrics, contentGroupings) {
+    const ret = {};
+
+    each([metrics, dimensions, contentGroupings], (group) => {
+      each(group, (prop, key) => {
+        let value = obj[prop];
+        if (is.boolean(value)) value = value.toString();
+        if (value || value === 0) ret[key] = value;
+      });
+    });
+
+    return ret;
+  }
+
+  formatValue(value) {
+    if (!value || value < 0) return 0;
+    return Math.round(value);
+  }
+
+  /**
+   * @param  {} props
+   * @param  {} inputs
+   */
+  setCustomDimenionsAndMetrics(props) {
+    const ret = {};
+    const custom = this.metricsFunction(
+      props,
+      this.dimensionsArray,
+      this.metricsArray,
+      this.contentGroupingsArray,
+    );
+    if (Object.keys(custom).length > 0) {
+      if (this.setAllMappedProps) {
+        window.ga(`${this.trackerName}set`, custom);
+      } else {
+        Object.keys(custom).forEach((key) => {
+          ret[key] = custom[key];
+        });
+        // each(custom, (key, value) => {
+        //   ret[key] = value;
+        // });
+      }
+    }
+    return ret;
+  }
+
+  /**
+   *  Return the path based on `properties` and `options`
+   *
+   * @param  {} properties
+   * @param  {} includeSearch
+   */
+  path(properties, includeSearch) {
+    let str = properties.path;
+    if (properties && includeSearch && properties.search) {
+      str += properties.search;
+    }
+    return str;
+  }
+
+  /**
+   * Creates a track out of product properties
+   * @param  {} htElement
+   * @param  {} properties
+   */
+  createProductTrack(htElement, properties) {
+    const props = properties || {};
+    props.currency = properties.currency || htElement.message.properties.currency;
+    return { properties: props };
+  }
+
+  /**
+   * Loads ec.js (unless already loaded)
+   * @param  {} htElement
+   * @param  {} a
+   */
+  loadEnhancedEcommerce(htElement) {
+    if (this.enhancedEcommerceLoaded === 0) {
+      window.ga(`${this.trackerName}require`, 'ec');
+      this.enhancedEcommerceLoaded = 1;
+    }
+
+    window.ga(`${this.trackerName}set`, '&cu', htElement.message.properties.currency);
+  }
+
+  /**
+   * helper class to not repeat `ec:addProduct`
+   * @param  {} htElement
+   * @param  {} inputs
+   */
+  enhancedEcommerceTrackProduct(htElement) {
+    const props = htElement.message.properties;
+
+    let product = {
+      id: props.product_id || props.id || props.sku,
+      name: props.name,
+      category: props.category,
+      quantity: props.quantity,
+      price: props.price,
+      brand: props.brand,
+      variant: props.variant,
+      currency: props.currency,
+    };
+
+    if (props.position != null) {
+      product.position = Math.round(props.position);
+    }
+
+    const { coupon } = props;
+    if (coupon) product.coupon = coupon;
+    product = {
+      ...product,
+      ...this.metricsFunction(
+        props,
+        this.dimensionsArray,
+        this.metricsArray,
+        this.contentGroupingsArray,
+      ),
+    };
+
+    window.ga(`${this.trackerName}ec:addProduct`, product);
+  }
+
+  /**
+   * set action with data
+   * @param  {} htElement
+   * @param  {} action
+   * @param  {} data
+   * @param  {} inputs
+   */
+  enhancedEcommerceTrackProductAction(htElement, action, data) {
+    this.enhancedEcommerceTrackProduct(htElement);
+    window.ga(`${this.trackerName}ec:setAction`, action, data || {});
+  }
+
+  /**
+   * @param  {} htElement
+   * @param  {} inputs
+   */
+  pushEnhancedEcommerce(htElement) {
+    const args = rejectArr([
+      'send',
+      'event',
+      htElement.message.properties.category || 'EnhancedEcommerce',
+      htElement.message.event || 'Action not defined',
+      htElement.message.properties.label,
+      {
+        nonInteraction: 1,
+        ...this.setCustomDimenionsAndMetrics(htElement.message.properties),
+      },
+    ]);
+
+    let { event } = htElement.message;
+    event = event.toLowerCase();
+
+    if (this.eventWithCategoryFieldProductScoped.includes(event)) {
+      args[2] = 'EnhancedEcommerce';
+    }
+
+    window.ga.call(window, ...args);
+  }
+
+  /**
+   * @param  {} item
+   * @param  {} products
+   */
+  getProductPosition(item, products) {
+    const { position, product_id: productId } = item.properties;
+
+    if (
+      typeof position !== 'undefined' &&
+      !Number.isNaN(Number(position)) &&
+      Number(position) > -1
+    ) {
+      return position;
+    }
+
+    return products.map((x) => x.product_id).indexOf(productId) + 1;
+  }
+
+  /**
+   *extracts checkout options
+   * @param  {} htElement
+   */
+  extractCheckoutOptions(htElement) {
+    const options = [
+      htElement.message.properties.paymentMethod,
+      htElement.message.properties.shippingMethod,
+    ];
+    // remove all nulls and join with commas.
+    const valid = rejectArr(options);
+    return valid.length > 0 ? valid.join(', ') : null;
+  }
+}